applied a documentation patch from Stefan Kost Daniel
* error.c parser.c tree.c: applied a documentation patch from Stefan Kost
Daniel
diff --git a/ChangeLog b/ChangeLog
index 7036f81..9229d9f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Jan 24 15:12:44 CET 2003 Daniel Veillard <daniel@veillard.com>
+
+ * error.c parser.c tree.c: applied a documentation patch from
+ Stefan Kost
+
Fri Jan 24 02:00:50 CET 2003 Daniel Veillard <daniel@veillard.com>
* relaxng.c: more work on Relax-NG
diff --git a/error.c b/error.c
index d6266af..9666693 100644
--- a/error.c
+++ b/error.c
@@ -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)
diff --git a/parser.c b/parser.c
index cb2be96..f05c64f 100644
--- a/parser.c
+++ b/parser.c
@@ -10910,6 +10910,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
diff --git a/tree.c b/tree.c
index 2a2c68f..69c6465 100644
--- a/tree.c
+++ b/tree.c
@@ -6217,7 +6217,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
@@ -6478,7 +6478,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
@@ -6516,7 +6516,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
@@ -6683,7 +6683,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
@@ -6725,7 +6725,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
@@ -6988,7 +6988,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
@@ -7026,7 +7026,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
@@ -7260,7 +7260,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
*/
@@ -7375,7 +7375,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
@@ -7466,6 +7466,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) {
@@ -7553,6 +7555,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) {
@@ -7574,6 +7578,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,
@@ -7644,6 +7650,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.
*/