CSGuiApiDocumentationSection
in package
The CSGuiApiDocumentationSection provides a standardized Section in a CSGuiApiDocumentation
This class has no public constructor, use the factory method instead.
Tags
Table of Contents
- addTag() : void
- Adds a tag with a key and a value to the taglist of the section
- getDescription() : string
- Returns the description of the section
- getID() : string
- Returns the ID of the section as a 9-character MD5 Hash of the title
- getTags() : array<string|int, mixed>
- Returns the tags of the section
- getTitle() : string
- Returns the title of the section
- setDescription() : void
- Sets the description text between the headline and the tags
- setTitle() : void
- Sets the title text of the section
Methods
addTag()
Adds a tag with a key and a value to the taglist of the section
public
addTag(string $key, string $val) : void
Parameters
- $key : string
-
the key of the tag
- $val : string
-
the value of the tag
Tags
Return values
void —getDescription()
Returns the description of the section
public
getDescription() : string
Tags
Return values
string —the description
getID()
Returns the ID of the section as a 9-character MD5 Hash of the title
public
getID() : string
Tags
Return values
string —the ID
getTags()
Returns the tags of the section
public
getTags() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —array with the tags. For each tag one array with a key and with a val is returned
getTitle()
Returns the title of the section
public
getTitle() : string
Tags
Return values
string —the title
setDescription()
Sets the description text between the headline and the tags
public
setDescription(mixed $description) : void
Parameters
- $description : mixed
Tags
Return values
void —setTitle()
Sets the title text of the section
public
setTitle(mixed $title) : void
Parameters
- $title : mixed