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

drop ignoring @internal #823

Merged
merged 7 commits into from Mar 30, 2017
Merged

drop ignoring @internal #823

merged 7 commits into from Mar 30, 2017

Conversation

TomasVotruba
Copy link
Contributor

@TomasVotruba TomasVotruba commented Mar 29, 2017

This annotation clearly states that method is used for internal purpose - usually public method, that should be private -, so it should not be displayed and turning it off doesn't make sense. It would be like using reflection to make public method private.

Show only in source code.

@TomasVotruba
Copy link
Contributor Author

Ready to merge

@jankal jankal merged commit 95e9b1e into master Mar 30, 2017
@TomasVotruba TomasVotruba deleted the drop-internal-disabling branch March 30, 2017 13:36
@ek9
Copy link
Contributor

ek9 commented Apr 2, 2017

Small comment regarding this on @internal:

The @internal tag can be used as counterpart of the @api tag, indicating that the associated Structural Elements are used purely for the internal workings of this piece of software.

An additional use of @internal is to add internal comments or additional description text inline to the Long Description. This may be done, for example, to withhold certain business-critical or confusing information when generating documentation from the source code of this piece of software.

Source: https://www.phpdoc.org/docs/latest/references/phpdoc/tags/internal.html

While from my understanding we do not support @api tag, perhaps this had use-cases from the previous users and we should consider bringing it back.

@TomasVotruba
Copy link
Contributor Author

Please try to keep features frozen until we're ready with 4-year old task of replacing Reflection.

We need to focus our attention there. Having that done, we can easily ad new features, don't worry.

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

Successfully merging this pull request may close these issues.

None yet

3 participants