You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
56 lines
1.7 KiB
56 lines
1.7 KiB
<html>
|
|
<body>
|
|
|
|
<h1 align='right'><a name='MXMLDOC'>4 - Using the mxmldoc
|
|
Utility</a></h1>
|
|
|
|
<p>Originally developed to generate the Mini-XML and CUPS API
|
|
documentation, the <tt>mxmldoc(1)</tt> program converts C and C++
|
|
source files into an intermediate XML format and uses in-line
|
|
comments rather than comment headers to annotate functions, types,
|
|
and constants. This chapter describes how to use it.</p>
|
|
|
|
<h2>The Basics</h2>
|
|
|
|
<h2>Commenting Your Code</h2>
|
|
|
|
<h2>Creating HTML Documentation</h2>
|
|
|
|
<h2>Creating Man Pages</h2>
|
|
|
|
<h2>The XML Schema</h2>
|
|
|
|
<p><i>mxmldoc</i> scans the specified C and C++ source files to
|
|
produce an XML representation of globally accessible classes,
|
|
constants, enumerations, functions, structures, typedefs,
|
|
unions, and variables. The XML file is updated as necessary and
|
|
a HTML representation of the XML file is written to the standard
|
|
output. If no source files are specified then the current XML
|
|
file is converted to HTML on the standard output.
|
|
<p>In general, any C or C++ source code is handled by
|
|
<i>mxmldoc</i>, however it was specifically written to handle
|
|
code with documentation that is formatted according to the CUPS
|
|
Configuration Management Plan which is available at
|
|
"http://www.cups.org/documentation.php".
|
|
<h3 _hd_omit_toc>Options</h3>
|
|
<dl>
|
|
<dt>--intro introfile.html
|
|
</dt>
|
|
<dd>Inserts the specified file at the top of the output documentation.
|
|
</dd>
|
|
<dt>--section section
|
|
</dt>
|
|
<dd>Sets the section/keywords in the output documentation.
|
|
</dd>
|
|
<dt>--title title
|
|
</dt>
|
|
<dd>Sets the title of the output documentation.
|
|
</dd>
|
|
</dl>
|
|
<h3 _hd_omit_toc>See Also</h3>
|
|
mxml(3), Mini-XML Programmers Manual, http://www.easysw.com/~mike/mxml/
|
|
<h3 _hd_omit_toc>Copyright</h3>
|
|
Copyright 2003-2005 by Michael Sweet.
|
|
|
|
</body>
|
|
</html>
|
|
|