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.
- Python 3.6 or greater
- LXML 4.0 or greater
To install doxml, use pip passing the doxml source directory.
For exmaple:
$ pip install /path/to/doxml
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.
Zero or more patterns matching files to process with Doxygen.
Zero or more patterns to exclude from Doxygen processing.
A file containg Doxyfile-like entries to be passed to Doxygen. The options specified in this file may be overwritten by more specific options.
Rather than running Doxygen, just print on standard output the options that would be passed to it.
The following environment variables affect the operation of doxml.
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.