Developers can contribute to this manual to keep the descriptions of the code up-to-date and provide usage instructions and examples. Source code documentation is automatically extracted from the source code, including those JavaDoc tags contained in comments. These manual pages are written using the Markdown syntax.

Requirements

Doxygen version 1.8.0 or higher

Instructions

Edit the JavaDoc tagging as needed in the source code.

Edit the source in the $JOSHUA/doc/*.md manual pages or create new ones in the directory. (Note the use of reference links in the manual sources.)

Regenerate the updated documentation by running the following ant target:

cd $JOSHUA
ant documentation

Preview the regenerated manual by opening $JOSHUA/doc/html/index.html in a web browser.

Documentation

Documenting Joshua is of great importance. The manual is automatically generated using Doxygen. Find out more on the documentation page.

Style guide

Format

If you are using Eclipse, the project settings can be loaded automatically by pointing Eclipse to the $JOSHUA/.settings/ directory. If you are using another tool, please follow these conventions:

100 characters maximum line width
Indent with 2 spaces

In emacs:

(setq tab-width 2) (setq-default indent-tabs-mode nil)

Use spaces only for tabbing http://blog.ayjay.org/uncategorized/according-to-conway-there-is-a-disconnect-between-the-desire-to-travel-into-space-and-the-desire/* Open brace on same line
Keep else if on one line