forked from qury/phpdoc-to-rst
/
GenerateDocumentationCommand.php
executable file
·108 lines (102 loc) · 4 KB
/
GenerateDocumentationCommand.php
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?php
/**
* @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
* @author Julius Härtl <jus@bitgrid.net>
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace JuliusHaertl\PHPDocToRst;
use JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension;
use JuliusHaertl\PHPDocToRst\Extension\NoPrivateExtension;
use JuliusHaertl\PHPDocToRst\Extension\PublicOnlyExtension;
use JuliusHaertl\PHPDocToRst\Extension\TocExtension;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
* Class GenerateDocumentationCommand.
*
* @internal Only for use of the phpdoc-to-rst cli tool
*/
class GenerateDocumentationCommand extends Command
{
protected function configure()
{
$this->setName('generate')->setDescription('Generate documentation')->setHelp('This command allows you to generate sphinx/rst based documentation from PHPDoc annotations.')->addArgument(
'target',
InputArgument::REQUIRED,
'Destination for the generated rst files'
)->addArgument(
'src',
InputArgument::IS_ARRAY,
'Source directories to parse'
)->addOption(
'public-only',
'p',
InputOption::VALUE_NONE
)->addOption(
'show-private',
null,
InputOption::VALUE_NONE
)->addOption(
'element-toc',
't',
InputOption::VALUE_NONE
)->addOption(
'repo-github',
null,
InputOption::VALUE_REQUIRED,
'Github URL of the projects git repository (requires --repo-base as well)',
false
)->addOption(
'repo-base',
null,
InputOption::VALUE_REQUIRED,
'Base path of the project git repository',
false
);
}
protected function execute(InputInterface $input, OutputInterface $output)
{
$src = $input->getArgument('src');
$dst = $input->getArgument('target');
$apiDocBuilder = new ApiDocBuilder($src, $dst);
if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
$apiDocBuilder->setVerboseOutput(true);
}
if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE) {
$apiDocBuilder->setVerboseOutput(true);
$apiDocBuilder->setDebugOutput(true);
}
if ($input->getOption('public-only')) {
$apiDocBuilder->addExtension(PublicOnlyExtension::class);
}
if (!$input->getOption('show-private')) {
$apiDocBuilder->addExtension(NoPrivateExtension::class);
}
if ($input->getOption('element-toc')) {
$apiDocBuilder->addExtension(TocExtension::class);
}
if ($input->getOption('repo-github') && $input->getOption('repo-base')) {
$apiDocBuilder->addExtension(GithubLocationExtension::class, [
$input->getOption('repo-base'),
$input->getOption('repo-github'),
]);
}
$apiDocBuilder->build();
}
}