
DOC++ fr Atari TOS Computer

Status:
  Public Domain (GNU Lizenz)

Autoren:
  Malte Zoecker (http://www.zib.de/zoeckler)
  Roland Wunderling (mailto:wunderling@zib.de)
  (http://www.zib.de/Visual/software/doc++/index.html)

Portierung fr TOS:
  Volker Hemsen (mailto:hemsen@t-online.de)
  (http://home.t-online.de/home/hemsen)


DOC++ ist ein JavaDoc kompatibles Quelltext-Dokumentationstool fr C++ und
Java. Es wurde von Malte Zoecker und Roland Wunderling in C++ unter Unix
entwickelt und kann bei einigen wenigen nderungen problemlos fr TOS, DOS
und Windows 95/98/NT portiert werden.
DOC++ scant '.H' und '.JAVA'-Dateien nach speziellen Kommentaren ( ///
fr Einzeiler und /** */ fr Mehrzeiler ) und exportiert diese in TEX-
oder HTML-Dateien. Die ntigen Schlsselworte findet man in der DOC++
Dokumentation und in jedem guten Buch ber Java.

Fr den Betrieb unter TOS werden bentigt:
 - ein Dateisystem mit langen Dateinamen
 - ein TEX-System
 oder
 - optional ein HTML-Browser mit Java-Runtime (z.B. Netscape und MagiCMac
   auf Apple Macintosh oder MagiCPC unter Windows)
   Ansonsten (bei Verwendung von CAB) mu auf die Darstellung von Klassen-
   diagrammen verzichtet werden!

DOC++ ist ein Kommandozeilenprogramm und versteht folgende Sytax:

 docpp.ttp [Optionen] [-d ausgabepfad] [scanpfad]
 
 z.B.: docpp.ttp -H -f -u -d c:\gnu\src\ c:\gnu\src\.
     
       als AGNUS-Tool:
       docpp.ttp -H -f -u -d $prjdir\doku $prjdir\.

 Erluterungen:
  -H : erzeuge HTML-Dokumentation
  -f : zeige Dateinamen
  -u : Pfeil geht von Unter- zur Oberklasse (entspricht UML)
  -d : Es folgt der Ausgabepfad als nchste Option. Ansonsten wird in das
       aktuelle Verzeichnis geschrieben. 
  danach: der Scanpfad, wenn dieser gleich dem aktuellen Pfad ist, sollte
          man unbedingt einen Punkt ('.') angeben.

 Weitere Optionen kann man mit
      docpp.ttp -h
 bekommen.
 Weitere Fragen klrt die DOC++ Dokumentation!

Viel Spa in der wundervollen Welt von DOC++ wnscht Euch

Volker Hemsen

