mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-13 23:35:30 +00:00
54 lines
2.2 KiB
HTML
54 lines
2.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Mini-XML Programmers Manual, Version 2.0</TITLE>
|
|
<META NAME="author" CONTENT="Michael Sweet">
|
|
<META NAME="copyright" CONTENT="Copyright 2003-2004">
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
|
|
<LINK REL="Start" HREF="index.html">
|
|
<LINK REL="Contents" HREF="toc.html">
|
|
<LINK REL="Prev" HREF="4UsingthemxmldocUtility.html">
|
|
<LINK REL="Next" HREF="CodeDocumentationConventions.html">
|
|
<STYLE TYPE="text/css"><!--
|
|
BODY { font-family: serif }
|
|
H1 { font-family: sans-serif }
|
|
H2 { font-family: sans-serif }
|
|
H3 { font-family: sans-serif }
|
|
H4 { font-family: sans-serif }
|
|
H5 { font-family: sans-serif }
|
|
H6 { font-family: sans-serif }
|
|
SUB { font-size: smaller }
|
|
SUP { font-size: smaller }
|
|
PRE { font-family: monospace }
|
|
--></STYLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<A HREF="toc.html">Contents</A>
|
|
<A HREF="4UsingthemxmldocUtility.html">Previous</A>
|
|
<A HREF="CodeDocumentationConventions.html">Next</A>
|
|
<HR NOSHADE>
|
|
<H2><A NAME="5_1">The Basics</A></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. Each source and
|
|
header file must conform to some simple code commenting conventions so
|
|
that <TT>mxmldoc</TT> can extract the necessary descriptive text.</P>
|
|
<P>The <TT>mxmldoc</TT> 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, <TT>
|
|
mxmldoc</TT> writes XHTML documentation to the standard output, which
|
|
can be redirected to the file using the <KBD>>filename</KBD> syntax:</P>
|
|
<PRE>
|
|
<KBD>mxmldoc myfile.xml >myfile.html ENTER</KBD>
|
|
<KBD>mxmldoc myfile.xml file1.c file2.cxx file3.h >myfile.html ENTER</KBD>
|
|
</PRE>
|
|
<P>If no source files are provided on the command-line, the current
|
|
contents of the XML file are converted to XHTML.</P>
|
|
<HR NOSHADE>
|
|
<A HREF="toc.html">Contents</A>
|
|
<A HREF="4UsingthemxmldocUtility.html">Previous</A>
|
|
<A HREF="CodeDocumentationConventions.html">Next</A>
|
|
</BODY>
|
|
</HTML>
|