ParserFile class - Documentation for Pelzini

Info Page:

Page options:

class ParserFile

Represents a file

Name	Visibility	Description
__construct	public
applyComment	public	This parses a comment for a specific item
cascadeTags	public	Cascades parent Docblock tags into a child item
dump	public	Debugging use only
getDocblockTags	public	Gets the Docblock tags of this item
processGenericDocblockTags	protected	Processes general DocBlock tags that should apply to everything
processSpecificDocblockTags	public	Applies the contents of a doc-block to this element
processTags	public	Processes the tags for a specific item
setDocblockTags	public	Sets the Docblock tags for this item
treeWalk	public	Cascades Docblock tags into the children that do not have any tags, and then

void $ParserFile->__construct ( );

This function does not have a description

void $CodeParserItem->applyComment ( mixed $comment );

This parses a comment for a specific item

void $CodeParserItem->cascadeTags ( ParserItem $child );

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

void $ParserFile->dump ( );

Debugging use only

unknown $CodeParserItem->getDocblockTags ( );

Gets the Docblock tags of this item

void $CodeParserItem->processGenericDocblockTags ( mixed $docblock_tags );

Processes general DocBlock tags that should apply to everything

void $ParserFile->processSpecificDocblockTags ( $text $docblock_tags );

Applies the contents of a doc-block to this element

void $CodeParserItem->processTags ( );

Processes the tags for a specific item

void $CodeParserItem->setDocblockTags ( array $tags );

Sets the Docblock tags for this item

void $ParserFile->treeWalk ( mixed $function_name [, ParserItem $parent_item ] );

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