Class: tutorialLink

Source Location: /phpDocumentor/LinkClasses.inc

Class Overview [line 330]

abstractLink
   |
   --tutorialLink

Variables

Constants

Methods


Inherited Methods

Class: abstractLink

abstractLink::addLink()
sets up the link


Class Details

tutorial link

Tags:

[ Top ]


Class Variables

$section =  ''

[line 336]

Type: string

Overrides:

[ Top ]

$title =  false

[line 337]

Type: string

Overrides:

[ Top ]

$type =  'tutorial'

[line 335]

Type: string

Overrides: Array

[ Top ]


Class Methods

addLink

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

[line 353]

sets up the link

Overrides abstractLink::addLink() (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

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:09 -0600 by phpDocumentor 1.4.4