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

[line 330]
tutorial link



Tags:

author:  Gregory Beaver <cellog@php.net>
version:  Release: @VER@
copyright:  2002-2008 Gregory Beaver
link:  http://pear.php.net/PhpDocumentor
link:  http://www.phpdoc.org
todo:  CS cleanup - change package to PhpDocumentor
todo:  CS cleanup - change classname to PhpDocumentor_*
license:  LGPL


[ 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 ]

    Поддержать сайт на родительском проекте КГБ