Class: parserExampleTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserSourceTag
            |
            --parserExampleTag

represents "@example"

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $

Variables

Methods

Inherited Variables

Inherited Methods

Class: parserSourceTag

parserSourceTag::parserSourceTag()
parserSourceTag::Convert()
parserSourceTag::ConvertSource()
parserSourceTag::getSourceLink()
parserSourceTag::writeSource()

Class: parserTag

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

Class: parserStringWithInlineTags

parserStringWithInlineTags::add(): equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert(): Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString(): return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

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

Class Details

[line 543]
represents "@example"

The example tag

Version: $Id: DocBlockTags.inc,v 1.3 2003/01/18 07:25:19 CelloG Exp $
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>
Todo: implement support in PDF Converter
Tutorial: @example

[ Top ]

Class Variables

$keyword = 'example'

[line 545]

Type:	mixed
Overrides:	Array

[ Top ]

$writesource = 'writeExample'

[line 546]

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

parserExampleTag (Constructor) [line 547]

parserExampleTag parserExampleTag(
mixed
$tag, mixed
$value)

[ Top ]

getSourceLink [line 577]

void getSourceLink(
mixed
&$c)

Overrides parserSourceTag::getSourceLink() (parent method not documented)

[ Top ]

writeSource [line 572]

void writeSource(
mixed
&$c, mixed
$source)

Overrides parserSourceTag::writeSource() (parent method not documented)

[ Top ]