From 0a79a46ac32a4f338f45189b245ff7c5818c6bde Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Tue, 24 Apr 2007 02:48:40 +0000 Subject: [PATCH] Save work on manual. --- doc/advanced.html | 6 ++++-- doc/intro.html | 6 +++--- doc/license.html | 14 ++++++-------- doc/mxml-pocket.book | 2 +- doc/mxmldoc.html | 29 ++++++++--------------------- doc/title.html | 37 +++++++++++++++++++++++++++++++++++++ 6 files changed, 59 insertions(+), 35 deletions(-) create mode 100644 doc/title.html diff --git a/doc/advanced.html b/doc/advanced.html index 1acd7d1..731bfc4 100644 --- a/doc/advanced.html +++ b/doc/advanced.html @@ -504,7 +504,8 @@ a user data pointer you supply:

     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)
     {
       ... do something ...
@@ -538,7 +539,8 @@ simulating a normal in-memory load:

     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)
     {
       if (event != MXML_SAX_ELEMENT_CLOSE)
diff --git a/doc/intro.html b/doc/intro.html
index 2a212e2..876620d 100644
--- a/doc/intro.html
+++ b/doc/intro.html
@@ -1,9 +1,9 @@
 
 
 	Mini-XML Programmers Manual, Version 2.3
-	
-	
-	
+	
+	
+	
 
 
 
diff --git a/doc/license.html b/doc/license.html
index 54c4917..a41ee7f 100644
--- a/doc/license.html
+++ b/doc/license.html
@@ -30,8 +30,6 @@ the following exceptions:

- -

GNU LIBRARY GENERAL PUBLIC LICENSE

Version 2, June 1991
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 all of these conditions:

-
+

    a) The modified work must itself be a software library. @@ -232,7 +230,7 @@ all of these conditions:

    application does not supply it, the square root function must still compute square roots.)

    -
+

These requirements apply to the modified work as a whole. If 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 copy of this License. Also, you must do one of these things:

-
+
    a) Accompany the work with the complete corresponding machine-readable source code for the @@ -372,7 +370,7 @@ copy of this License. Also, you must do one of these things:

    received a copy of these materials or that you have already sent this user a copy.

    -
+

For an executable, the required form of the "work that uses the Library" 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 provided that you do these two things:

-
+
    a) Accompany the combined library with a copy of the same work based on the Library, uncombined @@ -409,7 +407,7 @@ provided that you do these two things:

    based on the Library, and explaining where to find the accompanying uncombined form of the same work.

    -
+

8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly diff --git a/doc/mxml-pocket.book b/doc/mxml-pocket.book index f851b3a..af9afdc 100644 --- a/doc/mxml-pocket.book +++ b/doc/mxml-pocket.book @@ -1,5 +1,5 @@ #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 install.html basics.html diff --git a/doc/mxmldoc.html b/doc/mxmldoc.html index e90572b..4bb3ad9 100644 --- a/doc/mxmldoc.html +++ b/doc/mxmldoc.html @@ -4,13 +4,18 @@

4 - Using the mxmldoc Utility

+

The Basics

+

Originally developed to generate the Mini-XML and CUPS API documentation, the mxmldoc(1) 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.

+and constants.

+ +

+ + -

The Basics

Commenting Your Code

@@ -32,25 +37,7 @@ file is converted to HTML on the standard output. code with documentation that is formatted according to the CUPS Configuration Management Plan which is available at "http://www.cups.org/documentation.php". -

Options

-
-
--intro introfile.html -
-
Inserts the specified file at the top of the output documentation. -
-
--section section -
-
Sets the section/keywords in the output documentation. -
-
--title title -
-
Sets the title of the output documentation. -
-
-

See Also

-mxml(3), Mini-XML Programmers Manual, http://www.easysw.com/~mike/mxml/ -

Copyright

-Copyright 2003-2005 by Michael Sweet. + diff --git a/doc/title.html b/doc/title.html new file mode 100644 index 0000000..60f54d7 --- /dev/null +++ b/doc/title.html @@ -0,0 +1,37 @@ + + + + Mini-XML Programmers Manual + + + + + + + +
+ +

Mini-XML Programmers Manual
+Version 2.3

+ +

MICHAEL R. SWEET

+ +
+ + +

Mini-XML Programmers Manual, Version 2.3

+ +

Copyright © 2003-2007 by Michael R. Sweet

+ +

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 Appendix A - Mini-XML License.

+ +

This book was created solely using free software +tools.

+ +

First Printing: April 2007

+ + +