Legacy platform

Generating developer documentation

Learn how to generate a developer documentation.

The developer documentation such as Javadoc, is contained within a documentation EAR file. Do not deploy this EAR file to a production system.

To generate the developer documentation when building the application EAR, complete the following steps:
  1. Browse to the <INSTALL_DIR>/properties/ folder.
  2. Open the sandbox.cfg file and set the value of BUILD_DOC_EAR property to "true".
  3. Run the setup files script.

    The developer documentation gets generated along with the application EAR in a production environment.

Note: The create-ear parameter and -Dnodocear=true takes precedence over the BUILD_DOC_EAR property. For example, the developer documentation does not get generated if you set the value of BUILD_DOC_EAR property to "true", and then use the -Dnodocear=true parameter along with the create-ear script.