You are here: Interface Components > Doc-O-Matic Tools
Other Interface Components
Doc-O-Matic Tools
Messages
> Command Line Compiler
Command Line Compiler
Close
Doc-O-Matic 10
Command Line Compiler

Doc-O-Matic includes a command line tool - the Doc-O-Matic command line compiler. This tool allows you to automate the documentation-building step by integrating it into a batch build job. 

The command line compiler (dmcc.exe) takes a Doc-O-Matic project file (*.dox) as input and generates documentation according to the settings in the project. This is the DMCC usage:

dmcc.exe [-config "<NAME>"] [-chk] [-all] [-noshow] [-w1|w2|w3] <PROJECT> or dmcc.exe -sym <SYMBOLFILE> <PROJECT>
Option
Meaning
config "<name>"
Builds a named configuration.
chk
Check for errors only, do not build.
all
Build using all configurations.
noshow
Do not show documentation after build is complete.
w1
Warning Level 1: show hints, warnings and errors.
w2
Warning Level 2: show warnings and errors.
w3
Warning Level 3: show errors only.
<project>
The .dox project file to be processed.
sym
Alternative usage to generate a symbol ID list.
<symbolfile>
The symbol ID list file to be generated
-i [code[;code[;code...]]]
Ignores message code numbers followed by semicolon separated list of codes. The compiler will print the number of messages that were not output. Even though the messages matching these codes will not be output, the exit code of the compiler does not change. That means that even if all warnings are suppressed, the exit code will still be set to inform the calling program of the presence of warnings. This also applies to the -w1 -w2 and -w3 command line options.

The command line compiler returns the following exit codes:

Code
Meaning
0
No error.
20
Warnings (such as broken links).
30
QA checks set up in the project failed.
40
Errors during the output phase.
41
Fatal errors during output (usually indicates bugs).
50
Output file cannot be created (locked by other application).
100
Invalid command line (eg. wrong command line switch).
110
The given project cannot be found or loaded.
Copyright © 2000-2020 toolsfactory software inc. All rights reserved.