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

Class: parserEntity

Source Location: /phpDocumentor/PackagePageElements.inc

Class parserEntity

Class Overview

a standard entity like ”

This class is designed to represent all DocBook entities.

Located in /phpDocumentor/PackagePageElements.inc [line 479]



		
				Author(s):
		
		
		
Information Tags:
Tutorial:  phpDocumentor Tutorials
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_*
Since:  1.2
License:  LGPL

Methods

[ Top ]
Method Summary
parserEntity   parserEntity()   sets up the entity
string   Convert()   calls the output conversion

[ Top ]
Methods
Constructor parserEntity  [line 486]

  parserEntity parserEntity( string $name  )

sets up the entity

Parameters:
string   $name:  entity name


[ Top ]
Convert  [line 501]

  string Convert( Converter &$c, [bool $postprocess = true]  )

calls the output conversion

Parameters:
Converter   &$c:  the output converter
bool   $postprocess:  if postprocessing is needed

API Tags:
Uses:  Converter::TranslateEntity() - convert contents to text

Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:35 -0600 by phpDocumentor 1.4.4