(phpDocumentor 0.1+ )
inline {@link} -- display a hyperlink or link to an element's documentation in the the flow of descriptive textYou may use the inline{@link} tag 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 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)
Caution |
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 inline {@link} differs from all ordinary tags. Inline tags parse and display their output directly in the documentation. In other words, this DocBlock:
/** * Text with a normal @see and @link tag * @see element * @link http://www.example.com */ function element() { } |
Parses as:
elementelement ( ) Text with a normal @see and @link tag
|
/** * Text with an {@link http://www.example.com Inline Link to a Hyperlink} and an inline link to {@link element} displays * without a break in the flow */ function element() { } |
Parses as:
elementelement ( ) Text with an Inline Link to a Hyperlink and an inline link to element() displays without a break in the flow
|
Prev | Home | Next |
@see | Up | inline {@id} |
Tag Documentation written by Gregory Beaver <cellog@users.sourceforge.net>
Copyright © 2002, Gregory Beaver