Previous Up Next
@todo phpDocumentor tags @uses

@tutorial

Display a link to the documentation for a tutorial

Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 0.1+)
@tutorial package/ subpackage/ tutorialname.ext #section.subsection description

Description

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

Example

Here's an example of valid @tutorial syntax:

  1. /**
  2.  * This will link to the phpDocumentor.pkg tutorial if it is unique, regardless
  3.  * of its location
  4.  * @tutorial phpDocumentor.pkg
  5.  */
  6. class test1
  7. {
  8. }
  9.  
  10. /**
  11.  * This will link to the phpDocumentor.pkg tutorial if and only if it is in the
  12.  * phpDocumentor package, any subpackage.
  13.  * @tutorial phpDocumentor/phpDocumentor.pkg
  14.  */
  15. class test2
  16. {
  17. }
  18.  
  19. /**
  20.  * This will link to the phpDocumentor.pkg tutorial if and only if it is in the
  21.  * phpDocumentor package, info subpackage.
  22.  * @tutorial phpDocumentor/info/phpDocumentor.pkg
  23.  */
  24. class test3
  25. {
  26. }
  27.  
  28. /**
  29.  * This will link to the phpDocumentor.pkg tutorial, section1 and subsection one
  30.  * @tutorial phpDocumentor.pkg#section1, phpDocumentor.pkg#section1.subsection1
  31.  */
  32. class test4
  33. {
  34. }

Previous Up Next
@todo phpDocumentor tags @uses

Documentation generated on Mon, 05 Dec 2011 21:35:25 -0600 by phpDocumentor 1.4.4