StripInternal

Extends \Zend\Filter\AbstractFilter

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.

link

http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/internal.html

package

Default

Methods

Initializes this filter with an instance of the builder to retrieve the latest ProjectDescriptor from.

__construct(\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder) 

If the ProjectDescriptor's settings allow internal tags then return the Descriptor, otherwise null to filter it.

filter(\phpDocumentor\Descriptor\DescriptorAbstract $value) : \phpDocumentor\Descriptor\DescriptorAbstract|null

Properties

builder

builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder