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

Class: parserDescParser

Source Location: /phpDocumentor/ParserDescCleanup.inc

Class parserDescParser

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Publisher

Publisher::$subscriber

Inherited From Parser

Parser::Parser()
Set up invariant parsing variables
Parser::categoryTagHandler()
handles @category
Parser::checkEventPop()
this function checks whether parameter $word is a token for popping the current event off of the Event Stack.
Parser::checkEventPush()
this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.
Parser::configWordParser()
tell the parser's WordParser $wp to set up tokens to parse words by.
Parser::defaultTagHandler()
Handles all standard tags that only have a description
Parser::endTag()
Called to clean up at the end of parsing a @tag in a docblock
Parser::exampleTagHandler()
handles @example
Parser::getParserEventName()
Debugging function, takes an event number and attempts to return its name
Parser::globalTagHandler()
handles @global
Parser::invalidTagHandler()
Handles tags like [email protected]' that only work in PHP 4.3.0+
Parser::packageTagHandler()
handles @package
Parser::paramTagHandler()
handles @param
Parser::parse()
Parse a new file
Parser::propertyTagHandler()
Handles @property(-read or -write) and @method magic tag
Parser::returnTagHandler()
handles @return
Parser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays
Parser::staticvarTagHandler()
handles @staticvar
Parser::usesTagHandler()
handles @uses
Parser::varTagHandler()
handles @var

Inherited From Publisher

Publisher::publishEvent()
Publish an event
Publisher::subscribe()
Adds a subscriber to the $subscriber array().

[ Top ]
Method Summary
parserDescParser   parserDescParser()   sets $wp to be a ObjectWordParser
boolean   doSimpleList()   Return a simple list, if found
void   getParserEventName()  
void   parse()   Parse a long or short description for tags
void   setupStates()   setup the parser tokens, and the pushEvent/popEvent arrays

[ Top ]
Methods
Constructor parserDescParser  [line 349]

  parserDescParser parserDescParser( )

sets $wp to be a ObjectWordParser

$wp is the word parser that retrieves tokens



[ Top ]
doSimpleList  [line 1188]

  boolean doSimpleList( string $word  )

Return a simple list, if found

This helper function extracts a simple list beginning with any of 'o','-'.'#','+','0','1','0.','1.' and starts parsing it.

Parameters:
string   $word:  line that may contain a simple list

API Tags:
Return:  true if a list is found, false otherwise


[ Top ]
getParserEventName  [line 1462]

  void getParserEventName( $value  )

Parameters:
   $value: 


Redefinition of:
Parser::getParserEventName()
Debugging function, takes an event number and attempts to return its name

[ Top ]
parse  [line 363]

  void parse( array &$parse_data, [boolean $sdesc = false], [string $ind_type = 'parserDesc']  )

Parse a long or short description for tags

Parameters:
array   &$parse_data:  array of strings or parserInlineTags
boolean   $sdesc:  true if the description is a short description. (only 1 paragraph allowed in short desc)
string   $ind_type:  name of the class to instantiate for each paragraph. parserDesc for desc/sdesc, parserStringWithInlineTags for tag data

API Tags:
Staticvar:  integer $endrecur: used for recursion limiting if a handler for an event is not found
Usedby:  parserDocBlock::postProcess()


Redefinition of:
Parser::parse()
Parse a new file

[ Top ]
setupStates  [line 1231]

  void setupStates( boolean $sdesc  )

setup the parser tokens, and the pushEvent/popEvent arrays

Parameters:
boolean   $sdesc:  determines whether to allow paragraph parsing

API Tags:
Global:  boolean 0: used to determine whether to slow things down or not by eliminating whitespace from comments
See:  Publisher::$tokens, Publisher::$pushEvent, Publisher::$popEvent


Redefinition of:
Parser::setupStates()
setup the parser tokens, and the pushEvent/popEvent arrays

[ Top ]

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