StripInternal
in package
Implements
FilterInterface
Filters a Descriptor when the @internal inline tag, or normal tag, is used.
When a Descriptor's description contains the inline tag @internal then the description of that tag should be included only when the visibility allows INTERNAL information. Otherwise it needs to be removed.
Similarly, whenever the normal @internal tag is used should this filter return null if the visibility does not allow INTERNAL information. This will remove this descriptor from the project.
Interfaces, Classes & Used Traits
Properties
$builder Line 35
protected$builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder
Methods
__construct() Line 40
Initializes this filter with an instance of the builder to retrieve the latest ProjectDescriptor from.
public__construct(ProjectDescriptorBuilder $builder) : mixed
__invoke() Line 48
If the ProjectDescriptor's settings allow internal tags then return the Descriptor, otherwise null to filter it.
public__invoke(DescriptorAbstract|null $value) : DescriptorAbstract|null