QtagsTags
@foo.bar
This tag is just a test tag
Deprecation warning
this tag is deprecated. use @blurge instead
Allowed locations
| class |
method |
constructor |
field |
| false |
true |
true |
false |
| Parameter |
Required |
Allowed values |
Default value |
Array |
Token separator |
Description |
| age |
false |
Any value |
|
no |
|
|
| age-list |
false |
Any value |
|
yes |
, |
|
| apple |
false |
red, green |
|
no |
|
Bla bla |
| apple-list |
false |
red, green |
|
yes |
, |
Bla bla |
| funny |
false |
true, false |
|
no |
|
Hip hop |
| funny-list |
false |
true, false |
|
yes |
; |
Hip hop |
| grape-fruit |
true |
Any value |
|
no |
|
Ping pong |
| grape-fruit-list |
true |
Any value |
|
yes |
, |
Ping pong |
@qtags.alias
class level tag to specify deprecated aliases of current tag. those will be
bombed on creation
Allowed locations
| class |
method |
constructor |
field |
| true |
true |
true |
true |
@qtags.allowed-value
specify one of the allowed values for tag or parameter
Allowed locations
| class |
method |
constructor |
field |
| true |
true |
false |
false |
@qtags.default
specify default value for tag or tag parameter. this can be used only
on method level.
Allowed locations
| class |
method |
constructor |
field |
| false |
true |
false |
false |
@qtags.deprecated
class level tag to specify deprecation of @-tag.
Allowed locations
| class |
method |
constructor |
field |
| true |
false |
false |
false |
@qtags.ignore
class level tag to specify that marked interface shall be not generated
itself. ( But methods will be used ) This is necessary to allow tag interface inheritance. ( For example,
hibernate has shitload of collection tags which share a lot of common parameters. )
Allowed locations
| class |
method |
constructor |
field |
| true |
false |
false |
false |
@qtags.list-token
Specify the token used in list processing
Allowed locations
| class |
method |
constructor |
field |
| false |
true |
false |
false |
@qtags.location
class level tag to specify allowed locations. this tag cab ne used only on class level to specify
locations where usage is allowed. Recognized values are "class" "method" "constructor" "field"
Allowed locations
| class |
method |
constructor |
field |
| true |
false |
false |
false |
@qtags.once
specify that this tag can be use once on given program element
Allowed locations
| class |
method |
constructor |
field |
| true |
false |
false |
false |
@qtags.required
specify that certain value is required to be present.
Allowed locations
| class |
method |
constructor |
field |
| false |
true |
false |
false |
@qtags.verbatim
specify that the parameter name should not be hyphenated
Allowed locations
| class |
method |
constructor |
field |
| false |
true |
false |
false |