Class Salient\PHPDoc\PHPDoc

`final`
`implements`	`Readable`
`uses`	`ReadsProtectedProperties`

A PSR-5 PHPDoc

Summaries that break over multiple lines are unwrapped. Descriptions and tags may contain Markdown, including fenced code blocks.

Located at Toolkit/PHPDoc/PHPDoc.php

Methods
`public`	`__construct(string $docBlock, ?string $classDocBlock = null, class-string\|null $class = null, ?string $member = null)` Creates a new PHPDoc object from a PHP DocBlock Creates a new PHPDoc object from a PHP DocBlock	#
`public`	`unwrap(?string $value): ?string`	#
`public`	`getTemplates(bool $all = false): array<string, TemplateTag>` Get the PHPDoc's template tags, optionally including class templates and any templates inherited from parent classes Get the PHPDoc's template tags, optionally including class templates and any templates inherited from parent classes	#
`public`	`hasDetail(): bool` True if the PHPDoc contains more than a summary and/or variable type information True if the PHPDoc contains more than a summary and/or variable type information	#
`public`	`mergeInherited(PHPDoc $parent): void` Add missing values from an instance that represents the same structural element in a parent class or interface Add missing values from an instance that represents the same structural element in a parent class or interface	#
`public static`	`fromDocBlocks( array<class-string\|int, string> $docBlocks, array<class-string\|int, string\|null>\|null $classDocBlocks = null, ?string $member = null, class-string $fallbackClass = null, ): ?self`	#
`public static`	`normaliseType(string $type, bool $strict = false): string` Normalise a PHPDoc type Normalise a PHPDoc type If `$strict` is `true`, an exception is thrown if `$type` is not a valid PHPDoc type.	#

Methods used from Salient\Core\Concern\ReadsProtectedProperties
`getReadableProperties()`

Properties
`public readonly`	`string\|null`	`$Summary` Summary (if provided) Summary (if provided)	#
`public readonly`	`string\|null`	`$Description` Description (if provided) Description (if provided)	#
`public readonly`	`string[]`	`$Tags` Original tags, in order of appearance Original tags, in order of appearance	#
`public readonly`	`array<string, string[]>`	`$TagsByName` Original tag metadata, indexed by tag name Original tag metadata, indexed by tag name	#
`public readonly`	`array<string, ParamTag>`	`$Params` "@param" tags, indexed by name "@param" tags, indexed by name	#
`public readonly`	`ReturnTag\|null`	`$Return` "@return" tag (if provided) "@return" tag (if provided)	#
`public readonly`	`VarTag[]`	`$Vars` "@var" tags "@var" tags	#
`public readonly`	`array<string, TemplateTag>`	`$Templates` "@template" tags, indexed by name "@template" tags, indexed by name	#
`public readonly`	`class-string\|null`	`$Class`	#
`public readonly`	`string\|null`	`$Member`	#