Clean up mxmldoc and refactor a bunch of the code.

This commit is contained in:
Michael Sweet 2017-04-06 14:25:19 -04:00
parent 8b32ac7556
commit 003eea7429
7 changed files with 1375 additions and 2101 deletions

View File

@ -348,9 +348,10 @@ testmxml.o: mxml.h
mxml.xml: mxmldoc-static mxml.h $(PUBLIBOBJS:.o=.c)
echo Generating API documentation...
$(RM) mxml.xml
./mxmldoc-static --header doc/reference.heading \
./mxmldoc-static --header doc/reference.header \
--docversion @VERSION@ --author "Michael R Sweet" \
--copyright "Copyright 2003-2017, All Rights Reserved." \
--title "Mini-XML API Reference" \
mxml.xml mxml.h $(PUBLIBOBJS:.o=.c) >doc/reference.html
./mxmldoc-static --man mxml --title "Mini-XML API" \
--intro doc/intro.man --footer doc/footer.man \

View File

@ -1,6 +1,7 @@
<h1>Mini-XML API Reference</h1>
<div class='summary'><table>
<div class='summary'>
<table>
<thead>
<tr>
<th>Header</th>
@ -13,4 +14,5 @@
<td>-lmxml</td>
</tr>
</tbody>
</table></div>
</table>
</div>

View File

@ -23,16 +23,7 @@
#include &lt;mxml.h&gt;
</pre>
<p>Nodes are defined by the "<a href="#mxml_node_t">mxml_node_t</a>" structure;
the "type" member defines the node type (element, integer, opaque, real, or
text) which determines which value you want to look at in the "value" union.
New nodes can be created using the
"<a href="#mxmlNewElement">mxmlNewElement()</a>",
"<a href="#mxmlNewInteger">mxmlNewInteger()</a>",
"<a href="#mxmlNewOpaque">mxmlNewOpaque()</a>",
"<a href="#mxmlNewReal">mxmlNewReal()</a>", and
"<a href="#mxmlNewText">mxmlNewText()</a>" functions. Only elements can have
child nodes, and the top node must be an element, usually "?xml".</p>
<p>Nodes are defined by the "<a href="#mxml_node_t">mxml_node_t</a>" structure; the "type" member defines the node type (element, integer, opaque, real, or text) which determines which value you want to look at in the "value" union. New nodes can be created using the "<a href="#mxmlNewElement">mxmlNewElement()</a>", "<a href="#mxmlNewInteger">mxmlNewInteger()</a>", "<a href="#mxmlNewOpaque">mxmlNewOpaque()</a>", "<a href="#mxmlNewReal">mxmlNewReal()</a>", and "<a href="#mxmlNewText">mxmlNewText()</a>" functions. Only elements can have child nodes, and the top node must be an element, usually "?xml".</p>
<p>You load an XML file using the "mxmlLoadFile()" function:</p>
@ -45,8 +36,7 @@ tree = mxmlLoadFile(NULL, fp, MXML_NO_CALLBACK);
fclose(fp);
</pre>
<p>Similarly, you save an XML file using the
"<a href="#mxmlSaveFile">mxmlSaveFile()</a>" function:</p>
<p>Similarly, you save an XML file using the "<a href="#mxmlSaveFile">mxmlSaveFile()</a>" function:</p>
<pre class="example">
FILE *fp;
@ -57,10 +47,7 @@ mxmlSaveFile(tree, fp, MXML_NO_CALLBACK);
fclose(fp);
</pre>
<p>The "<a href="#mxmlLoadString">mxmlLoadString()</a>",
"<a href="#mxmlSaveAllocString">mxmlSaveAllocString()</a>", and
"<a href="#mxmlSaveString">mxmlSaveString()</a>" functions load XML node trees
from and save XML node trees to strings:</p>
<p>The "<a href="#mxmlLoadString">mxmlLoadString()</a>", "<a href="#mxmlSaveAllocString">mxmlSaveAllocString()</a>", and "<a href="#mxmlSaveString">mxmlSaveString()</a>" functions load XML node trees from and save XML node trees to strings:</p>
<pre class="example">
char buffer[8192];
@ -78,8 +65,7 @@ mxmlSaveString(tree, buffer, sizeof(buffer),
ptr = mxmlSaveAllocString(tree, MXML_NO_CALLBACK);
</pre>
<p>You can find a named element/node using the
"<a href="#mxmlFindElement">mxmlFindElement()</a>" function:</p>
<p>You can find a named element/node using the "<a href="#mxmlFindElement">mxmlFindElement()</a>" function:</p>
<pre class="example">
mxml_node_t *node = mxmlFindElement(tree, tree, "name",
@ -87,8 +73,7 @@ mxml_node_t *node = mxmlFindElement(tree, tree, "name",
MXML_DESCEND);
</pre>
<p>The "name", "attr", and "value" arguments can be passed as
<code>NULL</code> to act as wildcards, e.g.:</p>
<p>The "name", "attr", and "value" arguments can be passed as <code>NULL</code> to act as wildcards, e.g.:</p>
<pre class="example">
/* Find the first "a" element */
@ -128,15 +113,13 @@ for (node = mxmlFindElement(tree, tree, "name", NULL,
}
</pre>
<p>The "mxmlFindPath()" function finds the (first) value node under a specific
element using a "path":</p>
<p>The "mxmlFindPath()" function finds the (first) value node under a specific element using a "path":</p>
<pre class="example">
mxml_node_t *value = mxmlFindPath(tree, "path/to/*/foo/bar");
</pre>
<p>The "mxmlGetInteger()", "mxmlGetOpaque()", "mxmlGetReal()", and
"mxmlGetText()" functions retrieve the value from a node:</p>
<p>The "mxmlGetInteger()", "mxmlGetOpaque()", "mxmlGetReal()", and "mxmlGetText()" functions retrieve the value from a node:</p>
<pre class="example">
mxml_node_t *node;
@ -151,9 +134,7 @@ int whitespacevalue;
const char *textvalue = mxmlGetText(node, &amp;whitespacevalue);
</pre>
<p>Finally, once you are done with the XML data, use the
"<a href="#mxmlDelete">mxmlDelete()</a>" function to recursively free the
memory that is used for a particular node or the entire tree:</p>
<p>Finally, once you are done with the XML data, use the "<a href="#mxmlDelete">mxmlDelete()</a>" function to recursively free the memory that is used for a particular node or the entire tree:</p>
<pre class="example">
mxmlDelete(tree);

1
doc/reference.header Normal file
View File

@ -0,0 +1 @@
<h1 align="right"><a name="REFERENCE">Appendix B - Library Reference</a></h1>

View File

@ -1 +0,0 @@
<h1 align='right'><a name='REFERENCE'>Appendix B - Library Reference</a></h1>

File diff suppressed because it is too large Load Diff

1701
mxmldoc.c

File diff suppressed because it is too large Load Diff