@name

Description

Some earlier documentors introduced the @name tag in order to name procedural pages, and so phpDocumentor supports this syntax. Use a @name tag in a page-level DocBlock to rename the procedural page. Using @name will disable automatic procpage documentation linking from include tags, as they will no longer be able to find the file associated with the new name.

phpDocumentor also recognizes the @name tag in global variable DocBlocks (in conjunction with @global), and uses it to rename a global variable for documentation to make it more readable. A global variable name MUST begin with a dollar sign ($) or phpDocumentor will ignore the tag and raise an error.

Here's a few examples:

/**
* example of page-level @name
* @name mypage
* @author blahblah
* @version -6
*/
/**
* @name $baz
* @global $GLOBALS['baz']
*/
$GLOBALS['baz'] = array('foo','bar');