Overview
Prev	Solar_Docs_Phpdoc	Next

Overview

Parses a single PHPDoc comment block into summary, narrative, and technical portions.

http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#format

Supported technical tags are ...

For classes ...

@category name                   # category for the package
@package name                    # class package name
@subpackage name                 # class subpackage name
@copyright info                  # class copyright information
@license uri name text           # licensing information
@version info                    # version information

For properties ...

@var type [summary]              # class property

For methods ...

@exception class [summary]       # alias to @throws
@param type [$name] [summary]    # method parameter
@return type [summary]           # method return
@throws class [summary]          # exceptions thrown by the method
@staticvar type $name summary    # use of a static variable within a method

General-purpose ...

@see name                        # "see also" this element name
@todo summary                    # todo item
@ignore                          # ignore this element
@author name <email> summ        # author name, email, and summary
@deprecated                      # notes the element is deprecated
@deprec                          # alias to @deprecated
@link uri text                   # link to an external URI
@since info                      # element has been available since this time
@example file                    # path to an external example file

Not supported ...

@global type $globalvar          # description of global variable usage in a function
@name procpagealias              #
@name $globalvaralias            #
@magic                           # phpdoc.de compatibility
@internal                        # private information for advanced developers only
{@code}                          # inline tags
{@docRoot}                       # 
{@inheritDoc}                    # 
{@link}                          # 
{@linkplain}                     # 
{@literal}                       # 
{@value}                         #

Package

This class is part of the Solar_Docs package.

Inheritance:

Solar_Base
- Solar_Docs_Phpdoc

Configuration Keys

None.

Constants

None.

Public Properties

The Solar_Docs_Phpdoc class has no public properties; try the list of all properties.

Public Methods

These are all the public methods in the Solar_Docs_Phpdoc class.

You can also view the list of all public, protected, and private methods.

__construct(): Constructor.
__destruct(): Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
dump(): Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
locale(): Looks up class-specific locale strings based on a key.
parse(): Returns docblock comment parsed into summary, narrative, and technical information portions.
parseAuthor(): Parses one or more @author lines into $this->_info.
parseCategory(): Parses one @category line into $this->_info.
parseConfig(): Parses one or more @config lines into $this->_info.
parseCopyright(): Parses one @copyright line into $this->_info.
parseDeprec(): Parses one @deprec line into $this->_info; alias for @deprecated.
parseDeprecated(): Parses one @deprecated line into $this->_info.
parseExample(): Parses one @example line into $this->_info.
parseException(): Parses one or more @exception lines into $this->_info; alias for @throws.
parseIgnore(): Parses one @ignore line into $this->_info.
parseLicense(): Parses one @license line into $this->_info.
parseLink(): Parses one or more @link lines into $this->_info.
parsePackage(): Parses one @package line into $this->_info.
parseParam(): Parses one or more @param lines into $this->_info.
parseReturn(): Parses one @return line into $this->_info.
parseSee(): Parses one or more @see lines into $this->_info.
parseSince(): Parses one @since line into $this->_info.
parseStaticvar(): Parses one or more @staticvar lines into $this->_info.
parseSubpackage(): Parses one @subpackage line into $this->_info.
parseThrows(): Parses one or more @throws lines into $this->_info.
parseTodo(): Parses one or more @todo lines into $this->_info.
parseVar(): Parses one @var line into $this->_info.
parseVersion(): Parses one @version line into $this->_info.

Prev	Up	Next
Solar_Docs_Phpdoc	Home	Configuration