mirror of
https://github.com/barryvdh/ReflectionDocBlock.git
synced 2026-08-18 18:13:13 +00:00
remove unused docblocks
This commit is contained in:
committed by
Jaap van Otterdijk
parent
4a9675841b
commit
082c811880
@@ -83,7 +83,6 @@ final class DocBlock
|
||||
|
||||
/**
|
||||
* Returns the current context.
|
||||
*
|
||||
*/
|
||||
public function getContext(): Types\Context
|
||||
{
|
||||
@@ -116,7 +115,6 @@ final class DocBlock
|
||||
* elements that follow until another DocBlock is found that contains the closing marker (`#@-`).
|
||||
*
|
||||
* @see self::isTemplateEnd() for the check whether a closing marker was provided.
|
||||
*
|
||||
*/
|
||||
public function isTemplateStart(): bool
|
||||
{
|
||||
@@ -127,7 +125,6 @@ final class DocBlock
|
||||
* Returns whether this DocBlock is the end of a Template section.
|
||||
*
|
||||
* @see self::isTemplateStart() for a more complete description of the Docblock Template functionality.
|
||||
*
|
||||
*/
|
||||
public function isTemplateEnd(): bool
|
||||
{
|
||||
|
||||
@@ -47,8 +47,6 @@ class DescriptionFactory
|
||||
|
||||
/**
|
||||
* Returns the parsed text of this description.
|
||||
*
|
||||
*
|
||||
*/
|
||||
public function create(string $contents, ?TypeContext $context = null): Description
|
||||
{
|
||||
|
||||
@@ -87,8 +87,6 @@ class ExampleFinder
|
||||
* 2. Checks the source folder for the given filename
|
||||
* 3. Checks the 'examples' folder in the current working directory for examples
|
||||
* 4. Checks the path relative to the current working directory for the given filename
|
||||
*
|
||||
*
|
||||
*/
|
||||
private function getExampleFileContents(string $filename): ?string
|
||||
{
|
||||
|
||||
@@ -182,8 +182,6 @@ final class StandardTagFactory implements TagFactory
|
||||
/**
|
||||
* Creates a new tag object with the given name and body or returns null if the tag name was recognized but the
|
||||
* body was invalid.
|
||||
*
|
||||
*
|
||||
*/
|
||||
private function createTag(string $body, string $name, TypeContext $context): ?Tag
|
||||
{
|
||||
|
||||
@@ -60,7 +60,6 @@ final class Covers extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the structural element this tag refers to.
|
||||
*
|
||||
*/
|
||||
public function getReference(): Fqsen
|
||||
{
|
||||
|
||||
@@ -80,7 +80,6 @@ final class Deprecated extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Gets the version section of the tag.
|
||||
*
|
||||
*/
|
||||
public function getVersion(): ?string
|
||||
{
|
||||
|
||||
@@ -19,8 +19,6 @@ interface Formatter
|
||||
{
|
||||
/**
|
||||
* Formats a tag into a string representation according to a specific format, such as Markdown.
|
||||
*
|
||||
*
|
||||
*/
|
||||
public function format(Tag $tag): string;
|
||||
}
|
||||
|
||||
@@ -98,7 +98,6 @@ final class Param extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the variable's type or null if unknown.
|
||||
*
|
||||
*/
|
||||
public function getType(): ?Type
|
||||
{
|
||||
@@ -107,7 +106,6 @@ final class Param extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns whether this tag is variadic.
|
||||
*
|
||||
*/
|
||||
public function isVariadic(): bool
|
||||
{
|
||||
|
||||
@@ -88,7 +88,6 @@ class Property extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the variable's type or null if unknown.
|
||||
*
|
||||
*/
|
||||
public function getType(): ?Type
|
||||
{
|
||||
|
||||
@@ -88,7 +88,6 @@ class PropertyRead extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the variable's type or null if unknown.
|
||||
*
|
||||
*/
|
||||
public function getType(): ?Type
|
||||
{
|
||||
|
||||
@@ -88,7 +88,6 @@ class PropertyWrite extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the variable's type or null if unknown.
|
||||
*
|
||||
*/
|
||||
public function getType(): ?Type
|
||||
{
|
||||
|
||||
@@ -65,7 +65,6 @@ class See extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the ref of this tag.
|
||||
*
|
||||
*/
|
||||
public function getReference(): Reference
|
||||
{
|
||||
|
||||
@@ -57,7 +57,6 @@ final class Throws extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the type section of the variable.
|
||||
*
|
||||
*/
|
||||
public function getType(): Type
|
||||
{
|
||||
|
||||
@@ -60,7 +60,6 @@ final class Uses extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the structural element this tag refers to.
|
||||
*
|
||||
*/
|
||||
public function getReference(): Fqsen
|
||||
{
|
||||
|
||||
@@ -88,7 +88,6 @@ class Var_ extends BaseTag implements Factory\StaticMethod
|
||||
|
||||
/**
|
||||
* Returns the variable's type or null if unknown.
|
||||
*
|
||||
*/
|
||||
public function getType(): ?Type
|
||||
{
|
||||
|
||||
@@ -40,7 +40,6 @@ final class DocBlockFactory implements DocBlockFactoryInterface
|
||||
* Factory method for easy instantiation.
|
||||
*
|
||||
* @param string[] $additionalTags
|
||||
*
|
||||
*/
|
||||
public static function createInstance(array $additionalTags = []): DocBlockFactory
|
||||
{
|
||||
@@ -62,7 +61,6 @@ final class DocBlockFactory implements DocBlockFactoryInterface
|
||||
/**
|
||||
* @param object|string $docblock A string containing the DocBlock to parse or an object supporting the
|
||||
* getDocComment method (such as a ReflectionClass object).
|
||||
*
|
||||
*/
|
||||
public function create($docblock, ?Types\Context $context = null, ?Location $location = null): DocBlock
|
||||
{
|
||||
|
||||
@@ -8,13 +8,11 @@ interface DocBlockFactoryInterface
|
||||
* Factory method for easy instantiation.
|
||||
*
|
||||
* @param string[] $additionalTags
|
||||
*
|
||||
*/
|
||||
public static function createInstance(array $additionalTags = []): DocBlockFactory;
|
||||
|
||||
/**
|
||||
* @param string|object $docblock
|
||||
*
|
||||
*/
|
||||
public function create($docblock, ?Types\Context $context = null, ?Location $location = null): DocBlock;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user