• Home
• phpDoctor

PHP Class phpDoctor

ファイルを表示 Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property	Type	Description
$_constants	boolean	Parse out global constants.
$_currentFilename	str	The path and filename of the current file being parsed.
$_defaultPackage	str	Package to use for elements not in a package.
$_doclet	str	Specifies the name of the class that starts the doclet used in generating the documentation.
$_docletPath	str	Specifies the path to the doclet starting class file. If the doclet class is not in a file named <_doclet>/<_doclet>.php then this path should include the filename of the class file also.
$_files	str[]	Array of files to parse.
$_formatter	str	Specifies the name of the text formatter class.
$_formatterPath	str	Specifies the path to the formatters to use.
$_globals	boolean	Parse out global variables.
$_ignore	str[]	Array of files not to parse.
$_ignorePackageTags	boolean	Ignore any package tags in the source code.
$_options	str[]	Options from config file.
$_overview	str	Overview file. The "source" file that contains the overview documentation.
$_packageCommentDir	str	Package comment directory. if set, PHPDoctor will look in this directory for package comment files. Otherwise it looks in a directory named after the package ala Javadoc.
$_path	str	The path PHPDoctor is running from.
$_pearCompat	boolean	Whether or not to use PEAR compatibility mode for first sentence tags.
$_private	boolean	Parse all classes and members.
$_protected	boolean	Parse protected and public classes and members.
$_public	boolean	Parse only public classes and members.
$_quiet	boolean	Turn off all output other than warnings and errors.
$_sourceIndex
$_sourcePath	str	Directory containing files for parsing.
$_startTime	integer	The time in microseconds at the start of execution.
$_subdirs	boolean	Traverse sub-directories
$_tagletPath	str	Specifies the path to the taglets to use.
$_tree	boolean	Display class tree.
$_useClassPathAsPackage	boolean	Use the filesystem path of the class as the package it should be in.
$_verbose	boolean	Turn on verbose output.
$_version	str	The version of PHPDoctor.

Public Methods

Method	Description
_buildFileList ( $files, $dir )	Build a complete list of file to parse. Expand out wildcards and traverse directories if asked to.
_getNext ( &$tokens, $key, $whatToGet, $maxDist ) : str	Get next token of a certain type from token array
_getPrev ( &$tokens, $key, $whatToGet ) : str	Get previous token of a certain type from token array
_getProgramElementName ( &$tokens, $key ) : str	Get the next program element name from the token list
_getTime ( ) : integer	Get the current time in microseconds.
_hasPrivateName ( $name ) : boolean	Does the given element name conform to the format that is used for private elements?
_includeElements ( &$element ) : boolean	Is an element private and we are including private elements, or element is protected and we are including protected elements.
_mergeArrays ( $one, $two ) : mixed[]	Recursively merge two arrays into a single array. This differs from the PHP function array_merge_recursive as it replaces values with the same index from the first array with items from the second.
_mergeSuperClassData ( &$rootDoc, $parent = NULL )
createTag ( $name, $text, &$data, &$root ) : Tag	Create a tag. This method first tries to load a Taglet for the given tag name, upon failing it then tries to load a PHPDoctor specialised tag class (e.g. classes/paramtag.php), if it still has not found a tag class it uses the standard tag class.
defaultPackage ( ) : str	Return the default package.
docletPath ( ) : str	Return the path PHPDoctor is running from.
error ( $msg )	Write an error message to standard error.
execute ( &$rootDoc ) : boolean	Loads and runs the doclet.
fixPath ( $path ) : str	Add a trailing slash to a path if it does not have one.
getFormatter ( ) : TextFormatter	Creates the formatter and returns it.
getOption ( $option ) : str	Get a configuration option.
makeAbsolutePath ( $path, $prefix ) : str	Turn path into an absolute path using the given prefix?
message ( $msg )	Write a message to standard output.
options ( ) : str[]	Return a reference to the set options.
parse ( ) : RootDoc	Parse files into tokens and create rootDoc.
phpDoctor ( $config = 'default.ini' )	Constructor
processDocComment ( $comment, &$root ) : mixed[]	Process a doc comment into a doc tag array.
sourcePath ( ) : str	Return the source path.
verbose ( $msg )	Write a message to standard output.
version ( ) : str	Return the version of PHPDoctor.
warning ( $msg )	Write a warning message to standard error.

Method Details

Property Details