interface DocblockInterface

Docblock interface to represent models that have a docblock

Implementation is realized in the DocblockPart

Methods

$this
setDocblock(Docblock|string $doc)

Sets a docblock

Docblock
getDocblock()

Returns a docblock

$this
generateDocblock()

Generates a docblock from provided information

Details

at line line 21
$this setDocblock(Docblock|string $doc)

Sets a docblock

Parameters

Docblock|string $doc

Return Value

$this

at line line 28
Docblock getDocblock()

Returns a docblock

Return Value

Docblock

at line line 35
$this generateDocblock()

Generates a docblock from provided information

Return Value

$this