\phpDocumentor\Plugin\Scrybe\Converter\MetadataGlossary

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) } } }

Summary

Methods
Properties
Constants
addTerm()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

addTerm()

addTerm(string  $term, string  $filename, integer  $line_number) : void

Adds a glossary term to the collection.

Parameters

string $term
string $filename
integer $line_number