Introduction

The general idea of AutoDOC is to dispense with the notion of 2 documents, one containing the code, the other its documentation and to integrate both into a single document instead. This is not a new idea, its origins can be traced back to Donald Knuth's WEB system.

In contrast to WEB documentation and code do not stand side by side, as equals. Here the documentation is embedded into the comments sprinkled throughout the code. Special formatting commands are used to distinguish regular comments and documentation.

The following sections will describe these commands and all other interfaces and assumptions made by AutoDoc in detail.

Next


Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,