You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
1.1 KiB
53 lines
1.1 KiB
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* This file is part of phpDocumentor.
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*
|
|
* @link http://phpdoc.org
|
|
*/
|
|
|
|
namespace phpDocumentor\Reflection\DocBlock\Tags;
|
|
|
|
use phpDocumentor\Reflection\DocBlock;
|
|
use phpDocumentor\Reflection\DocBlock\Description;
|
|
|
|
/**
|
|
* Parses a tag definition for a DocBlock.
|
|
*/
|
|
abstract class BaseTag implements DocBlock\Tag
|
|
{
|
|
/** @var string Name of the tag */
|
|
protected $name = '';
|
|
|
|
/** @var Description|null Description of the tag. */
|
|
protected $description;
|
|
|
|
/**
|
|
* Gets the name of this tag.
|
|
*
|
|
* @return string The name of this tag.
|
|
*/
|
|
public function getName() : string
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
public function getDescription() : ?Description
|
|
{
|
|
return $this->description;
|
|
}
|
|
|
|
public function render(?Formatter $formatter = null) : string
|
|
{
|
|
if ($formatter === null) {
|
|
$formatter = new Formatter\PassthroughFormatter();
|
|
}
|
|
|
|
return $formatter->format($this);
|
|
}
|
|
}
|
|
|