How we make API references.

Overview

How do we create API documentation for CloudStack?

...

The API documentation can be built with Maven using the following commands (should work on 4.1 and above):

1. mvn  mvn -Pdeveloper -Dnoredist clean install mvn -P developer -pl :cloud-apidoc

Built documentation can be found here: tools/apidoc/target/xmldoc/html

...

You can call it with the following command:

java -cp /.m2/repository/com/thoughtworks/xstream/xstream/1.4.3/xstream-1.4.3.jar:/cloudstack/dist/rpmbuild/BUILD/cloudstack-4.2.0-SNAPSHOT/server/target/classes \
com.cloud.api.doc.ApiXmlDocReader -old /path/to/4.0.commands.xml -new /path/to/4.1.commands.xml -d /path/to/diff/

...