Zend\Code\Generator\DocBlockGenerator
Synopsis
class DocBlockGenerator
extends AbstractGenerator
{
- // Inherited constants from AbstractGenerator
- const LINE_FEED = "\n";
- // members
- protected string $shortDescription;
- protected string $longDescription;
- protected array $tags;
- protected string $indentation;
- protected bool $wordwrap;
- protected $tagManager;
- // Inherited members from AbstractGenerator
- protected bool $isSourceDirty;
- protected int|string $indentation;
- protected string $sourceContent;
- // methods
- public static DocBlockGenerator fromReflection()
- public static DocBlockGenerator fromArray()
- protected static void getTagManager()
- public void __construct()
- public DocBlockGenerator setShortDescription()
- public string getShortDescription()
- public DocBlockGenerator setLongDescription()
- public string getLongDescription()
- public DocBlockGenerator setTags()
- public DocBlockGenerator setTag()
- public array getTags()
- public DocBlockGenerator setWordWrap()
- public bool getWordWrap()
- public string generate()
- protected string docCommentize()
- // Inherited methods from AbstractGenerator
- public void __construct()
- public AbstractGenerator setSourceDirty()
- public bool isSourceDirty()
- public AbstractGenerator setIndentation()
- public string getIndentation()
- public AbstractGenerator setSourceContent()
- public string getSourceContent()
- public AbstractGenerator setOptions()
Hierarchy
Constants
Name | Value |
---|---|
LINE_FEED | "\n" |
Members
protected
- $indentation — string
- $indentation — Zend\Code\Generator\int|string
- $isSourceDirty — Zend\Code\Generator\bool
- $longDescription — string
- $shortDescription — string
- $sourceContent — string
- $tagManager
- $wordwrap — Zend\Code\Generator\bool
Methods
protected
public
- __construct()
- fromArray() — Generate from array
- fromReflection() — Build a DocBlock generator object from a reflection object
- generate()
- getLongDescription()
- getShortDescription()
- getTags()
- getWordWrap()
- setLongDescription()
- setShortDescription()
- setTag()
- setTags()
- setWordWrap()