CyDocs/cli.php at master · cyclonephp/CyDocs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?php

use cyclone as cy;

return array(
    'docs' => array(
        'descr' => 'Documentation generator tool for CyclonePHP',
        'commands' => array(
            'api' => array(
                'descr' => 'generates API docs for the classes in the enables libraries',
                'callback' => array(cy\Docs::inst(), 'cli_api_bootstrap'),
                'arguments' => array(
                    '--output-dir' => array(
                        'alias' => '-o',
                        'default' => cy\SYSROOT . 'docs/',
                        'parameter' => '<output-dir>',
                        'descr' => 'the root directory of the generated documentation'
                    ),
                    '--internal' => array(
                        'alias' => '-i',
                        'default' => FALSE,
                        'parameter' => NULL,
                        'descr' => 'include internal documentation too (recommmended for people who develop CyclonePHP itself)'
                    ),
                    '--lib' => array(
                        'parameter' => '<libraries>',
                        'alias' => '-l',
                        'descr' => 'a comma-separated list of libraries that\'s docs should be generated. all stands for all libs (including the application)',
                        'default' => 'all'
                    ),
                    '--stylesheet' => array(
                        'parameter' => '<path>',
                        'alias' => '-s',
                        'descr' => 'the stylesheet file that should be applied to the output',
                        'default' => cy\FileSystem::get_root_path('cydocs') . 'assets/css/cydocs/default.css'
                    ),
                    '--pdf' => array(
                        'alias' => '-p',
                        'default' => FALSE,
                        'descr' => 'flag marking that PDF output should be generated instead of HTML',
                        'parameter' => NULL
                    ),
                    '--forced' => array(
                        'parameter' => NULL,
                        'default' => FALSE,
                        'alias' => '-f',
                        'descr' => 'the generator removes all existing docs directories if passed'
                    ),
                    '--measure' => array(
                        'parameter' => NULL,
                        'default' => FALSE,
                        'alias' => '-m',
                        'descr' => 'flag marking if the execution time and memory usage'
                    ),
                    '--title' => array(
                        'parameter' => '<title>',
                        'alias' => '-t',
                        'default' => '',
                        'descr' => 'The title of the generated documentation. Only used if the generation goes for multiple libraries.'
                    ),
                    '--preface' => array(
                        'parameter' => '<html-file-containing-preface>',
                        'alias' => '-p',
                        'default' => FALSE,
                        'descr' => 'The main page of the output. Only used if the generation goes for multiple libraries.'
                    ),
                    '--line-numbers' => array(
                        'parameter' => NULL,
                        'alias' => '-L',
                        'descr' => 'show line numbers of code examples'
                    )
                )
            )
        )
    )
);