Creating Javadocs for CM Source Code

Information about the Javadoc tool can be found at the following location: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html. Please refer to the documentation concerning how to write tags, troubleshoot warnings and errors, and any other Javadoc tool questions.

Some known warnings are generated as part of the CM Javadoc process. The following two warnings are safe to ignore:

• The product's annotations currently use tags that are unrecognized by the Javadoc tool. Currently, the Javadoc tool is reporting these as warnings. These warnings are safe to ignore. For the list of tags that are relevant, please refer to the reference guide. For example, the Javadoc tool emits the following warning when it encounters the product's EntityPageMaintenance annotation. It is safe to ignore.

  warning - @EntityPageMaintenance is an unknown tag

• The Javadocs tool may also generate warnings that appear from the generated artifacts. These are easily identifiable by looking at the path for the name "sourcegen." For example the following warning can be ignored since path name includes the "sourcegen" directory.

  C:\spl\CCB_​PROJ1\java\sourcegen\cm\com\splwg\cm\domain\common\cmCisDiv\CmCisDivisionMaintenance_​Gen.java:437

For all other warnings, please refer to the Javadoc documentation.

To generate Javadocs, run the utility script generateJavadoc.bat.

To integrate CM and the product's Javadocs, run the utility script reindexJavadoc.bat to recreate the indices to reflect current environment.