phpDocumentor phpDocumentor

Links

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

phpDocumentor

Packages:

phpDocumentor
Converters

Tutorials/Manuals:

Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

actions.php
bug-560532.php
bug-772441.php
builder.php
Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
config.php
EventStack.inc
file_dialog.php
HighlightParserTests.php
IntermediateParser.inc
IntermediateParserTests.php
Io.inc
new_phpdoc.php
ParserClassTests.php
ParserDescCleanup.inc
ParserPageTests.php
phpdoc.inc
phpdoc.php
phpDocumentorSetupTests.php
phpDocumentorTParserTests.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

DescHTML
DescHTML.inc

DocBlockTags
DocBlockTags.inc

Errors
Errors.inc

InlineTags
InlineTags.inc

Links
LinkClasses.inc

ParserData
ParserData.inc

ParserDocBlock
ParserDocBlock.inc

ParserElements
ParserElements.inc

Parsers
Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

setup
find_phpdoc.php

Tutorial
PackagePageElements.inc

WordParsers
phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
Parser
parserDescParser
phpDocumentorTParser
phpDocumentor_HighlightParser
phpDocumentor_HighlightWordParser
phpDocumentor_peardoc2_XML_Beautifier
phpDocumentor_TutorialHighlightParser
phpDocumentor_XML_Beautifier_Tokenizer
ppageParser
XMLPackagePageParser

bug_772441
Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
tests_HighlightParserTests
tests_IntermediateParserTests
tests_ParserClassTests
tests_ParserPageTests
tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests

DescHTML
parserB
parserBr
parserCode
parserDescVar
parserI
parserKbd
parserList
parserPre
parserSamp

DocBlockTags
parserAccessTag
parserExampleTag
parserFileSourceTag
parserLicenseTag
parserLinkTag
parserMethodTag
parserNameTag
parserParamTag
parserPropertyReadTag
parserPropertyTag
parserPropertyWriteTag
parserReturnTag
parserSeeTag
parserStaticvarTag
parserTag
parserTutorialTag
parserUsedByTag
parserUsesTag
parserVarTag

Errors
ErrorTracker
RecordError
RecordWarning

InlineTags
parserExampleInlineTag
parserIdInlineTag
parserInheritdocInlineTag
parserInlineTag
parserLinkInlineTag
parserSourceInlineTag
parserTocInlineTag
parserTutorialInlineTag

Links
abstractLink
classLink
constLink
defineLink
functionLink
globalLink
methodLink
pageLink
tutorialLink
varLink

Tutorial
parserCData
parserEntity
parserXMLDocBookTag

ParserData
parserBase
parserData
parserPage
parserStringWithInlineTags

WordParsers
ObjectWordParser
phpDocumentorTWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
parserClass
parserConst
parserDefine
parserElement
parserFunction
parserGlobal
parserInclude
parserMethod
parserPackagePage
parserTutorial
parserVar

Class: tutorialLink

Source Location: /phpDocumentor/LinkClasses.inc

Class tutorialLink

Class Overview

Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

tutorial link

Located in /phpDocumentor/LinkClasses.inc [line 330 ]

abstractLink
 |
 --tutorialLink

Author(s):

Gregory Beaver <[email protected]>

Information Tags:

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

addLink

[ Top ]

Inherited Properties, Constants, and Methods

Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From abstractLink

abstractLink::$category

abstractLink::$fileAlias

abstractLink::$name

abstractLink::$package

abstractLink::$path

abstractLink::$subpackage

Inherited From abstractLink

abstractLink::addLink()

sets up the link

[ Top ]

Property Summary

Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

string $section

string $title

string $type

[ Top ]

Method Summary

Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

void addLink() sets up the link

[ Top ]

Properties

Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

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

Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail

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 2011年12月06日 07:20:34 -0600 by phpDocumentor 1.4.4