/doxml

A simple Doxygen driver to produce XML output.

Primary LanguagePython

doxml

The doxml utility drives Doxygen, causing it to produce its XML output. The resulting XML is minimized and cleaned of empty nodes, ready for further processing.

Requirements

Installation

To install doxml, use pip passing the doxml source directory.

For exmaple:

$ pip install /path/to/doxml

Command-Line Arguments

-o, --output-file

This option forces the generated output to be written to the specified file. If the specified file is empty or - then the output is written to standard output.

-i, --include

Zero or more patterns matching files to process with Doxygen.

-e, --exclude

Zero or more patterns to exclude from Doxygen processing.

-c, --config

A file containg Doxyfile-like entries to be passed to Doxygen. The options specified in this file may be overwritten by more specific options.

-d, --dump-config

Rather than running Doxygen, just print on standard output the options that would be passed to it.

Environment

The following environment variables affect the operation of doxml.

DOXYGEN

The DOXYGEN environment variable specifies the path to the Doxygen utility. If omitted, the default doxygen name is used. If you have not specified the DOXYGEN environment variable, you should ensure that the doxygen program is available in one of the directories specified in the PATH environment variable, or on Windows, within the current directory.