Previous | Up | Next |
@todo | phpDocumentor tags | @uses |
The @tutorial tag may be used to document any element (global variable, include, page, class, function, define, method, variable)
@tutorial only displays links to tutorials/extended documentation. If you want to display a hyperlink or link to a documented element, use @see or @link or inline {@link}Along with inline {@tutorial}, the @tutorial tag is among the most useful features of phpDocumentor. With this tag, you can create a link to any tutorial or extended documentation. The @tutorial parser can be told exactly where to look using a format similar to a URI:
package/ -- Preface to specify a tutorial in a specific package
subpackage/ -- Preface to specify a tutorial in a specific package/subpackage
#section -- Link to a specific section of the documentation package/subpackage/tutorial.ext#section
.subsection -- Link to a specific sub-section of the documentation package/subpackage/tutorial.ext#section.subsection
However, @tutorial, like @see, is also intelligent enough to recognize shorthand. The search order for a tutorial is identical to what is specified in @see
Here's an example of valid @tutorial syntax:
Previous | Up | Next |
@todo | phpDocumentor tags | @uses |
Documentation generated on Mon, 05 Dec 2011 21:46:37 -0600 by phpDocumentor 1.4.4