Differences between revisions 4 and 5
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
<<TableOfContents([2])>> <<TableOfContents(2)>>

Contents

  1. PonderDoc

PonderDoc

PonderDoc is similar to JavaDoc insofar as it is generated from a combination of Java comments and method arguments. It also includes the information it gets from the Ponder2op annotations. The PonderDoc output is generated at compile time by the Java apt compiler while the adaptor stub code is generated.

Currently PonderDoc is generated as a set of HTML pages but plug-ins may be written in the future to support other formats such as PDF or DocBook.

Adaptor stub code is generated in a directory called apt_generated with subdirectories representing the Java package names of the Managed Objects' packages. Another directory called doc is also created within the apt_generated directory and this contains the PonderDoc documentation.

PonderDoc (last edited 2010-08-18 09:18:03 by KevinTwidle)