Source Documentation Toolkit

Overview

SDToolkit (Source Documentation Toolkit) provides a framework which allows a developer to add special javadoc style comments into source code. This information is then extracted together with the surrounding source code and analysed to produce API/technical documentation.

Features

Written in Java providing platform independence *
Main framework can be hosted remotely. Providing a centralised service on a local intranet for example.
Source file readers are pluggable and can be interchanged by any object implementing the bjsoftware.docobjects.IDocReader inteface
Similary documentation writers are pluggable and can be replaced by any object implementing the bjsoftware.docobjects.IDocWriter inteface
Highly customisable
Currently pascal/Delphi and VB source file readers are available
A default documentation writer is available to produce an XML document

* SDToolkit can be hosted on any platform with an available Java 1.2 compatable JVM.

Downloads

Packages can be downloaded from the project download page.

Documentation

View the API documentation online [framed] [noframes] or download it from the project download page.

All other documentation related to SDToolkit can be found here.

Test Suite

I have written a couple of servlets for testing across a web interface. Go here for the pascal servlet and here for VB.

Bug Reporting/Support Requests

Any bugs can be reported here. Support requests should be logged here.