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

Class: parserCode

Source Location: /phpDocumentor/DescHTML.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserCode

Used for <code> in a description


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2007 Gregory Beaver

Methods


Inherited Variables

Inherited Methods

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 is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

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

Class Details

[line 74]
Used for <code> in a description



Tags:

author:  Greg Beaver <[email protected]>
version:  Release: @VER@
copyright:  2002-2007 Gregory Beaver
link:  http://pear.php.net/PhpDocumentor
link:  http://www.phpdoc.org
todo:  CS cleanup - change package to PhpDocumentor
todo:  CS cleanup - rename class to ParserCode
since:  1.2
license:  LGPL


[ Top ]


Class Methods


method Convert [line 85]

string Convert( Converter &$c)

performs the conversion of code tags



Tags:

return:  the converted code block
todo:  CS cleanup - rename method to convert()
uses:  Converter::ProgramExample()


Overrides parserStringWithInlineTags::Convert() (Use to convert the string to a real string with all inline tags parsed and linked)

Parameters:

Converter   &$c   the converter object

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:11:47 -0600 by phpDocumentor 1.4.4