ApiDocumentationSet extends DocumentationSetInterface, CompilableSubject
Base class for descriptors containing the most used options.
Table of Contents
Methods
- findElement() : ElementInterface|null
- Finds a structural element with the given FQSEN in this Documentation Set, or returns null when it could not be found.
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getFiles() : Collection<string|int, FileInterface>
- Returns the list of files that is in this documentation set.
- getIndex() : Collection<string|int, ElementInterface>
- Returns an index with the given name.
- getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
- Returns all indexes in this documentation set.
- getName() : string
- Returns the name for this element.
- getNamespace() : NamespaceInterface|string
- Returns the namespace for this element (defaults to global "\")
- getOutputLocation() : string
- getPackage() : PackageInterface|null
- getSettings() : ApiSpecification
- getSource() : Source
- Returns the source location for this set of documentation.
- getTableOfContents() : Collection<string|int, TocDescriptor>
- setDescription() : void
- Sets a longer description for this element.
- setName() : void
- Sets the local name for this element.
Methods
findElement()
Finds a structural element with the given FQSEN in this Documentation Set, or returns null when it could not be found.
public
findElement(Fqsen $fqsen) : ElementInterface|null
Parameters
- $fqsen : Fqsen
Return values
ElementInterface|nullgetDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetFiles()
Returns the list of files that is in this documentation set.
public
getFiles() : Collection<string|int, FileInterface>
Return values
Collection<string|int, FileInterface>getIndex()
Returns an index with the given name.
public
getIndex(string $name) : Collection<string|int, ElementInterface>
If the index does not exist yet, it will dynamically be added to the list of indexes.
Parameters
- $name : string
Return values
Collection<string|int, ElementInterface>getIndexes()
Returns all indexes in this documentation set.
public
getIndexes() : Collection<string|int, Collection<string|int, ElementInterface>>
Tags
Return values
Collection<string|int, Collection<string|int, ElementInterface>>getName()
Returns the name for this element.
public
getName() : string
Return values
stringgetNamespace()
Returns the namespace for this element (defaults to global "\")
public
getNamespace() : NamespaceInterface|string
Return values
NamespaceInterface|stringgetOutputLocation()
public
getOutputLocation() : string
Return values
stringgetPackage()
public
getPackage() : PackageInterface|null
Return values
PackageInterface|nullgetSettings()
public
getSettings() : ApiSpecification
Return values
ApiSpecificationgetSource()
Returns the source location for this set of documentation.
public
getSource() : Source
Tags
Return values
SourcegetTableOfContents()
public
getTableOfContents() : Collection<string|int, TocDescriptor>
Return values
Collection<string|int, TocDescriptor>setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string