phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Exception
Filter
Interfaces
ProjectDescriptor
TableOfContents
Tag
BaseTypes
Validation
Event
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig

\phpDocumentor\Descriptor\TagExampleDescriptor

Descriptor representing the example tag.

Summary

Methods
Properties
Constants
__construct()
getName()
setDescription()
getDescription()
__toString()
setErrors()
getErrors()
setFilePath()
getFilePath()
setStartingLine()
getStartingLine()
setLineCount()
getLineCount()
setExample()
getExample()
No public properties found
No constants found
setName()
$name
$description
$errors
N/A
No private methods found
$filePath
$startingLine
$lineCount
$example
N/A

Properties

$name

$name : string

Type

string — Name of the tag.

$description

$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

DescriptionDescriptor — A description line for this tag

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

Error> — A collection of errors found during filtering.

$filePath

$filePath : string

Type

string — the content of the example.

$startingLine

$startingLine : int|null

Type

int|null — the content of the example.

$lineCount

$lineCount : int|null

Type

int|null — the content of the example.

$example

$example : string

Type

string — the content of the example.

Methods

__construct()

__construct(string  $name, ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description = null) : mixed

Initializes the tag by setting the name and errors,

Parameters

string $name
?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

Returns

mixed —

getName()

getName() : string

Returns the name for this tag.

Returns

string —

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description for this tab instance.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this tag,

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

__toString()

__toString() : string

Returns

string —

setErrors()

setErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>  $errors) : void

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

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors associated with this tag.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

setFilePath()

setFilePath(string  $filePath) : void

Sets the location where the example points to.

Parameters

string $filePath

getFilePath()

getFilePath() : string

Returns the location where this example points to.

Returns

string —

setStartingLine()

setStartingLine(int  $startingLine) : void

Returns the location where this example points to.

Parameters

int $startingLine

getStartingLine()

getStartingLine() : ?int

Returns the location where this example points to.

Returns

?int —

setLineCount()

setLineCount(int  $lineCount) : void

Returns the location where this example points to.

Parameters

int $lineCount

getLineCount()

getLineCount() : ?int

Returns the location where this example points to.

Returns

?int —

setExample()

setExample(string  $example) : void

Returns the content of the example.

Parameters

string $example

getExample()

getExample() : string

Returns the content of the example.

Returns

string —

setName()

setName(string  $name) : void

Sets the name for this tag.

Parameters

string $name