BaseTag.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

BaseTag.php
View Options

	<?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 string $name = '';

	/** @var Description\|null Description of the tag. */
	protected ?Description $description = null;

	/**
	* 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);
	}
	}