Pelzini

This is the code documentation for the Pelzini project

class ParserItem

The top-level class of all parser items. Almost all ParserItems should extend CodeParserItem.

Class structure

As a function argument

cascadeTags from class CodeParserItem

Cascades parent Docblock tags into a child item
Only cascades the tags specified in the config

Argument name: $child
From /processor/code_parser_item.php

treeWalk from class CodeParserItem

Executes a function for this ParserItem, and all of its children ParserItems

The function will be called with a two arguments, the ParserItem that it should operate on, and the parent
of the parser item

Argument name: $parent_item
From /processor/code_parser_item.php

treeWalk from class ParserInterface

Cascades Docblock tags into the children that do not have any tags, and then
runs processTags() for all of the children items.

Argument name: $parent_item
From /processor/parser_interface.php

treeWalk from class ParserClass

Cascades Docblock tags into the children that do not have any tags, and then
runs processTags() for all of the children items.

Argument name: $parent_item
From /processor/parser_class.php

treeWalk from class ParserFile

Cascades Docblock tags into the children that do not have any tags, and then
runs processTags() for all of the children items.

Argument name: $parent_item
From /processor/parser_file.php