\phpDocumentor\Descriptor\TraitsHasDescription

This file is part of phpDocumentor.

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Summary

Methods
Properties
Constants
setDescription()
getDescription()
No public properties found
No constants found
No protected methods found
$description
N/A
No private methods found
No private properties found
N/A

Properties

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Methods

setDescription()

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

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

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

Returns the description for this element.

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

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —