phpDocumentor creates documentation from PHP source files. The simplest way to use it is: $ phpdoc run -d -t

This will parse every file ending with .php, .php3 and .phtml in and then output a HTML site containing easily readable documentation in

. phpDocumentor will try to look for a phpdoc.dist.xml or phpdoc.xml file in your current working directory and use that to override the default settings if present. In the configuration file can you specify the same settings (and more) as the command line provides.

 Methods

__call(string $name, \string[] $arguments) : void | string

__construct() : void

__get(string $key) : string

__isset(string $key) : boolean

__set(string $key, string $value) : void

__toString() : string

__unset(string $key) : void

addArguments(array $argv) : \Zend_Console_Getopt

addOption(\string[] | string $flags, string $parameter_type, string $description) : void

addRules(array $rules) : \Zend_Console_Getopt

execute() : void

getOption(string $flag) : mixed

getOptions() : array

getRemainingArgs() : array

getUsageDescription() : string | null

getUsageMessage() : string

parse(bool $force) : null | \phpDocumentor_Task_Project_Run

setAliases(array $aliasMap) : \Zend_Console_Getopt

setArguments(array $argv) : \Zend_Console_Getopt

setConfig(string $value) : void

setHelp(array $helpMap) : \Zend_Console_Getopt

setOption(string $configKey, string $configValue) : \Zend_Console_Getopt

setOptions(array $getoptConfig) : \Zend_Console_Getopt

setUsageDescription(string $description) : void

toArray() : array

toJson() : string

toString() : string

toXml() : string

_addRulesModeGnu(string $rules) : void

_addRulesModeZend(array $rules) : void

_checkParameterType(string $flag, string $param) : bool

_parseLongOption(mixed $argv) : void

_parseShortOptionCluster(mixed $argv) : void

_parseSingleOption(string $flag, mixed $argv) : void

configure() : void

getVisibility() : string

prePopulate() : void

 Properties

$_argv : array

$_getoptConfig 

$_options : array

$_parsed : boolean

$_progname : string

$_remainingArgs : array

$_ruleMap : array

$_rules : array

$taskname : string

$usage_description : string

 Constants

CONFIG_DASHDASH 

CONFIG_IGNORECASE 

CONFIG_PARSEALL 

CONFIG_RULEMODE 

MODE_GNU 

MODE_ZEND 

PARAM_OPTIONAL 

PARAM_REQUIRED 

TYPE_INTEGER 

TYPE_STRING 

TYPE_WORD