Heiko W. Rupp fixed a lot of comments to generate better API descriptions
* include/libxml/*.h: Heiko W. Rupp fixed a lot of comments
to generate better API descriptions etc...
Daniel
diff --git a/include/libxml/xpath.h b/include/libxml/xpath.h
index ef77e13..f36b16f 100644
--- a/include/libxml/xpath.h
+++ b/include/libxml/xpath.h
@@ -25,7 +25,7 @@
typedef xmlXPathParserContext *xmlXPathParserContextPtr;
/**
- * The set of XPath error codes
+ * The set of XPath error codes.
*/
typedef enum {
@@ -54,7 +54,7 @@
} xmlXPathError;
/*
- * A node-set (an unordered collection of nodes without duplicates)
+ * A node-set (an unordered collection of nodes without duplicates).
*/
typedef struct _xmlNodeSet xmlNodeSet;
typedef xmlNodeSet *xmlNodeSetPtr;
@@ -142,7 +142,7 @@
* @ctxt: an XPath parser context
* @nargs: the number of arguments passed to the function
*
- * an XPath evaluation function, the parameters are on the XPath context stack
+ * An XPath evaluation function, the parameters are on the XPath context stack.
*/
typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt,
@@ -168,7 +168,7 @@
* the first time with cur == NULL and repeat until the function returns
* NULL indicating the end of the axis traversal.
*
- * Returns the next node in that axis or NULL if at the end of the axis
+ * Returns the next node in that axis or NULL if at the end of the axis.
*/
typedef xmlXPathObjectPtr (*xmlXPathAxisFunc) (xmlXPathParserContextPtr ctxt,
@@ -255,7 +255,7 @@
};
/*
- * The structure of a compiled expression form is not public
+ * The structure of a compiled expression form is not public.
*/
typedef struct _xmlXPathCompExpr xmlXPathCompExpr;
@@ -264,7 +264,7 @@
/**
* xmlXPathParserContext:
*
- * An XPath parser context, it contains pure parsing informations,
+ * An XPath parser context. It contains pure parsing informations,
* an xmlXPathContext, and the stack of objects.
*/
struct _xmlXPathParserContext {
@@ -289,7 +289,7 @@
* @ctxt: the XPath interprestation context
* @nargs: the number of arguments
*
- * An XPath function
+ * An XPath function.
* The arguments (if any) are popped out from the context stack
* and the result is pushed on the stack.
*/
@@ -318,7 +318,7 @@
* xmlXPathNodeSetGetLength:
* @ns: a node-set
*
- * Implement a functionality similar to the DOM NodeList.length
+ * Implement a functionality similar to the DOM NodeList.length.
*
* Returns the number of nodes in the node-set.
*/
@@ -328,7 +328,7 @@
* @ns: a node-set
* @index: index of a node in the set
*
- * Implements a functionality similar to the DOM NodeList.item()
+ * Implements a functionality similar to the DOM NodeList.item().
*
* Returns the xmlNodePtr at the given @index in @ns or NULL if
* @index is out of range (0 to length-1)
@@ -342,9 +342,9 @@
* xmlXPathNodeSetIsEmpty:
* @ns: a node-set
*
- * Checks whether @ns is empty or not
+ * Checks whether @ns is empty or not.
*
- * Returns %TRUE if @ns is an empty node-set
+ * Returns %TRUE if @ns is an empty node-set.
*/
#define xmlXPathNodeSetIsEmpty(ns) \
(((ns) == NULL) || ((ns)->nodeNr == 0) || ((ns)->nodeTab == NULL))
@@ -358,7 +358,7 @@
int xmlXPathCmpNodes (xmlNodePtr node1,
xmlNodePtr node2);
/**
- * Conversion functions to basic types
+ * Conversion functions to basic types.
*/
int xmlXPathCastNumberToBoolean (double val);
int xmlXPathCastStringToBoolean (const xmlChar * val);
@@ -382,7 +382,7 @@
xmlXPathObjectPtr xmlXPathConvertString (xmlXPathObjectPtr val);
/**
- * Context handling
+ * Context handling.
*/
void xmlXPathInit (void);
xmlXPathContextPtr xmlXPathNewContext (xmlDocPtr doc);
@@ -398,7 +398,7 @@
int xmlXPathEvalPredicate (xmlXPathContextPtr ctxt,
xmlXPathObjectPtr res);
/**
- * Separate compilation/evaluation entry points
+ * Separate compilation/evaluation entry points.
*/
xmlXPathCompExprPtr xmlXPathCompile (const xmlChar *str);
xmlXPathObjectPtr xmlXPathCompiledEval (xmlXPathCompExprPtr comp,