-
Notifications
You must be signed in to change notification settings - Fork 32
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
The @api doc block annotation #48
Labels
enhancement
New feature or request
Comments
Hi @mad-briller |
Thanks @williamdes for your swift and friendly response, as always! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hey there,
Currently, Doctum responds to the
@internal
tag by adding a label to the structural element's documentation.This is great to help guide users away from methods that they should not be using, or that aren't covered by backwards compatibility promises
However, the
@api
tag also exists: https://docs.phpdoc.org/guide/references/phpdoc/tags/api.htmlThis tag is meant to do the opposite; guide a user to look at the public interface / backwards compatible ensured elements first.
I think Doctum could handle the
@api
tag, and i propose a few things it could do when it detects it:internal
one, that's green or some other positive color@api
elements to the top of their respective list, so they are seen firstAs always, thanks your time and input.
The text was updated successfully, but these errors were encountered: