mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-08 13:39:58 +00:00
81 lines
2.5 KiB
HTML
81 lines
2.5 KiB
HTML
<html>
|
|
<body>
|
|
|
|
<h1 align='right'><a name='MXMLDOC'>4 - Using the mxmldoc
|
|
Utility</a></h1>
|
|
|
|
<p>This chapter describes how to use the <tt>mxmldoc(1)</tt>
|
|
utility that comes with Mini-XML to automatically generate
|
|
documentation for your programs.</p>
|
|
|
|
<h2>The Basics</h2>
|
|
|
|
<p>The <tt>mxmldoc</tt> 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.</p>
|
|
|
|
<h2>XML Schema</h2>
|
|
|
|
<p>The following poor-man's schema describes the format of the
|
|
XML files produced by <tt>mxmldoc</tt>:
|
|
|
|
<pre>
|
|
<?xml version="1.0"?>
|
|
<namespace name=""> [optional...]
|
|
<constant name="">
|
|
<description>descriptive text</description>
|
|
</constant>
|
|
|
|
<enumeration name="">
|
|
<constant name="">...</constant>
|
|
</enumeration>
|
|
|
|
<typedef name="">
|
|
<description>descriptive text</description>
|
|
<type>type string</type>
|
|
</typedef>
|
|
|
|
<function name="" scope="">
|
|
<description>descriptive text</description>
|
|
<argument name="" direction="I|O|IO" default="">
|
|
<description>descriptive text</description>
|
|
<type>type string</type>
|
|
</argument>
|
|
<returnvalue>
|
|
<description>descriptive text</description>
|
|
<type>type string</type>
|
|
</returnvalue>
|
|
<seealso>function names separated by spaces</seealso>
|
|
</function>
|
|
|
|
<variable name="" scope="">
|
|
<description>descriptive text</description>
|
|
<type>type string</type>
|
|
</variable>
|
|
|
|
<struct name="">
|
|
<description>descriptive text</description>
|
|
<variable name="">...</variable>
|
|
<function name="">...</function>
|
|
</struct>
|
|
|
|
<union name="">
|
|
<description>descriptive text</description>
|
|
<variable name="">...</variable>
|
|
</union>
|
|
|
|
<class name="" parent="">
|
|
<description>descriptive text</description>
|
|
<class name="">...</class>
|
|
<enumeration name="">...</enumeration>
|
|
<function name="">...</function>
|
|
<struct name="">...</struct>
|
|
<variable name="">...</variable>
|
|
</class>
|
|
</namespace>
|
|
</pre>
|
|
|
|
</body>
|
|
</html>
|