75 lines
622 B
Plaintext
75 lines
622 B
Plaintext
=== Parameters
|
|
|
|
.file
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require documentation of files
|
|
****
|
|
.class
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require documentation of classes
|
|
****
|
|
.function
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require documentation of functions
|
|
****
|
|
.throws_tag
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require an "@throws" tag where appropriate
|
|
****
|
|
.return_tag
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require an "@return" tag
|
|
****
|
|
.param_tag
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require an "@param" tag for each function parameter
|
|
****
|
|
.variables
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require documentation of variables
|
|
****
|
|
.var_tag
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
Require that variable documentation contain an "@var" tag
|
|
****
|