[xml] documentation patches



If it's okay, I sent more diffs with FAQ from the list.

Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 300066
|      ///           04277 Leipzig      04277 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost gmx net    kost imn htwk-leipzig de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

--------------020304050607080809030503
Content-Type: text/plain;
 name="error.c.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="error.c.patch"

--- error.c.orig        Fri Jan 24 14:27:49 2003
+++ error.c     Fri Jan 24 14:27:57 2003
@@ -80,6 +80,7 @@
  * @handler:  the handler
  * 
  * Set or reset (if NULL) the default handler for generic errors
+ * to the builtin error function.
  */
 void
 initGenericErrorDefaultFunc(xmlGenericErrorFunc * handler)

--------------020304050607080809030503
Content-Type: text/plain;
 name="parser.c.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="parser.c.patch"

--- parser.c.orig       Fri Jan 24 14:22:46 2003
+++ parser.c    Fri Jan 24 14:28:07 2003
@@ -10907,6 +10907,8 @@
  * parsing related global memory allocated for the parser processing.
  * It doesn't deallocate any document related memory. Calling this
  * function should not prevent reusing the parser.
+ * One should call xmlCleanupParser() only when the process has
+ * finished using the library or XML document built with it.
  */
 
 void

--------------020304050607080809030503
Content-Type: text/plain;
 name="tree.c.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="tree.c.patch"

--- tree.c.orig Fri Jan 24 14:16:24 2003
+++ tree.c      Fri Jan 24 14:21:10 2003
@@ -6216,7 +6216,7 @@
  * @format: is formatting allowed
  *
  * Dump an XML node, recursive behaviour,children are printed too.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  *
  * Returns the number of bytes written to the buffer or -1 in case of error
@@ -6475,7 +6475,7 @@
  * @encoding:  an optional encoding string
  *
  * Dump an XML node list, recursive behaviour, children are printed too.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 static void
@@ -6513,7 +6513,7 @@
  * @encoding:  an optional encoding string
  *
  * Dump an XML node, recursive behaviour, children are printed too.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 static void
@@ -6680,7 +6680,7 @@
  * @encoding:  an optional encoding string
  *
  * Dump an XML node, recursive behaviour, children are printed too.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 void
@@ -6722,7 +6722,7 @@
  * @format:  should formatting spaces been added
  *
  * Dump an XML document.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 static void
@@ -6985,7 +6985,7 @@
  * @encoding:  an optional encoding string
  *
  * Dump an XML node list, recursive behaviour, children are printed too.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 static void
@@ -7023,7 +7023,7 @@
  * @encoding:  an optional encoding string
  *
  * Dump an XHTML node, recursive behaviour, children are printed too.
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 static void
@@ -7257,7 +7257,7 @@
  * Dump the current DOM tree into memory using the character encoding specified
  * by the caller.  Note it is up to the caller of this function to free the
  * allocated memory with xmlFree().
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 
@@ -7372,7 +7372,7 @@
  *
  * Dump an XML document in memory and return the #xmlChar * and it's size.
  * It's up to the caller to free the memory with xmlFree().
- * Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
  * or xmlKeepBlanksDefault(0) was called
  */
 void
@@ -7463,6 +7463,8 @@
  * Dump an XML document to an open FILE.
  *
  * returns: the number of bytes written or -1 in case of failure.
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * or xmlKeepBlanksDefault(0) was called
  */
 int
 xmlDocFormatDump(FILE *f, xmlDocPtr cur, int format) {
@@ -7550,6 +7552,8 @@
  * Dump an XML document to an I/O buffer.
  *
  * returns: the number of bytes written or -1 in case of failure.
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * or xmlKeepBlanksDefault(0) was called
  */
 int
 xmlSaveFormatFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding, int format) {
@@ -7571,6 +7575,8 @@
  * Dump an XML document to a file or an URL.
  *
  * Returns the number of bytes written or -1 in case of error.
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * or xmlKeepBlanksDefault(0) was called
  */
 int
 xmlSaveFormatFileEnc( const char * filename, xmlDocPtr cur,
@@ -7638,6 +7644,8 @@
  * Dump an XML document to a file. Will use compression if
  * compiled in and enabled. If @filename is "-" the stdout file is
  * used. If @format is set then the document will be indented on output.
+ * Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1
+ * or xmlKeepBlanksDefault(0) was called
  *
  * returns: the number of bytes written or -1 in case of failure.
  */

--------------020304050607080809030503--

Attachment: pgpwtvWOAK0_W.pgp
Description: PGP signature



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]