Prev | Next |
The inline {@tutorial} tag is used in any context to link to the documentation for a tutorial.
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 @tutorialThe inline {@tutorial} 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):
<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>
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>
Prev | Up | Next |
inline {@toc} | phpDocumentor Inline tags | Writing a New Converter |