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

Class: tutorialLink

Source Location: /phpDocumentor/LinkClasses.inc

Class tutorialLink

Inherited Properties, Constants, and Methods
Property Summary
string   $section  
string   $title  
string   $type  

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

[ Top ]
Properties
string   $section = '' [line 336]

[ Top ]
string   $title = false [line 337]

[ Top ]
string   $type = 'tutorial' [line 335]

Redefinition of:
abstractLink::$type
element type linked to.

[ Top ]
Methods
addLink  [line 353]

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

sets up the link

Parameters:
string   $section:  section/subsection name
string   $path:  full path to file containing element
string   $name:  page name, as configured by Parser::parse
string   $package:  package element is in
string   $subpackage:  subpackage element is in
string   $title:  title of tutorial
string   $category:  optional category that documentation is in


Redefinition of:
abstractLink::addLink()
sets up the link

[ Top ]

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