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

Class: abstractLink

Source Location: /phpDocumentor/LinkClasses.inc

Class abstractLink

Direct descendents
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  
mixed   $fileAlias   phpdoc alias _phpdoc_inc for phpdoc.inc
string   $name  
string   $package  
string   $path  
string   $subpackage  
mixed   $type   element type linked to.

[ Top ]
Method Summary
void   addLink()  

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

[ Top ]
mixed   $fileAlias = '' [line 56]

phpdoc alias _phpdoc_inc for phpdoc.inc


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

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

[ Top ]
string   $path [line 52]

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

[ Top ]
mixed   $type = '' [line 61]

element type linked to.

can only be a documentable element


Redefined in descendants as:

[ Top ]
Methods
addLink  [line 76]

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

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, 24 Oct 2006 09:23:56 -0500 by phpDocumentor 1.3.1