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

support @internal tag #16

Open
paulgibbs opened this issue Jun 13, 2013 · 3 comments
Open

support @internal tag #16

paulgibbs opened this issue Jun 13, 2013 · 3 comments

Comments

@paulgibbs
Copy link
Contributor

I'd like to update the wp-cli commands to not create posts for functions/classes/etc marked as @internal unless an override flag is passed to wp-cli.

When generating documentation from PHPDoc comments it is RECOMMENDED to hide the associated element unless the user has explicitly indicated that internal elements should be included.

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.

https://github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md#78-internal

@paulgibbs
Copy link
Contributor Author

Going to go ahead and add this later this week unless I get an objection soon :)

@rmccue
Copy link
Contributor

rmccue commented Jun 21, 2013

👍

@Rarst
Copy link
Contributor

Rarst commented Feb 26, 2014

This seems sound in spec, however WP's use of @internal is (as usual) inconsistent.

On this, #37 and anything alike I am thinking towards standardizing behavior on default everything and opt-out options.

The primary goal of parser is to extract data as abundant as possible from source processing, narrowing that data down is post-processing stage.

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

No branches or pull requests

3 participants