Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\Descriptor\TagExampleDescriptor

Descriptor representing the example tag with a descriptor.

Summary

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

Properties

$name

$name : string

Type

string — Name of the tag.

$description

$description : string

Type

string — A description line for this tag

$filePath

$filePath : string

Type

string — the content of the example.

$lineCount

$lineCount : integer

Type

integer — the content of the example.

$startingLine

$startingLine : integer

Type

integer — the content of the example.

$example

$example : string

Type

string — the content of the example.

Methods

__construct()

__construct(string  $name)

Initializes the tag by setting the name and errors,

Parameters

string $name

getName()

getName() : string

Returns the name for this tag.

Returns

string

setDescription()

setDescription(string  $description) : void

Sets a description for this tab instance.

Parameters

string $description

getDescription()

getDescription() : string

Returns the description for this tag,

Returns

string

setErrors()

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

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

Parameters

\phpDocumentor\Descriptor\Collection $errors

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(  $startingLine) : void

Returns the location where this example points to.

Parameters

$startingLine

getStartingLine()

getStartingLine() : integer

Returns the location where this example points to.

Returns

integer

setLineCount()

setLineCount(  $lineCount) : void

Returns the location where this example points to.

Parameters

$lineCount

getLineCount()

getLineCount() : integer

Returns the location where this example points to.

Returns

integer

setExample()

setExample(  $example) : void

Returns the content of the example.

Parameters

$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