ApiGen\Console\Command\GenerateCommand::configure PHP Method

configure() protected method

protected configure ( )
    protected function configure()
    {
        $this->setName('generate')->setDescription('Generate API documentation')->addOption('source', 's', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Dirs or files documentation is generated for.')->addOption('destination', 'd', InputOption::VALUE_REQUIRED, 'Target dir for documentation.')->addOption('accessLevels', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Access levels of included method and properties [options: public, protected, private].', ['public', 'protected'])->addOption('annotationGroups', null, InputOption::VALUE_REQUIRED, 'Generate page with elements with specific annotation.')->addOption('config', null, InputOption::VALUE_REQUIRED, 'Custom path to apigen.neon config file.', getcwd() . '/apigen.neon')->addOption('googleCseId', null, InputOption::VALUE_REQUIRED, 'Custom google search engine id (for search box).')->addOption('baseUrl', null, InputOption::VALUE_REQUIRED, 'Base url used for sitemap (for search box).')->addOption('googleAnalytics', null, InputOption::VALUE_REQUIRED, 'Google Analytics tracking code.')->addOption('debug', null, InputOption::VALUE_NONE, 'Turn on debug mode.')->addOption('download', null, InputOption::VALUE_NONE, 'Add link to ZIP archive of documentation.')->addOption('extensions', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Scanned file extensions.', ['php'])->addOption('exclude', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Directories and files matching this mask will not be parsed (e.g. */tests/*).')->addOption('groups', null, InputOption::VALUE_REQUIRED, 'The way elements are grouped in menu [options: namespaces, packages].', 'namespaces')->addOption('main', null, InputOption::VALUE_REQUIRED, 'Elements with this name prefix will be first in tree.')->addOption('internal', null, InputOption::VALUE_NONE, 'Include elements marked as @internal.')->addOption('php', null, InputOption::VALUE_NONE, 'Generate documentation for PHP internal classes.')->addOption('noSourceCode', null, InputOption::VALUE_NONE, 'Do not generate highlighted source code for elements.')->addOption('templateTheme', null, InputOption::VALUE_REQUIRED, 'ApiGen template theme name.', 'default')->addOption('templateConfig', null, InputOption::VALUE_REQUIRED, 'Your own template config, has higher priority then --template-theme.')->addOption('title', null, InputOption::VALUE_REQUIRED, 'Title of generated documentation.')->addOption('tree', null, InputOption::VALUE_NONE, 'Generate tree view of classes, interfaces, traits and exceptions.')->addOption('deprecated', null, InputOption::VALUE_NONE, 'Generate documentation for elements marked as @deprecated (deprecated, only present for BC).')->addOption('todo', null, InputOption::VALUE_NONE, 'Generate documentation for elements marked as @todo (deprecated, only present for BC).')->addOption('charset', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Charset of scanned files (deprecated, only present for BC).')->addOption('skip-doc-path', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Files matching this mask will be included in class tree,' . ' but will not create a link to their documentation (deprecated, only present for BC).')->addOption('overwrite', 'o', InputOption::VALUE_NONE, 'Force overwrite destination directory');
    }