inline {@tutorial}
Display a link to a tutorial in the the flow of descriptive text
by Gregory Beaver
Tag Documentation written by [email protected]
Copyright 2002, Gregory Beaver
(phpDocumentor 1.2+)
{@tutorial
package/
subpackage/
tutorialname.ext
#section.subsection
description
}
}
Description
The inline {@tutorial} tag is used in any context to link to the documentation for a tutorial.
Caution | inline {@tutorial} displays links directly in the natural text flow of a DocBlock. If you want to display links to a tutorial prominently after descriptive text, use @tutorial |
Example
The inline {@tutorial} differs from ordinary non-inline tags. Inline tags parse and display their output directly in the documentation. In other words, this DocBlock:
/**
* Text with a normal @tutorial tag
* @tutorial phpDocumentor/phpDocumentor.pkg
*/
function element()
{
}
Parses as (with -o HTML:frames:default):
<H3>element</H3>
<P><B>element ( )</B></P>
<!-- ========== Info from phpDoc block ========= -->
<b></b>
<pre>
Text with a normal @tutorial tag
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
<DD><b>Tutorial</b> - <CODE><a href="../phpDocumentor/tutorial_phpDocumentor.pkg.html">phpDocumentor 1.2.2 Tutorial</a></CODE></DD>
</DL>
<HR>
|
/**
* Text with an inline link to {@tutorial phpDocumentor/phpDocumentor.pkg} displays
* without a break in the flow
*/
function element()
{
}
Parses as (with -o HTML:frames:default):
<H3>element</H3>
<P><B>element ( )</B></P>
<!-- ========== Info from phpDoc block ========= -->
<b></b>
<pre>
Text with an an inline link to <a href="../phpDocumentor/tutorial_phpDocumentor.pkg.html">phpDocumentor 1.2.2 Tutorial</a> displays without a break in the flow
</pre>
<DL>
<DT>Function Parameters:</DT>
<DT>Function Info:</DT>
</DL>
<HR>
|