HOWTO: Generate the Documentation

Preliminaries

This document explains the basic steps to create the application programming interface documentation of Gravisto. It is assumed that you are working with Eclipse and that you can start Gravisto within Eclipse, see HOWTO: Get Started with Gravisto.
All API documentation is done via javadoc. All of the code you are writing not only for your private purposes should be documented in detail and in javadoc style.
Under Graffiti_Core, Graffiti_Editor, and Graffiti_Plugins you can find the API reference of Gravisto which is daily automatically generated from the cvs repository.

Generate Your Own Documentation

For generation of your own documentation of Gravisto's API follow the following steps:

  1. In Eclipse switch to the Java Perspective.
  2. In package Graffiti_Core right click on create_javadoc.xml and select Run Ant... from the context menu. After setting a tick to Targets > javadoc (default target) and pressing Run the reference of Graffiti_Core is generated under Graffiti_Core/javadoc in your workspace of Eclipse.
  3. In package Graffiti_Editor right click on create_javadoc.xml and select Run Ant... from the context menu. After setting a tick to Targets > javadoc (default target) and pressing Run the reference of Graffiti_Editor is generated under Graffiti_Editor/javadoc in your workspace of Eclipse.
  4. In package Graffiti_Plugins right click on create_javadoc.xml and select Run Ant... from the context menu. After setting a tick to Targets > javadoc (default target) and pressing Run the reference of Graffiti_Plugins is generated under Graffiti_Plugins/javadoc in your workspace of Eclipse.
    With this create_javadoc.xml you have in the ant dialog also the opportunity by setting a tick to Targets > javadoc-all to generate the reference of all Gravisto projects into one documentation. It is created under Graffiti_plugins/javadoc_all in your workspace of Eclipse. This has the advantage that links from one Gravisto project to objects of another Gravisto project are available offline.

If you have a private documentation, there is the possibility of testing newly added documentation of your source code before checking it in into the cvs repository.