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:

subpackage DescHTML

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

subpackage InlineTags

subpackage Links

LinkClasses.inc

subpackage ParserData

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

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

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage 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: parserIdInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserIdInlineTag

Represents the inline {@id} tag for tutorials

Author(s):

Gregory Beaver <[email protected]>

Version:

Release: @VER@

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Inherited Variables

Class: parserInlineTag

parserInlineTag::$type

Class: parserBase

parserBase::$value

Inherited Methods

Class: parserInlineTag

parserInlineTag::parserInlineTag(): sets up the tag
parserInlineTag::getString(): always gets an empty string
parserInlineTag::Strlen(): get length of the tag

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 835]
Represents the inline {@id} tag for tutorials

Tags:

tutorial:	inline {@id}
author:	Gregory Beaver <[email protected]>
version:	Release: @VER@
copyright:	2002-2008 Gregory Beaver
see:	parserStringWithInlineTags
link:	http://www.phpdoc.org
link:	http://pear.php.net/PhpDocumentor
todo:	CS cleanup - change classname to PhpDocumentor_*
todo:	CS cleanup - change package to PhpDocumentor
license:	LGPL

[ Top ]

Class Variables

$category = 'default'

[line 851]

category of the {@id}

Type:

string

[ Top ]

$id =

[line 866]

section/subsection name

Type:

string

[ Top ]

$inlinetype = 'id'

[line 841]

always 'id'

Type:	string
Overrides:	Array

[ Top ]

$package = 'default'

[line 846]

package of the {@id}

Type:

string

[ Top ]

$subpackage = ''

[line 856]

subpackage of the {@id}

Type:

string

[ Top ]

$tutorial =

[line 861]

full name of the tutorial

Type:

string

[ Top ]

Class Methods

constructor parserIdInlineTag [line 877]

parserIdInlineTag parserIdInlineTag(
string
$category, string
$package, string
$subpackage, string
$tutorial, [string
$id = false])

constructor

Parameters:

string	$category	category name
string	$package	package name
string	$subpackage	subpackage name
string	$tutorial	tutorial name
string	$id	section/subsection name

[ Top ]

method Convert [line 895]

string Convert(
Converter
&$c)

converter

Tags:

todo:	CS cleanup - rename to convert for camelCase rule
uses:	Converter::getTutorialId() - retrieve converter-specific ID

Parameters:

&$c

output converter

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:13:50 -0600 by phpDocumentor 1.4.4