Cleanup, cleanup .. removed libxml softlink for good cleanup to get 100%
Cleanup, cleanup ..
* configure.in Makefile.am: removed libxml softlink for good
* include/libxml/*.h *.c doc/Makefile.am: cleanup to get
100% coverage by gtk-doc
Daniel
diff --git a/include/libxml/SAX.h b/include/libxml/SAX.h
index aad01b8..4472f83 100644
--- a/include/libxml/SAX.h
+++ b/include/libxml/SAX.h
@@ -54,7 +54,7 @@
xmlChar *content);
void attributeDecl (void *ctx,
const xmlChar *elem,
- const xmlChar *name,
+ const xmlChar *fullname,
int type,
int def,
const xmlChar *defaultValue,
diff --git a/include/libxml/catalog.h b/include/libxml/catalog.h
index 16b0f67..504b2e6 100644
--- a/include/libxml/catalog.h
+++ b/include/libxml/catalog.h
@@ -36,7 +36,7 @@
#define XML_CATALOGS_NAMESPACE \
(const xmlChar *) "urn:oasis:names:tc:entity:xmlns:xml:catalog"
-int xmlLoadCatalog (const char *URL);
+int xmlLoadCatalog (const char *filename);
void xmlLoadCatalogs (const char *paths);
void xmlCatalogCleanup (void);
void xmlCatalogDump (FILE *out);
diff --git a/include/libxml/debugXML.h b/include/libxml/debugXML.h
index 6ed6ef9..36f86a4 100644
--- a/include/libxml/debugXML.h
+++ b/include/libxml/debugXML.h
@@ -43,11 +43,9 @@
void xmlDebugDumpDocument (FILE *output,
xmlDocPtr doc);
void xmlDebugDumpDTD (FILE *output,
- xmlDtdPtr doc);
+ xmlDtdPtr dtd);
void xmlDebugDumpEntities (FILE *output,
xmlDocPtr doc);
-void xmlLsOneNode (FILE *output,
- xmlNodePtr node);
/****************************************************************
* *
diff --git a/include/libxml/hash.h b/include/libxml/hash.h
index dcbcc6c..2447606 100644
--- a/include/libxml/hash.h
+++ b/include/libxml/hash.h
@@ -104,19 +104,10 @@
*/
xmlHashTablePtr xmlHashCopy (xmlHashTablePtr table,
xmlHashCopier f);
-int xmlHashSize (xmlHashTablePtr);
+int xmlHashSize (xmlHashTablePtr table);
void xmlHashScan (xmlHashTablePtr table,
xmlHashScanner f,
void *data);
-void xmlHashScan1 (xmlHashTablePtr table,
- const xmlChar *name,
- xmlHashScanner f,
- void *data);
-void xmlHashScan2 (xmlHashTablePtr table,
- const xmlChar *name,
- const xmlChar *name2,
- xmlHashScanner f,
- void *data);
void xmlHashScan3 (xmlHashTablePtr table,
const xmlChar *name,
const xmlChar *name2,
diff --git a/include/libxml/parser.h b/include/libxml/parser.h
index f3ae597..fdfb75f 100644
--- a/include/libxml/parser.h
+++ b/include/libxml/parser.h
@@ -19,8 +19,10 @@
extern "C" {
#endif
-/*
- * Constants.
+/**
+ * XML_DEFAULT_VERSION:
+ *
+ * The default version of XML used: 1.0
*/
#define XML_DEFAULT_VERSION "1.0"
@@ -36,6 +38,7 @@
*/
typedef void (* xmlParserInputDeallocate)(xmlChar *);
+
typedef struct _xmlParserInput xmlParserInput;
typedef xmlParserInput *xmlParserInputPtr;
struct _xmlParserInput {
@@ -344,6 +347,11 @@
*/
#ifdef VMS
+/**
+ * xmlSubstituteEntitiesDefaultValue:
+ *
+ * global variable controlling the entity substitution default behaviour
+ */
LIBXML_DLL_IMPORT extern int xmlSubstituteEntitiesDefaultVal;
#define xmlSubstituteEntitiesDefaultValue xmlSubstituteEntitiesDefaultVal
#else
diff --git a/include/libxml/parserInternals.h b/include/libxml/parserInternals.h
index 5370ac1..81ecff7 100644
--- a/include/libxml/parserInternals.h
+++ b/include/libxml/parserInternals.h
@@ -326,12 +326,29 @@
void xmlParseExternalSubset (xmlParserCtxtPtr ctxt,
const xmlChar *ExternalID,
const xmlChar *SystemID);
-/*
- * Entities substitution
+/**
+ * XML_SUBSTITUTE_NONE:
+ *
+ * If no entities need to be substitued
*/
#define XML_SUBSTITUTE_NONE 0
+/**
+ * XML_SUBSTITUTE_REF:
+ *
+ * Whether general entities need to be substitued
+ */
#define XML_SUBSTITUTE_REF 1
+/**
+ * XML_SUBSTITUTE_PEREF:
+ *
+ * Whether parameter entities need to be substitued
+ */
#define XML_SUBSTITUTE_PEREF 2
+/**
+ * XML_SUBSTITUTE_BOTH:
+ *
+ * Both general and parameter entities need to be substitued
+ */
#define XML_SUBSTITUTE_BOTH 3
xmlChar * xmlDecodeEntities (xmlParserCtxtPtr ctxt,
diff --git a/include/libxml/tree.h b/include/libxml/tree.h
index b5f6302..d72ebf7 100644
--- a/include/libxml/tree.h
+++ b/include/libxml/tree.h
@@ -25,6 +25,12 @@
extern "C" {
#endif
+/**
+ * XML_XML_NAMESPACE:
+ *
+ * This is the namespace for the special xml: prefix predefined in the
+ * XML Namespace specification
+ */
#define XML_XML_NAMESPACE \
(const xmlChar *) "http://www.w3.org/XML/1998/namespace"
@@ -249,6 +255,11 @@
};
+/**
+ * XML_LOCAL_NAMESPACE:
+ *
+ * A namespace declaration node
+ */
#define XML_LOCAL_NAMESPACE XML_NAMESPACE_DECL
typedef xmlElementType xmlNsType;
@@ -259,7 +270,6 @@
* Note that prefix == NULL is valid, it defines the default namespace
* within the subtree (until overriden).
*
- * XML_GLOBAL_NAMESPACE is now deprecated for good
* xmlNsType is unified with xmlElementType
*/
@@ -405,8 +415,21 @@
xmlNs *nsDef; /* namespace definitions on this node */
};
-#define XML_GET_CONTENT(n) ((n)->type == XML_ELEMENT_PTR ? NULL : (n)->content)
-#define XML_GET_LINE(n) ((n)->type == XML_ELEMENT_PTR ? (int) (n)->content : 0)
+/**
+ * XML_GET_CONTENT:
+ *
+ * macro to extract the content pointer of a node
+ */
+#define XML_GET_CONTENT(n) \
+ ((n)->type == XML_ELEMENT_PTR ? NULL : (n)->content)
+
+/**
+ * XML_GET_LINE:
+ *
+ * macro to extract the line number of an element node
+ */
+#define XML_GET_LINE(n) \
+ ((n)->type == XML_ELEMENT_PTR ? (int) (n)->content : 0)
/**
* xmlDoc:
@@ -499,7 +522,6 @@
unsigned int len);
void xmlBufferEmpty (xmlBufferPtr buf);
const xmlChar* xmlBufferContent (const xmlBufferPtr buf);
-int xmlBufferUse (const xmlBufferPtr buf);
void xmlBufferSetAllocationScheme(xmlBufferPtr buf,
xmlBufferAllocationScheme scheme);
int xmlBufferLength (const xmlBufferPtr buf);
@@ -709,7 +731,6 @@
* Removing content.
*/
int xmlRemoveProp (xmlAttrPtr attr);
-int xmlRemoveNode (xmlNodePtr node); /* TODO */
int xmlUnsetProp (xmlNodePtr node,
const xmlChar *name);
int xmlUnsetNsProp (xmlNodePtr node,
diff --git a/include/libxml/uri.h b/include/libxml/uri.h
index e4bbbe8..972ef92 100644
--- a/include/libxml/uri.h
+++ b/include/libxml/uri.h
@@ -45,7 +45,7 @@
xmlURIPtr xmlCreateURI (void);
xmlChar * xmlBuildURI (const xmlChar *URI,
const xmlChar *base);
-xmlURIPtr xmlParseURI (const char *URI);
+xmlURIPtr xmlParseURI (const char *str);
int xmlParseURIReference (xmlURIPtr uri,
const char *str);
xmlChar * xmlSaveUri (xmlURIPtr uri);
diff --git a/include/libxml/valid.h b/include/libxml/valid.h
index 01d1873..5b29e8d 100644
--- a/include/libxml/valid.h
+++ b/include/libxml/valid.h
@@ -160,7 +160,6 @@
xmlDocPtr doc,
const xmlChar *value,
xmlAttrPtr attr);
-xmlIDTablePtr xmlCopyIDTable (xmlIDTablePtr table);
void xmlFreeIDTable (xmlIDTablePtr table);
xmlAttrPtr xmlGetID (xmlDocPtr doc,
const xmlChar *ID);
@@ -174,7 +173,6 @@
xmlDocPtr doc,
const xmlChar *value,
xmlAttrPtr attr);
-xmlRefTablePtr xmlCopyRefTable (xmlRefTablePtr table);
void xmlFreeRefTable (xmlRefTablePtr table);
int xmlIsRef (xmlDocPtr doc,
xmlNodePtr elem,
diff --git a/include/libxml/xlink.h b/include/libxml/xlink.h
index 6d27166..318ebca 100644
--- a/include/libxml/xlink.h
+++ b/include/libxml/xlink.h
@@ -60,9 +60,7 @@
* This is the prototype for the link detection routine
* It calls the default link detection callbacks upon link detection.
*/
-typedef void
-(*xlinkNodeDetectFunc) (void *ctx,
- xmlNodePtr node);
+typedef void (*xlinkNodeDetectFunc) (void *ctx, xmlNodePtr node);
/**
* The link detection module interract with the upper layers using
diff --git a/include/libxml/xmlmemory.h b/include/libxml/xmlmemory.h
index e0cb81e..b96b01a 100644
--- a/include/libxml/xmlmemory.h
+++ b/include/libxml/xmlmemory.h
@@ -35,11 +35,16 @@
/**
* 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
+
+/**
+ * MEM_LIST:
+ *
+ * keep track of all allocated blocks for error reporting
+ */
#define MEM_LIST /* keep a list of all the allocated memory blocks */
#endif
@@ -90,9 +95,34 @@
int xmlInitMemory (void);
#ifdef DEBUG_MEMORY_LOCATION
-#define xmlMalloc(x) xmlMallocLoc((x), __FILE__, __LINE__)
-#define xmlRealloc(p, x) xmlReallocLoc((p), (x), __FILE__, __LINE__)
-#define xmlMemStrdup(x) xmlMemStrdupLoc((x), __FILE__, __LINE__)
+/**
+ * xmlMalloc:
+ * @size: number of bytes to allocate
+ *
+ * Wrapper for the malloc() function used in the XML library
+ *
+ * Returns the pointer to the allocated area or NULL in case of error
+ */
+#define xmlMalloc(size) xmlMallocLoc((size), __FILE__, __LINE__)
+/**
+ * xmlRealloc:
+ * @ptr: pointer to the existing allocated area
+ * @size: number of bytes to allocate
+ *
+ * Wrapper for the realloc() function used in the XML library
+ *
+ * Returns the pointer to the allocated area or NULL in case of error
+ */
+#define xmlRealloc(ptr, size) xmlReallocLoc((ptr), (size), __FILE__, __LINE__)
+/**
+ * xmlMemStrdup:
+ * @str: pointer to the existing string
+ *
+ * Wrapper for the strdup() function, xmlStrdup() is usually preferred
+ *
+ * Returns the pointer to the allocated area or NULL in case of error
+ */
+#define xmlMemStrdup(str) xmlMemStrdupLoc((str), __FILE__, __LINE__)
void * xmlMallocLoc(size_t size, const char *file, int line);
void * xmlReallocLoc(void *ptr,size_t size, const char *file, int line);
diff --git a/include/libxml/xmlversion.h.in b/include/libxml/xmlversion.h.in
index 7244d6f..54bc1b6 100644
--- a/include/libxml/xmlversion.h.in
+++ b/include/libxml/xmlversion.h.in
@@ -20,9 +20,34 @@
#ifndef LIBXML2_COMPILING_MSCCDEF
extern void xmlCheckVersion(int version);
#endif /* LIBXML2_COMPILING_MSCCDEF */
+
+/**
+ * LIBXML_DOTTED_VERSION:
+ *
+ * the version string like "1.2.3"
+ */
#define LIBXML_DOTTED_VERSION "@VERSION@"
+
+/**
+ * LIBXML_VERSION:
+ *
+ * the version number: 1.2.3 value is 1002003
+ */
#define LIBXML_VERSION @LIBXML_VERSION_NUMBER@
+
+/**
+ * LIBXML_VERSION_STRING:
+ *
+ * the version number string, 1.2.3 value is "1002003"
+ */
#define LIBXML_VERSION_STRING "@LIBXML_VERSION_NUMBER@"
+
+/**
+ * LIBXML_TEST_VERSION:
+ *
+ * Macro to check that the libxml version in use is compatible with
+ * the version the software has been compiled against
+ */
#define LIBXML_TEST_VERSION xmlCheckVersion(@LIBXML_VERSION_NUMBER@);
/**
@@ -32,8 +57,6 @@
*/
#if @WITH_TRIO@
#define WITH_TRIO
-#else
-#define WITHOUT_TRIO
#endif
/**
@@ -43,8 +66,6 @@
*/
#if @WITH_FTP@
#define LIBXML_FTP_ENABLED
-#else
-#define LIBXML_FTP_DISABLED
#endif
/**
@@ -54,8 +75,6 @@
*/
#if @WITH_HTTP@
#define LIBXML_HTTP_ENABLED
-#else
-#define LIBXML_HTTP_DISABLED
#endif
/**
@@ -65,8 +84,6 @@
*/
#if @WITH_HTML@
#define LIBXML_HTML_ENABLED
-#else
-#define LIBXML_HTML_DISABLED
#endif
/**
@@ -76,8 +93,6 @@
*/
#if @WITH_CATALOG@
#define LIBXML_CATALOG_ENABLED
-#else
-#define LIBXML_CATALOG_DISABLED
#endif
/**
@@ -87,8 +102,6 @@
*/
#if @WITH_DOCB@
#define LIBXML_DOCB_ENABLED
-#else
-#define LIBXML_DOCB_DISABLED
#endif
/**
@@ -98,8 +111,6 @@
*/
#if @WITH_XPATH@
#define LIBXML_XPATH_ENABLED
-#else
-#define LIBXML_XPATH_DISABLED
#endif
/**
@@ -109,8 +120,6 @@
*/
#if @WITH_XPTR@
#define LIBXML_XPTR_ENABLED
-#else
-#define LIBXML_XPTR_DISABLED
#endif
/**
@@ -120,8 +129,6 @@
*/
#if @WITH_XINCLUDE@
#define LIBXML_XINCLUDE_ENABLED
-#else
-#define LIBXML_XINCLUDE_DISABLED
#endif
/**
@@ -132,8 +139,6 @@
#if !defined(WIN32) || defined(__CYGWIN__)
#if @WITH_ICONV@
#define LIBXML_ICONV_ENABLED
-#else
-#define LIBXML_ICONV_DISABLED
#endif
#endif
@@ -144,8 +149,6 @@
*/
#if @WITH_DEBUG@
#define LIBXML_DEBUG_ENABLED
-#else
-#define LIBXML_DEBUG_DISABLED
#endif
/**
@@ -157,6 +160,11 @@
#define DEBUG_MEMORY_LOCATION
#endif
+/**
+ * LIBXML_DLL_IMPORT:
+ *
+ * Used on Windows to declare a variable as exported by the library
+ */
#ifndef LIBXML_DLL_IMPORT
#if defined(WIN32) && !defined(STATIC)
#define LIBXML_DLL_IMPORT __declspec(dllimport)
diff --git a/include/libxml/xpath.h b/include/libxml/xpath.h
index 8724f1c..a3c925a 100644
--- a/include/libxml/xpath.h
+++ b/include/libxml/xpath.h
@@ -367,8 +367,6 @@
*/
xmlXPathObjectPtr xmlXPathEval (const xmlChar *str,
xmlXPathContextPtr ctxt);
-xmlXPathObjectPtr xmlXPathEvalXPtrExpr (const xmlChar *str,
- xmlXPathContextPtr ctxt);
xmlXPathObjectPtr xmlXPathEvalExpression (const xmlChar *str,
xmlXPathContextPtr ctxt);
int xmlXPathEvalPredicate (xmlXPathContextPtr ctxt,
diff --git a/include/libxml/xpathInternals.h b/include/libxml/xpathInternals.h
index 1574e78..ca3943f 100644
--- a/include/libxml/xpathInternals.h
+++ b/include/libxml/xpathInternals.h
@@ -64,6 +64,8 @@
* xmlXPathGetError:
* @ctxt: an XPath parser context
*
+ * Get the error code of an XPath context
+ *
* Returns the context error
*/
#define xmlXPathGetError(ctxt) ((ctxt)->error)
@@ -72,6 +74,8 @@
* xmlXPathCheckError:
* @ctxt: an XPath parser context
*
+ * Check if an XPath error was raised
+ *
* Returns true if an error has been raised, false otherwise.
*/
#define xmlXPathCheckError(ctxt) ((ctxt)->error != XPATH_EXPRESSION_OK)
@@ -80,6 +84,8 @@
* xmlXPathGetDocument:
* @ctxt: an XPath parser context
*
+ * Get the document of an XPath context
+ *
* Returns the context document
*/
#define xmlXPathGetDocument(ctxt) ((ctxt)->context->doc)
@@ -88,6 +94,8 @@
* xmlXPathGetContextNode:
* @ctxt: an XPath parser context
*
+ * Get the context node of an XPath context
+ *
* Returns the context node
*/
#define xmlXPathGetContextNode(ctxt) ((ctxt)->context->node)
@@ -186,6 +194,9 @@
* xmlXPathStackIsNodeSet:
* @ctxt: an XPath parser context
*
+ * Check if the current value on the XPath stack is a node set or
+ * an XSLT value tree
+ *
* Returns true if the current object on the stack is a node-set
*/
#define xmlXPathStackIsNodeSet(ctxt) \
@@ -300,8 +311,7 @@
/*
* Variable Lookup forwarding
*/
-typedef xmlXPathObjectPtr
- (*xmlXPathVariableLookupFunc) (void *ctxt,
+typedef xmlXPathObjectPtr (*xmlXPathVariableLookupFunc) (void *ctxt,
const xmlChar *name,
const xmlChar *ns_uri);