doku.mod - Automatische Quellcode-Dokumentation (Stand: 23.02.2004 / 12:00)
Modul: doku.mod
benötigte Module:

Dokumentierte Prozeduren im Modul:

HINWEIS
Angelegt: 26/04/02 14:07:48
Geändert: 23/02/04 sk

Autor: Thomas Friebel

Beschreibung:


Dieses Modul ist weniger für die direkte Wiederverwendung in anderen Modulen gedacht, als vielmehr als Entwicklungswerkzeug, um Module mit Hilfe ihrer Quellcode-Kommentare zu dokumentieren.
Alle Kommentare, die sich zwischen den Tags <DOKU> und </DOKU> befinden werden in ein HTML-Dokument geschrieben, welches den Dateinamen des Moduls (inkl. der Endung ".mod") und der Erweiterung ".htm" bekommt.
Der Aufruf auf Kommandozeilenebene sieht exemplarisch wie folgt aus:

/tdbengine/tdbengine doku.prg -cwin -smeinmodul.mod -ddoku

Wurde kein "-d Paramter" als Zielverzeichnis übergeben, so wird ein Unterverzeichnis ./doku/ angelegt und als Zielpfad verwendet.

Das Ergebnis ist eine Datei namens meinmodul.mod.htm
Das Doku-Modul unterscheidet bisher 2 Vorkommensarten der <Doku>-Tags, nämlich
a.) Innerhalb eines PROCEDURe-Rumpfes und
b.) ausserhalb irgendwelcher Prozeduren.

Im 1. Fall werden alle Doku-Abschnitte erkannt und der Procedure zugeordnet ausgegeben.

TODO:

Um grössere Dokumentationsblöcke nicht mitten im Quellcode platzieren zu müssen ist noch eine Art Doku-Verweis einzubauen.
An der Stelle, an der im HTML-Dokument ein Text erscheinen soll ist im Quellcode nur noch ein "Link" auf einen am Modul-Ende stehenden Block einzufügen. Das soll die Übersichtlichkeit im Source wahren.


displayHelp

Angelegt: 30/04/02 11:19:56
Geändert: 30/04/02 11:19:56

Autor: TF

Beschreibung:

Gibt die Kommandozeilen-Hilfe zum Modul aus

TODO:
Für HTML-Ausgabe einrichten


getUses(fDoc : Integer; cFileTarget : String)

Angelegt: 30/04/02 11:20:50
Geändert: 03/05/02 11:20:50 / TF

Autor: TF

Beschreibung:


Ermittelt alle mit Uses/Include eingebundenen Module und listet diese im Kopfbereich der Doku als Links zu deren Dokus auf.
Es wird dabei nicht auf die Existenz entsprechender Dokus geprüft.

Parameter:
  • fDoc : File-Handle des zu erzeugenden HTML-Files


Keywords: eingebundene Module, ermitteln, verlinken


ParseBlock

Angelegt: 30/04/02 11:22:36
Geändert: 30/04/02 11:22:36

Autor: TF

Ersetzt alle Doku-Tags im Doku-Block durch entsprechende HTML-Konstrukte.

Main

Angelegt: 30/04/02 11:25:02
Geändert: 30/04/02 11:25:02

Autor: TF

Beschreibung:

Die Hauptprozedur des Doku-Moduls. Hier werden die einzelnen Sourcen nach den <DOKU>-Tags gescannt und die HTML-Dokumente erstellt