ExampleDescriptor

Extends \phpDocumentor\Descriptor\TagDescriptor

Descriptor representing the example tag with a descriptor.

package

Default

Methods

Initializes the tag by setting the name and errors,

__construct(string $name) 
inherited

Arguments

$name

string

Returns the description for this tag,

getDescription() : string
inherited

Response

string

Returns all errors associated with this tag.

getErrors() : \phpDocumentor\Descriptor\Collection
inherited

Returns the content of the example.

getExample() : string

Response

string

Returns the location where this example points to.

getFilePath() : string

Response

string

Returns the location where this example points to.

getLineCount() : integer

Response

integer

Returns the name for this tag.

getName() : string
inherited

Response

string

Returns the location where this example points to.

getStartingLine() : integer

Response

integer

Sets a description for this tab instance.

setDescription(string $description) : void
inherited

Arguments

$description

string

Sets a list of errors found on the usage of this tag.

setErrors(\phpDocumentor\Descriptor\Collection $errors) : void
inherited

Returns the content of the example.

setExample( $example) : void

Arguments

$example

Sets the location where the example points to.

setFilePath(string $filePath) : void

Arguments

$filePath

string

Returns the location where this example points to.

setLineCount( $lineCount) : void

Arguments

$lineCount

Sets the name for this tag.

setName(string $name) : void
inherited

Arguments

$name

string

Returns the location where this example points to.

setStartingLine( $startingLine) : void

Arguments

$startingLine

Properties

the content of the example.

filePath : string
var

the content of the example.

Type(s)

string

the content of the example.

lineCount : integer
var

the content of the example.

Type(s)

integer

the content of the example.

startingLine : integer
var

the content of the example.

Type(s)

integer

the content of the example.

example : string
var

the content of the example.

Type(s)

string

Name of the tag.

name : string
inherited
var

Name of the tag.

Type(s)

string

A description line for this tag

description : string
inherited
var

A description line for this tag

Type(s)

string

A collection of errors found during filtering.

errors : \phpDocumentor\Descriptor\Collection
inherited
var

A collection of errors found during filtering.

Type(s)

\phpDocumentor\Descriptor\Collection