search

theseer / phpdox

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)
http://phpdox.de
Other
600 stars 121 forks source link

Hide @internal classes #350

Open jeremy-wizaplace opened 5 years ago

jeremy-wizaplace commented 5 years ago

Hello,

Is-it possible to hide or disable generation for internal classes ?

Thanks

theseer commented 5 years ago

That's currently not implemented but would actually be a nice feature.

theseer commented 5 years ago

Thinking about it, how would such a feature work?

The naive approach would be to simply exclude every class having @internal in the accompanying docblock. But that won't work: What if there's a class extending from it that is NOT marked in the same fashion? Or implementing an interface? Or a trait being used? The documentation would be incomplete.

What about @internal classes/interfaces as type declarations? Usually, phpDox would try to resolve them. Should it not in this case?

jeremy-wizaplace commented 5 years ago

If a class/interface without @internal extends/implement an @internal class/interface you should show this class. It's a mistake from the develop and he must fix this if he don't want to display this class.

jeremy-wizaplace commented 5 years ago

It would be nice if you can add a parameter like publiconly="true" named hideinternal="true"