This is a taglet to document the default constraints of a GENIUS class by means of one or more tables.
Usage in the javadoc of a class:
@genius.defaultConstraints [[
complement_for_header]] index_0:Class_0:item_0:constraints_0;
index_1:Class_1:item_1:; index_2:Class_2:item_2:constraints_2
where:
-
complement_for_header (optional) : is an optional text to be added to the header of the table of
constraints (part into {} in the example). It must be given into double brackets [[]].
-
index_n (optional) : is the subcomponent index to be documented.
-
Class_n (optional) : is the class name of the subcomponent to be documented.
-
item_n (optional) : is the name or widgetID given to the subcomponent.
-
constraints_n (optional) : are the constraints that apply to the subcomponent by default.
If any of the elements is not given, the word (undefined) will appear in the table instead.
Note that the columns are separated by GConstants.DOTCOMMA and the cells within the same column are separated by ":".
Table aspect :
Default Constraint(s){ for complement_for_header}:
Index |
Class |
Item |
Constraint |
0 |
Class_0 |
item_0 |
constraints_0 |
1 |
Class_1 |
item_1 |
(undefined) |
2 |
Class_2 |
item_2 |
constraints_2 |