Download the PHP package eloquent/blox without Composer
On this page you can find all versions of the php package eloquent/blox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eloquent/blox
More information about eloquent/blox
Files in eloquent/blox
Package blox
Short Description A parser for block comment documentation.
License MIT
Homepage https://github.com/eloquent/blox
Informations about the package blox
Blox
A parser for block comment documentation.
Installation and documentation
- Available as Composer package eloquent/blox.
- API documentation available.
What is Blox?
Blox is a parser for PHP block comment documentation. Blox allows a standard documentation block comment to be parsed into an object tree representation, with a simple interface for retrieving information.
Usage
Conventions
Blox has a small set of conventions for block comments. They aim to be quite loose, so that Blox can be used, regardless of the body text format in use.
Summary text
The summary text starts from the first non-blank line and continues until a blank line, or the end of the block is encountered. White space at the beginning of lines, and newlines, are collapsed into a single space.
Body text
The body text starts from the first non-blank line after the summary, and continues until a tag, or the end of the block is encountered. White space and newlines are left as-is.
Tags
A tag is any line starting with the 'at' symbol (@
) followed by one or more
'word' characters (as defined in PCRE). These 'word' characters make up the
tag's 'name'.
Tags can optionally be followed by content which will be associated with the tag. White space directly after the tag name is ignored, but subsequent text is included in the tag content, as are subsequent lines until a blank line or another tag is encountered. White space at the beginning of lines, and newlines, are collapsed into a single space.