Converts a DocBlock back from an object to a complete DocComment including Asterisks.

CloneableInstantiable
Methods
public __construct( $indent = 0, $indentString = ' ', $indentFirstLine = true, $lineLength = NULL, $tagFormatter = NULL)
 
Create a Serializer instance.

    public getDocComment(phpDocumentor\Reflection\DocBlock $docblock)
     
    Generate a DocBlock comment.

    • return string The serialized doc block.
    Properties
    protected $indent
     


    • var int The number of times the indent string is repeated.
    protected $indentString
     


    • var string The string to indent the comment with.
    protected $isFirstLineIndented
     


    • var bool Whether to indent the first line with the given indent amount and string.
    protected $lineLength
     


    • var int|null The max length of a line.
    protected $tagFormatter
     


    • var DocBlock\Tags\Formatter A custom tag formatter.
    Methods
    private addAsterisksForEachLine( $indent, $text)
     


    • return mixed
    private addTagBlock(phpDocumentor\Reflection\DocBlock $docblock, $wrapLength, $indent, $comment)
     


    • return string
    private getSummaryAndDescriptionTextBlock(phpDocumentor\Reflection\DocBlock $docblock, $wrapLength)
     


    • return string
    private removeTrailingSpaces( $indent, $text)
     


    • return mixed
    © 2020 Bruce Wells
    Search Namespaces \ Classes
    ConfigurationNumbers (0-9.) only