Generating and accessing Javadoc

By default, Javadoc is not part of the runtime image or extracted runtime directory. You must generate the Javadoc files to access them.

Before you begin

Ensure that you have a copy of the extracted runtime as documented in Update custom extensions.

Javadoc is not part of the runtime image or extracted runtime directory. You must generate them first to be able to access them.

To generate the Javadoc files, browse to the extracted_runtime/bin folder, and run the following command:
bash ./sci_ant.sh -f ../properties/xapiDeployer.xml alldocs
Go to the extracted_runtime/xapidocs folder.
Open the index.html file from the corresponding directory based on the type of document that you want to access. For example, api_javadocs, propertydocs, or cufdocs.

Note: You cannot deploy a doc EAR. You can instead access the Javadoc files from the xapidocs folder.