Add CGL rules for annotations
Since annotations are part of the code in FLOW3, we should add some more rules in the CGL documentation.
E.g. it would be good to have a list of all annotations used in FLOW3 (including @aspect eg).
And it should be stated which annotations are required in which cases.
Additionally the order of annotation tags varies from class to class currently. My suggestion for a defined order is
For constructor and methods in classes:
// parameters/return type @param @return // validation @validate @dontvalidate // authors (we might get rid of this?) @author // API related @api @since @deprecated // additional annotations @see @todo
For test cases:
@test @dataProvider @expectedException @author
What am I missing?
Updated by Karsten Dambekalns about 12 years ago
I'll commit the suggested change to the manual soon. I added lists like above to the CGL appendix. The required annotations are listed in the standard docblock examples, further explanation of FLOW3-specific annotations must be in the related chapters. Feel free to check my changes and comment if needed!