VersionInterface extends Descriptor
Base class for descriptors containing the most used options.
Table of Contents
Methods
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getDocumentationSets() : Collection<string|int, DocumentationSetDescriptor>
- getName() : string
- Returns the local name for this element.
- getNumber() : string
- Returns the name for this element.
- getTableOfContents() : Collection<string|int, TocDescriptor>
- setDescription() : void
- Sets a longer description for this element.
- setName() : void
- Sets the local name for this element.
Methods
getDescription()
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
DescriptionDescriptorgetDocumentationSets()
public
getDocumentationSets() : Collection<string|int, DocumentationSetDescriptor>
Return values
Collection<string|int, DocumentationSetDescriptor>getName()
Returns the local name for this element.
public
getName() : string
Return values
stringgetNumber()
Returns the name for this element.
public
getNumber() : string
Return values
stringgetTableOfContents()
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