Commit 4636114c authored by Michael R Sweet's avatar Michael R Sweet

Really Mini-XML 2.3, update documentation.

parent cb7c6c23
CHANGES - 2007-04-17
--------------------
CHANGES IN Mini-XML 2.4
CHANGES IN Mini-XML 2.3
- Added two exceptions to the LGPL to support static
linking of applications against Mini-XML.
- Added user_data and ref_count members to mxml_node_t
structure.
- Added mxmlReleaseNode() and mxmlRetainNode() APIs for
reference-counted nodes.
- Added mxmlSetWrapMargin() to control the wrapping of XML
output.
CHANGES IN Mini-XML 2.3
- Added two exceptions to the LGPL to support static
linking of applications against Mini-XML.
- Added conditional check for EINTR error code for
certain Windows compilers that do not define it (STR
#33)
......@@ -22,7 +18,7 @@ CHANGES IN Mini-XML 2.3
output (previously it generated invalid XHTML...)
- The mxmldoc program now supports "@deprecated@,
"@private@", and "@since version@" comments.
- Fixed function and enumeraion type bugs in mxmldoc.
- Fixed function and enumeration type bugs in mxmldoc.
- Fixed XML schema for mxmldoc.
- The mxmldoc program now supports --intro, --section,
and --title options.
......
......@@ -23,7 +23,7 @@ dnl Set the name of the config header file...
AC_CONFIG_HEADER(config.h)
dnl Version number...
VERSION=2.4
VERSION=2.3
AC_SUBST(VERSION)
AC_DEFINE_UNQUOTED(MXML_VERSION, "Mini-XML v$VERSION")
......
<html>
<head>
<title>Mini-XML Programmers Manual, Version 2.3</title>
<meta name='copyright' content='Copyright 2003-2005'/>
<meta name='copyright' content='Copyright 2003-2007'/>
<meta name='author' content='Michael Sweet'/>
<meta name='keywords' content='XML, C, C++, library'/>
</head>
......
......@@ -70,9 +70,9 @@
<li><a href='#mxmlNewReal'><tt>mxmlNewReal()</tt></a> </li>
<li><a href='#mxmlNewText'><tt>mxmlNewText()</tt></a> </li>
<li><a href='#mxmlNewTextf'><tt>mxmlNewTextf()</tt></a> </li>
<li><a href='#mxmlRelease'><tt>mxmlRelease()</tt></a> </li>
<li><a href='#mxmlRelease'><tt>mxmlRelease()</tt></a> <span class='info'>&nbsp;Mini-XML 2.4&nbsp;</span></li>
<li><a href='#mxmlRemove'><tt>mxmlRemove()</tt></a> </li>
<li><a href='#mxmlRetain'><tt>mxmlRetain()</tt></a> </li>
<li><a href='#mxmlRetain'><tt>mxmlRetain()</tt></a> <span class='info'>&nbsp;Mini-XML 2.4&nbsp;</span></li>
<li><a href='#mxmlSaveAllocString'><tt>mxmlSaveAllocString()</tt></a> </li>
<li><a href='#mxmlSaveFd'><tt>mxmlSaveFd()</tt></a> </li>
<li><a href='#mxmlSaveFile'><tt>mxmlSaveFile()</tt></a> </li>
......@@ -87,7 +87,7 @@
<li><a href='#mxmlSetReal'><tt>mxmlSetReal()</tt></a> </li>
<li><a href='#mxmlSetText'><tt>mxmlSetText()</tt></a> </li>
<li><a href='#mxmlSetTextf'><tt>mxmlSetTextf()</tt></a> </li>
<li><a href='#mxmlSetWrapMargin'><tt>mxmlSetWrapMargin()</tt></a> </li>
<li><a href='#mxmlSetWrapMargin'><tt>mxmlSetWrapMargin()</tt></a> <span class='info'>&nbsp;Mini-XML 2.4&nbsp;</span></li>
<li><a href='#mxmlWalkNext'><tt>mxmlWalkNext()</tt></a> </li>
<li><a href='#mxmlWalkPrev'><tt>mxmlWalkPrev()</tt></a> </li>
</ul>
......@@ -715,12 +715,14 @@ mxmlNewTextf(
<h4>Returns</h4>
<p>New node</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='mxmlRelease'>mxmlRelease()</a></h3>
<h3 class='title'><span class='info'>&nbsp;Mini-XML 2.4&nbsp;</span><a name='mxmlRelease'>mxmlRelease()</a></h3>
<h4>Description</h4>
<p>Release a node.
When the reference count reaches zero, the node (and any children)
is deleted via mxmlDelete().</p>
is deleted via mxmlDelete().
</p>
<h4>Syntax</h4>
<pre>
int
......@@ -757,9 +759,11 @@ mxmlRemove(
<h4>Returns</h4>
<p>Nothing.</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='mxmlRetain'>mxmlRetain()</a></h3>
<h3 class='title'><span class='info'>&nbsp;Mini-XML 2.4&nbsp;</span><a name='mxmlRetain'>mxmlRetain()</a></h3>
<h4>Description</h4>
<p>Retain a node.</p>
<p>Retain a node.
</p>
<h4>Syntax</h4>
<pre>
int
......@@ -1114,11 +1118,13 @@ mxmlSetTextf(
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3 class='title'><a name='mxmlSetWrapMargin'>mxmlSetWrapMargin()</a></h3>
<h3 class='title'><span class='info'>&nbsp;Mini-XML 2.4&nbsp;</span><a name='mxmlSetWrapMargin'>mxmlSetWrapMargin()</a></h3>
<h4>Description</h4>
<p>Set the the wrap margin when saving XML data.
Wrapping is disabled when &quot;column&quot; is &lt;= 0.</p>
Wrapping is disabled when &quot;column&quot; is &lt;= 0.
</p>
<h4>Syntax</h4>
<pre>
void
......
......@@ -10,6 +10,15 @@
<li>Added two exceptions to the LGPL to support static
linking of applications against Mini-XML.</li>
<li>Added user_data and ref_count members to mxml_node_t
structure.</li>
<li>Added mxmlReleaseNode() and mxmlRetainNode() APIs for
reference-counted nodes.</li>
<li>Added mxmlSetWrapMargin() to control the wrapping of XML
output.</li>
<li>Added conditional check for EINTR error code for
certain Windows compilers that do not define it (STR
#33)</li>
......
......@@ -26,6 +26,7 @@
* mxmlSaveString() - Save an XML node tree to a string.
* mxmlSetCustomHandlers() - Set the handling functions for custom data.
* mxmlSetErrorCallback() - Set the error message callback.
* mxmlSetWrapMargin() - Set the the wrap margin when saving XML data.
* mxml_add_char() - Add a character to a buffer, expanding as needed.
* mxml_fd_getc() - Read a character from a file descriptor.
* mxml_fd_putc() - Write a character to a file descriptor.
......@@ -483,6 +484,8 @@ mxmlSetErrorCallback(void (*cb)(const char *))
* 'mxmlSetWrapMargin()' - Set the the wrap margin when saving XML data.
*
* Wrapping is disabled when "column" is <= 0.
*
* @since Mini-XML 2.3@
*/
void
......
......@@ -660,6 +660,8 @@ mxmlRemove(mxml_node_t *node) /* I - Node to remove */
*
* When the reference count reaches zero, the node (and any children)
* is deleted via mxmlDelete().
*
* @since Mini-XML 2.3@
*/
int /* O - New reference count */
......@@ -682,6 +684,8 @@ mxmlRelease(mxml_node_t *node) /* I - Node */
/*
* 'mxmlRetain()' - Retain a node.
*
* @since Mini-XML 2.3@
*/
int /* O - New reference count */
......
......@@ -497,7 +497,9 @@ string must be nul-terminated and is formatted into the new node.</description>
<description>Release a node.
When the reference count reaches zero, the node (and any children)
is deleted via mxmlDelete().</description>
is deleted via mxmlDelete().
@since Mini-XML 2.4@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
......@@ -518,7 +520,9 @@ This function does nothing if the node has no parent.</description>
<type>int</type>
<description>New reference count</description>
</returnvalue>
<description>Retain a node.</description>
<description>Retain a node.
@since Mini-XML 2.4@</description>
<argument name="node" direction="I">
<type>mxml_node_t *</type>
<description>Node</description>
......@@ -792,7 +796,9 @@ The node is not changed if it is not a text node.</description>
<function name="mxmlSetWrapMargin">
<description>Set the the wrap margin when saving XML data.
Wrapping is disabled when &quot;column&quot; is &lt;= 0.</description>
Wrapping is disabled when &quot;column&quot; is &lt;= 0.
@since Mini-XML 2.4@</description>
<argument name="column" direction="I">
<type>int</type>
<description>Column for wrapping</description>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment