Module JAXB

JAXB Module

The JAXB module processes all the Java data types that can be (de)serialized to/from XML using JAXB. The JAXB module creates the model that is used to generate all the XML-based documentation for the API.

Configuration

The configuration for the JAXB module is specified by the jaxb element under the modules element in the Enunciate configuration file. The following attributes are supported on the jaxb element:

attribute	description
datatype-detection	The "datatype-detection" dictates how the module is to detect data types for the API. The valid values are "passive" (data types will only be detected when other modules and services explicitly depend on the data types), "aggressive" (data types will be detected aggressively, by scanning the entire classpath), and "local" (data types will be detected only from among those in the source code of the current invocation context). Default is "passive".
disableExamples	(Since 2.7) Whether to disable examples in the generated documentation. Default: false.

Elements

The jaxb element supports the following child elements:

examples

(As of 2.10.)

The "examples" subelement of the "jaxb" element is used to declare external documentation examples. Child "example" elements support the following attributes:

• The "type" attribute specifies documentation type for which to provide an example.
• The "example" attribute specifies the text of the documentation example.