DocblockTrait
Docblock trait
Tags
Table of Contents
Properties
- $docblock : DocblockGenerator|null
- Docblock generator object
Methods
- getDesc() : string|null
- Get the docblock description
- getDocblock() : DocblockGenerator|null
- Access the docblock generator object
- hasDesc() : bool
- Has a docblock description
- hasDocblock() : bool
- Has docblock generator object
- setDesc() : static
- Set the docblock description
- setDocblock() : static
- Set the docblock generator object
Properties
$docblock
Docblock generator object
protected
DocblockGenerator|null
$docblock
= null
Methods
getDesc()
Get the docblock description
public
getDesc() : string|null
Return values
string|nullgetDocblock()
Access the docblock generator object
public
getDocblock() : DocblockGenerator|null
Return values
DocblockGenerator|nullhasDesc()
Has a docblock description
public
hasDesc() : bool
Return values
boolhasDocblock()
Has docblock generator object
public
hasDocblock() : bool
Return values
boolsetDesc()
Set the docblock description
public
setDesc([string|null $desc = null ]) : static
Parameters
- $desc : string|null = null
Return values
staticsetDocblock()
Set the docblock generator object
public
setDocblock(DocblockGenerator $docblock) : static
Parameters
- $docblock : DocblockGenerator