Coming from
#1969970: How do document needed @Translation on dedicated
It appears that our standards on plugin annotations
http://drupal.org/coding-standards/docs#Plugin
are outdated, in that it is more likely that someone will be using a specific class instead of Plugin, so the tag will be flexible, like
@EntityType
So, I think we need to:
a) Update the docs standards to make this clear.
b) Update the API module to deal with this.
I'm not currently quite sure what the right way to do either is, so filing this issue to discuss both...
On (b), webchick suggested on the other issue that if the API module encounters @[CamelCaseClassNamePattern] it should do what it's currently doing for @Plugin. What it's currently doing is detecting @Plugin(...) at the very end of the doc block, and replacing this with a Plugin annotation H3 header, with the @Plugin(...) as if it was in @code/@endcode. This seems fairly reasonable, since I don't think any of our other @tags start with a capital letter. In addition, I think we could make the ClassName turn into a link to the class.
Thoughts? Any suggested rewrites of the standards page section?