Child classes:
- pageLink
- procedural page link
- functionLink
- function link
- defineLink
- define link
- globalLink
- global variable link
- classLink
- class link
- methodLink
- method link
- tutorialLink
- tutorial link
Inherited Variables
Inherited Constants
Inherited Methods
Class Details
linking classes parent
Tags:
- author - Gregory Beaver <[email protected]>
- version - Release: @VER@
- copyright - 2002-2008 Gregory Beaver
- link - http://pear.php.net/PhpDocumentor
- link - http://www.phpdoc.org
- todo - CS cleanup - change package to PhpDocumentor
- todo - CS cleanup - change classname to PhpDocumentor_*
- license - LGPL
[ Top ]
Class Variables
$category = ''
[ Top ]
$fileAlias = ''
[ Top ]
$name = ''
[ Top ]
$package = ''
[ Top ]
$path
[ Top ]
$subpackage = ''
[ Top ]
$type = ''
[ Top ]
Class Methods
addLink
void addLink(
string
$path, string
$fileAlias, string
$name, string
$package, string
$subpackage, [string
$category = false])
[line 94]
sets up the link
Overridden in child classes as:
- methodLink::addLink()
- sets up the link
- tutorialLink::addLink()
- sets up the link
Parameters:
- string $path - full path to file containing element
- string $fileAlias - page name, as configured by Parser::parse
- string $name - element name
- string $package - package element is in
- string $subpackage - subpackage element is in
- string $category - optional category that documentation is in
[ Top ]