mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-08 13:39:58 +00:00
67 lines
2.1 KiB
HTML
67 lines
2.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<html>
|
|
<!-- SECTION: Man Pages -->
|
|
<head>
|
|
<style type='text/css'><!--
|
|
h1, h2, h3, p { font-family: sans-serif; text-align: justify; }
|
|
tt, pre a:link, pre a:visited, tt a:link, tt a:visited { font-weight: bold; color: #7f0000; }
|
|
pre { font-weight: bold; color: #7f0000; margin-left: 2em; }
|
|
h1.title, h2.title, h3.title { border-bottom: solid 2px #000000; }
|
|
--></style>
|
|
<title>mxmldoc</title>
|
|
</head>
|
|
<body>
|
|
<!-- NEW PAGE -->
|
|
<h2 class='title'><a name='mxmldoc.1'>mxmldoc(1)</a></h2>
|
|
<h3 _hd_omit_toc>Name</h3>
|
|
mxmldoc - mini-xml documentation generator
|
|
<h3 _hd_omit_toc>Synopsis</h3>
|
|
<b>mxmldoc
|
|
</b>[ --intro
|
|
<i>introfile.html
|
|
</i>] [ --section
|
|
<i>section
|
|
</i>] [ --title
|
|
<i>title
|
|
</i>] [
|
|
<i>filename.xml
|
|
</i>] [
|
|
<i>source file(s)
|
|
</i>] >
|
|
<i>filename.html
|
|
</i><h3 _hd_omit_toc>Description</h3>
|
|
<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>
|