2.3 Doclet parameters
Prev 2. Running the jax-doclets Next

2.3 Doclet parameters

Generic parameters

These parameters are valid for all jax-doclets

Table 2.1. jax-doclet generic parameters
Parameter Function
-stylesheet The CSS stylesheet to copy and use.
-header The header which is inserted on every page header.
-footer The footer which is inserted on every page footer.
-charset The charset to use for source files and produced HTML documentation.
-link Path to another JavaDoc documentation. This is used to produce links to other package's documentation, either regular JavaDoc or to JAXB documentation in the case of the JAX-RS doclet.

JAX-RS doclet parameters

These parameters are only valid for the JAX-RS doclet

Table 2.2. JAX-RS doclet parameters
Parameter Function
-jaxrscontext The URL path to your RESTful API, if there is a prefix prepended to it on your deploy site.
Prev Up Next
2.2 Running jax-doclets in ant Home 3. JAX-RS doclet documentation