phpDocumentor phpDocumentor
Links
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: abstractLink

Source Location: /phpDocumentor/LinkClasses.inc

Class abstractLink

Descendants
Child Class Description
pageLink procedural page link
functionLink function link
defineLink define link
globalLink global variable link
classLink class link
methodLink method link
tutorialLink tutorial link

[ Top ]
Property Summary
string   $category  
string   $fileAlias   phpdoc alias _phpdoc_inc for phpdoc.inc
string   $name  
string   $package  
string   $path  
string   $subpackage  
string   $type   element type linked to.

[ Top ]
Method Summary
void   addLink()   sets up the link

[ Top ]
Properties
string   $category = '' [line 77]

[ Top ]
string   $fileAlias = '' [line 70]

phpdoc alias _phpdoc_inc for phpdoc.inc


[ Top ]
string   $name = '' [line 76]

[ Top ]
string   $package = '' [line 78]

[ Top ]
string   $path [line 66]

[ Top ]
string   $subpackage = '' [line 79]

[ Top ]
string   $type = '' [line 75]

element type linked to.

can only be a documentable element


Redefined in descendants as:

[ Top ]
Methods
addLink  [line 94]

  void addLink( string $path, string $fileAlias, string $name, string $package, string $subpackage, [string $category = false]  )

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


Redefined in descendants as:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:32 -0600 by phpDocumentor 1.4.4