lib/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-07-28 00:21:53 +03:00
Code Activity

applied a documentation patch from Stefan Kost Daniel

Browse Source 
* error.c parser.c tree.c: applied a documentation patch from Stefan Kost
Daniel
This commit is contained in:
Daniel Veillard
2003-01-24 14:14:52 +00:00
parent 276be4a6e5
commit 7424eb6008
4 changed files with 25 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -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> Fri Jan 24 02:00:50 CET 2003 Daniel Veillard <daniel@veillard.com>
* relaxng.c: more work on Relax-NG * relaxng.c: more work on Relax-NG

1
error.c
View File

@ -80,6 +80,7 @@ xmlGenericErrorDefaultFunc(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...) {
* @handler: the handler * @handler: the handler
* *
* Set or reset (if NULL) the default handler for generic errors * Set or reset (if NULL) the default handler for generic errors
* to the builtin error function.
*/ */
void void
initGenericErrorDefaultFunc(xmlGenericErrorFunc * handler) initGenericErrorDefaultFunc(xmlGenericErrorFunc * handler)

2
parser.c
View File

@ -10910,6 +10910,8 @@ xmlInitParser(void) {
* parsing related global memory allocated for the parser processing. * parsing related global memory allocated for the parser processing.
* It doesn't deallocate any document related memory. Calling this * It doesn't deallocate any document related memory. Calling this
* function should not prevent reusing the parser. * 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 void

26
tree.c
View File

@ -6217,7 +6217,7 @@ xmlAttrSerializeContent(xmlBufferPtr buf, xmlDocPtr doc, xmlAttrPtr attr)
* @format: is formatting allowed * @format: is formatting allowed
* *
* Dump an XML node, recursive behaviour,children are printed too. * 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 * or xmlKeepBlanksDefault(0) was called
* *
* Returns the number of bytes written to the buffer or -1 in case of error * Returns the number of bytes written to the buffer or -1 in case of error
@ -6478,7 +6478,7 @@ xmlAttrListDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
* @encoding: an optional encoding string * @encoding: an optional encoding string
* *
* Dump an XML node list, recursive behaviour, children are printed too. * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
static void static void
@ -6516,7 +6516,7 @@ xmlNodeListDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
* @encoding: an optional encoding string * @encoding: an optional encoding string
* *
* Dump an XML node, recursive behaviour, children are printed too. * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
static void static void
@ -6683,7 +6683,7 @@ xmlNodeDumpOutputInternal(xmlOutputBufferPtr buf, xmlDocPtr doc,
* @encoding: an optional encoding string * @encoding: an optional encoding string
* *
* Dump an XML node, recursive behaviour, children are printed too. * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
void void
@ -6725,7 +6725,7 @@ xmlNodeDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur,
* @format: should formatting spaces been added * @format: should formatting spaces been added
* *
* Dump an XML document. * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
static void static void
@ -6988,7 +6988,7 @@ xhtmlAttrListDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
* @encoding: an optional encoding string * @encoding: an optional encoding string
* *
* Dump an XML node list, recursive behaviour, children are printed too. * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
static void static void
@ -7026,7 +7026,7 @@ xhtmlNodeListDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
* @encoding: an optional encoding string * @encoding: an optional encoding string
* *
* Dump an XHTML node, recursive behaviour, children are printed too. * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
static void static void
@ -7260,7 +7260,7 @@ xhtmlNodeDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur,
* Dump the current DOM tree into memory using the character encoding specified * 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 * by the caller. Note it is up to the caller of this function to free the
* allocated memory with xmlFree(). * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
@ -7375,7 +7375,7 @@ xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int *size) {
* *
* Dump an XML document in memory and return the #xmlChar * and it's size. * 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(). * 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 * or xmlKeepBlanksDefault(0) was called
*/ */
void void
@ -7466,6 +7466,8 @@ xmlSetCompressMode(int mode) {
* Dump an XML document to an open FILE. * Dump an XML document to an open FILE.
* *
* returns: the number of bytes written or -1 in case of failure. * 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 int
xmlDocFormatDump(FILE *f, xmlDocPtr cur, int format) { xmlDocFormatDump(FILE *f, xmlDocPtr cur, int format) {
@ -7553,6 +7555,8 @@ xmlSaveFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding) {
* Dump an XML document to an I/O buffer. * Dump an XML document to an I/O buffer.
* *
* returns: the number of bytes written or -1 in case of failure. * 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 int
xmlSaveFormatFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding, int format) { xmlSaveFormatFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding, int format) {
@ -7574,6 +7578,8 @@ xmlSaveFormatFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding,
* Dump an XML document to a file or an URL. * Dump an XML document to a file or an URL.
* *
* Returns the number of bytes written or -1 in case of error. * 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 int
xmlSaveFormatFileEnc( const char * filename, xmlDocPtr cur, xmlSaveFormatFileEnc( const char * filename, xmlDocPtr cur,
@ -7644,6 +7650,8 @@ xmlSaveFileEnc(const char *filename, xmlDocPtr cur, const char *encoding) {
* Dump an XML document to a file. Will use compression if * Dump an XML document to a file. Will use compression if
* compiled in and enabled. If @filename is "-" the stdout file is * compiled in and enabled. If @filename is "-" the stdout file is
* used. If @format is set then the document will be indented on output. * 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. * returns: the number of bytes written or -1 in case of failure.
*/ */