phpDocumentor

TagInterface extends Descriptor, Filterable, Stringable

Base class for any tag descriptor and used when a tag has no specific descriptor.

getDescription() : DescriptionDescriptor: Returns the description for this element.
getErrors() : Collection<string|int, Error>: Returns all errors associated with this tag.
getName() : string: Returns the local name for this element.
setDescription() : void: Sets a longer description for this element.
setErrors() : void: Sets a list of errors on the associated element.
setName() : void: Sets the local name for this element.

Returns the description for this element.


    public
                    getDescription() : DescriptionDescriptor

This method will automatically attempt to inherit the parent's description if this one has none.

DescriptionDescriptor

Returns all errors associated with this tag.


    public
                    getErrors() : Collection<string|int, Error>

Collection<string|int, Error>

Returns the local name for this element.


    public
                    getName() : string

string

Sets a longer description for this element.


    public
                    setDescription(DescriptionDescriptor $description) : void

Sets a list of errors on the associated element.


    public
                    setErrors(Collection<string|int, Error> $errors) : void

Sets the local name for this element.


    public
                    setName(string $name) : void