Classes, interfaces and traits

Assets

This collection manages which assets were found during the discovery phase.

Each asset is represented by an entry containing the path to that asset relative to the project root.

« More »

Glossary

The glossary is a collection containing a collection of terms and uses that were discovered during the discovery phase.

The key of this collection is the term that was discovered and the value is an array of locations where the term was used.

The array of locations consists of a filename as key and an array with the linenumbers where the term occurred.

Example:

array(1) { ["term"]=> array(1) { ["filename"]=> array(3) { [0]=> int(10) [1]=> int(14) [2]=> int(20) } } }

« More »

TableOfContents

This collection manages which headings were discovered during the discovery phase and stores them as entries.

« More »

Classes, interfaces and traits

BaseEntry

The Table of Contents entry provides essential information on the current entry, it's place in the structure and where it points to.

« More »

File

The Table of Contents File describes a file and the headings it contains.

A File may also contain other files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.

« More »

Heading

The Table of Contents File describes a headings and the Files and subentries it may contain.

A Heading may also contain files, those will serve as containers for more headings or other files. This way it is possible to 'include' another File as part of a hierarchy and have a integrated table of contents.

« More »

Module

The Table of Contents module represents an independent section of the documentation.

« More »