phpDocumentor

ExampleDescriptor extends TagDescriptor
in package

Descriptor representing the example tag.

Table of Contents

$description  : DescriptionDescriptor
$errors  : Collection<string|int, Error>
$name  : string
$example  : string
$filePath  : string
$lineCount  : int|null
$startingLine  : int|null
__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getDescription()  : DescriptionDescriptor
Returns the description for this tag,
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getExample()  : string
Returns the content of the example.
getFilePath()  : string
Returns the location where this example points to.
getLineCount()  : int|null
Returns the location where this example points to.
getName()  : string
Returns the name for this tag.
getStartingLine()  : int|null
Returns the location where this example points to.
setDescription()  : void
Sets a description for this tab instance.
setErrors()  : void
Sets a list of errors found on the usage of this tag.
setExample()  : void
Returns the content of the example.
setFilePath()  : void
Sets the location where the example points to.
setLineCount()  : void
Returns the location where this example points to.
setStartingLine()  : void
Returns the location where this example points to.
setName()  : void
Sets the name for this tag.

Properties

Methods

__toString()

public __toString() : string
Return values
string

getExample()

Returns the content of the example.

public getExample() : string
Return values
string

getFilePath()

Returns the location where this example points to.

public getFilePath() : string
Return values
string

getLineCount()

Returns the location where this example points to.

public getLineCount() : int|null
Return values
int|null

getName()

Returns the name for this tag.

public getName() : string
Return values
string

getStartingLine()

Returns the location where this example points to.

public getStartingLine() : int|null
Return values
int|null

setExample()

Returns the content of the example.

public setExample(string $example) : void
Parameters
$example : string
Return values
void

setFilePath()

Sets the location where the example points to.

public setFilePath(string $filePath) : void
Parameters
$filePath : string
Return values
void

setLineCount()

Returns the location where this example points to.

public setLineCount(int $lineCount) : void
Parameters
$lineCount : int
Return values
void

setStartingLine()

Returns the location where this example points to.

public setStartingLine(int $startingLine) : void
Parameters
$startingLine : int
Return values
void

setName()

Sets the name for this tag.

protected setName(string $name) : void
Parameters
$name : string
Return values
void

Search results