configWordParser (line 2231)

Give the word parser necessary data to begin a new parse

• usedby: phpDocumentor_HighlightParser::parse() - pass $parse_data to prepare retrieval of tokens

• array &$data: all tokens separated by line number

Parser::configWordParser()

tell the parser's WordParser $wp to set up tokens to parse words by.

parse (line 406)

Parse a new file

The parse() method is a do...while() loop that retrieves tokens one by one from the $_event_stack, and uses the token event array set up by the class constructor to call event handlers.

The event handlers each process the tokens passed to them, and use the _addoutput() method to append the processed tokens to the $_line variable. The word parser calls newLineNum() every time a line is reached.

In addition, the event handlers use special linking functions _link() and its cousins (_classlink(), etc.) to create in-code hyperlinks to the documentation for source code elements that are in the source code.

• staticvar: int $endrecur: used for recursion limiting if a handler for an event is not found
• todo: CS cleanup - rename tokenizer_ext constant to uppercase
• uses: phpDocumentor_HighlightParser::setupStates() - initialize parser state variables
• uses: phpDocumentor_HighlightParser::configWordParser() - pass $parse_data to prepare retrieval of tokens

• array &$parse_data: the parse data
• Converter &$converter: the converter object
• bool $inlinesourceparse: whether this data is from an inline {@source} tag
• string|false $class: if a string, it is the name of the class whose method we are parsing containing a {@source} tag
• false|integer $linenum: starting line number from {@source linenum}
• false|string $filesourcepath: full path to file with @filesource tag, if this is a @filesource parse

phpDocumentorTParser::parse()

Parse a new file

setupStates (line 2248)

Initialize all parser state variables

• usedby: phpDocumentor_HighlightParser::parse() - initialize parser state variables
• uses: $_wp - sets to a new phpDocumentor_HighlightWordParser

• bool $inlinesourceparse: true if we are highlighting an inline {@source} tag's output
• false|string $class: name of class we are going to start from

Parser::setupStates()

setup the parser tokens, and the pushEvent/popEvent arrays