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

Class: tutorialLink

Source Location: /phpDocumentor/LinkClasses.inc

Class Overview

abstractLink
   |
   --tutorialLink

tutorial link


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods

Class: abstractLink

abstractLink::addLink()
sets up the link

Class Details



[ Top ]


Class Variables

$section =  ''

[line 336]


Type:   string


[ Top ]

$title =  false

[line 337]


Type:   string


[ Top ]

$type =  'tutorial'

[line 335]


Type:   string
Overrides:   Array


[ Top ]



Class Methods


method 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



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 ]


Documentation generated on Tue, 06 Dec 2011 07:14:22 -0600 by phpDocumentor 1.4.4