Previous | Up | Next |
inline {@inheritdoc} | phpDocumentor Inline tags | inline {@source} |
The inline {@link} tag is used to document any element (page, global variable, include, class, function, define, method, variable).
New in version 1.2: You can link to any defined function in the current php version using the function's name. This linking is done using the standard php function http://www.php.net/get_defined_functions, and so relies on the version of php that is used to execute phpDocumentor. A benefit of this method is that the function highlighting will automatically upgrade with a php upgrade without any change to the underlying code. You may also link directly to any portion of the php website using the fake package override PHP_MANUAL (as in PHP_MANUAL#get_defined_functions, or PHP_MANUAL#support.php).
inline {@link} displays links directly in the natural text flow of a DocBlock. If you want to display links prominently after descriptive text, use @see or @link.For parameter information, see @see or @link. The guidelines for giving the element name to inline @link are the same as outlined in the @see manual page.
The inline {@link} differs from ordinary non-inline tags. Inline tags parse and display their output directly in the documentation. In other words, this DocBlock:
Parses as (with -o HTML:frames:default):
Parses as (with -o HTML:frames:default):
Previous | Up | Next |
inline {@inheritdoc} | phpDocumentor Inline tags | inline {@source} |
Documentation generated on Mon, 05 Dec 2011 21:41:04 -0600 by phpDocumentor 1.4.4