2007/05
23
Command-line switches
来源于： phpdoc manual
-cp --converterparams dynamic parameters for a converter, separate values with commas
-ct --customtags comma-separated list of non-standard @tags to pass to the converter as valid tags
-d --directory name of a directory(s) to parse directory1,directory2
-dc --defaultcategoryname name to use for the default category. If not specified, uses 'default'
-dh --hidden set equal to on (-dh on) to descend into hidden directories (directories starting with '.'), default is off
-dn --defaultpackagename name to use for the default package. If not specified, uses 'default'
-ed --examplesdir full path of the directory to look for example files from @example tags
-f --filename name of file(s) to parse ',' file1,file2. Can contain complete path and * ? wildcards
-i --ignore file(s) that will be ignored, multiple separated by ','. Wildcards * and ? are ok
-is --ignoresymlinks Explicitly ignore symlinks, both symlinked directories and symlinked files. Valid options are "on" and "offn" default value is "off"
-it --ignore-tags tags to ignore for this parse. @package, @subpackage, @access and @ignore may not be ignored.
-j --javadocdesc use JavaDoc-compliant description (short desc is part of description, and is everything up to first .)
-o --output output information, format:converter:template (HTML:frames:phpedit for example)
-p --pear Parse a PEAR-style repository (package is directory, _members are @access private) on/off default off
-po --packageoutput output documentation only for selected packages. Use a comma-delimited list
-pp --parseprivate parse elements marked private with @access. Valid options are "on" and "off" default value is "off"
-q --quiet do not display parsing/conversion messages. Useful for cron jobs. Valid options are "on" and "off" default value is "off"
-ric --readmeinstallchangelog Specify custom filenames to parse like README, INSTALL or CHANGELOG files
-s --sourcecode generate highlighted sourcecode for every parsed file (PHP 4.3.0+ only) on/off default off
-t --target path where to save the generated files
-ti --title title of generated documentation, default is 'Generated Documentation'
-tb --templatebase base location of all templates for this parse. Note that if -tb /path/to/here, then templates for HTML:frames:default must be in /path/to/here/Converters/HTML/frames/templates/default/templates and the /path/to/here/Converters/HTML/frames/templates/default/templates_c directory must exist, or Smarty will bail on attempting to compile the templates.
-ue --undocumentedelements Enable warnings for undocumented elements. Useful for identifying classes and methods that haven't yet been documented. Valid options are "on" and "offn" default value is "off"
来源于： phpdoc manual
Last modified on 2007-05-23 15:46
