PHPFUI/InstaDoc
 
Copied!

Parses a tag definition for a DocBlock.

CloneableFinalInstantiable
Methods
public __construct(string $name, ?phpDocumentor\Reflection\DocBlock\Description $description = NULL)
 

Parses a tag and populates the member variables.

  • param string $name Name of the tag.
  • param \Description $description The contents of the given tag.
public __toString() : string
 

Returns the tag as a serialized string

public static create(string $body, string $name = '', ?phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory = NULL, ?phpDocumentor\Reflection\Types\Context $context = NULL) : self
 

Creates a new tag that represents any unknown tag type.

  • return static
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription() : ?phpDocumentor\Reflection\DocBlock\Description
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName() : string
 

Gets the name of this tag.

  • return string The name of this tag.
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render(?phpDocumentor\Reflection\DocBlock\Tags\Formatter $formatter = NULL) : string
Properties
protected ?phpDocumentor\Reflection\DocBlock\Description phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$description = NULL
 
  • var \Description|null Description of the tag.
protected string phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$name = ''
 
  • var string Name of the tag
Methods
private validateTagName(string $name) : void
 

Validates if the tag name matches the expected format, otherwise throws an exception.

Methods
public static create(string $body, string $name = '', ?phpDocumentor\Reflection\DocBlock\DescriptionFactory $descriptionFactory = NULL, ?phpDocumentor\Reflection\Types\Context $context = NULL) : self
 

Creates a new tag that represents any unknown tag type.

  • return static
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration