Annotation Type RestFooter
@Documented
@Target(PACKAGE)
@Retention(SOURCE)
public @interface RestFooter
Used to append documentation at the end of the generated HTML REST documentation.
It should provide the location of a file, relative to the module's root directory, containing the text to be appended.
A collection of file names can be provided, and the order of appended file content depends on the order in which file
names are declared on the annotation.
This annotation should be used only on the package-info.java file in the root folder of REST web services (/rest).
-
Required Element Summary
Required Elements Modifier and Type Required Element Description java.lang.String[]
filenames
Array of filenames to append at the end of the REST documentatino.
-
Element Details
-
filenames
java.lang.String[] filenamesArray of filenames to append at the end of the REST documentatino.
Required.
-