Next: Setup and configuration  Prev: Documentation language

Synopsis:

d4cab [flags] top-source-directory top-documentation-directory file1 file2 ...

Flags:

-I directory

--include-dir=directory

Adds directory to d4c&b search path. d4c&b searches for references in those directories.

-D name

--defined=name

Define name, so that `#ifdef name' evaluates to true if d4c&b needs to evaluate it. (``C++'' only)

-U name

--undefined=name

Undefine name, so that `#ifndef name' evaluates to true if d4c&b needs to evaluate it.(``C++'' only)

-p name

--preferences=name

Overrides name of preference file, by default `d4cab.pref'. This can be an absolute name or just a name.

-W

--warn-include

Issue a warning is a directory specified with -I is not under the project tree. Typically it is harmless, since it is convenient to give d4c&b the same flags used by the compiler, and some of those point to external include directories.