Development Documentation TODO

Javadoc

This is automatically generated from source. However, it needs to be updated (and kept up to date) in many files. The Javadoc also needs to be built and posted on the website.

Architecture

This describes all the modules of Mulgara, and how they interact. Processes involving the modules also requires documentation.

Recommend a walk through of the code for several common operations, including insertions and queries.

Module Descriptions

This is a detailed description of all the Mulgara modules in isolation.

Plans

Write up suggested features and refactorings, including:

  • What we want to build.
  • Why it should be built.
  • High level design.