SilverLeague\IDEAnnotator\Generators\DocBlockGenerator
Class DocBlockGenerator
Synopsis
class DocBlockGenerator
{
- // members
- protected string $className = '';
- protected ReflectionClass $reflector;
- protected AbstractTagGenerator $tagGenerator;
- // methods
- public void __construct()
- public array getExistingTags()
- public bool|string getExistingDocBlock()
- public DocBlock|string getGeneratedDocBlock()
- protected string mergeGeneratedTagsIntoDocBlock()
- public string removeExistingSupportedTags()
- public array getGeneratedTags()
Members
protected
- $className
—
string
The current class we are working with - $reflector — ReflectionClass
- $tagGenerator — SilverLeague\IDEAnnotator\Generators\AbstractTagGenerator
Methods
protected
public
- __construct() — DocBlockGenerator constructor.
- getExistingDocBlock() — Not that in case there are multiple doblocks for a class, the last one will be returned
- getExistingTags()
- getGeneratedDocBlock()
- getGeneratedTags()
- removeExistingSupportedTags() — Remove all existing tags that are supported by this module.