You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When adding the @ignore annotation to classes, the annotation is ignored and documentation is generated for them anyway.
One workaround seems to be to add @internal which hides them from the docs - but that seems like a bit of a cheat.
Expected Behavior
The class should be omitted from the documentation
Actual Behavior
The class appears in the documentation
Steps to Reproduce the Problem
Create a class with docblocks
Add @ignore to the class
The class appears in the documentation anyway
Your environment
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
Since many issue might only occur on a specific code base it would be very helpful if you link to your project
or add any code that is involved in to the issue.
Version used: 2.x
Install method: Composer
php version: 7.1
Operating system and version (e.g. Ubuntu 16.04, Windows 7): Windows 10
@ssilviogit The only workaround I know of is currently to add manual <ignore> directives in phpdoc.dist.xml for every source file or source directory that I don't want to document.
This issue should be resolved in phpDocumentor v3. I haven't had time yet to verify your specific example against it; help there is much appreciated. I will keep the issue open to verify this later; I am currently doing triage on open items
When adding the
@ignore
annotation to classes, the annotation is ignored and documentation is generated for them anyway.One workaround seems to be to add
@internal
which hides them from the docs - but that seems like a bit of a cheat.Expected Behavior
The class should be omitted from the documentation
Actual Behavior
The class appears in the documentation
Steps to Reproduce the Problem
@ignore
to the classYour environment
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
Since many issue might only occur on a specific code base it would be very helpful if you link to your project
or add any code that is involved in to the issue.
The text was updated successfully, but these errors were encountered: