The @api doc block annotation

[mad-briller]

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.html
This 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:

• add a label similar to the internal one, that's green or some other positive color
• sort @api elements to the top of their respective list, so they are seen first

As always, thanks your time and input.

[williamdes]

Hi @mad-briller
Thank you for your feedback, I will surely support this as soon as possible !

[mad-briller]

Thanks @williamdes for your swift and friendly response, as always!