Docs For Class parserDescParser

Description

Parses a DocBlock description to retrieve abstract representations of

tutorial: phpDocumentor Tutorial
author: Greg Beaver <[email protected]>
version: $Id: Parser.inc 238276 2007-06-22 14:58:30Z ashnazg $
copyright: 2000-2007 Kellin, Joshua Eichorn
since: 1.2

Located in /phpDocumentor/ParserDescCleanup.inc (line 298)

Publisher
   |
   --Parser
      |
      --parserDescParser

Method Summary

parserDescParser parserDescParser ()

boolean doSimpleList (string $word)

void getParserEventName ( $value)

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

void setupStates (boolean $sdesc)

Variables

Inherited Variables

Inherited from Publisher

Publisher::$subscriber

Methods

Constructor parserDescParser (line 349)

sets $wp to be a ObjectWordParser

$wp is the word parser that retrieves tokens

parserDescParser parserDescParser ()

doSimpleList (line 1188)

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.

return: true if a list is found, false otherwise

boolean doSimpleList (string $word)

string $word: line that may contain a simple list

getParserEventName (line 1462)

void getParserEventName ( $value)

$value

Redefinition of:

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

parse (line 363)

Parse a long or short description for tags

staticvar: integer $endrecur: used for recursion limiting if a handler for an event is not found
usedby: parserDocBlock::postProcess()

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

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

Redefinition of:

Parser::parse(): Parse a new file

setupStates (line 1231)

setup the parser tokens, and the pushEvent/popEvent arrays

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

void setupStates (boolean $sdesc)

boolean $sdesc: determines whether to allow paragraph parsing

Redefinition of:

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

Inherited Methods

Inherited From Parser

Parser::Parser()
Parser::categoryTagHandler()
Parser::checkEventPop()
Parser::checkEventPush()
Parser::configWordParser()
Parser::defaultTagHandler()
Parser::endTag()
Parser::exampleTagHandler()
Parser::getParserEventName()
Parser::globalTagHandler()
Parser::invalidTagHandler()
Parser::packageTagHandler()
Parser::paramTagHandler()
Parser::parse()
Parser::propertyTagHandler()
Parser::returnTagHandler()
Parser::setupStates()
Parser::staticvarTagHandler()
Parser::usesTagHandler()
Parser::varTagHandler()

Inherited From Publisher

Publisher::publishEvent()
Publisher::subscribe()