Pelzini

CAnalyser

Analyses the C tokens, and creates a set of ParserItem objects.

CodeParserItem

Stores information about parser items that are actual source code.
Typically these parser items have authors and versions, so all of that information
is stored in this class.

CParser

Does the complete parsing of a C file.

DebugOutputter

Outputs the tree to the screen

JavascriptAnalyser

Analyses the javascript tokens, and creates a set of ParserItem objects.

JavascriptParser

Does the complete parsing of a javascript file.

MysqlOutputter

Outputs the tree as MySQL

ParserArgument

Represents a function argument

ParserClass

Stores information about a specific class

ParserDocument

Represents a function

ParserFile

Represents a file

ParserInterface

Represents an interface

ParserReturn

Represents a function return type

ParserThrow

Represents an exception which is thrown

PhpParser

This is the parser for PHP files. It converts a file from the raw PHP into a document tree

QualityCheckTransformer

This is a transformer that does quality checks on the codebase

It checks that the documentation has the required tags. Currently the 'required tags' are only the summary

The documentation is created in a report called the check report.

Token

This class is used to represent a token that has been tokenised using a Lexer. (e.g. the JavascriptLexer)
These tokens are used to create various ParserItems, by passing them to an Analyser (e.g. the JavascriptAnalyser)

VirtualEnumerationsTransformer

This transformer converts constants that start with the same name into an enumeration of that name.

So if a file has the following constants:
  APP_VERSION
  ITEM_TYPE_APPLE
  ITEM_TYPE_ORANGE

The APPLE and ORANGE constants will become a part of the virtual enumeration ITEM_TYPE.

get_filenames

Gets all the filenames in a directory and in the subdirectories

htmlify_text

This will take the provided text, and turn it into HTML
If it contains HTML, it will validate it, otherwise it
will wrap everything in a PRE

This function also removes extra spaces from the beginning of lines
but will do so in a manner that indenting is preserved

parse_doc_comment

Parses a DocBlock comment tag
Accepts the raw comment text of the comment straight from the file, including all the stars in the middle
Returns an array of tags. Each paremeter will contain an array of the tags that existed, one for each tag
The summary is returned in a 'summary' tag.

The output for a function with two param tags, a return tag and a summary will be something like the following:
array {
  ['@summary'] = '...',
  ['@param'] {
    [0] = '...',
    [1] = '...'
  },
  ['@return'] {
    [0] = '...',
  }
}

processor_autoload

Automatically loads the classes that are needed