Kommandozeilenkompiler

Doc-O-Matic stellt ein Kommandozeilen-Werkzeug zur Verfügung - den Doc-O-Matic Kommandozeilencompiler. Mit Hilfe dieses Werkzeuges können Sie den Ausgabeprozess Stufe für Stufe automatisieren, um ihn in einen Batchauftrag zu integrieren.

Der Kommandozeilencompiler (dmcc.exe) nimmt eine Doc-O-Matic Projektdatei (*.dox) als Input und erzeugt die Dokumentation entsprechend den Einstellungen im Projekt.

Das ist die Handhabung des DMCC:

dmcc.exe [-chk] [-all] [-noshow] [-w1|w2|w3] [{-load filter.dll}] <PROJECT>
   or
dmcc.exe -sym <SYMBOLFILE> <PROJECT>

Option	Bedeutung
config "<name>"	Erzeugt die genannte Konfiguration.
chk	Kontrolliert, ob es Fehler gibt, erzeugt keine Ausgabe.
all	Erzeugt eine Ausgabe von allen Konfigurationen (wie das Alle erzeugen Kommando).
noshow	Zeigt die Ausgabe nicht an, nachdem die Erzeugung abgeschlossen ist.
w1	Warnung Ebene 1: zeigt Hinweise, Warnungen und Fehler.
w2	Warnung Ebene 2: zeigt Warnungen und Fehler.
w3	Warnung Ebene 3: zeigt nur Fehler.
load	Lädt eine spezielle Filter DLL anstelle der Filter die eingetragen sind.
<project>	Die .dox Projektdatei, die bearbeitet werden soll.
sym	Alternative Methode, um eine Liste der Symbol IDs zu erstellen.
<symbolfile>	Die zu erzeugende Symbol ID Datei.
-i [code[;code[;code...]]]	Ignoriert Mitteilungscodenummern, gefolgt von einer durch Strichpunkte getrennten Liste von Codes. Der Compiler druckt die Anzahl der Mitteilungen, die nicht ausgegeben wurden. Auch wenn die Mitteilungen, die den angegebenen Codes entsprechen, nicht ausgegeben werden, ändert sich der Exitcode des Compilers nicht. Das bedeutet, dass auch wenn die Mitteilungen unterdrückt werden, der Exitcode dennoch so eingestellt ist, dass er dem aufrufende Programm die Warnungen mitteilt. Dies gilt auch für die -w1 -w2 und -w3 Kommandozeilenoptionens.

Der Kommandozeilencompiler kann die folgenden Fehlermeldungscodes ausgeben:

Code	Bedeutung
0	Kein Fehler.
20	Warnung (wie zum Beispiel eine nicht funktionierende Hyperlinks).
30	QA Kontrollen des Projektes waren nicht erfolgreich.
40	Fehler während der Ausgabephase.
41	Ein fataler Fehler, während der Erzeugung der Ausgabe (üblicherweise Fehler des Programmes).
50	Ausgabedatei kann nicht erzeugt werden (wird von einem anderen Programm benutzt).
100	Falsche Kommandozeile (zum Beispiel falsche Kommandozeilenoption).
110	Das eingegebene Projekt kann nicht gefunden oder geladen werden.