Documentation
class Documentation extends Message
Properties
string | $summary | ||
Page[] | $pages | ||
DocumentationRule[] | $rules | ||
string | $documentation_root_url | ||
string | $overview |
Methods
static
descriptor()
No description
boolean
hasSummary()
Check if
clearSummary()
Clear
string
getSummary()
Get
setSummary(string $value)
Set
boolean
hasPages()
Check if
clearPages()
Clear
Page[]
getPagesList()
Get all elements of
boolean
hasRules()
Check if
clearRules()
Clear
getRules(int $idx = NULL)
Get
getRulesList()
Get all elements of
boolean
hasDocumentationRootUrl()
Check if
clearDocumentationRootUrl()
Clear
string
getDocumentationRootUrl()
Get
setDocumentationRootUrl(string $value)
Set
boolean
hasOverview()
Check if
clearOverview()
Clear
string
getOverview()
Get
setOverview(string $value)
Set
Details
at line line 29
static
descriptor()
at line line 87
boolean
hasSummary()
Check if
at line line 96
Documentation
clearSummary()
Clear
at line line 105
string
getSummary()
Get
at line line 115
Documentation
setSummary(string $value)
Set
at line line 124
boolean
hasPages()
Check if
at line line 133
Documentation
clearPages()
Clear
at line line 143
Page
getPages(int $idx = NULL)
Get
at line line 153
Documentation
setPages(Page $value, $idx = NULL)
Set
at line line 162
Page[]
getPagesList()
Get all elements of
at line line 172
Documentation
addPages(Page $value)
Add a new element to
at line line 181
boolean
hasRules()
Check if
at line line 190
Documentation
clearRules()
Clear
at line line 200
DocumentationRule
getRules(int $idx = NULL)
Get
at line line 210
Documentation
setRules(DocumentationRule $value, $idx = NULL)
Set
at line line 219
DocumentationRule[]
getRulesList()
Get all elements of
at line line 229
Documentation
addRules(DocumentationRule $value)
Add a new element to
at line line 238
boolean
hasDocumentationRootUrl()
Check if
at line line 247
Documentation
clearDocumentationRootUrl()
Clear
at line line 256
string
getDocumentationRootUrl()
Get
at line line 266
Documentation
setDocumentationRootUrl(string $value)
Set
at line line 275
boolean
hasOverview()
Check if
at line line 284
Documentation
clearOverview()
Clear
at line line 293
string
getOverview()
Get
at line line 303
Documentation
setOverview(string $value)
Set