Module Documentation

You can generate documentation for your module using the ant make-all-docs target.


Only public models and actions will be exposed for ModelDoc documentation. You can generate ModelDoc documentation using the ant modeldoc target.


All java classes defined in src and auto-generated classes in build/gen-src will be exposed for Javadoc documentation. You can generate Javadoc documentation using the ant javadoc target.

JS Doc

Any code with JSDoc tags is considered to be "private". It will be excluded from the generated documentation. As a best practice, modules should avoid explicit usage of any such APIs.

You can generate JS documentation using the ant jsdoc target.