- HTMLparser.c: Closed bug #54891
- result/HTML/cf_128.html* test/HTML/cf_128.html: added the test
to the suite
forgot to commit this one yesterday
- encoding.h hash.c nanoftp.h parser.h tree.h uri.h xlink.h xpointer.c:
applied a documentation patch from LotR and filled in a few missing
descriptions
Daniel
diff --git a/include/libxml/encoding.h b/include/libxml/encoding.h
index 555558f..f25d9fd 100644
--- a/include/libxml/encoding.h
+++ b/include/libxml/encoding.h
@@ -32,6 +32,8 @@
#endif
/**
+ * xmlCharEncoding:
+ *
* Predefined values for some standard encodings
* Libxml don't do beforehand translation on UTF8, ISOLatinX
* It also support UTF16 (LE and BE) by default.
diff --git a/include/libxml/nanoftp.h b/include/libxml/nanoftp.h
index 5346528..cf33420 100644
--- a/include/libxml/nanoftp.h
+++ b/include/libxml/nanoftp.h
@@ -42,6 +42,10 @@
int minute);
/**
* ftpDataCallback:
+ * @userData: the user provided context
+ * @data: the data received
+ * @len: its size in bytes
+ *
* A callback for the xmlNanoFTPGet command
*/
typedef void (*ftpDataCallback) (void *userData, const char *data, int len);
diff --git a/include/libxml/parser.h b/include/libxml/parser.h
index 0e91245..a8f0637 100644
--- a/include/libxml/parser.h
+++ b/include/libxml/parser.h
@@ -25,6 +25,8 @@
#define XML_DEFAULT_VERSION "1.0"
/**
+ * xmlParserInput:
+ *
* an xmlParserInput is an input flow for the XML processor.
* Each entity parsed is associated an xmlParserInput (except the
* few predefined ones). This is the case both for internal entities
@@ -56,6 +58,8 @@
};
/**
+ * xmlParserNodeInfo:
+ *
* the parser can be asked to collect Node informations, i.e. at what
* place in the file they were detected.
* NOTE: This is off by default and not very well tested.
@@ -81,6 +85,8 @@
};
/**
+ * xmlParserInputState:
+ *
* The parser is now working also as a state based parser
* The recursive one use the stagte info for entities processing
*/
@@ -105,6 +111,8 @@
} xmlParserInputState;
/**
+ * xmlParserCtxt:
+ *
* The parser context.
* NOTE This doesn't completely defines the parser state, the (current ?)
* design of the parser uses recursive function calls since this allow
@@ -191,6 +199,8 @@
};
/**
+ * xmlSAXLocator:
+ *
* a SAX Locator.
*/
typedef struct _xmlSAXLocator xmlSAXLocator;
@@ -203,6 +213,8 @@
};
/**
+ * xmlSAXHandler:
+ *
* a SAX handler is bunch of callbacks called by the parser when processing
* of the input generate data or structure informations.
*/
@@ -288,13 +300,18 @@
};
/**
+ * xmlExternalEntityLoader:
+ * @URL: The System ID of the resource requested
+ * @ID: The Public ID of the resource requested
+ * @xmlParserCtxtPtr: the XML parser context
+ *
* External entity loaders types
*/
typedef xmlParserInputPtr (*xmlExternalEntityLoader)(const char *URL,
const char *ID,
xmlParserCtxtPtr context);
-/**
+/*
* Global variables: just the default SAX interface tables and XML
* version infos.
*/
@@ -305,7 +322,7 @@
LIBXML_DLL_IMPORT extern xmlSAXHandler htmlDefaultSAXHandler;
LIBXML_DLL_IMPORT extern xmlSAXHandler docbDefaultSAXHandler;
-/**
+/*
* entity substitution default behaviour.
*/
@@ -318,13 +335,13 @@
LIBXML_DLL_IMPORT extern int xmlGetWarningsDefaultValue;
-/**
+/*
* Init/Cleanup
*/
void xmlInitParser (void);
void xmlCleanupParser (void);
-/**
+/*
* Input functions
*/
int xmlParserInputRead (xmlParserInputPtr in,
@@ -332,7 +349,7 @@
int xmlParserInputGrow (xmlParserInputPtr in,
int len);
-/**
+/*
* xmlChar handling
*/
xmlChar * xmlStrdup (const xmlChar *cur);
@@ -369,7 +386,7 @@
const xmlChar *add,
int len);
-/**
+/*
* Basic parsing Interfaces
*/
xmlDocPtr xmlParseDoc (xmlChar *cur);
@@ -381,7 +398,7 @@
void xmlStopParser (xmlParserCtxtPtr ctxt);
int xmlPedanticParserDefault(int val);
-/**
+/*
* Recovery mode
*/
xmlDocPtr xmlRecoverDoc (xmlChar *cur);
@@ -389,7 +406,7 @@
int size);
xmlDocPtr xmlRecoverFile (const char *filename);
-/**
+/*
* Less common routines and SAX interfaces
*/
int xmlParseDocument (xmlParserCtxtPtr ctxt);
@@ -440,13 +457,13 @@
const xmlChar *ID,
xmlNodePtr *list);
-/**
+/*
* SAX initialization routines
*/
void xmlDefaultSAXHandlerInit(void);
void htmlDefaultSAXHandlerInit(void);
-/**
+/*
* Parser contexts handling.
*/
void xmlInitParserCtxt (xmlParserCtxtPtr ctxt);
@@ -457,7 +474,7 @@
const char* filename);
xmlParserCtxtPtr xmlCreateDocParserCtxt (xmlChar *cur);
-/**
+/*
* Reading/setting optional parsing features.
*/
@@ -470,7 +487,7 @@
const char *name,
void *value);
-/**
+/*
* Interfaces for the Push mode
*/
xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
@@ -483,7 +500,7 @@
int size,
int terminate);
-/**
+/*
* Special I/O mode
*/
@@ -498,7 +515,7 @@
xmlParserInputBufferPtr input,
xmlCharEncoding enc);
-/**
+/*
* Node infos
*/
const xmlParserNodeInfo*
diff --git a/include/libxml/tree.h b/include/libxml/tree.h
index 841fef1..4be4c5f 100644
--- a/include/libxml/tree.h
+++ b/include/libxml/tree.h
@@ -313,7 +313,9 @@
xmlBufferAllocationScheme alloc; /* The realloc method */
};
-/*
+/**
+ * xmlNode:
+ *
* A node in an XML tree.
*/
typedef struct _xmlNode xmlNode;
diff --git a/include/libxml/uri.h b/include/libxml/uri.h
index e7aeda4..3d87e14 100644
--- a/include/libxml/uri.h
+++ b/include/libxml/uri.h
@@ -18,20 +18,23 @@
#endif
/**
+ * xmlURI:
*
+ * A parsed URI reference. This is a struct containing the various fields
+ * as described in RFC 2396 but separated for further processing
*/
typedef struct _xmlURI xmlURI;
typedef xmlURI *xmlURIPtr;
struct _xmlURI {
- char *scheme;
- char *opaque;
- char *authority;
- char *server;
- char *user;
- int port;
- char *path;
- char *query;
- char *fragment;
+ char *scheme; /* the URI scheme */
+ char *opaque; /* opaque part */
+ char *authority; /* the authority part */
+ char *server; /* the server part */
+ char *user; /* the user part */
+ int port; /* the port number */
+ char *path; /* the path string */
+ char *query; /* the query string */
+ char *fragment; /* the fragment identifier */
};
/*
diff --git a/include/libxml/xlink.h b/include/libxml/xlink.h
index 37a5415..dbe228b 100644
--- a/include/libxml/xlink.h
+++ b/include/libxml/xlink.h
@@ -156,7 +156,7 @@
xlinkExtendedLinkSetFunk set;
};
-/**
+/*
* the default detection routine, can be overriden, they call the default
* detection callbacks.
*/
@@ -164,7 +164,7 @@
xlinkNodeDetectFunc xlinkGetDefaultDetect (void);
void xlinkSetDefaultDetect (xlinkNodeDetectFunc func);
-/**
+/*
* Routines to set/get the default handlers.
*/
xlinkHandlerPtr xlinkGetDefaultHandler (void);
diff --git a/include/libxml/xmlmemory.h b/include/libxml/xmlmemory.h
index 12538ab..bd82c6d 100644
--- a/include/libxml/xmlmemory.h
+++ b/include/libxml/xmlmemory.h
@@ -11,9 +11,13 @@
#include <stdio.h>
#include <libxml/xmlversion.h>
-/*
- * DEBUG_MEMORY_LOCATION should be activated only done when debugging
- * libxml.
+/**
+ * DEBUG_MEMORY:
+ *
+ * should be activated only done when debugging libxml. It replaces the
+ * allocator with a collect and debug shell to the libc allocator.
+ * DEBUG_MEMORY should be activated only when debugging
+ * libxml i.e. if libxml has been configured with --with-debug-mem too
*/
/* #define DEBUG_MEMORY_FREED */
/* #define DEBUG_MEMORY_LOCATION */
@@ -24,15 +28,15 @@
#endif
#endif
+/**
+ * DEBUG_MEMORY_LOCATION:
+ *
+ * should be activated
+ * DEBUG_MEMORY_LOCATION should be activated only when debugging
+ * libxml i.e. if libxml has been configured with --with-debug-mem too
+ */
#ifdef DEBUG_MEMORY_LOCATION
#define MEM_LIST /* keep a list of all the allocated memory blocks */
-#define DEBUG_MEMORY_FREED
-#endif
-
-#ifdef DEBUG_MEMORY_FREED
-#define MEM_CLEANUP(p,l) memset((p), -1, (l));
-#else
-#define MEM_CLEANUP(p,l)
#endif
#ifdef __cplusplus