Docs For Class parserExampleTag

Description

represents "@example"

tutorial: @example
author: Greg Beaver <[email protected]>
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

Located in /phpDocumentor/DocBlockTags.inc (line 1180)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserFileSourceTag
            |
            --parserExampleTag

Variable Summary

string $keyword

Method Summary

parserExampleTag parserExampleTag (parserStringWithInlineTags $value, string $current_path)

void ConvertSource (Converter &$c)

string getSourceLink (Converter &$c)

Variables

string $keyword = 'example' (line 1186)

always "example"

Redefinition of:

parserFileSourceTag::$keyword: Always "filesource"

Inherited Variables

Inherited from parserFileSourceTag

parserFileSourceTag::$path
parserFileSourceTag::$source

Inherited from parserTag

parserTag::$type

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value

Methods

Constructor parserExampleTag (line 1203)

Reads and parses the example file indicated

The example tag takes one parameter: the full path to a php file that should be parsed and included as an example.

todo: does this "x = y = z = false" still work as expected in PHP5?
todo: CS cleanup - rename constant to TOKENIZER_EXT
uses: phpDocumentorTWordParser::getFileSource() - uses to parse an example and retrieve all tokens by line number

parserExampleTag parserExampleTag (parserStringWithInlineTags $value, string $current_path)

parserStringWithInlineTags $value: tag value
string $current_path: path of file containing this @example tag

ConvertSource (line 1353)

convert the source code

todo: CS cleanup - rename to convertSource for camelCase rule
todo: what's up with all the "return" statements? can they _all_ be removed?
uses: parserFileSourceTag::writeSource()
uses: phpDocumentor_HighlightParser - highlights source code

void ConvertSource (Converter &$c)

Converter &$c: the output converter

Redefinition of:

parserFileSourceTag::ConvertSource(): convert the source code

getSourceLink (line 1389)

Retrieve a converter-specific link to the example

uses: Converter::getExampleLink() - retrieve the link to the example

string getSourceLink (Converter &$c)

Converter &$c: the output converter

Redefinition of:

parserFileSourceTag::getSourceLink(): gets path to the sourcecode file

Inherited Methods

Inherited From parserFileSourceTag

parserFileSourceTag::parserFileSourceTag()
parserFileSourceTag::Convert()
parserFileSourceTag::ConvertSource()
parserFileSourceTag::getSourceLink()
parserFileSourceTag::writeSource()

Inherited From parserTag

parserTag::parserTag()
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent()

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()