From 4636114c5b0b85ee307a42c052494165849ee8ac Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Wed, 18 Apr 2007 01:55:03 +0000 Subject: [PATCH] Really Mini-XML 2.3, update documentation. --- CHANGES | 12 ++++-------- configure.in | 2 +- doc/intro.html | 2 +- doc/reference.html | 24 +++++++++++++++--------- doc/relnotes.html | 9 +++++++++ mxml-file.c | 3 +++ mxml-node.c | 4 ++++ mxml.xml | 12 +++++++++--- 8 files changed, 46 insertions(+), 22 deletions(-) diff --git a/CHANGES b/CHANGES index 4d5a84f..66108d9 100644 --- a/CHANGES +++ b/CHANGES @@ -1,20 +1,16 @@ 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. diff --git a/configure.in b/configure.in index 47e1ee1..205f231 100644 --- a/configure.in +++ b/configure.in @@ -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") diff --git a/doc/intro.html b/doc/intro.html index 76359a2..660fa57 100644 --- a/doc/intro.html +++ b/doc/intro.html @@ -1,7 +1,7 @@ Mini-XML Programmers Manual, Version 2.3 - + diff --git a/doc/reference.html b/doc/reference.html index 7234c5b..9df16f0 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -70,9 +70,9 @@
  • mxmlNewReal()
  • mxmlNewText()
  • mxmlNewTextf()
    • -
  • mxmlRelease()
    • +
  • mxmlRelease()  Mini-XML 2.4 
  • mxmlRemove()
    • -
  • mxmlRetain()
    • +
  • mxmlRetain()  Mini-XML 2.4 
  • mxmlSaveAllocString()
  • mxmlSaveFd()
  • mxmlSaveFile()
    • @@ -87,7 +87,7 @@
  • mxmlSetReal()
  • mxmlSetText()
  • mxmlSetTextf()
    • -
  • mxmlSetWrapMargin()
    • +
  • mxmlSetWrapMargin()  Mini-XML 2.4 
  • mxmlWalkNext()
  • mxmlWalkPrev()
    • @@ -715,12 +715,14 @@ mxmlNewTextf(

    Returns

    New node

    -

    mxmlRelease()

    +

     Mini-XML 2.4 mxmlRelease()

    Description

    Release a node. When the reference count reaches zero, the node (and any children) -is deleted via mxmlDelete().

    +is deleted via mxmlDelete(). + +

    Syntax

     int
@@ -757,9 +759,11 @@ mxmlRemove(
 
    Returns
    
 
    Nothing.
    
 
-
    mxmlRetain()
    
+
     Mini-XML 2.4 mxmlRetain()
    
 
    Description
    
-
    Retain a node.
    
+
    Retain a node.
+
+
    
 
    Syntax
    
 
     int
@@ -1114,11 +1118,13 @@ mxmlSetTextf(
 
    Returns
    
 
    0 on success, -1 on failure
    
 
-
    mxmlSetWrapMargin()
    
+
     Mini-XML 2.4 mxmlSetWrapMargin()
    
 
    Description
    
 
    Set the the wrap margin when saving XML data.
 
-Wrapping is disabled when "column" is <= 0.
    
+Wrapping is disabled when "column" is <= 0.
+
+
    
 
    Syntax
    
 
     void
diff --git a/doc/relnotes.html b/doc/relnotes.html
index 2c6ed6b..254e33c 100644
--- a/doc/relnotes.html
+++ b/doc/relnotes.html
@@ -10,6 +10,15 @@
 	
  • 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.
    • 
+
 	
  • Added conditional check for EINTR error code for
 	certain Windows compilers that do not define it (STR
 	#33)
    • 
diff --git a/mxml-file.c b/mxml-file.c
index 1e5256c..5893679 100644
--- a/mxml-file.c
+++ b/mxml-file.c
@@ -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
diff --git a/mxml-node.c b/mxml-node.c
index 4f0c5cf..94b50de 100644
--- a/mxml-node.c
+++ b/mxml-node.c
@@ -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 */
diff --git a/mxml.xml b/mxml.xml
index 3cdf2d6..8ca8e55 100644
--- a/mxml.xml
+++ b/mxml.xml
@@ -497,7 +497,9 @@ string must be nul-terminated and is formatted into the new node.
     Release a node.
 
 When the reference count reaches zero, the node (and any children)
-is deleted via mxmlDelete().
+is deleted via mxmlDelete().
+
+@since Mini-XML 2.4@
     
       mxml_node_t *
       Node
@@ -518,7 +520,9 @@ This function does nothing if the node has no parent.
       int
       New reference count
     
-    Retain a node.
+    Retain a node.
+
+@since Mini-XML 2.4@
     
       mxml_node_t *
       Node
@@ -792,7 +796,9 @@ The node is not changed if it is not a text node.
   
     Set the the wrap margin when saving XML data.
 
-Wrapping is disabled when "column" is <= 0.
+Wrapping is disabled when "column" is <= 0.
+
+@since Mini-XML 2.4@
     
       int
       Column for wrapping