Description
Located in File: /phpDocumentor/LinkClasses.inc
linking classes parent
- 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
Classes extended from abstractLink:
- pageLink
- procedural page link
- functionLink
- function link
- defineLink
- define link
- globalLink
- global variable link
- classLink
- class link
- methodLink
- method link
- tutorialLink
- tutorial link
Class Variables
Summary:
string
$category
string
$fileAlias
string
$name
string
$package
string
$path
string
$subpackage
string
$type
$category = '' (line Class Constants
Summary:Method Detail
Summary:
void
addLink
(string $path, string $fileAlias, string $name, string $package, string $subpackage, [string $category = false])
Method addLink (line 94)
void addLink( string $path, string $fileAlias, string $name, string $package, string $subpackage, [string $category = false])
Overridden in child classes as:
- methodLink::addLink()
- sets up the link
- tutorialLink::addLink()
- sets up the link
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