phpdox icon indicating copy to clipboard operation
phpdox copied to clipboard

Hide @internal classes

Open jeremy-wizaplace opened this issue 6 years ago • 4 comments

Hello,

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

Thanks

jeremy-wizaplace avatar Feb 11 '19 15:02 jeremy-wizaplace

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

theseer avatar Feb 11 '19 21:02 theseer

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?

theseer avatar Feb 11 '19 21:02 theseer

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 avatar Feb 12 '19 08:02 jeremy-wizaplace

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

jeremy-wizaplace avatar Feb 12 '19 08:02 jeremy-wizaplace