@name
Specify an alias to use for a procedural page or global variable in displayed documentation and linking
Gregory Beaver
Copyright 2002, Gregory Beaver
(phpDocumentor 1.1+)
@name
$globalvariablename
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:
/**
* Now, when @global is used in a function, it will link to $baz
* @name $baz
* @global array $GLOBALS['baz']
*/
$GLOBALS['baz'] = array('foo','bar');
/**
* @global array used for stuff
*/
function mine()
{
global $baz;
}