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

has a value

clearSummary()

Clear

value

string
getSummary()

Get

value

setSummary(string $value)

Set

value

boolean
hasPages()

Check if has a value

clearPages()

Clear value

getPages(int $idx = NULL)

Get value

setPages(Page $value, $idx = NULL)

Set value

Page[]
getPagesList()

Get all elements of

addPages(Page $value)

Add a new element to

boolean
hasRules()

Check if has a value

clearRules()

Clear value

getRules(int $idx = NULL)

Get value

setRules(DocumentationRule $value, $idx = NULL)

Set value

getRulesList()

Get all elements of

addRules(DocumentationRule $value)

Add a new element to

boolean
hasDocumentationRootUrl()

Check if has a value

string
setDocumentationRootUrl(string $value)

Set value

boolean
hasOverview()

Check if has a value

string
getOverview()

Get value

setOverview(string $value)

Set value

Details

at line line 29
static descriptor()

at line line 87
boolean hasSummary()

Check if

has a value

Return Value

boolean

at line line 96
Documentation clearSummary()

Clear

value

Return Value

Documentation

at line line 105
string getSummary()

Get

value

Return Value

string

at line line 115
Documentation setSummary(string $value)

Set

value

Parameters

string $value

Return Value

Documentation

at line line 124
boolean hasPages()

Check if has a value

Return Value

boolean

at line line 133
Documentation clearPages()

Clear value

Return Value

Documentation

at line line 143
Page getPages(int $idx = NULL)

Get value

Parameters

int $idx

Return Value

Page

at line line 153
Documentation setPages(Page $value, $idx = NULL)

Set value

Parameters

Page $value
$idx

Return Value

Documentation

at line line 162
Page[] getPagesList()

Get all elements of

Return Value

Page[]

at line line 172
Documentation addPages(Page $value)

Add a new element to

Parameters

Page $value

Return Value

Documentation

at line line 181
boolean hasRules()

Check if has a value

Return Value

boolean

at line line 190
Documentation clearRules()

Clear value

Return Value

Documentation

at line line 200
DocumentationRule getRules(int $idx = NULL)

Get value

Parameters

int $idx

Return Value

DocumentationRule

at line line 210
Documentation setRules(DocumentationRule $value, $idx = NULL)

Set value

Parameters

DocumentationRule $value
$idx

Return Value

Documentation

at line line 219
DocumentationRule[] getRulesList()

Get all elements of

Return Value

DocumentationRule[]

at line line 229
Documentation addRules(DocumentationRule $value)

Add a new element to

Parameters

DocumentationRule $value

Return Value

Documentation

at line line 238
boolean hasDocumentationRootUrl()

Check if has a value

Return Value

boolean

at line line 247
Documentation clearDocumentationRootUrl()

Clear value

Return Value

Documentation

at line line 256
string getDocumentationRootUrl()

Get value

Return Value

string

at line line 266
Documentation setDocumentationRootUrl(string $value)

Set value

Parameters

string $value

Return Value

Documentation

at line line 275
boolean hasOverview()

Check if has a value

Return Value

boolean

at line line 284
Documentation clearOverview()

Clear value

Return Value

Documentation

at line line 293
string getOverview()

Get value

Return Value

string

at line line 303
Documentation setOverview(string $value)

Set value

Parameters

string $value

Return Value

Documentation