@name

Description

phpDocumentor 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.

Example

Here's an examples:

1. /**
2.  * Now, when @global is used in a function, it will link to $baz
3.  * @name $baz
4.  * @global $GLOBALS['baz'] 
5.  */
6. $GLOBALS['baz'] = array('foo','bar');
7.  
8. /**
9.  * @global array used for stuff
10.  */
11. function mine()
12. {
13.     global $baz;
14. }