phpDocumentor phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Prev Next

phpDocumentor Inline tags

How to use Inline tags in DocBlocks and in Tutorials

by Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver

Inline Tags Manual

Welcome to the phpDocumentor Inline Tags Manual

Unlike regular tags (see phpDocumentor tags), Inline tags display in the text flow where they appear. As of version 1.2, there are several inline tags. The allowed inline tag list is different for tutorials and regular in-code documentation.

Inline tags allowed in both tutorials and DocBlocks include:

Inline tags allowed in only DocBlocks include:

Inline tags allowed in only tutorials include:

The example below will display the text "this function works heavily with foo() to rule the world" where foo() represents a hyperlink that links to the function foo()'s documentation.

  1. /**
  2.  * inline tags demonstration
  3.  *
  4.  * this function works heavily with {@link foo()} to rule the world. If I want
  5.  * to use the characters "{@link" in a docblock, I just use "{@}link."  If
  6.  * I want the characters "{@*}" I use "{@}*}"
  7.  */
  8. function bar()
  9. {
  10. }
  11.  
  12. function foo()

Prev Up Next
@version phpDocumentor Manual inline {@example}

Documentation generated on Tue, 06 Dec 2011 07:15:56 -0600 by phpDocumentor 1.4.4