Pelzini

This is the code documentation for the Pelzini project

Page options:

Inherited members

class ParserInterface

Represents an interface

Authors

Variables

NameVisibilityDescription
$authors 
$deprecated 
$description 
$docblock_tags 
$example 
$extends 
$functions 
$info_tags 
$linenum 
$name 
$see 
$since 
$tables 
$visibility 

Functions

NameVisibilityDescription
__constructpublic 
applyCommentpublicThis parses a comment for a specific item
cascadeTagspublicCascades parent Docblock tags into a child item
dumppublicDebugging use only
getDocblockTagspublicGets the Docblock tags of this item
processGenericDocblockTagsprotectedProcesses general DocBlock tags that should apply to everything
processSpecificDocblockTagsprotectedProcesses Javadoc tags that are specific to this PaserItem
processTagspublicProcesses the tags for a specific item
setDocblockTagspublicSets the Docblock tags for this item
treeWalkpublicCascades Docblock tags into the children that do not have any tags, and then

public __construct

void $ParserInterface->__construct ( );

This function does not have a description

public applyComment (from CodeParserItem)

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

This parses a comment for a specific item

public cascadeTags (from CodeParserItem)

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

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

public dump

void $ParserInterface->dump ( );

Debugging use only

public getDocblockTags (from CodeParserItem)

unknown $CodeParserItem->getDocblockTags ( );

Gets the Docblock tags of this item

protected processGenericDocblockTags (from CodeParserItem)

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

Processes general DocBlock tags that should apply to everything

protected processSpecificDocblockTags

void $ParserInterface->processSpecificDocblockTags ( mixed $docblock_tags );

Processes Javadoc tags that are specific to this PaserItem

public processTags (from CodeParserItem)

void $CodeParserItem->processTags ( );

Processes the tags for a specific item

public setDocblockTags (from CodeParserItem)

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

Sets the Docblock tags for this item

public treeWalk

void $ParserInterface->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.