Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hide @internal classes #350

Open
jeremy-wizaplace opened this issue Feb 11, 2019 · 4 comments
Open

Hide @internal classes #350

jeremy-wizaplace opened this issue Feb 11, 2019 · 4 comments
Labels

Comments

@jeremy-wizaplace
Copy link

Hello,

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

Thanks

@theseer
Copy link
Owner

theseer commented Feb 11, 2019

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

@theseer
Copy link
Owner

theseer commented Feb 11, 2019

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
Copy link
Author

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants