Class parserExampleTag

Description

represents "@example"

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)
ConvertSource (line 1353)

convert the source code

void ConvertSource (Converter &$c)

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)

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()

Documentation generated on Mon, 05 Dec 2011 21:03:54 -0600 by phpDocumentor 1.4.4