AIR
/
mxml
mirror of https://github.com/michaelrsweet/mxml.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Save work on manual.

Browse Source
pull/193/head
Michael R Sweet 17 years ago
parent 8ed535457f
commit 0a79a46ac3
6 changed files with 59 additions and 35 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 6
      doc/advanced.html
  2. 6
      doc/intro.html
  3. 14
      doc/license.html
  4. 2
      doc/mxml-pocket.book
  5. 29
      doc/mxmldoc.html
  6. 37
      doc/title.html

6
doc/advanced.html
Unescape View File

@ -504,7 +504,8 @@ a user data pointer you supply:</p>
<pre> <pre>
void void
sax_cb(mxml_node_t *node, mxml_sax_event_t event, sax_cb(mxml_node_t *node,
mxml_sax_event_t event,
void *data) void *data)
{ {
... do something ... ... do something ...
@ -538,7 +539,8 @@ simulating a normal in-memory load:</p>
<pre> <pre>
void void
sax_cb(mxml_node_t *node, mxml_sax_event_t event, sax_cb(mxml_node_t *node,
mxml_sax_event_t event,
void *data) void *data)
{ {
if (event != MXML_SAX_ELEMENT_CLOSE) if (event != MXML_SAX_ELEMENT_CLOSE)

6
doc/intro.html
Unescape View File

@ -1,9 +1,9 @@
<html> <html>
<head> <head>
<title>Mini-XML Programmers Manual, Version 2.3</title> <title>Mini-XML Programmers Manual, Version 2.3</title>
<meta name='copyright' content='Copyright 2003-2007'/> <meta name='copyright' content='Copyright 2003-2007'>
<meta name='author' content='Michael Sweet'/> <meta name='author' content='Michael R. Sweet'>
<meta name='keywords' content='XML, C, C++, library'/> <meta name='keywords' content='XML, C, C++, library'>
</head> </head>
<body> <body>

14
doc/license.html
Unescape View File

@ -30,8 +30,6 @@ the following exceptions:</p>
</ol> </ol>
<!-- NEW PAGE -->
<p align=center><b>GNU LIBRARY GENERAL PUBLIC LICENSE</b></p> <p align=center><b>GNU LIBRARY GENERAL PUBLIC LICENSE</b></p>
<p align='center'>Version 2, June 1991 <p align='center'>Version 2, June 1991
<br />Copyright (C) 1991 Free Software Foundation, Inc. <br />Copyright (C) 1991 Free Software Foundation, Inc.
@ -201,7 +199,7 @@ Library, and copy and distribute such modifications or work
under the terms of Section 1 above, provided that you also meet under the terms of Section 1 above, provided that you also meet
all of these conditions:</p> all of these conditions:</p>
<blockquote> <ul>
<p><strong>a)</strong> The modified work must itself be <p><strong>a)</strong> The modified work must itself be
a software library. a software library.
@ -232,7 +230,7 @@ all of these conditions:</p>
application does not supply it, the square root function application does not supply it, the square root function
must still compute square roots.)</p> must still compute square roots.)</p>
</blockquote> </ul>
<p>These requirements apply to the modified work as a whole. If <p>These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the identifiable sections of that work are not derived from the
@ -341,7 +339,7 @@ notices, you must include the copyright notice for the Library
among them, as well as a reference directing the user to the among them, as well as a reference directing the user to the
copy of this License. Also, you must do one of these things:</p> copy of this License. Also, you must do one of these things:</p>
<blockquote> <ul>
<strong>a)</strong> Accompany the work with the complete <strong>a)</strong> Accompany the work with the complete
corresponding machine-readable source code for the corresponding machine-readable source code for the
@ -372,7 +370,7 @@ copy of this License. Also, you must do one of these things:</p>
received a copy of these materials or that you have received a copy of these materials or that you have
already sent this user a copy.</p> already sent this user a copy.</p>
</blockquote> </ul>
<p>For an executable, the required form of the &quot;work that <p>For an executable, the required form of the &quot;work that
uses the Library&quot; must include any data and utility uses the Library&quot; must include any data and utility
@ -397,7 +395,7 @@ the separate distribution of the work based on the Library and
of the other library facilities is otherwise permitted, and of the other library facilities is otherwise permitted, and
provided that you do these two things:</p> provided that you do these two things:</p>
<blockquote> <ul>
<strong>a)</strong> Accompany the combined library with <strong>a)</strong> Accompany the combined library with
a copy of the same work based on the Library, uncombined a copy of the same work based on the Library, uncombined
@ -409,7 +407,7 @@ provided that you do these two things:</p>
based on the Library, and explaining where to find the based on the Library, and explaining where to find the
accompanying uncombined form of the same work.</p> accompanying uncombined form of the same work.</p>
</blockquote> </ul>
<p><strong>8.</strong> You may not copy, modify, sublicense, <p><strong>8.</strong> You may not copy, modify, sublicense,
link with, or distribute the Library except as expressly link with, or distribute the Library except as expressly

2
doc/mxml-pocket.book
Unescape View File

@ -1,5 +1,5 @@
#HTMLDOC 1.8.27.1 #HTMLDOC 1.8.27.1
-t pdf14 -f "mxml-pocket.pdf" --book --toclevels 3 --no-numbered --toctitle "Table of Contents" --title --titleimage "logo.png" --linkstyle plain --size 4.25x6.875in --left 0.750in --right 0.50in --top 0.50in --bottom 0.50in --header .t. --header1 ... --footer h.1 --nup 1 --tocheader .t. --tocfooter ..i --duplex --portrait --color --no-pscommands --no-xrxcomments --compression=9 --jpeg=95 --fontsize 9.0 --fontspacing 1.2 --headingfont Helvetica --bodyfont Helvetica --headfootsize 8.0 --headfootfont Helvetica-Oblique --charset iso-8859-1 --links --no-embedfonts --pagemode outline --pagelayout single --firstpage c1 --pageeffect none --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password "" --user-password "" --browserwidth 680 --no-strict --no-overflow -t pdf14 -f "mxml-pocket.pdf" --book --toclevels 3 --no-numbered --toctitle "Table of Contents" --title --titleimage "title.html" --linkstyle plain --size 4.25x6.875in --left 0.750in --right 0.50in --top 0.50in --bottom 0.50in --header .t. --header1 ... --footer h.1 --nup 1 --tocheader .t. --tocfooter ..i --duplex --portrait --color --no-pscommands --no-xrxcomments --compression=9 --jpeg=95 --fontsize 9.0 --fontspacing 1.2 --headingfont Helvetica --bodyfont Helvetica --headfootsize 8.0 --headfootfont Helvetica-Oblique --charset iso-8859-1 --links --no-embedfonts --pagemode outline --pagelayout single --firstpage c1 --pageeffect none --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password "" --user-password "" --browserwidth 680 --no-strict --no-overflow
intro.html intro.html
install.html install.html
basics.html basics.html

29
doc/mxmldoc.html
Unescape View File

@ -4,13 +4,18 @@
<h1 align='right'><a name='MXMLDOC'>4 - Using the mxmldoc <h1 align='right'><a name='MXMLDOC'>4 - Using the mxmldoc
Utility</a></h1> Utility</a></h1>
<h2>The Basics</h2>
<p>Originally developed to generate the Mini-XML and CUPS API <p>Originally developed to generate the Mini-XML and CUPS API
documentation, the <tt>mxmldoc(1)</tt> program converts C and C++ documentation, the <tt>mxmldoc(1)</tt> program converts C and C++
source files into an intermediate XML format and uses in-line source files into an intermediate XML format and uses in-line
comments rather than comment headers to annotate functions, types, comments rather than comment headers to annotate functions, types,
and constants. This chapter describes how to use it.</p> and constants.</p>
<p></p>
<h2>The Basics</h2>
<h2>Commenting Your Code</h2> <h2>Commenting Your Code</h2>
@ -32,25 +37,7 @@ file is converted to HTML on the standard output.
code with documentation that is formatted according to the CUPS code with documentation that is formatted according to the CUPS
Configuration Management Plan which is available at Configuration Management Plan which is available at
"http://www.cups.org/documentation.php". "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> </body>
</html> </html>

37
doc/title.html
Unescape View File

@ -0,0 +1,37 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Mini-XML Programmers Manual</title>
<meta name="author" content="Michael R Sweet">
<meta name="copyright" content="Copyright 2003-2007">
</head>
<body>
<table width="100%" height="100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tr><td height="100%">
<H1 ALIGN="CENTER"><FONT SIZE="-1">Mini-XML Programmers Manual<br>
Version 2.3</H1>
<P ALIGN="CENTER">MICHAEL R. SWEET</P>
</td></tr>
</table>
<!-- NEW PAGE -->
<P><FONT SIZE="+1"><B>Mini-XML Programmers Manual, Version 2.3</B></FONT></P>
<P><B>Copyright &copy; 2003-2007 by Michael R. Sweet</B></P>
<P><SMALL>Permission is granted to copy, distribute and/or modify
this document under the terms of the GNU Library General Public
License, Version 2. A copy of this license is included in <A
HREF="#LICENSE">Appendix A - Mini-XML License</A>.</SMALL></P>
<P><SMALL>This book was created solely using free software
tools.</SMALL></P>
<P><SMALL>First Printing: April 2007</SMALL></P>
</body>
</html>
Write Preview
Loading…
Cancel
Save