Contents Previous Next

The Basics

The mxmldoc utility scans C and C++ source and header files and produces an XML file describing the library interface and an XHTML file providing a human-readable reference to the code. Each source and header file must conform to some simple code commenting conventions so that mxmldoc can extract the necessary descriptive text.

The mxmldoc command requires the name of an XML file to store the code information; this file is created and updated as necessary. The XML file is optionally followed by a list of source files to scan. After scanning any source files on the command-line, mxmldoc writes XHTML documentation to the standard output, which can be redirected to the file using the >filename syntax:

    mxmldoc myfile.xml >myfile.html ENTER
    mxmldoc myfile.xml file1.c file2.cxx file3.h >myfile.html ENTER

If no source files are provided on the command-line, the current contents of the XML file are converted to XHTML.


Contents Previous Next