diff --git a/HTMLparser.c b/HTMLparser.c
index a9628f86..cf90224c 100644
--- a/HTMLparser.c
+++ b/HTMLparser.c
@@ -113,8 +113,7 @@ htmlParseElementInternal(htmlParserCtxtPtr ctxt);
************************************************************************/
/**
- * htmlErrMemory:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Handle an out-of-memory error
*/
@@ -125,12 +124,11 @@ htmlErrMemory(xmlParserCtxtPtr ctxt)
}
/**
- * htmlParseErr:
- * @ctxt: an HTML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: string infor
- * @str2: string infor
+ * @param ctxt an HTML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 string infor
+ * @param str2 string infor
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -149,13 +147,12 @@ htmlParseErr(xmlParserCtxtPtr ctxt, xmlParserErrors error,
************************************************************************/
/**
- * htmlnamePush:
- * @ctxt: an HTML parser context
- * @value: the element name
+ * @param ctxt an HTML parser context
+ * @param value the element name
*
* Pushes a new element name on top of the name stack
*
- * Returns -1 in case of error, the index in the stack otherwise
+ * @returns -1 in case of error, the index in the stack otherwise
*/
static int
htmlnamePush(htmlParserCtxtPtr ctxt, const xmlChar * value)
@@ -187,12 +184,11 @@ htmlnamePush(htmlParserCtxtPtr ctxt, const xmlChar * value)
return (ctxt->nameNr++);
}
/**
- * htmlnamePop:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Pops the top element name from the name stack
*
- * Returns the name just removed
+ * @returns the name just removed
*/
static const xmlChar *
htmlnamePop(htmlParserCtxtPtr ctxt)
@@ -214,13 +210,12 @@ htmlnamePop(htmlParserCtxtPtr ctxt)
}
/**
- * htmlNodeInfoPush:
- * @ctxt: an HTML parser context
- * @value: the node info
+ * @param ctxt an HTML parser context
+ * @param value the node info
*
* Pushes a new element name on top of the node info stack
*
- * Returns 0 in case of error, the index in the stack otherwise
+ * @returns 0 in case of error, the index in the stack otherwise
*/
static int
htmlNodeInfoPush(htmlParserCtxtPtr ctxt, htmlParserNodeInfo *value)
@@ -249,12 +244,11 @@ htmlNodeInfoPush(htmlParserCtxtPtr ctxt, htmlParserNodeInfo *value)
}
/**
- * htmlNodeInfoPop:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Pops the top element name from the node info stack
*
- * Returns 0 in case of error, the pointer to NodeInfo otherwise
+ * @returns 0 in case of error, the pointer to NodeInfo otherwise
*/
static htmlParserNodeInfo *
htmlNodeInfoPop(htmlParserCtxtPtr ctxt)
@@ -324,8 +318,7 @@ htmlNodeInfoPop(htmlParserCtxtPtr ctxt)
#define CUR (*ctxt->input->cur)
/**
- * htmlFindEncoding:
- * @the HTML parser context
+ * `the` HTML parser context
*
* Ty to find and encoding in the current data available in the input
* buffer this is needed to try to switch to the proper encoding when
@@ -334,7 +327,7 @@ htmlNodeInfoPop(htmlParserCtxtPtr ctxt)
* try to use a meta which had been commented out, that's the reason it
* should only be used in case of error, not as a default.
*
- * Returns an encoding string or NULL if not found, the string need to
+ * @returns an encoding string or NULL if not found, the string need to
* be freed
*/
static xmlChar *
@@ -445,12 +438,11 @@ invalid:
}
/**
- * htmlSkipBlankChars:
- * @ctxt: the HTML parser context
+ * @param ctxt the HTML parser context
*
* skip all blanks character found at that point in the input streams.
*
- * Returns the number of space chars skipped
+ * @returns the number of space chars skipped
*/
static int
@@ -1245,9 +1237,8 @@ htmlParserFinishElementParsing(htmlParserCtxtPtr ctxt) {
}
/**
- * htmlInitAutoClose:
*
- * DEPRECATED: This is a no-op.
+ * @deprecated This is a no-op.
*/
void
htmlInitAutoClose(void) {
@@ -1262,14 +1253,13 @@ htmlCompareTags(const void *key, const void *member) {
}
/**
- * htmlTagLookup:
- * @tag: The tag name in lowercase
+ * @param tag The tag name in lowercase
*
- * DEPRECATED: Only supports HTML 4.
+ * @deprecated Only supports HTML 4.
*
* Lookup the HTML tag in the ElementTable
*
- * Returns the related htmlElemDescPtr or NULL if not found.
+ * @returns the related htmlElemDescPtr or NULL if not found.
*/
const htmlElemDesc *
htmlTagLookup(const xmlChar *tag) {
@@ -1282,10 +1272,9 @@ htmlTagLookup(const xmlChar *tag) {
}
/**
- * htmlGetEndPriority:
- * @name: The name of the element to look up the priority for.
+ * @param name The name of the element to look up the priority for.
*
- * Return value: The "endtag" priority.
+ * @returns value: The "endtag" priority.
**/
static int
htmlGetEndPriority (const xmlChar *name) {
@@ -1313,14 +1302,13 @@ htmlCompareStartClose(const void *vkey, const void *member) {
}
/**
- * htmlCheckAutoClose:
- * @newtag: The new tag name
- * @oldtag: The old tag name
+ * @param newtag The new tag name
+ * @param oldtag The old tag name
*
* Checks whether the new tag is one of the registered valid tags for
* closing old.
*
- * Returns 0 if no, 1 if yes.
+ * @returns 0 if no, 1 if yes.
*/
static int
htmlCheckAutoClose(const xmlChar * newtag, const xmlChar * oldtag)
@@ -1337,9 +1325,8 @@ htmlCheckAutoClose(const xmlChar * newtag, const xmlChar * oldtag)
}
/**
- * htmlAutoCloseOnClose:
- * @ctxt: an HTML parser context
- * @newtag: The new tag name
+ * @param ctxt an HTML parser context
+ * @param newtag The new tag name
*
* The HTML DTD allows an ending tag to implicitly close other tags.
*/
@@ -1385,8 +1372,7 @@ htmlAutoCloseOnClose(htmlParserCtxtPtr ctxt, const xmlChar * newtag)
}
/**
- * htmlAutoCloseOnEnd:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Close all remaining tags at the end of the stream
*/
@@ -1409,9 +1395,8 @@ htmlAutoCloseOnEnd(htmlParserCtxtPtr ctxt)
}
/**
- * htmlAutoClose:
- * @ctxt: an HTML parser context
- * @newtag: The new tag name or NULL
+ * @param ctxt an HTML parser context
+ * @param newtag The new tag name or NULL
*
* The HTML DTD allows a tag to implicitly close other tags.
* The list is kept in htmlStartClose array. This function is
@@ -1439,19 +1424,18 @@ htmlAutoClose(htmlParserCtxtPtr ctxt, const xmlChar * newtag)
}
/**
- * htmlAutoCloseTag:
- * @doc: the HTML document
- * @name: The tag name
- * @elem: the HTML element
+ * @param doc the HTML document
+ * @param name The tag name
+ * @param elem the HTML element
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* The HTML DTD allows a tag to implicitly close other tags.
* The list is kept in htmlStartClose array. This function checks
* if the element or one of it's children would autoclose the
* given tag.
*
- * Returns 1 if autoclose, 0 otherwise
+ * @returns 1 if autoclose, 0 otherwise
*/
int
htmlAutoCloseTag(htmlDocPtr doc, const xmlChar *name, htmlNodePtr elem) {
@@ -1469,17 +1453,16 @@ htmlAutoCloseTag(htmlDocPtr doc, const xmlChar *name, htmlNodePtr elem) {
}
/**
- * htmlIsAutoClosed:
- * @doc: the HTML document
- * @elem: the HTML element
+ * @param doc the HTML document
+ * @param elem the HTML element
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* The HTML DTD allows a tag to implicitly close other tags.
* The list is kept in htmlStartClose array. This function checks
* if a tag is autoclosed by one of it's child
*
- * Returns 1 if autoclosed, 0 otherwise
+ * @returns 1 if autoclosed, 0 otherwise
*/
int
htmlIsAutoClosed(htmlDocPtr doc, htmlNodePtr elem) {
@@ -1495,9 +1478,8 @@ htmlIsAutoClosed(htmlDocPtr doc, htmlNodePtr elem) {
}
/**
- * htmlCheckImplied:
- * @ctxt: an HTML parser context
- * @newtag: The new tag name
+ * @param ctxt an HTML parser context
+ * @param newtag The new tag name
*
* The HTML DTD allows a tag to exists only implicitly
* called when a new tag has been detected and generates the
@@ -1562,7 +1544,7 @@ htmlCheckImplied(htmlParserCtxtPtr ctxt, const xmlChar *newtag) {
/**
* htmlStartCharData
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Prepare for non-whitespace character data.
*/
@@ -1580,14 +1562,13 @@ htmlStartCharData(htmlParserCtxtPtr ctxt) {
}
/**
- * htmlIsScriptAttribute:
- * @name: an attribute name
+ * @param name an attribute name
*
- * DEPRECATED: Only supports HTML 4.
+ * @deprecated Only supports HTML 4.
*
* Check if an attribute is of content type Script
*
- * Returns 1 is the attribute is a script 0 otherwise
+ * @returns 1 is the attribute is a script 0 otherwise
*/
int
htmlIsScriptAttribute(const xmlChar *name) {
@@ -1906,16 +1887,15 @@ static const htmlEntityDesc html40EntitiesTable[] = {
************************************************************************/
/**
- * htmlEntityLookup:
- * @name: the entity name
+ * @param name the entity name
*
- * DEPRECATED: Only supports HTML 4.
+ * @deprecated Only supports HTML 4.
*
* Lookup the given entity in EntitiesTable
*
* TODO: the linear scan is really ugly, an hash table is really needed.
*
- * Returns the associated htmlEntityDescPtr if found, NULL otherwise.
+ * @returns the associated htmlEntityDescPtr if found, NULL otherwise.
*/
const htmlEntityDesc *
htmlEntityLookup(const xmlChar *name) {
@@ -1939,16 +1919,15 @@ htmlCompareEntityDesc(const void *vkey, const void *vdesc) {
}
/**
- * htmlEntityValueLookup:
- * @value: the entity's unicode value
+ * @param value the entity's unicode value
*
- * DEPRECATED: Only supports HTML 4.
+ * @deprecated Only supports HTML 4.
*
* Lookup the given entity in EntitiesTable
*
* TODO: the linear scan is really ugly, an hash table is really needed.
*
- * Returns the associated htmlEntityDescPtr if found, NULL otherwise.
+ * @returns the associated htmlEntityDescPtr if found, NULL otherwise.
*/
const htmlEntityDesc *
htmlEntityValueLookup(unsigned int value) {
@@ -1963,21 +1942,20 @@ htmlEntityValueLookup(unsigned int value) {
}
/**
- * htmlUTF8ToHtml:
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of UTF-8 chars
- * @inlen: the length of @in
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of UTF-8 chars
+ * @param inlen the length of `in`
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Take a block of UTF-8 chars in and try to convert it to an ASCII
* plus HTML entities block of chars out.
*
- * Returns 0 if success, -2 if the transcoding fails, or -1 otherwise
- * The value of @inlen after return is the number of octets consumed
+ * @returns 0 if success, -2 if the transcoding fails, or -1 otherwise
+ * The value of `inlen` after return is the number of octets consumed
* as the return value is positive, else unpredictable.
- * The value of @outlen after return is the number of octets consumed.
+ * The value of `outlen` after return is the number of octets consumed.
*/
int
htmlUTF8ToHtml(unsigned char* out, int *outlen,
@@ -2065,22 +2043,21 @@ done:
}
/**
- * htmlEncodeEntities:
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of UTF-8 chars
- * @inlen: the length of @in
- * @quoteChar: the quote character to escape (' or ") or zero.
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of UTF-8 chars
+ * @param inlen the length of `in`
+ * @param quoteChar the quote character to escape (' or ") or zero.
*
- * DEPRECATED: Only supports HTML 4.
+ * @deprecated Only supports HTML 4.
*
* Take a block of UTF-8 chars in and try to convert it to an ASCII
* plus HTML entities block of chars out.
*
- * Returns 0 if success, -2 if the transcoding fails, or -1 otherwise
- * The value of @inlen after return is the number of octets consumed
+ * @returns 0 if success, -2 if the transcoding fails, or -1 otherwise
+ * The value of `inlen` after return is the number of octets consumed
* as the return value is positive, else unpredictable.
- * The value of @outlen after return is the number of octets consumed.
+ * The value of `outlen` after return is the number of octets consumed.
*/
int
htmlEncodeEntities(unsigned char* out, int *outlen,
@@ -2187,13 +2164,13 @@ static const char *allowPCData[] = {
/**
* areBlanks:
- * @ctxt: an HTML parser context
- * @str: a xmlChar *
- * @len: the size of @str
+ * @param ctxt an HTML parser context
+ * @param str a xmlChar *
+ * @param len the size of `str`
*
* Is this a sequence of blank chars that one can ignore ?
*
- * Returns 1 if ignorable 0 if whitespace, -1 otherwise.
+ * @returns 1 if ignorable 0 if whitespace, -1 otherwise.
*/
static int areBlanks(htmlParserCtxtPtr ctxt, const xmlChar *str, int len) {
@@ -2253,14 +2230,13 @@ static int areBlanks(htmlParserCtxtPtr ctxt, const xmlChar *str, int len) {
}
/**
- * htmlNewDocNoDtD:
- * @URI: URI for the dtd, or NULL
- * @ExternalID: the external ID of the DTD, or NULL
+ * @param URI URI for the dtd, or NULL
+ * @param ExternalID the external ID of the DTD, or NULL
*
- * Creates a new HTML document without a DTD node if @URI and @ExternalID
+ * Creates a new HTML document without a DTD node if `URI` and `ExternalID`
* are NULL
*
- * Returns a new document, do not initialize the DTD if not provided
+ * @returns a new document, do not initialize the DTD if not provided
*/
htmlDocPtr
htmlNewDocNoDtD(const xmlChar *URI, const xmlChar *ExternalID) {
@@ -2306,13 +2282,12 @@ htmlNewDocNoDtD(const xmlChar *URI, const xmlChar *ExternalID) {
}
/**
- * htmlNewDoc:
- * @URI: URI for the dtd, or NULL
- * @ExternalID: the external ID of the DTD, or NULL
+ * @param URI URI for the dtd, or NULL
+ * @param ExternalID the external ID of the DTD, or NULL
*
* Creates a new HTML document
*
- * Returns a new document
+ * @returns a new document
*/
htmlDocPtr
htmlNewDoc(const xmlChar *URI, const xmlChar *ExternalID) {
@@ -2339,14 +2314,13 @@ htmlNewDoc(const xmlChar *URI, const xmlChar *ExternalID) {
************************************************************************/
/**
- * htmlParseHTMLName:
- * @ctxt: an HTML parser context
- * @attr: whether this is an attribute name
+ * @param ctxt an HTML parser context
+ * @param attr whether this is an attribute name
*
* parse an HTML tag or attribute name, note that we convert it to lowercase
* since HTML names are not case-sensitive.
*
- * Returns the Tag Name parsed or NULL
+ * @returns the Tag Name parsed or NULL
*/
static xmlHashedString
@@ -2576,16 +2550,15 @@ htmlFindEntityPrefix(const xmlChar *string, size_t slen, int isAttr,
}
/**
- * htmlParseData:
- * @ctxt: an HTML parser context
- * @mask: mask of terminating characters
- * @comment: true if parsing a comment
- * @refs: true if references are allowed
- * @maxLength: maximum output length
+ * @param ctxt an HTML parser context
+ * @param mask mask of terminating characters
+ * @param comment true if parsing a comment
+ * @param refs true if references are allowed
+ * @param maxLength maximum output length
*
* Parse data until terminator is reached.
*
- * Returns the parsed string or NULL in case of errors.
+ * @returns the parsed string or NULL in case of errors.
*/
static xmlChar *
@@ -2890,13 +2863,12 @@ error:
}
/**
- * htmlParseEntityRef:
- * @ctxt: an HTML parser context
- * @str: location to store the entity name
+ * @param ctxt an HTML parser context
+ * @param str location to store the entity name
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns NULL.
+ * @returns NULL.
*/
const htmlEntityDesc *
htmlParseEntityRef(htmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -2905,15 +2877,14 @@ htmlParseEntityRef(htmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * htmlParseAttValue:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* parse a value for an attribute
* Note: the parser won't do substitution of entities here, this
* will be handled later in xmlStringGetNodeList, unless it was
* asked for ctxt->replaceEntities != 0
*
- * Returns the AttValue parsed or NULL.
+ * @returns the AttValue parsed or NULL.
*/
static xmlChar *
@@ -3000,13 +2971,12 @@ htmlCharDataSAXCallback(htmlParserCtxtPtr ctxt, const xmlChar *buf,
}
/**
- * htmlParseCharData:
- * @ctxt: an HTML parser context
- * @partial: true if the input buffer is incomplete
+ * @param ctxt an HTML parser context
+ * @param partial true if the input buffer is incomplete
*
* Parse character data and references.
*
- * Returns 1 if all data was parsed, 0 otherwise.
+ * @returns 1 if all data was parsed, 0 otherwise.
*/
static int
@@ -3391,9 +3361,8 @@ restart:
}
/**
- * htmlParseComment:
- * @ctxt: an HTML parser context
- * @bogus: true if this is a bogus comment
+ * @param ctxt an HTML parser context
+ * @param bogus true if this is a bogus comment
*
* Parse an HTML comment
*/
@@ -3432,12 +3401,11 @@ htmlParseComment(htmlParserCtxtPtr ctxt, int bogus) {
}
/**
- * htmlParseCharRef:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns 0
+ * @returns 0
*/
int
htmlParseCharRef(htmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED) {
@@ -3446,12 +3414,11 @@ htmlParseCharRef(htmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED) {
/**
- * htmlParseDoctypeLiteral:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Parse a DOCTYPE SYTSTEM or PUBLIC literal.
*
- * Returns the literal or NULL in case of error.
+ * @returns the literal or NULL in case of error.
*/
static xmlChar *
@@ -3534,8 +3501,7 @@ htmlSkipBogusDoctype(htmlParserCtxtPtr ctxt) {
}
/**
- * htmlParseDocTypeDecl:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Parse a DOCTYPE declaration.
*/
@@ -3608,9 +3574,8 @@ bogus:
}
/**
- * htmlParseAttribute:
- * @ctxt: an HTML parser context
- * @value: a xmlChar ** used to store the value of the attribute
+ * @param ctxt an HTML parser context
+ * @param value a xmlChar ** used to store the value of the attribute
*
* parse an attribute
*
@@ -3625,7 +3590,7 @@ bogus:
* Also the case QName == xmlns:??? is handled independently as a namespace
* definition.
*
- * Returns the attribute name, and the value in *value.
+ * @returns the attribute name, and the value in *value.
*/
static xmlHashedString
@@ -3653,9 +3618,8 @@ htmlParseAttribute(htmlParserCtxtPtr ctxt, xmlChar **value) {
}
/**
- * htmlCheckEncoding:
- * @ctxt: an HTML parser context
- * @attvalue: the attribute value
+ * @param ctxt an HTML parser context
+ * @param attvalue the attribute value
*
* Checks an http-equiv attribute from a Meta tag to detect
* the encoding
@@ -3689,9 +3653,8 @@ htmlCheckEncoding(htmlParserCtxtPtr ctxt, const xmlChar *attvalue) {
}
/**
- * htmlCheckMeta:
- * @ctxt: an HTML parser context
- * @atts: the attributes values
+ * @param ctxt an HTML parser context
+ * @param atts the attributes values
*
* Checks an attributes from a Meta tag
*/
@@ -3732,16 +3695,15 @@ htmlCheckMeta(htmlParserCtxtPtr ctxt, const xmlChar **atts) {
}
/**
- * htmlAttrHashInsert:
- * @ctxt: parser context
- * @size: size of the hash table
- * @name: attribute name
- * @hashValue: hash value of name
- * @aindex: attribute index (this is a multiple of 5)
+ * @param ctxt parser context
+ * @param size size of the hash table
+ * @param name attribute name
+ * @param hashValue hash value of name
+ * @param aindex attribute index (this is a multiple of 5)
*
* Inserts a new attribute into the hash table.
*
- * Returns INT_MAX if no existing attribute was found, the attribute
+ * @returns INT_MAX if no existing attribute was found, the attribute
* index if an attribute was found, -1 if a memory allocation failed.
*/
static int
@@ -3774,8 +3736,7 @@ htmlAttrHashInsert(xmlParserCtxtPtr ctxt, unsigned size, const xmlChar *name,
}
/**
- * htmlParseStartTag:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* parse a start of tag either for rule element or
* EmptyElement. In both case we don't parse the tag closing chars.
@@ -3790,7 +3751,7 @@ htmlAttrHashInsert(xmlParserCtxtPtr ctxt, unsigned size, const xmlChar *name,
*
* [NS 10] EmptyElement ::= '<' QName (S Attribute)* S? '/>'
*
- * Returns 0 in case of success, -1 in case of error and 1 if discarded
+ * @returns 0 in case of success, -1 in case of error and 1 if discarded
*/
static void
@@ -4046,8 +4007,7 @@ done:
}
/**
- * htmlParseEndTag:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* parse an end of tag
*
@@ -4057,7 +4017,7 @@ done:
*
* [NS 9] ETag ::= ''
*
- * Returns 1 if the current level should be closed.
+ * @returns 1 if the current level should be closed.
*/
static void
@@ -4189,8 +4149,7 @@ htmlParseEndTag(htmlParserCtxtPtr ctxt)
}
/**
- * htmlParseContent:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Parse a content: comment, sub-element, reference or text.
* New version for non recursive htmlParseElementInternal
@@ -4250,8 +4209,7 @@ htmlParseContent(htmlParserCtxtPtr ctxt) {
}
/**
- * htmlParseElementInternal:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* parse an HTML element, new version, non recursive
*
@@ -4327,10 +4285,9 @@ htmlParseElementInternal(htmlParserCtxtPtr ctxt) {
}
/**
- * htmlParseElement:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse an HTML element, this is highly recursive
* this is kept for compatibility with previous code versions
@@ -4368,11 +4325,10 @@ htmlParseElement(htmlParserCtxtPtr ctxt) {
}
/**
- * htmlCtxtParseContentInternal:
- * @ctxt: parser context
- * @input: parser input
+ * @param ctxt parser context
+ * @param input parser input
*
- * Returns a node list.
+ * @returns a node list.
*/
xmlNodePtr
htmlCtxtParseContentInternal(htmlParserCtxtPtr ctxt, xmlParserInputPtr input) {
@@ -4425,14 +4381,13 @@ htmlCtxtParseContentInternal(htmlParserCtxtPtr ctxt, xmlParserInputPtr input) {
}
/**
- * htmlParseDocument:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Parse an HTML document and invoke the SAX handlers. This is useful
* if you're only interested in custom SAX callbacks. If you want a
* document tree, use htmlCtxtParseDocument.
*
- * Returns 0, -1 in case of error.
+ * @returns 0, -1 in case of error.
*/
int
@@ -4558,14 +4513,13 @@ htmlParseDocument(htmlParserCtxtPtr ctxt) {
************************************************************************/
/**
- * htmlInitParserCtxt:
- * @ctxt: an HTML parser context
- * @sax: SAX handler
- * @userData: user data
+ * @param ctxt an HTML parser context
+ * @param sax SAX handler
+ * @param userData user data
*
* Initialize a parser context
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
static int
@@ -4650,8 +4604,7 @@ htmlInitParserCtxt(htmlParserCtxtPtr ctxt, const htmlSAXHandler *sax,
}
/**
- * htmlFreeParserCtxt:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Free all the memory used by a parser context. However the parsed
* document in ctxt->myDoc is not freed.
@@ -4664,7 +4617,6 @@ htmlFreeParserCtxt(htmlParserCtxtPtr ctxt)
}
/**
- * htmlNewParserCtxt:
*
* Allocate and initialize a new HTML parser context.
*
@@ -4677,7 +4629,7 @@ htmlFreeParserCtxt(htmlParserCtxtPtr ctxt)
*
* See htmlNewSAXParserCtxt for custom SAX parsers.
*
- * Returns the htmlParserCtxtPtr or NULL in case of allocation error
+ * @returns the htmlParserCtxtPtr or NULL in case of allocation error
*/
htmlParserCtxtPtr
@@ -4687,9 +4639,8 @@ htmlNewParserCtxt(void)
}
/**
- * htmlNewSAXParserCtxt:
- * @sax: SAX handler
- * @userData: user data
+ * @param sax SAX handler
+ * @param userData user data
*
* Allocate and initialize a new HTML SAX parser context. If userData
* is NULL, the parser context will be passed as user data.
@@ -4700,7 +4651,7 @@ htmlNewParserCtxt(void)
*
* Also see htmlNewParserCtxt.
*
- * Returns the htmlParserCtxtPtr or NULL in case of allocation error
+ * @returns the htmlParserCtxtPtr or NULL in case of allocation error
*/
htmlParserCtxtPtr
@@ -4751,16 +4702,15 @@ htmlCreateMemoryParserCtxtInternal(const char *url,
}
/**
- * htmlCreateMemoryParserCtxt:
- * @buffer: a pointer to a char array
- * @size: the size of the array
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
*
- * DEPRECATED: Use htmlNewParserCtxt and htmlCtxtReadMemory.
+ * @deprecated Use htmlNewParserCtxt and htmlCtxtReadMemory.
*
* Create a parser context for an HTML in-memory document. The input
* buffer must not contain any terminating null bytes.
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
htmlParserCtxtPtr
htmlCreateMemoryParserCtxt(const char *buffer, int size) {
@@ -4771,14 +4721,13 @@ htmlCreateMemoryParserCtxt(const char *buffer, int size) {
}
/**
- * htmlCreateDocParserCtxt:
- * @str: a pointer to an array of xmlChar
- * @url: URL of the document (optional)
- * @encoding: encoding (optional)
+ * @param str a pointer to an array of xmlChar
+ * @param url URL of the document (optional)
+ * @param encoding encoding (optional)
*
* Create a parser context for a null-terminated string.
*
- * Returns the new parser context or NULL if a memory allocation failed.
+ * @returns the new parser context or NULL if a memory allocation failed.
*/
static htmlParserCtxtPtr
htmlCreateDocParserCtxt(const xmlChar *str, const char *url,
@@ -4828,8 +4777,7 @@ typedef enum {
} xmlLookupStates;
/**
- * htmlParseLookupGt:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Check whether there's enough data in the input buffer to finish parsing
* a tag. This has to take quotes into account.
@@ -4926,12 +4874,11 @@ htmlParseLookupGt(xmlParserCtxtPtr ctxt) {
}
/**
- * htmlParseLookupString:
- * @ctxt: an XML parser context
- * @startDelta: delta to apply at the start
- * @str: string
- * @strLen: length of string
- * @extraLen: extra length
+ * @param ctxt an XML parser context
+ * @param startDelta delta to apply at the start
+ * @param str string
+ * @param strLen length of string
+ * @param extraLen extra length
*
* Check whether the input buffer contains a string.
*/
@@ -4981,17 +4928,16 @@ htmlParseLookupString(xmlParserCtxtPtr ctxt, size_t startDelta,
}
/**
- * htmlParseLookupCommentEnd:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Try to find a comment end tag in the input stream
* The search includes "-->" as well as WHATWG-recommended incorrectly-closed tags.
- * (See https://html.spec.whatwg.org/multipage/parsing.html#parse-error-incorrectly-closed-comment)
+ * (See https://html.spec.whatwg.org/multipage/parsing.html\#parse-error-incorrectly-closed-comment)
* This function has a side effect of (possibly) incrementing ctxt->checkIndex
* to avoid rescanning sequences of bytes, it DOES change the state of the
* parser, do not use liberally.
*
- * Returns the index to the current parsing point if the full sequence is available, -1 otherwise.
+ * @returns the index to the current parsing point if the full sequence is available, -1 otherwise.
*/
static int
htmlParseLookupCommentEnd(htmlParserCtxtPtr ctxt)
@@ -5026,13 +4972,12 @@ htmlParseLookupCommentEnd(htmlParserCtxtPtr ctxt)
/**
- * htmlParseTryOrFinish:
- * @ctxt: an HTML parser context
- * @terminate: last chunk indicator
+ * @param ctxt an HTML parser context
+ * @param terminate last chunk indicator
*
* Try to progress on parsing
*
- * Returns zero if no parsing was possible
+ * @returns zero if no parsing was possible
*/
static void
htmlParseTryOrFinish(htmlParserCtxtPtr ctxt, int terminate) {
@@ -5230,11 +5175,10 @@ htmlParseTryOrFinish(htmlParserCtxtPtr ctxt, int terminate) {
}
/**
- * htmlParseChunk:
- * @ctxt: an HTML parser context
- * @chunk: chunk of memory
- * @size: size of chunk in bytes
- * @terminate: last chunk indicator
+ * @param ctxt an HTML parser context
+ * @param chunk chunk of memory
+ * @param size size of chunk in bytes
+ * @param terminate last chunk indicator
*
* Parse a chunk of memory in push parser mode.
*
@@ -5242,13 +5186,13 @@ htmlParseTryOrFinish(htmlParserCtxtPtr ctxt, int terminate) {
* htmlCreatePushParserCtxt.
*
* The last chunk, which will often be empty, must be marked with
- * the @terminate flag. With the default SAX callbacks, the resulting
+ * the `terminate` flag. With the default SAX callbacks, the resulting
* document will be available in ctxt->myDoc. This pointer will not
* be freed by the library.
*
* If the document isn't well-formed, ctxt->myDoc is set to NULL.
*
- * Returns an xmlParserErrors code (0 on success).
+ * @returns an xmlParserErrors code (0 on success).
*/
int
htmlParseChunk(htmlParserCtxtPtr ctxt, const char *chunk, int size,
@@ -5315,17 +5259,16 @@ htmlParseChunk(htmlParserCtxtPtr ctxt, const char *chunk, int size,
************************************************************************/
/**
- * htmlCreatePushParserCtxt:
- * @sax: a SAX handler (optional)
- * @user_data: The user data returned on SAX callbacks (optional)
- * @chunk: a pointer to an array of chars (optional)
- * @size: number of chars in the array
- * @filename: only used for error reporting (optional)
- * @enc: encoding (deprecated, pass XML_CHAR_ENCODING_NONE)
+ * @param sax a SAX handler (optional)
+ * @param user_data The user data returned on SAX callbacks (optional)
+ * @param chunk a pointer to an array of chars (optional)
+ * @param size number of chars in the array
+ * @param filename only used for error reporting (optional)
+ * @param enc encoding (deprecated, pass XML_CHAR_ENCODING_NONE)
*
* Create a parser context for using the HTML parser in push mode.
*
- * Returns the new parser context or NULL if a memory allocation
+ * @returns the new parser context or NULL if a memory allocation
* failed.
*/
htmlParserCtxtPtr
@@ -5361,19 +5304,18 @@ htmlCreatePushParserCtxt(htmlSAXHandlerPtr sax, void *user_data,
#endif /* LIBXML_PUSH_ENABLED */
/**
- * htmlSAXParseDoc:
- * @cur: a pointer to an array of xmlChar
- * @encoding: a free form C string describing the HTML document encoding, or NULL
- * @sax: the SAX handler block
- * @userData: if using SAX, this pointer will be provided on callbacks.
+ * @param cur a pointer to an array of xmlChar
+ * @param encoding a free form C string describing the HTML document encoding, or NULL
+ * @param sax the SAX handler block
+ * @param userData if using SAX, this pointer will be provided on callbacks.
*
- * DEPRECATED: Use htmlNewSAXParserCtxt and htmlCtxtReadDoc.
+ * @deprecated Use htmlNewSAXParserCtxt and htmlCtxtReadDoc.
*
* Parse an HTML in-memory document. If sax is not NULL, use the SAX callbacks
* to handle parse events. If sax is NULL, fallback to the default DOM
* behavior and return a tree.
*
- * Returns the resulting document tree unless SAX is NULL or the document is
+ * @returns the resulting document tree unless SAX is NULL or the document is
* not well formed.
*/
@@ -5403,17 +5345,16 @@ htmlSAXParseDoc(const xmlChar *cur, const char *encoding,
}
/**
- * htmlParseDoc:
- * @cur: a pointer to an array of xmlChar
- * @encoding: the encoding (optional)
+ * @param cur a pointer to an array of xmlChar
+ * @param encoding the encoding (optional)
*
- * DEPRECATED: Use htmlReadDoc.
+ * @deprecated Use htmlReadDoc.
*
* Parse an HTML in-memory document and build a tree.
*
* This function uses deprecated global parser options.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
@@ -5423,11 +5364,10 @@ htmlParseDoc(const xmlChar *cur, const char *encoding) {
/**
- * htmlCreateFileParserCtxt:
- * @filename: the filename
- * @encoding: optional encoding
+ * @param filename the filename
+ * @param encoding optional encoding
*
- * DEPRECATED: Use htmlNewParserCtxt and htmlCtxtReadFile.
+ * @deprecated Use htmlNewParserCtxt and htmlCtxtReadFile.
*
* Create a parser context to read from a file.
*
@@ -5436,7 +5376,7 @@ htmlParseDoc(const xmlChar *cur, const char *encoding) {
* Automatic support for ZLIB/Compress compressed document is provided
* by default if found at compile-time.
*
- * Returns the new parser context or NULL if a memory allocation failed.
+ * @returns the new parser context or NULL if a memory allocation failed.
*/
htmlParserCtxtPtr
htmlCreateFileParserCtxt(const char *filename, const char *encoding)
@@ -5467,20 +5407,19 @@ htmlCreateFileParserCtxt(const char *filename, const char *encoding)
}
/**
- * htmlSAXParseFile:
- * @filename: the filename
- * @encoding: encoding (optional)
- * @sax: the SAX handler block
- * @userData: if using SAX, this pointer will be provided on callbacks.
+ * @param filename the filename
+ * @param encoding encoding (optional)
+ * @param sax the SAX handler block
+ * @param userData if using SAX, this pointer will be provided on callbacks.
*
- * DEPRECATED: Use htmlNewSAXParserCtxt and htmlCtxtReadFile.
+ * @deprecated Use htmlNewSAXParserCtxt and htmlCtxtReadFile.
*
* parse an HTML file and build a tree. Automatic support for ZLIB/Compress
* compressed document is provided by default if found at compile-time.
* It use the given SAX function block to handle the parsing callback.
* If sax is NULL, fallback to the default DOM tree building routines.
*
- * Returns the resulting document tree unless SAX is NULL or the document is
+ * @returns the resulting document tree unless SAX is NULL or the document is
* not well formed.
*/
@@ -5512,13 +5451,12 @@ htmlSAXParseFile(const char *filename, const char *encoding, htmlSAXHandlerPtr s
}
/**
- * htmlParseFile:
- * @filename: the filename
- * @encoding: encoding (optional)
+ * @param filename the filename
+ * @param encoding encoding (optional)
*
* Parse an HTML file and build a tree.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
@@ -5527,14 +5465,13 @@ htmlParseFile(const char *filename, const char *encoding) {
}
/**
- * htmlHandleOmittedElem:
- * @val: int 0 or 1
+ * @param val int 0 or 1
*
- * DEPRECATED: Use HTML_PARSE_NOIMPLIED
+ * @deprecated Use HTML_PARSE_NOIMPLIED
*
* Set and return the previous value for handling HTML omitted tags.
*
- * Returns the last value for 0 for no handling, 1 for auto insertion.
+ * @returns the last value for 0 for no handling, 1 for auto insertion.
*/
int
@@ -5546,13 +5483,12 @@ htmlHandleOmittedElem(int val) {
}
/**
- * htmlElementAllowedHere:
- * @parent: HTML parent element
- * @elt: HTML element
+ * @param parent HTML parent element
+ * @param elt HTML element
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
- * Returns 1
+ * @returns 1
*/
int
htmlElementAllowedHere(const htmlElemDesc* parent ATTRIBUTE_UNUSED,
@@ -5561,13 +5497,12 @@ htmlElementAllowedHere(const htmlElemDesc* parent ATTRIBUTE_UNUSED,
}
/**
- * htmlElementStatusHere:
- * @parent: HTML parent element
- * @elt: HTML element
+ * @param parent HTML parent element
+ * @param elt HTML element
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
- * Returns HTML_VALID
+ * @returns HTML_VALID
*/
htmlStatus
htmlElementStatusHere(const htmlElemDesc* parent ATTRIBUTE_UNUSED,
@@ -5576,14 +5511,13 @@ htmlElementStatusHere(const htmlElemDesc* parent ATTRIBUTE_UNUSED,
}
/**
- * htmlAttrAllowed:
- * @elt: HTML element
- * @attr: HTML attribute
- * @legacy: whether to allow deprecated attributes
+ * @param elt HTML element
+ * @param attr HTML attribute
+ * @param legacy whether to allow deprecated attributes
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
- * Returns HTML_VALID
+ * @returns HTML_VALID
*/
htmlStatus
htmlAttrAllowed(const htmlElemDesc* elt ATTRIBUTE_UNUSED,
@@ -5593,14 +5527,13 @@ htmlAttrAllowed(const htmlElemDesc* elt ATTRIBUTE_UNUSED,
}
/**
- * htmlNodeStatus:
- * @node: an htmlNodePtr in a tree
- * @legacy: whether to allow deprecated elements (YES is faster here
+ * @param node an htmlNodePtr in a tree
+ * @param legacy whether to allow deprecated elements (YES is faster here
* for Element nodes)
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
- * Returns HTML_VALID
+ * @returns HTML_VALID
*/
htmlStatus
htmlNodeStatus(htmlNodePtr node ATTRIBUTE_UNUSED,
@@ -5615,7 +5548,7 @@ htmlNodeStatus(htmlNodePtr node ATTRIBUTE_UNUSED,
************************************************************************/
/**
* DICT_FREE:
- * @str: a string
+ * @param str a string
*
* Free a string if it is not owned by the "dict" dictionary in the
* current scope
@@ -5626,8 +5559,7 @@ htmlNodeStatus(htmlNodePtr node ATTRIBUTE_UNUSED,
xmlFree((char *)(str));
/**
- * htmlCtxtReset:
- * @ctxt: an HTML parser context
+ * @param ctxt an HTML parser context
*
* Reset a parser context
*/
@@ -5776,9 +5708,8 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask)
}
/**
- * htmlCtxtSetOptions:
- * @ctxt: an HTML parser context
- * @options: a bitmask of xmlParserOption values
+ * @param ctxt an HTML parser context
+ * @param options a bitmask of xmlParserOption values
*
* Applies the options to the parser context. Unset options are
* cleared.
@@ -5871,7 +5802,7 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask)
*
* Available since 2.14.0.
*
- * Returns 0 in case of success, the set of unknown or unimplemented options
+ * @returns 0 in case of success, the set of unknown or unimplemented options
* in case of error.
*/
int
@@ -5881,11 +5812,10 @@ htmlCtxtSetOptions(xmlParserCtxtPtr ctxt, int options)
}
/**
- * htmlCtxtUseOptions:
- * @ctxt: an HTML parser context
- * @options: a combination of htmlParserOption(s)
+ * @param ctxt an HTML parser context
+ * @param options a combination of htmlParserOption(s)
*
- * DEPRECATED: Use htmlCtxtSetOptions.
+ * @deprecated Use htmlCtxtSetOptions.
*
* Applies the options to the parser context. The following options
* are never cleared and can only be enabled:
@@ -5899,7 +5829,7 @@ htmlCtxtSetOptions(xmlParserCtxtPtr ctxt, int options)
* HTML_PARSE_IGNORE_ENC
* HTML_PARSE_BIG_LINES
*
- * Returns 0 in case of success, the set of unknown or unimplemented options
+ * @returns 0 in case of success, the set of unknown or unimplemented options
* in case of error.
*/
int
@@ -5923,15 +5853,14 @@ htmlCtxtUseOptions(htmlParserCtxtPtr ctxt, int options)
}
/**
- * htmlCtxtParseDocument:
- * @ctxt: an HTML parser context
- * @input: parser input
+ * @param ctxt an HTML parser context
+ * @param input parser input
*
* Parse an HTML document and return the resulting document tree.
*
* Available since 2.13.0.
*
- * Returns the resulting document tree or NULL
+ * @returns the resulting document tree or NULL
*/
htmlDocPtr
htmlCtxtParseDocument(htmlParserCtxtPtr ctxt, xmlParserInputPtr input)
@@ -5966,18 +5895,17 @@ htmlCtxtParseDocument(htmlParserCtxtPtr ctxt, xmlParserInputPtr input)
}
/**
- * htmlReadDoc:
- * @str: a pointer to a zero terminated string
- * @url: only used for error reporting (optoinal)
- * @encoding: the document encoding (optional)
- * @options: a combination of htmlParserOptions
+ * @param str a pointer to a zero terminated string
+ * @param url only used for error reporting (optoinal)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of htmlParserOptions
*
* Convenience function to parse an HTML document from a zero-terminated
* string.
*
* See htmlCtxtReadDoc for details.
*
- * Returns the resulting document tree.
+ * @returns the resulting document tree.
*/
htmlDocPtr
htmlReadDoc(const xmlChar *str, const char *url, const char *encoding,
@@ -6004,17 +5932,16 @@ htmlReadDoc(const xmlChar *str, const char *url, const char *encoding,
}
/**
- * htmlReadFile:
- * @filename: a file or URL
- * @encoding: the document encoding (optional)
- * @options: a combination of htmlParserOptions
+ * @param filename a file or URL
+ * @param encoding the document encoding (optional)
+ * @param options a combination of htmlParserOptions
*
* Convenience function to parse an HTML file from the filesystem,
* the network or a global user-defined resource loader.
*
* See htmlCtxtReadFile for details.
*
- * Returns the resulting document tree.
+ * @returns the resulting document tree.
*/
htmlDocPtr
htmlReadFile(const char *filename, const char *encoding, int options)
@@ -6039,19 +5966,18 @@ htmlReadFile(const char *filename, const char *encoding, int options)
}
/**
- * htmlReadMemory:
- * @buffer: a pointer to a char array
- * @size: the size of the array
- * @url: only used for error reporting (optional)
- * @encoding: the document encoding, or NULL
- * @options: a combination of htmlParserOption(s)
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
+ * @param url only used for error reporting (optional)
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of htmlParserOption(s)
*
* Convenience function to parse an HTML document from memory.
* The input buffer must not contain any terminating null bytes.
*
* See htmlCtxtReadMemory for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlReadMemory(const char *buffer, int size, const char *url,
@@ -6081,11 +6007,10 @@ htmlReadMemory(const char *buffer, int size, const char *url,
}
/**
- * htmlReadFd:
- * @fd: an open file descriptor
- * @url: only used for error reporting (optional)
- * @encoding: the document encoding, or NULL
- * @options: a combination of htmlParserOptions
+ * @param fd an open file descriptor
+ * @param url only used for error reporting (optional)
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of htmlParserOptions
*
* Convenience function to parse an HTML document from a
* file descriptor.
@@ -6095,7 +6020,7 @@ htmlReadMemory(const char *buffer, int size, const char *url,
*
* See htmlCtxtReadFd for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlReadFd(int fd, const char *url, const char *encoding, int options)
@@ -6120,20 +6045,19 @@ htmlReadFd(int fd, const char *url, const char *encoding, int options)
}
/**
- * htmlReadIO:
- * @ioread: an I/O read function
- * @ioclose: an I/O close function (optional)
- * @ioctx: an I/O handler
- * @url: only used for error reporting (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of htmlParserOption(s)
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function (optional)
+ * @param ioctx an I/O handler
+ * @param url only used for error reporting (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of htmlParserOption(s)
*
* Convenience function to parse an HTML document from I/O functions
* and context.
*
* See htmlCtxtReadIO for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose,
@@ -6160,18 +6084,17 @@ htmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose,
}
/**
- * htmlCtxtReadDoc:
- * @ctxt: an HTML parser context
- * @str: a pointer to a zero terminated string
- * @URL: only used for error reporting (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of htmlParserOptions
+ * @param ctxt an HTML parser context
+ * @param str a pointer to a zero terminated string
+ * @param URL only used for error reporting (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of htmlParserOptions
*
* Parse an HTML in-memory document and build a tree.
*
* See htmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlCtxtReadDoc(htmlParserCtxtPtr ctxt, const xmlChar *str,
@@ -6194,18 +6117,17 @@ htmlCtxtReadDoc(htmlParserCtxtPtr ctxt, const xmlChar *str,
}
/**
- * htmlCtxtReadFile:
- * @ctxt: an HTML parser context
- * @filename: a file or URL
- * @encoding: the document encoding (optional)
- * @options: a combination of htmlParserOptions
+ * @param ctxt an HTML parser context
+ * @param filename a file or URL
+ * @param encoding the document encoding (optional)
+ * @param options a combination of htmlParserOptions
*
* Parse an HTML file from the filesystem, the network or a
* user-defined resource loader.
*
* See htmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlCtxtReadFile(htmlParserCtxtPtr ctxt, const char *filename,
@@ -6227,20 +6149,19 @@ htmlCtxtReadFile(htmlParserCtxtPtr ctxt, const char *filename,
}
/**
- * htmlCtxtReadMemory:
- * @ctxt: an HTML parser context
- * @buffer: a pointer to a char array
- * @size: the size of the array
- * @URL: only used for error reporting (optional)
- * @encoding: the document encoding (optinal)
- * @options: a combination of htmlParserOptions
+ * @param ctxt an HTML parser context
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
+ * @param URL only used for error reporting (optional)
+ * @param encoding the document encoding (optinal)
+ * @param options a combination of htmlParserOptions
*
* Parse an HTML in-memory document and build a tree. The input buffer must
* not contain any terminating null bytes.
*
* See htmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlCtxtReadMemory(htmlParserCtxtPtr ctxt, const char *buffer, int size,
@@ -6263,12 +6184,11 @@ htmlCtxtReadMemory(htmlParserCtxtPtr ctxt, const char *buffer, int size,
}
/**
- * htmlCtxtReadFd:
- * @ctxt: an HTML parser context
- * @fd: an open file descriptor
- * @URL: only used for error reporting (optional)
- * @encoding: the document encoding (optinal)
- * @options: a combination of htmlParserOptions
+ * @param ctxt an HTML parser context
+ * @param fd an open file descriptor
+ * @param URL only used for error reporting (optional)
+ * @param encoding the document encoding (optinal)
+ * @param options a combination of htmlParserOptions
*
* Parse an HTML from a file descriptor and build a tree.
*
@@ -6277,7 +6197,7 @@ htmlCtxtReadMemory(htmlParserCtxtPtr ctxt, const char *buffer, int size,
* NOTE that the file descriptor will not be closed when the
* context is freed or reset.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlCtxtReadFd(htmlParserCtxtPtr ctxt, int fd,
@@ -6299,20 +6219,19 @@ htmlCtxtReadFd(htmlParserCtxtPtr ctxt, int fd,
}
/**
- * htmlCtxtReadIO:
- * @ctxt: an HTML parser context
- * @ioread: an I/O read function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of htmlParserOption(s)
+ * @param ctxt an HTML parser context
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of htmlParserOption(s)
*
* Parse an HTML document from I/O functions and source and build a tree.
*
* See htmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
htmlDocPtr
htmlCtxtReadIO(htmlParserCtxtPtr ctxt, xmlInputReadCallback ioread,
diff --git a/HTMLtree.c b/HTMLtree.c
index cffa5296..4349b450 100644
--- a/HTMLtree.c
+++ b/HTMLtree.c
@@ -35,12 +35,11 @@
************************************************************************/
/**
- * htmlGetMetaEncoding:
- * @doc: the document
+ * @param doc the document
*
* Encoding definition lookup in the Meta tags
*
- * Returns the current encoding as flagged in the HTML source
+ * @returns the current encoding as flagged in the HTML source
*/
const xmlChar *
htmlGetMetaEncoding(htmlDocPtr doc) {
@@ -146,15 +145,14 @@ found_content:
}
/**
- * htmlSetMetaEncoding:
- * @doc: the document
- * @encoding: the encoding string
+ * @param doc the document
+ * @param encoding the encoding string
*
* Sets the current encoding in the Meta tags
* NOTE: this will not change the document content encoding, just
* the META flag associated.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
htmlSetMetaEncoding(htmlDocPtr doc, const xmlChar *encoding) {
@@ -305,14 +303,13 @@ static const char* const htmlBooleanAttrs[] = {
/**
- * htmlIsBooleanAttr:
- * @name: the name of the attribute to check
+ * @param name the name of the attribute to check
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Determine if a given attribute is a boolean attribute.
*
- * returns: false if the attribute is not boolean, true otherwise.
+ * @returns false if the attribute is not boolean, true otherwise.
*/
int
htmlIsBooleanAttr(const xmlChar *name)
@@ -346,15 +343,14 @@ htmlFindOutputEncoder(const char *encoding, xmlCharEncodingHandler **out) {
}
/**
- * htmlBufNodeDumpFormat:
- * @buf: the xmlBufPtr output
- * @doc: the document
- * @cur: the current node
- * @format: should formatting spaces been added
+ * @param buf the xmlBufPtr output
+ * @param doc the document
+ * @param cur the current node
+ * @param format should formatting spaces been added
*
* Dump an HTML node, recursive behaviour,children are printed too.
*
- * Returns the number of byte written or -1 in case of error
+ * @returns the number of byte written or -1 in case of error
*/
static size_t
htmlBufNodeDumpFormat(xmlBufPtr buf, xmlDocPtr doc, xmlNodePtr cur,
@@ -391,15 +387,14 @@ htmlBufNodeDumpFormat(xmlBufPtr buf, xmlDocPtr doc, xmlNodePtr cur,
}
/**
- * htmlNodeDump:
- * @buf: the HTML buffer output
- * @doc: the document
- * @cur: the current node
+ * @param buf the HTML buffer output
+ * @param doc the document
+ * @param cur the current node
*
* Dump an HTML node, recursive behaviour,children are printed too,
* and formatting returns are added.
*
- * Returns the number of byte written or -1 in case of error
+ * @returns the number of byte written or -1 in case of error
*/
int
htmlNodeDump(xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur) {
@@ -425,18 +420,17 @@ htmlNodeDump(xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur) {
}
/**
- * htmlNodeDumpFileFormat:
- * @out: the FILE pointer
- * @doc: the document
- * @cur: the current node
- * @encoding: the document encoding
- * @format: should formatting spaces been added
+ * @param out the FILE pointer
+ * @param doc the document
+ * @param cur the current node
+ * @param encoding the document encoding
+ * @param format should formatting spaces been added
*
* Dump an HTML node, recursive behaviour,children are printed too.
*
* TODO: if encoding == NULL try to save in the doc encoding
*
- * returns: the number of byte written or -1 in case of failure.
+ * @returns the number of byte written or -1 in case of failure.
*/
int
htmlNodeDumpFileFormat(FILE *out, xmlDocPtr doc,
@@ -463,10 +457,9 @@ htmlNodeDumpFileFormat(FILE *out, xmlDocPtr doc,
}
/**
- * htmlNodeDumpFile:
- * @out: the FILE pointer
- * @doc: the document
- * @cur: the current node
+ * @param out the FILE pointer
+ * @param doc the document
+ * @param cur the current node
*
* Dump an HTML node, recursive behaviour,children are printed too,
* and formatting returns are added.
@@ -477,11 +470,10 @@ htmlNodeDumpFile(FILE *out, xmlDocPtr doc, xmlNodePtr cur) {
}
/**
- * htmlDocDumpMemoryFormat:
- * @cur: the document
- * @mem: OUT: the memory pointer
- * @size: OUT: the memory length
- * @format: should formatting spaces been added
+ * @param cur the document
+ * @param mem OUT: the memory pointer
+ * @param size OUT: the memory length
+ * @param format should formatting spaces been added
*
* Dump an HTML document in memory and return the xmlChar * and it's size.
* It's up to the caller to free the memory.
@@ -526,10 +518,9 @@ htmlDocDumpMemoryFormat(xmlDocPtr cur, xmlChar**mem, int *size, int format) {
}
/**
- * htmlDocDumpMemory:
- * @cur: the document
- * @mem: OUT: the memory pointer
- * @size: OUT: the memory length
+ * @param cur the document
+ * @param mem OUT: the memory pointer
+ * @param size OUT: the memory length
*
* Dump an HTML document in memory and return the xmlChar * and it's size.
* It's up to the caller to free the memory.
@@ -547,10 +538,9 @@ htmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int *size) {
************************************************************************/
/**
- * htmlDtdDumpOutput:
- * @buf: the HTML buffer output
- * @doc: the document
- * @encoding: the encoding string
+ * @param buf the HTML buffer output
+ * @param doc the document
+ * @param encoding the encoding string
*
* TODO: check whether encoding is needed
*
@@ -581,10 +571,9 @@ htmlDtdDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
}
/**
- * htmlAttrDumpOutput:
- * @buf: the HTML buffer output
- * @doc: the document
- * @cur: the attribute pointer
+ * @param buf the HTML buffer output
+ * @param doc the document
+ * @param cur the attribute pointer
*
* Dump an HTML attribute
*/
@@ -651,12 +640,11 @@ htmlAttrDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc, xmlAttrPtr cur) {
}
/**
- * htmlNodeDumpFormatOutput:
- * @buf: the HTML buffer output
- * @doc: the document
- * @cur: the current node
- * @encoding: the encoding string (unused)
- * @format: should formatting spaces been added
+ * @param buf the HTML buffer output
+ * @param doc the document
+ * @param cur the current node
+ * @param encoding the encoding string (unused)
+ * @param format should formatting spaces been added
*
* Dump an HTML node, recursive behaviour,children are printed too.
*/
@@ -886,11 +874,10 @@ htmlNodeDumpFormatOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
}
/**
- * htmlNodeDumpOutput:
- * @buf: the HTML buffer output
- * @doc: the document
- * @cur: the current node
- * @encoding: the encoding string (unused)
+ * @param buf the HTML buffer output
+ * @param doc the document
+ * @param cur the current node
+ * @param encoding the encoding string (unused)
*
* Dump an HTML node, recursive behaviour,children are printed too,
* and formatting returns/spaces are added.
@@ -902,11 +889,10 @@ htmlNodeDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr doc,
}
/**
- * htmlDocContentDumpFormatOutput:
- * @buf: the HTML buffer output
- * @cur: the document
- * @encoding: the encoding string (unused)
- * @format: should formatting spaces been added
+ * @param buf the HTML buffer output
+ * @param cur the document
+ * @param encoding the encoding string (unused)
+ * @param format should formatting spaces been added
*
* Dump an HTML document.
*/
@@ -925,10 +911,9 @@ htmlDocContentDumpFormatOutput(xmlOutputBufferPtr buf, xmlDocPtr cur,
}
/**
- * htmlDocContentDumpOutput:
- * @buf: the HTML buffer output
- * @cur: the document
- * @encoding: the encoding string (unused)
+ * @param buf the HTML buffer output
+ * @param cur the document
+ * @param encoding the encoding string (unused)
*
* Dump an HTML document. Formatting return/spaces are added.
*/
@@ -945,13 +930,12 @@ htmlDocContentDumpOutput(xmlOutputBufferPtr buf, xmlDocPtr cur,
************************************************************************/
/**
- * htmlDocDump:
- * @f: the FILE*
- * @cur: the document
+ * @param f the FILE*
+ * @param cur the document
*
* Dump an HTML document to an open FILE.
*
- * returns: the number of byte written or -1 in case of failure.
+ * @returns the number of byte written or -1 in case of failure.
*/
int
htmlDocDump(FILE *f, xmlDocPtr cur) {
@@ -979,13 +963,12 @@ htmlDocDump(FILE *f, xmlDocPtr cur) {
}
/**
- * htmlSaveFile:
- * @filename: the filename (or URL)
- * @cur: the document
+ * @param filename the filename (or URL)
+ * @param cur the document
*
- * Dump an HTML document to a file. If @filename is "-" the stdout file is
+ * Dump an HTML document to a file. If `filename` is "-" the stdout file is
* used.
- * returns: the number of byte written or -1 in case of failure.
+ * @returns the number of byte written or -1 in case of failure.
*/
int
htmlSaveFile(const char *filename, xmlDocPtr cur) {
@@ -1013,15 +996,14 @@ htmlSaveFile(const char *filename, xmlDocPtr cur) {
}
/**
- * htmlSaveFileFormat:
- * @filename: the filename
- * @cur: the document
- * @format: should formatting spaces been added
- * @encoding: the document encoding
+ * @param filename the filename
+ * @param cur the document
+ * @param format should formatting spaces been added
+ * @param encoding the document encoding
*
* Dump an HTML document to a file using a given encoding.
*
- * returns: the number of byte written or -1 in case of failure.
+ * @returns the number of byte written or -1 in case of failure.
*/
int
htmlSaveFileFormat(const char *filename, xmlDocPtr cur,
@@ -1056,15 +1038,14 @@ htmlSaveFileFormat(const char *filename, xmlDocPtr cur,
}
/**
- * htmlSaveFileEnc:
- * @filename: the filename
- * @cur: the document
- * @encoding: the document encoding
+ * @param filename the filename
+ * @param cur the document
+ * @param encoding the document encoding
*
* Dump an HTML document to a file using a given encoding
* and formatting returns/spaces are added.
*
- * returns: the number of byte written or -1 in case of failure.
+ * @returns the number of byte written or -1 in case of failure.
*/
int
htmlSaveFileEnc(const char *filename, xmlDocPtr cur, const char *encoding) {
diff --git a/SAX2.c b/SAX2.c
index b5a221b4..60a738f3 100644
--- a/SAX2.c
+++ b/SAX2.c
@@ -31,9 +31,8 @@
#include "private/tree.h"
/*
- * xmlSAX2ErrMemory:
- * @ctxt: an XML validation parser context
- * @msg: a string to accompany the error message
+ * @param ctxt an XML validation parser context
+ * @param msg a string to accompany the error message
*/
static void
xmlSAX2ErrMemory(xmlParserCtxtPtr ctxt) {
@@ -41,12 +40,11 @@ xmlSAX2ErrMemory(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlValidError:
- * @ctxt: an XML validation parser context
- * @error: the error number
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt an XML validation parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Handle a validation error
*/
@@ -61,12 +59,11 @@ xmlErrValid(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlFatalErrMsg:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: an error string
- * @str2: an error string
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 an error string
+ * @param str2 an error string
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -79,11 +76,10 @@ xmlFatalErrMsg(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlWarnMsg:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: an error string
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 an error string
*
* Handle a parser warning
*/
@@ -96,12 +92,11 @@ xmlWarnMsg(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlNsWarnMsg:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: an error string
- * @str2: an error string
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 an error string
+ * @param str2 an error string
*
* Handle a namespace warning
*/
@@ -114,12 +109,11 @@ xmlNsWarnMsg(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlSAX2GetPublicId:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"
*
- * Returns a xmlChar *
+ * @returns a xmlChar *
*/
const xmlChar *
xmlSAX2GetPublicId(void *ctx ATTRIBUTE_UNUSED)
@@ -129,13 +123,12 @@ xmlSAX2GetPublicId(void *ctx ATTRIBUTE_UNUSED)
}
/**
- * xmlSAX2GetSystemId:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Provides the system ID, basically URL or filename e.g.
* http://www.sgmlsource.com/dtds/memo.dtd
*
- * Returns a xmlChar *
+ * @returns a xmlChar *
*/
const xmlChar *
xmlSAX2GetSystemId(void *ctx)
@@ -146,12 +139,11 @@ xmlSAX2GetSystemId(void *ctx)
}
/**
- * xmlSAX2GetLineNumber:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Provide the line number of the current parsing point.
*
- * Returns an int
+ * @returns an int
*/
int
xmlSAX2GetLineNumber(void *ctx)
@@ -162,12 +154,11 @@ xmlSAX2GetLineNumber(void *ctx)
}
/**
- * xmlSAX2GetColumnNumber:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Provide the column number of the current parsing point.
*
- * Returns an int
+ * @returns an int
*/
int
xmlSAX2GetColumnNumber(void *ctx)
@@ -178,12 +169,11 @@ xmlSAX2GetColumnNumber(void *ctx)
}
/**
- * xmlSAX2IsStandalone:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Is this document tagged standalone ?
*
- * Returns 1 if true
+ * @returns 1 if true
*/
int
xmlSAX2IsStandalone(void *ctx)
@@ -194,12 +184,11 @@ xmlSAX2IsStandalone(void *ctx)
}
/**
- * xmlSAX2HasInternalSubset:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Does this document has an internal subset
*
- * Returns 1 if true
+ * @returns 1 if true
*/
int
xmlSAX2HasInternalSubset(void *ctx)
@@ -210,12 +199,11 @@ xmlSAX2HasInternalSubset(void *ctx)
}
/**
- * xmlSAX2HasExternalSubset:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Does this document has an external subset
*
- * Returns 1 if true
+ * @returns 1 if true
*/
int
xmlSAX2HasExternalSubset(void *ctx)
@@ -226,11 +214,10 @@ xmlSAX2HasExternalSubset(void *ctx)
}
/**
- * xmlSAX2InternalSubset:
- * @ctx: the user data (XML parser context)
- * @name: the root element name
- * @ExternalID: the external ID
- * @SystemID: the SYSTEM ID (e.g. filename or URL)
+ * @param ctx the user data (XML parser context)
+ * @param name the root element name
+ * @param ExternalID the external ID
+ * @param SystemID the SYSTEM ID (e.g. filename or URL)
*
* Callback on internal subset declaration.
*/
@@ -259,11 +246,10 @@ xmlSAX2InternalSubset(void *ctx, const xmlChar *name,
}
/**
- * xmlSAX2ExternalSubset:
- * @ctx: the user data (XML parser context)
- * @name: the root element name
- * @ExternalID: the external ID
- * @SystemID: the SYSTEM ID (e.g. filename or URL)
+ * @param ctx the user data (XML parser context)
+ * @param name the root element name
+ * @param ExternalID the external ID
+ * @param SystemID the SYSTEM ID (e.g. filename or URL)
*
* Callback on external subset declaration.
*/
@@ -383,15 +369,14 @@ error:
}
/**
- * xmlSAX2ResolveEntity:
- * @ctx: the user data (XML parser context)
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctx the user data (XML parser context)
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* This is only used to load DTDs. The preferred way to install
* custom resolvers is xmlCtxtSetResourceLoader.
*
- * Returns a parser input.
+ * @returns a parser input.
*/
xmlParserInputPtr
xmlSAX2ResolveEntity(void *ctx, const xmlChar *publicId,
@@ -446,13 +431,12 @@ xmlSAX2ResolveEntity(void *ctx, const xmlChar *publicId,
}
/**
- * xmlSAX2GetEntity:
- * @ctx: the user data (XML parser context)
- * @name: The entity name
+ * @param ctx the user data (XML parser context)
+ * @param name The entity name
*
* Get an entity by name
*
- * Returns the xmlEntityPtr if found.
+ * @returns the xmlEntityPtr if found.
*/
xmlEntityPtr
xmlSAX2GetEntity(void *ctx, const xmlChar *name)
@@ -492,13 +476,12 @@ xmlSAX2GetEntity(void *ctx, const xmlChar *name)
}
/**
- * xmlSAX2GetParameterEntity:
- * @ctx: the user data (XML parser context)
- * @name: The entity name
+ * @param ctx the user data (XML parser context)
+ * @param name The entity name
*
* Get a parameter entity by name
*
- * Returns the xmlEntityPtr if found.
+ * @returns the xmlEntityPtr if found.
*/
xmlEntityPtr
xmlSAX2GetParameterEntity(void *ctx, const xmlChar *name)
@@ -514,13 +497,12 @@ xmlSAX2GetParameterEntity(void *ctx, const xmlChar *name)
/**
- * xmlSAX2EntityDecl:
- * @ctx: the user data (XML parser context)
- * @name: the entity name
- * @type: the entity type
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @content: the entity value (without processing).
+ * @param ctx the user data (XML parser context)
+ * @param name the entity name
+ * @param type the entity type
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param content the entity value (without processing).
*
* An entity definition has been parsed
*/
@@ -608,14 +590,13 @@ xmlSAX2EntityDecl(void *ctx, const xmlChar *name, int type,
}
/**
- * xmlSAX2AttributeDecl:
- * @ctx: the user data (XML parser context)
- * @elem: the name of the element
- * @fullname: the attribute name
- * @type: the attribute type
- * @def: the type of default value
- * @defaultValue: the attribute default value
- * @tree: the tree of enumerated value set
+ * @param ctx the user data (XML parser context)
+ * @param elem the name of the element
+ * @param fullname the attribute name
+ * @param type the attribute type
+ * @param def the type of default value
+ * @param defaultValue the attribute default value
+ * @param tree the tree of enumerated value set
*
* An attribute definition has been parsed
*/
@@ -678,11 +659,10 @@ xmlSAX2AttributeDecl(void *ctx, const xmlChar *elem, const xmlChar *fullname,
}
/**
- * xmlSAX2ElementDecl:
- * @ctx: the user data (XML parser context)
- * @name: the element name
- * @type: the element type
- * @content: the element value tree
+ * @param ctx the user data (XML parser context)
+ * @param name the element name
+ * @param type the element type
+ * @param content the element value tree
*
* An element definition has been parsed
*/
@@ -722,11 +702,10 @@ xmlSAX2ElementDecl(void *ctx, const xmlChar * name, int type,
}
/**
- * xmlSAX2NotationDecl:
- * @ctx: the user data (XML parser context)
- * @name: The name of the notation
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctx the user data (XML parser context)
+ * @param name The name of the notation
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* What to do when a notation declaration has been parsed.
*/
@@ -770,12 +749,11 @@ xmlSAX2NotationDecl(void *ctx, const xmlChar *name,
}
/**
- * xmlSAX2UnparsedEntityDecl:
- * @ctx: the user data (XML parser context)
- * @name: The name of the entity
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @notationName: the name of the notation
+ * @param ctx the user data (XML parser context)
+ * @param name The name of the entity
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param notationName the name of the notation
*
* What to do when an unparsed entity declaration is parsed
*/
@@ -789,9 +767,8 @@ xmlSAX2UnparsedEntityDecl(void *ctx, const xmlChar *name,
}
/**
- * xmlSAX2SetDocumentLocator:
- * @ctx: the user data (XML parser context)
- * @loc: A SAX Locator
+ * @param ctx the user data (XML parser context)
+ * @param loc A SAX Locator
*
* Receive the document locator at startup, actually xmlDefaultSAXLocator
* Everything is available on the context, so this is useless in our case.
@@ -802,8 +779,7 @@ xmlSAX2SetDocumentLocator(void *ctx ATTRIBUTE_UNUSED, xmlSAXLocatorPtr loc ATTRI
}
/**
- * xmlSAX2StartDocument:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* called when the document start being processed.
*/
@@ -853,8 +829,7 @@ xmlSAX2StartDocument(void *ctx)
}
/**
- * xmlSAX2EndDocument:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* called when the document end has been detected.
*/
@@ -921,12 +896,11 @@ xmlSAX2AppendChild(xmlParserCtxtPtr ctxt, xmlNodePtr node) {
#if defined(LIBXML_SAX1_ENABLED)
/**
- * xmlNsErrMsg:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: an error string
- * @str2: an error string
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 an error string
+ * @param str2 an error string
*
* Handle a namespace error
*/
@@ -939,11 +913,10 @@ xmlNsErrMsg(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlSAX1Attribute:
- * @ctxt: the parser context
- * @fullname: the attribute name, including namespace prefix
- * @value: the attribute value
- * @prefix: the namespace prefix
+ * @param ctxt the parser context
+ * @param fullname the attribute name, including namespace prefix
+ * @param value the attribute value
+ * @param prefix the namespace prefix
*
* Handle an attribute that has been read by the parser.
*
@@ -1231,7 +1204,6 @@ error:
}
/*
- * xmlCheckDefaultedAttributes:
*
* Check defaulted attributes from the DTD
*
@@ -1388,10 +1360,9 @@ process_external_subset:
}
/**
- * xmlSAX1StartElement:
- * @ctx: the user data (XML parser context)
- * @fullname: The element name, including namespace prefix
- * @atts: An array of name/value attributes pairs, NULL terminated
+ * @param ctx the user data (XML parser context)
+ * @param fullname The element name, including namespace prefix
+ * @param atts An array of name/value attributes pairs, NULL terminated
*
* called when an opening tag has been processed.
*
@@ -1622,10 +1593,9 @@ xmlSAX2HtmlAttribute(xmlParserCtxtPtr ctxt, const xmlChar *fullname,
}
/**
- * xmlSAX2StartHtmlElement:
- * @ctxt: parser context
- * @fullname: The element name, including namespace prefix
- * @atts: An array of name/value attributes pairs, NULL terminated
+ * @param ctxt parser context
+ * @param fullname The element name, including namespace prefix
+ * @param atts An array of name/value attributes pairs, NULL terminated
*
* Called when an opening tag has been processed.
*/
@@ -1678,12 +1648,11 @@ xmlSAX2StartHtmlElement(xmlParserCtxtPtr ctxt, const xmlChar *fullname,
#endif /* LIBXML_HTML_ENABLED */
/**
- * xmlSAX2StartElement:
- * @ctx: the user data (XML parser context)
- * @fullname: The element name, including namespace prefix
- * @atts: An array of name/value attributes pairs, NULL terminated
+ * @param ctx the user data (XML parser context)
+ * @param fullname The element name, including namespace prefix
+ * @param atts An array of name/value attributes pairs, NULL terminated
*
- * DEPRECATED: Don't call this function directly.
+ * @deprecated Don't call this function directly.
*
* Called when an opening tag has been processed.
*
@@ -1714,11 +1683,10 @@ xmlSAX2StartElement(void *ctx, const xmlChar *fullname, const xmlChar **atts) {
}
/**
- * xmlSAX2EndElement:
- * @ctx: the user data (XML parser context)
- * @name: The element name
+ * @param ctx the user data (XML parser context)
+ * @param name The element name
*
- * DEPRECATED: Don't call this function directly.
+ * @deprecated Don't call this function directly.
*
* called when the end of an element has been detected.
*
@@ -1750,14 +1718,13 @@ xmlSAX2EndElement(void *ctx, const xmlChar *name ATTRIBUTE_UNUSED)
}
/*
- * xmlSAX2TextNode:
- * @ctxt: the parser context
- * @str: the input string
- * @len: the string length
+ * @param ctxt the parser context
+ * @param str the input string
+ * @param len the string length
*
* Callback for a text node
*
- * Returns the newly allocated string or NULL if not needed or error
+ * @returns the newly allocated string or NULL if not needed or error
*/
static xmlNodePtr
xmlSAX2TextNode(xmlParserCtxtPtr ctxt, const xmlChar *str, int len) {
@@ -1837,14 +1804,13 @@ skip:
#ifdef LIBXML_VALID_ENABLED
/*
- * xmlSAX2DecodeAttrEntities:
- * @ctxt: the parser context
- * @str: the input string
- * @len: the string length
+ * @param ctxt the parser context
+ * @param str the input string
+ * @param len the string length
*
* Remove the entities from an attribute value
*
- * Returns the newly allocated string or NULL if not needed or error
+ * @returns the newly allocated string or NULL if not needed or error
*/
static xmlChar *
xmlSAX2DecodeAttrEntities(xmlParserCtxtPtr ctxt, const xmlChar *str,
@@ -1867,19 +1833,18 @@ decode:
#endif /* LIBXML_VALID_ENABLED */
/**
- * xmlSAX2AttributeNs:
- * @ctxt: the parser context
- * @localname: the local name of the attribute
- * @prefix: the attribute namespace prefix if available
- * @value: start of the attribute value
- * @valueend: end of the attribute value
+ * @param ctxt the parser context
+ * @param localname the local name of the attribute
+ * @param prefix the attribute namespace prefix if available
+ * @param value start of the attribute value
+ * @param valueend end of the attribute value
*
* Handle an attribute that has been read by the parser.
* The default handling is to convert the attribute into an
* DOM subtree and past it in a new xmlAttr element added to
* the element.
*
- * Returns the new attribute or NULL in case of error.
+ * @returns the new attribute or NULL in case of error.
*/
static xmlAttrPtr
xmlSAX2AttributeNs(xmlParserCtxtPtr ctxt,
@@ -2100,16 +2065,15 @@ xmlSAX2AttributeNs(xmlParserCtxtPtr ctxt,
}
/**
- * xmlSAX2StartElementNs:
- * @ctx: the user data (XML parser context)
- * @localname: the local name of the element
- * @prefix: the element namespace prefix if available
- * @URI: the element namespace name if available
- * @nb_namespaces: number of namespace definitions on that node
- * @namespaces: pointer to the array of prefix/URI pairs namespace definitions
- * @nb_attributes: the number of attributes on that node
- * @nb_defaulted: the number of defaulted attributes.
- * @attributes: pointer to the array of (localname/prefix/URI/value/end)
+ * @param ctx the user data (XML parser context)
+ * @param localname the local name of the element
+ * @param prefix the element namespace prefix if available
+ * @param URI the element namespace name if available
+ * @param nb_namespaces number of namespace definitions on that node
+ * @param namespaces pointer to the array of prefix/URI pairs namespace definitions
+ * @param nb_attributes the number of attributes on that node
+ * @param nb_defaulted the number of defaulted attributes.
+ * @param attributes pointer to the array of (localname/prefix/URI/value/end)
* attribute values.
*
* SAX2 callback when an element start has been detected by the parser.
@@ -2376,11 +2340,10 @@ have_attr:
}
/**
- * xmlSAX2EndElementNs:
- * @ctx: the user data (XML parser context)
- * @localname: the local name of the element
- * @prefix: the element namespace prefix if available
- * @URI: the element namespace name if available
+ * @param ctx the user data (XML parser context)
+ * @param localname the local name of the element
+ * @param prefix the element namespace prefix if available
+ * @param URI the element namespace name if available
*
* SAX2 callback when an element end has been detected by the parser.
* It provides the namespace information for the element.
@@ -2410,9 +2373,8 @@ xmlSAX2EndElementNs(void *ctx,
}
/**
- * xmlSAX2Reference:
- * @ctx: the user data (XML parser context)
- * @name: The entity name
+ * @param ctx the user data (XML parser context)
+ * @param name The entity name
*
* called when an entity xmlSAX2Reference is detected.
*/
@@ -2433,11 +2395,10 @@ xmlSAX2Reference(void *ctx, const xmlChar *name)
}
/**
- * xmlSAX2Text:
- * @ctxt: the parser context
- * @ch: a xmlChar string
- * @len: the number of xmlChar
- * @type: text or cdata
+ * @param ctxt the parser context
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
+ * @param type text or cdata
*
* Append characters.
*/
@@ -2575,10 +2536,9 @@ xmlSAX2Text(xmlParserCtxtPtr ctxt, const xmlChar *ch, int len,
}
/**
- * xmlSAX2Characters:
- * @ctx: the user data (XML parser context)
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctx the user data (XML parser context)
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some chars from the parser.
*/
@@ -2589,10 +2549,9 @@ xmlSAX2Characters(void *ctx, const xmlChar *ch, int len)
}
/**
- * xmlSAX2IgnorableWhitespace:
- * @ctx: the user data (XML parser context)
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctx the user data (XML parser context)
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some ignorable whitespaces from the parser.
* UNUSED: by default the DOM building will use xmlSAX2Characters
@@ -2603,10 +2562,9 @@ xmlSAX2IgnorableWhitespace(void *ctx ATTRIBUTE_UNUSED, const xmlChar *ch ATTRIBU
}
/**
- * xmlSAX2ProcessingInstruction:
- * @ctx: the user data (XML parser context)
- * @target: the target name
- * @data: the PI data's
+ * @param ctx the user data (XML parser context)
+ * @param target the target name
+ * @param data the PI data's
*
* A processing instruction has been parsed.
*/
@@ -2629,9 +2587,8 @@ xmlSAX2ProcessingInstruction(void *ctx, const xmlChar *target,
}
/**
- * xmlSAX2Comment:
- * @ctx: the user data (XML parser context)
- * @value: the xmlSAX2Comment content
+ * @param ctx the user data (XML parser context)
+ * @param value the xmlSAX2Comment content
*
* A xmlSAX2Comment has been parsed.
*/
@@ -2653,10 +2610,9 @@ xmlSAX2Comment(void *ctx, const xmlChar *value)
}
/**
- * xmlSAX2CDataBlock:
- * @ctx: the user data (XML parser context)
- * @value: The pcdata content
- * @len: the block length
+ * @param ctx the user data (XML parser context)
+ * @param value The pcdata content
+ * @param len the block length
*
* called when a pcdata block has been parsed
*/
@@ -2668,14 +2624,13 @@ xmlSAX2CDataBlock(void *ctx, const xmlChar *value, int len)
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlSAXDefaultVersion:
- * @version: the version, must be 2
+ * @param version the version, must be 2
*
- * DEPRECATED: Use parser option XML_PARSE_SAX1.
+ * @deprecated Use parser option XML_PARSE_SAX1.
*
* Has no effect.
*
- * Returns 2 in case of success and -1 in case of error.
+ * @returns 2 in case of success and -1 in case of error.
*/
int
xmlSAXDefaultVersion(int version)
@@ -2687,13 +2642,12 @@ xmlSAXDefaultVersion(int version)
#endif /* LIBXML_SAX1_ENABLED */
/**
- * xmlSAXVersion:
- * @hdlr: the SAX handler
- * @version: the version, 1 or 2
+ * @param hdlr the SAX handler
+ * @param version the version, 1 or 2
*
* Initialize the default XML SAX handler according to the version
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlSAXVersion(xmlSAXHandler *hdlr, int version)
@@ -2747,9 +2701,8 @@ xmlSAXVersion(xmlSAXHandler *hdlr, int version)
}
/**
- * xmlSAX2InitDefaultSAXHandler:
- * @hdlr: the SAX handler
- * @warning: flag if non-zero sets the handler warning procedure
+ * @param hdlr the SAX handler
+ * @param warning flag if non-zero sets the handler warning procedure
*
* Initialize the default XML SAX2 handler
*/
@@ -2765,9 +2718,8 @@ xmlSAX2InitDefaultSAXHandler(xmlSAXHandler *hdlr, int warning)
}
/**
- * xmlDefaultSAXHandlerInit:
*
- * DEPRECATED: This function is a no-op. Call xmlInitParser to
+ * @deprecated This function is a no-op. Call xmlInitParser to
* initialize the library.
*
* Initialize the default SAX2 handler
@@ -2780,8 +2732,7 @@ xmlDefaultSAXHandlerInit(void)
#ifdef LIBXML_HTML_ENABLED
/**
- * xmlSAX2InitHtmlDefaultSAXHandler:
- * @hdlr: the SAX handler
+ * @param hdlr the SAX handler
*
* Initialize the default HTML SAX2 handler
*/
@@ -2823,9 +2774,8 @@ xmlSAX2InitHtmlDefaultSAXHandler(xmlSAXHandler *hdlr)
}
/**
- * htmlDefaultSAXHandlerInit:
*
- * DEPRECATED: This function is a no-op. Call xmlInitParser to
+ * @deprecated This function is a no-op. Call xmlInitParser to
* initialize the library.
*/
void
diff --git a/buf.c b/buf.c
index c61a463d..c3545c88 100644
--- a/buf.c
+++ b/buf.c
@@ -37,7 +37,6 @@
#define BUF_STATIC(buf) ((buf)->flags & BUF_FLAG_STATIC)
/**
- * xmlBuf:
*
* A buffer structure. The base of the structure is somehow compatible
* with struct _xmlBuffer to limit risks on application which accessed
@@ -87,8 +86,7 @@ struct _xmlBuf {
#endif /* WITH_BUFFER_COMPAT */
/**
- * xmlBufMemoryError:
- * @buf: the buffer
+ * @param buf the buffer
*
* Handle an out of memory condition
* To be improved...
@@ -101,8 +99,7 @@ xmlBufMemoryError(xmlBufPtr buf)
}
/**
- * xmlBufOverflowError:
- * @buf: the buffer
+ * @param buf the buffer
*
* Handle a buffer overflow error
* To be improved...
@@ -115,11 +112,10 @@ xmlBufOverflowError(xmlBufPtr buf)
}
/**
- * xmlBufCreate:
- * @size: initial size of buffer
+ * @param size initial size of buffer
*
* routine to create an XML buffer.
- * returns the new structure.
+ * @returns the new structure.
*/
xmlBufPtr
xmlBufCreate(size_t size) {
@@ -150,19 +146,18 @@ xmlBufCreate(size_t size) {
}
/**
- * xmlBufCreateMem:
- * @mem: a memory area
- * @size: size of the buffer excluding terminator
- * @isStatic: whether the memory area is static
+ * @param mem a memory area
+ * @param size size of the buffer excluding terminator
+ * @param isStatic whether the memory area is static
*
* Create a buffer initialized with memory.
*
- * If @isStatic is set, uses the memory area directly as backing store.
+ * If `isStatic` is set, uses the memory area directly as backing store.
* The memory must be zero-terminated and not be modified for the
* lifetime of the buffer. A static buffer can't be grown, modified or
* detached, but it can be shrunk.
*
- * Returns a new buffer.
+ * @returns a new buffer.
*/
xmlBufPtr
xmlBufCreateMem(const xmlChar *mem, size_t size, int isStatic) {
@@ -204,14 +199,13 @@ xmlBufCreateMem(const xmlChar *mem, size_t size, int isStatic) {
}
/**
- * xmlBufDetach:
- * @buf: the buffer
+ * @param buf the buffer
*
* Remove the string contained in a buffer and give it back to the
* caller. The buffer is reset to an empty content.
* This doesn't work with immutable buffers as they can't be reset.
*
- * Returns the previous string contained by the buffer.
+ * @returns the previous string contained by the buffer.
*/
xmlChar *
xmlBufDetach(xmlBufPtr buf) {
@@ -237,8 +231,7 @@ xmlBufDetach(xmlBufPtr buf) {
}
/**
- * xmlBufFree:
- * @buf: the buffer to free
+ * @param buf the buffer to free
*
* Frees an XML buffer. It frees both the content and the structure which
* encapsulate it.
@@ -254,8 +247,7 @@ xmlBufFree(xmlBufPtr buf) {
}
/**
- * xmlBufEmpty:
- * @buf: the buffer
+ * @param buf the buffer
*
* empty a buffer.
*/
@@ -276,18 +268,17 @@ xmlBufEmpty(xmlBufPtr buf) {
}
/**
- * xmlBufShrink:
- * @buf: the buffer to dump
- * @len: the number of xmlChar to remove
+ * @param buf the buffer to dump
+ * @param len the number of xmlChar to remove
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Remove the beginning of an XML buffer.
* NOTE that this routine behaviour differs from xmlBufferShrink()
* as it will return 0 on error instead of -1 due to size_t being
* used as the return type.
*
- * Returns the number of byte removed or 0 in case of failure
+ * @returns the number of byte removed or 0 in case of failure
*/
size_t
xmlBufShrink(xmlBufPtr buf, size_t len) {
@@ -309,13 +300,12 @@ xmlBufShrink(xmlBufPtr buf, size_t len) {
}
/**
- * xmlBufGrowInternal:
- * @buf: the buffer
- * @len: the minimum free size to allocate
+ * @param buf the buffer
+ * @param len the minimum free size to allocate
*
- * Grow the available space of an XML buffer, @len is the target value
+ * Grow the available space of an XML buffer, `len` is the target value
*
- * Returns 0 on success, -1 in case of error
+ * @returns 0 on success, -1 in case of error
*/
static int
xmlBufGrowInternal(xmlBufPtr buf, size_t len) {
@@ -376,14 +366,13 @@ xmlBufGrowInternal(xmlBufPtr buf, size_t len) {
}
/**
- * xmlBufGrow:
- * @buf: the buffer
- * @len: the minimum free size to allocate
+ * @param buf the buffer
+ * @param len the minimum free size to allocate
*
- * Grow the available space of an XML buffer, @len is the target value
+ * Grow the available space of an XML buffer, `len` is the target value
* This is been kept compatible with xmlBufferGrow() as much as possible
*
- * Returns 0 on succes, -1 in case of error
+ * @returns 0 on succes, -1 in case of error
*/
int
xmlBufGrow(xmlBufPtr buf, size_t len) {
@@ -402,12 +391,11 @@ xmlBufGrow(xmlBufPtr buf, size_t len) {
}
/**
- * xmlBufContent:
- * @buf: the buffer
+ * @param buf the buffer
*
* Function to extract the content of a buffer
*
- * Returns the internal content
+ * @returns the internal content
*/
xmlChar *
@@ -420,12 +408,11 @@ xmlBufContent(const xmlBuf *buf)
}
/**
- * xmlBufEnd:
- * @buf: the buffer
+ * @param buf the buffer
*
* Function to extract the end of the content of a buffer
*
- * Returns the end of the internal content or NULL in case of error
+ * @returns the end of the internal content or NULL in case of error
*/
xmlChar *
@@ -439,15 +426,14 @@ xmlBufEnd(xmlBufPtr buf)
}
/**
- * xmlBufAddLen:
- * @buf: the buffer
- * @len: the size which were added at the end
+ * @param buf the buffer
+ * @param len the size which were added at the end
*
* Sometime data may be added at the end of the buffer without
* using the xmlBuf APIs that is used to expand the used space
* and set the zero terminating at the end of the buffer
*
- * Returns -1 in case of error and 0 otherwise
+ * @returns -1 in case of error and 0 otherwise
*/
int
xmlBufAddLen(xmlBufPtr buf, size_t len) {
@@ -463,12 +449,11 @@ xmlBufAddLen(xmlBufPtr buf, size_t len) {
}
/**
- * xmlBufUse:
- * @buf: the buffer
+ * @param buf the buffer
*
* Function to get the length of a buffer
*
- * Returns the length of data in the internal content
+ * @returns the length of data in the internal content
*/
size_t
@@ -482,15 +467,14 @@ xmlBufUse(const xmlBufPtr buf)
}
/**
- * xmlBufAvail:
- * @buf: the buffer
+ * @param buf the buffer
*
* Function to find how much free space is allocated but not
* used in the buffer. It reserves one byte for the NUL
* terminator character that is usually needed, so there is
* no need to subtract 1 from the result anymore.
*
- * Returns the amount, or 0 if none or if an error occurred.
+ * @returns the amount, or 0 if none or if an error occurred.
*/
size_t
@@ -504,12 +488,11 @@ xmlBufAvail(const xmlBufPtr buf)
}
/**
- * xmlBufIsEmpty:
- * @buf: the buffer
+ * @param buf the buffer
*
* Tell if a buffer is empty
*
- * Returns 0 if no, 1 if yes and -1 in case of error
+ * @returns 0 if no, 1 if yes and -1 in case of error
*/
int
xmlBufIsEmpty(const xmlBufPtr buf)
@@ -522,15 +505,14 @@ xmlBufIsEmpty(const xmlBufPtr buf)
}
/**
- * xmlBufAdd:
- * @buf: the buffer to dump
- * @str: the #xmlChar string
- * @len: the number of #xmlChar to add
+ * @param buf the buffer to dump
+ * @param str the \#xmlChar string
+ * @param len the number of \#xmlChar to add
*
* Add a string range to an XML buffer. if len == -1, the length of
* str is recomputed.
*
- * Returns 0 if successful, -1 in case of error.
+ * @returns 0 if successful, -1 in case of error.
*/
int
xmlBufAdd(xmlBufPtr buf, const xmlChar *str, size_t len) {
@@ -556,13 +538,12 @@ xmlBufAdd(xmlBufPtr buf, const xmlChar *str, size_t len) {
}
/**
- * xmlBufCat:
- * @buf: the buffer to add to
- * @str: the #xmlChar string (optional)
+ * @param buf the buffer to add to
+ * @param str the \#xmlChar string (optional)
*
* Append a zero terminated string to an XML buffer.
*
- * Returns 0 successful, a positive error code number otherwise
+ * @returns 0 successful, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -573,15 +554,14 @@ xmlBufCat(xmlBufPtr buf, const xmlChar *str) {
}
/**
- * xmlBufFromBuffer:
- * @buffer: incoming old buffer to convert to a new one
+ * @param buffer incoming old buffer to convert to a new one
*
* Helper routine to switch from the old buffer structures in use
* in various APIs. It creates a wrapper xmlBufPtr which will be
* used for internal processing until the xmlBufBackToBuffer() is
* issued.
*
- * Returns a new xmlBufPtr unless the call failed and NULL is returned
+ * @returns a new xmlBufPtr unless the call failed and NULL is returned
*/
xmlBufPtr
xmlBufFromBuffer(xmlBufferPtr buffer) {
@@ -620,17 +600,16 @@ xmlBufFromBuffer(xmlBufferPtr buffer) {
}
/**
- * xmlBufBackToBuffer:
- * @buf: new buffer wrapping the old one
- * @ret: old buffer
+ * @param buf new buffer wrapping the old one
+ * @param ret old buffer
*
* Function to be called once internal processing had been done to
* update back the buffer provided by the user. This can lead to
* a failure in case the size accumulated in the xmlBuf is larger
* than what an xmlBuffer can support on 64 bits (INT_MAX)
- * The xmlBufPtr @buf wrapper is deallocated by this call in any case.
+ * The xmlBufPtr `buf` wrapper is deallocated by this call in any case.
*
- * Returns 0 on success, -1 on error.
+ * @returns 0 on success, -1 on error.
*/
int
xmlBufBackToBuffer(xmlBufPtr buf, xmlBufferPtr ret) {
@@ -662,13 +641,12 @@ xmlBufBackToBuffer(xmlBufPtr buf, xmlBufferPtr ret) {
}
/**
- * xmlBufResetInput:
- * @buf: an xmlBufPtr
- * @input: an xmlParserInputPtr
+ * @param buf an xmlBufPtr
+ * @param input an xmlParserInputPtr
*
* Update the input to use the current set of pointers from the buffer.
*
- * Returns -1 in case of error, 0 otherwise
+ * @returns -1 in case of error, 0 otherwise
*/
int
xmlBufResetInput(xmlBufPtr buf, xmlParserInputPtr input) {
@@ -676,15 +654,14 @@ xmlBufResetInput(xmlBufPtr buf, xmlParserInputPtr input) {
}
/**
- * xmlBufUpdateInput:
- * @buf: an xmlBufPtr
- * @input: an xmlParserInputPtr
- * @pos: the cur value relative to the beginning of the buffer
+ * @param buf an xmlBufPtr
+ * @param input an xmlParserInputPtr
+ * @param pos the cur value relative to the beginning of the buffer
*
* Update the input to use the base and cur relative to the buffer
* after a possible reallocation of its content
*
- * Returns -1 in case of error, 0 otherwise
+ * @returns -1 in case of error, 0 otherwise
*/
int
xmlBufUpdateInput(xmlBufPtr buf, xmlParserInputPtr input, size_t pos) {
@@ -704,10 +681,9 @@ xmlBufUpdateInput(xmlBufPtr buf, xmlParserInputPtr input, size_t pos) {
************************************************************************/
/**
- * xmlSetBufferAllocationScheme:
- * @scheme: allocation method to use
+ * @param scheme allocation method to use
*
- * DEPRECATED: Use xmlBufferSetAllocationScheme.
+ * @deprecated Use xmlBufferSetAllocationScheme.
*
* Set the buffer allocation method. Types are
* XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down
@@ -719,9 +695,8 @@ xmlSetBufferAllocationScheme(xmlBufferAllocationScheme scheme ATTRIBUTE_UNUSED)
}
/**
- * xmlGetBufferAllocationScheme:
*
- * DEPRECATED: Use xmlBufferSetAllocationScheme.
+ * @deprecated Use xmlBufferSetAllocationScheme.
*
* Types are
* XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down
@@ -731,7 +706,7 @@ xmlSetBufferAllocationScheme(xmlBufferAllocationScheme scheme ATTRIBUTE_UNUSED)
* in normal usage, and doubleit on large strings to avoid
* pathological performance.
*
- * Returns the current allocation scheme
+ * @returns the current allocation scheme
*/
xmlBufferAllocationScheme
xmlGetBufferAllocationScheme(void) {
@@ -739,10 +714,9 @@ xmlGetBufferAllocationScheme(void) {
}
/**
- * xmlBufferCreate:
*
* routine to create an XML buffer.
- * returns the new structure.
+ * @returns the new structure.
*/
xmlBufferPtr
xmlBufferCreate(void) {
@@ -767,11 +741,10 @@ xmlBufferCreate(void) {
}
/**
- * xmlBufferCreateSize:
- * @size: initial size of buffer
+ * @param size initial size of buffer
*
* routine to create an XML buffer.
- * returns the new structure.
+ * @returns the new structure.
*/
xmlBufferPtr
xmlBufferCreateSize(size_t size) {
@@ -805,14 +778,13 @@ xmlBufferCreateSize(size_t size) {
}
/**
- * xmlBufferDetach:
- * @buf: the buffer
+ * @param buf the buffer
*
* Remove the string contained in a buffer and gie it back to the
* caller. The buffer is reset to an empty content.
* This doesn't work with immutable buffers as they can't be reset.
*
- * Returns the previous string contained by the buffer.
+ * @returns the previous string contained by the buffer.
*/
xmlChar *
xmlBufferDetach(xmlBufferPtr buf) {
@@ -838,11 +810,10 @@ xmlBufferDetach(xmlBufferPtr buf) {
}
/**
- * xmlBufferCreateStatic:
- * @mem: the memory area
- * @size: the size in byte
+ * @param mem the memory area
+ * @param size the size in byte
*
- * Returns an XML buffer initialized with bytes.
+ * @returns an XML buffer initialized with bytes.
*/
xmlBufferPtr
xmlBufferCreateStatic(void *mem, size_t size) {
@@ -853,9 +824,8 @@ xmlBufferCreateStatic(void *mem, size_t size) {
}
/**
- * xmlBufferSetAllocationScheme:
- * @buf: the buffer to tune
- * @scheme: allocation scheme to use
+ * @param buf the buffer to tune
+ * @param scheme allocation scheme to use
*
* Sets the allocation scheme for this buffer.
*
@@ -868,8 +838,7 @@ xmlBufferSetAllocationScheme(xmlBufferPtr buf ATTRIBUTE_UNUSED,
}
/**
- * xmlBufferFree:
- * @buf: the buffer to free
+ * @param buf the buffer to free
*
* Frees an XML buffer. It frees both the content and the structure which
* encapsulate it.
@@ -888,8 +857,7 @@ xmlBufferFree(xmlBufferPtr buf) {
}
/**
- * xmlBufferEmpty:
- * @buf: the buffer
+ * @param buf the buffer
*
* empty a buffer.
*/
@@ -912,15 +880,14 @@ xmlBufferEmpty(xmlBufferPtr buf) {
}
/**
- * xmlBufferShrink:
- * @buf: the buffer to dump
- * @len: the number of xmlChar to remove
+ * @param buf the buffer to dump
+ * @param len the number of xmlChar to remove
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Remove the beginning of an XML buffer.
*
- * Returns the number of #xmlChar removed, or -1 in case of failure.
+ * @returns the number of \#xmlChar removed, or -1 in case of failure.
*/
int
xmlBufferShrink(xmlBufferPtr buf, unsigned int len) {
@@ -944,15 +911,14 @@ xmlBufferShrink(xmlBufferPtr buf, unsigned int len) {
}
/**
- * xmlBufferGrow:
- * @buf: the buffer
- * @len: the minimum free size to allocate
+ * @param buf the buffer
+ * @param len the minimum free size to allocate
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Grow the available space of an XML buffer.
*
- * Returns the new available space or -1 in case of error
+ * @returns the new available space or -1 in case of error
*/
int
xmlBufferGrow(xmlBufferPtr buf, unsigned int len) {
@@ -1001,12 +967,11 @@ xmlBufferGrow(xmlBufferPtr buf, unsigned int len) {
}
/**
- * xmlBufferDump:
- * @file: the file output
- * @buf: the buffer to dump
+ * @param file the file output
+ * @param buf the buffer to dump
*
* Dumps an XML buffer to a FILE *.
- * Returns the number of #xmlChar written
+ * @returns the number of \#xmlChar written
*/
int
xmlBufferDump(FILE *file, xmlBufferPtr buf) {
@@ -1023,12 +988,11 @@ xmlBufferDump(FILE *file, xmlBufferPtr buf) {
}
/**
- * xmlBufferContent:
- * @buf: the buffer
+ * @param buf the buffer
*
* Function to extract the content of a buffer
*
- * Returns the internal content
+ * @returns the internal content
*/
const xmlChar *
@@ -1041,12 +1005,11 @@ xmlBufferContent(const xmlBuffer *buf)
}
/**
- * xmlBufferLength:
- * @buf: the buffer
+ * @param buf the buffer
*
* Function to get the length of a buffer
*
- * Returns the length of data in the internal content
+ * @returns the length of data in the internal content
*/
int
@@ -1059,15 +1022,14 @@ xmlBufferLength(const xmlBuffer *buf)
}
/**
- * xmlBufferResize:
- * @buf: the buffer to resize
- * @size: the desired size
+ * @param buf the buffer to resize
+ * @param size the desired size
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
- * Resize a buffer to accommodate minimum size of @size.
+ * Resize a buffer to accommodate minimum size of `size`.
*
- * Returns 0 in case of problems, 1 otherwise
+ * @returns 0 in case of problems, 1 otherwise
*/
int
xmlBufferResize(xmlBufferPtr buf, unsigned int size)
@@ -1084,15 +1046,14 @@ xmlBufferResize(xmlBufferPtr buf, unsigned int size)
}
/**
- * xmlBufferAdd:
- * @buf: the buffer to dump
- * @str: the #xmlChar string
- * @len: the number of #xmlChar to add
+ * @param buf the buffer to dump
+ * @param str the \#xmlChar string
+ * @param len the number of \#xmlChar to add
*
* Add a string range to an XML buffer. if len == -1, the length of
* str is recomputed.
*
- * Returns a xmlParserErrors code.
+ * @returns a xmlParserErrors code.
*/
int
xmlBufferAdd(xmlBufferPtr buf, const xmlChar *str, int len) {
@@ -1116,15 +1077,14 @@ xmlBufferAdd(xmlBufferPtr buf, const xmlChar *str, int len) {
}
/**
- * xmlBufferAddHead:
- * @buf: the buffer
- * @str: the #xmlChar string
- * @len: the number of #xmlChar to add
+ * @param buf the buffer
+ * @param str the \#xmlChar string
+ * @param len the number of \#xmlChar to add
*
* Add a string range to the beginning of an XML buffer.
- * if len == -1, the length of @str is recomputed.
+ * if len == -1, the length of `str` is recomputed.
*
- * Returns a xmlParserErrors code.
+ * @returns a xmlParserErrors code.
*/
int
xmlBufferAddHead(xmlBufferPtr buf, const xmlChar *str, int len) {
@@ -1172,13 +1132,12 @@ xmlBufferAddHead(xmlBufferPtr buf, const xmlChar *str, int len) {
}
/**
- * xmlBufferCat:
- * @buf: the buffer to add to
- * @str: the #xmlChar string
+ * @param buf the buffer to add to
+ * @param str the \#xmlChar string
*
* Append a zero terminated string to an XML buffer.
*
- * Returns 0 successful, a positive error code number otherwise
+ * @returns 0 successful, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -1187,13 +1146,12 @@ xmlBufferCat(xmlBufferPtr buf, const xmlChar *str) {
}
/**
- * xmlBufferCCat:
- * @buf: the buffer to dump
- * @str: the C char string
+ * @param buf the buffer to dump
+ * @param str the C char string
*
* Append a zero terminated C string to an XML buffer.
*
- * Returns 0 successful, a positive error code number otherwise
+ * @returns 0 successful, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -1202,9 +1160,8 @@ xmlBufferCCat(xmlBufferPtr buf, const char *str) {
}
/**
- * xmlBufferWriteCHAR:
- * @buf: the XML buffer
- * @string: the string to add
+ * @param buf the XML buffer
+ * @param string the string to add
*
* routine which manages and grows an output buffer. This one adds
* xmlChars at the end of the buffer.
@@ -1215,9 +1172,8 @@ xmlBufferWriteCHAR(xmlBufferPtr buf, const xmlChar *string) {
}
/**
- * xmlBufferWriteChar:
- * @buf: the XML buffer output
- * @string: the string to add
+ * @param buf the XML buffer output
+ * @param string the string to add
*
* routine which manage and grows an output buffer. This one add
* C chars at the end of the array.
@@ -1229,12 +1185,11 @@ xmlBufferWriteChar(xmlBufferPtr buf, const char *string) {
/**
- * xmlBufferWriteQuotedString:
- * @buf: the XML buffer output
- * @string: the string to add
+ * @param buf the XML buffer output
+ * @param string the string to add
*
* routine which manage and grows an output buffer. This one writes
- * a quoted or double quoted #xmlChar string, checking first if it holds
+ * a quoted or double quoted \#xmlChar string, checking first if it holds
* quote or double-quotes internally
*/
void
diff --git a/c14n.c b/c14n.c
index 6a9bebea..d0c9e3f7 100644
--- a/c14n.c
+++ b/c14n.c
@@ -129,8 +129,7 @@ static xmlChar *xmlC11NNormalizeString(const xmlChar * input,
************************************************************************/
/**
- * xmlC14NErrMemory:
- * @ctxt: a C14N evaluation context
+ * @param ctxt a C14N evaluation context
*
* Handle a redefinition of memory error
*/
@@ -164,8 +163,7 @@ xmlC14NErrFull(xmlC14NCtxPtr ctxt, xmlNodePtr node, int code, const char *str1,
}
/**
- * xmlC14NErrParam:
- * @ctxt: a C14N evaluation context
+ * @param ctxt a C14N evaluation context
*
* Handle a param error
*/
@@ -177,10 +175,9 @@ xmlC14NErrParam(xmlC14NCtxPtr ctxt)
}
/**
- * xmlC14NErrInvalidNode:
- * @ctxt: a C14N evaluation context
- * @node_type: node type
- * @extra: extra information
+ * @param ctxt a C14N evaluation context
+ * @param node_type node type
+ * @param extra extra information
*
* Handle an invalid node error
*/
@@ -193,10 +190,9 @@ xmlC14NErrInvalidNode(xmlC14NCtxPtr ctxt, const char *node_type,
}
/**
- * xmlC14NErrUnknownNode:
- * @ctxt: a C14N evaluation context
- * @node_type: node type
- * @extra: extra information
+ * @param ctxt a C14N evaluation context
+ * @param node_type node type
+ * @param extra extra information
*
* Handle an unknown node error
*/
@@ -208,9 +204,8 @@ xmlC14NErrUnknownNode(xmlC14NCtxPtr ctxt, int node_type, const char *extra)
}
/**
- * xmlC14NErrRelativeNamespace:
- * @ctxt: a C14N evaluation context
- * @ns_uri: namespace URI
+ * @param ctxt a C14N evaluation context
+ * @param ns_uri namespace URI
*
* Handle a relative namespace error
*/
@@ -224,11 +219,10 @@ xmlC14NErrRelativeNamespace(xmlC14NCtxPtr ctxt, const char *ns_uri)
/**
- * xmlC14NErr:
- * @ctxt: a C14N evaluation context
- * @node: the context node
- * @error: the error code
- * @msg: the message
+ * @param ctxt a C14N evaluation context
+ * @param node the context node
+ * @param error the error code
+ * @param msg the message
*
* Handle an error
*/
@@ -385,13 +379,12 @@ xmlC14NStrEqual(const xmlChar *str1, const xmlChar *str2) {
}
/**
- * xmlC14NVisibleNsStackFind:
- * @cur: the visible stack
- * @ns: the namespace to check
+ * @param cur the visible stack
+ * @param ns the namespace to check
*
* Checks whether the given namespace was already rendered or not
*
- * Returns 1 if we already wrote this namespace or 0 otherwise
+ * @returns 1 if we already wrote this namespace or 0 otherwise
*/
static int
xmlC14NVisibleNsStackFind(xmlC14NVisibleNsStackPtr cur, xmlNsPtr ns)
@@ -468,13 +461,12 @@ xmlExcC14NVisibleNsStackFind(xmlC14NVisibleNsStackPtr cur, xmlNsPtr ns, xmlC14NC
/**
- * xmlC14NIsXmlNs:
- * @ns: the namespace to check
+ * @param ns the namespace to check
*
* Checks whether the given namespace is a default "xml:" namespace
* with href="http://www.w3.org/XML/1998/namespace"
*
- * Returns 1 if the node is default or 0 otherwise
+ * @returns 1 if the node is default or 0 otherwise
*/
/* todo: make it a define? */
@@ -488,13 +480,12 @@ xmlC14NIsXmlNs(xmlNsPtr ns)
/**
- * xmlC14NNsCompare:
- * @data1: the pointer to first namespace
- * @data2: the pointer to second namespace
+ * @param data1 the pointer to first namespace
+ * @param data2 the pointer to second namespace
*
* Compares the namespaces by names (prefixes).
*
- * Returns -1 if ns1 < ns2, 0 if ns1 == ns2 or 1 if ns1 > ns2.
+ * @returns -1 if ns1 < ns2, 0 if ns1 == ns2 or 1 if ns1 > ns2.
*/
static int
xmlC14NNsCompare(const void *data1, const void *data2)
@@ -513,13 +504,12 @@ xmlC14NNsCompare(const void *data1, const void *data2)
/**
- * xmlC14NPrintNamespaces:
- * @ns: the pointer to namespace
- * @ctx: the C14N context
+ * @param ns the pointer to namespace
+ * @param ctx the C14N context
*
* Prints the given namespace to the output buffer from C14N context.
*
- * Returns 1 on success or 0 on fail.
+ * @returns 1 on success or 0 on fail.
*/
static int
xmlC14NPrintNamespaces(const xmlNs *ns, xmlC14NCtxPtr ctx)
@@ -551,10 +541,9 @@ xmlC14NPrintNamespacesWalker(const void *ns, void *ctx) {
}
/**
- * xmlC14NProcessNamespacesAxis:
- * @ctx: the C14N context
- * @cur: the current node
- * @visible: the visibility of node
+ * @param ctx the C14N context
+ * @param cur the current node
+ * @param visible the visibility of node
*
* Prints out canonical namespace axis of the current node to the
* buffer from C14N context as follows
@@ -588,7 +577,7 @@ xmlC14NPrintNamespacesWalker(const void *ns, void *ctx) {
* the document subset). This search and copying are omitted from the
* Exclusive XML Canonicalization method.
*
- * Returns 0 on success or -1 on fail.
+ * @returns 0 on success or -1 on fail.
*/
static int
xmlC14NProcessNamespacesAxis(xmlC14NCtxPtr ctx, xmlNodePtr cur, int visible)
@@ -670,10 +659,9 @@ error:
/**
- * xmlExcC14NProcessNamespacesAxis:
- * @ctx: the C14N context
- * @cur: the current node
- * @visible: the visibility of node
+ * @param ctx the C14N context
+ * @param cur the current node
+ * @param visible the visibility of node
*
* Prints out exclusive canonical namespace axis of the current node to the
* buffer from C14N context as follows
@@ -698,7 +686,7 @@ error:
* 3. After the recursion returns, pop thestate stack.
*
*
- * Returns 0 on success or -1 on fail.
+ * @returns 0 on success or -1 on fail.
*/
static int
xmlExcC14NProcessNamespacesAxis(xmlC14NCtxPtr ctx, xmlNodePtr cur, int visible)
@@ -858,13 +846,12 @@ error:
/**
- * xmlC14NIsXmlAttr:
- * @attr: the attr to check
+ * @param attr the attr to check
*
* Checks whether the given attribute is a default "xml:" namespace
* with href="http://www.w3.org/XML/1998/namespace"
*
- * Returns 1 if the node is default or 0 otherwise
+ * @returns 1 if the node is default or 0 otherwise
*/
/* todo: make it a define? */
@@ -877,13 +864,12 @@ xmlC14NIsXmlAttr(xmlAttrPtr attr)
/**
- * xmlC14NAttrsCompare:
- * @data1: the pointer tls o first attr
- * @data2: the pointer to second attr
+ * @param data1 the pointer tls o first attr
+ * @param data2 the pointer to second attr
*
* Prints the given attribute to the output buffer from C14N context.
*
- * Returns -1 if attr1 < attr2, 0 if attr1 == attr2 or 1 if attr1 > attr2.
+ * @returns -1 if attr1 < attr2, 0 if attr1 == attr2 or 1 if attr1 > attr2.
*/
static int
xmlC14NAttrsCompare(const void *data1, const void *data2)
@@ -928,16 +914,15 @@ xmlC14NAttrsCompare(const void *data1, const void *data2)
/**
- * xmlC14NPrintAttrs:
- * @data: the pointer to attr
- * @user: the C14N context
+ * @param data the pointer to attr
+ * @param user the C14N context
*
* Prints out canonical attribute urrent node to the
* buffer from C14N context as follows
*
* Canonical XML v 1.0 (http://www.w3.org/TR/xml-c14n)
*
- * Returns 1 on success or 0 on fail.
+ * @returns 1 on success or 0 on fail.
*/
static int
xmlC14NPrintAttrs(const void *data, void *user)
@@ -979,11 +964,10 @@ xmlC14NPrintAttrs(const void *data, void *user)
}
/**
- * xmlC14NFindHiddenParentAttr:
*
* Finds an attribute in a hidden parent node.
*
- * Returns a pointer to the attribute node (if found) or NULL otherwise.
+ * @returns a pointer to the attribute node (if found) or NULL otherwise.
*/
static xmlAttrPtr
xmlC14NFindHiddenParentAttr(xmlC14NCtxPtr ctx, xmlNodePtr cur, const xmlChar * name, const xmlChar * ns)
@@ -1002,11 +986,10 @@ xmlC14NFindHiddenParentAttr(xmlC14NCtxPtr ctx, xmlNodePtr cur, const xmlChar * n
}
/**
- * xmlC14NFixupBaseAttr:
*
* Fixes up the xml:base attribute
*
- * Returns the newly created attribute or NULL
+ * @returns the newly created attribute or NULL
*/
static xmlAttrPtr
xmlC14NFixupBaseAttr(xmlC14NCtxPtr ctx, xmlAttrPtr xml_base_attr)
@@ -1108,10 +1091,9 @@ xmlC14NFixupBaseAttr(xmlC14NCtxPtr ctx, xmlAttrPtr xml_base_attr)
}
/**
- * xmlC14NProcessAttrsAxis:
- * @ctx: the C14N context
- * @cur: the current node
- * @parent_visible: the visibility of the parent node
+ * @param ctx the C14N context
+ * @param cur the current node
+ * @param parent_visible the visibility of the parent node
*
* Prints out canonical attribute axis of the current node to the
* buffer from C14N context as follows
@@ -1137,7 +1119,7 @@ xmlC14NFixupBaseAttr(xmlC14NCtxPtr ctx, xmlAttrPtr xml_base_attr)
* the document subset). This search and copying are omitted from the
* Exclusive XML Canonicalization method.
*
- * Returns 0 on success or -1 on fail.
+ * @returns 0 on success or -1 on fail.
*/
static int
xmlC14NProcessAttrsAxis(xmlC14NCtxPtr ctx, xmlNodePtr cur, int parent_visible)
@@ -1359,13 +1341,12 @@ xmlC14NProcessAttrsAxis(xmlC14NCtxPtr ctx, xmlNodePtr cur, int parent_visible)
}
/**
- * xmlC14NCheckForRelativeNamespaces:
- * @ctx: the C14N context
- * @cur: the current element node
+ * @param ctx the C14N context
+ * @param cur the current element node
*
* Checks that current element node has no relative namespaces defined
*
- * Returns 0 if the node has no relative namespaces or -1 otherwise.
+ * @returns 0 if the node has no relative namespaces or -1 otherwise.
*/
static int
xmlC14NCheckForRelativeNamespaces(xmlC14NCtxPtr ctx, xmlNodePtr cur)
@@ -1405,10 +1386,9 @@ xmlC14NCheckForRelativeNamespaces(xmlC14NCtxPtr ctx, xmlNodePtr cur)
}
/**
- * xmlC14NProcessElementNode:
- * @ctx: the pointer to C14N context object
- * @cur: the node to process
- * @visible: this node is visible
+ * @param ctx the pointer to C14N context object
+ * @param cur the node to process
+ * @param visible this node is visible
*
* Canonical XML v 1.0 (http://www.w3.org/TR/xml-c14n)
*
@@ -1424,7 +1404,7 @@ xmlC14NCheckForRelativeNamespaces(xmlC14NCtxPtr ctx, xmlNodePtr cur)
* open angle bracket, a forward slash (/), the element QName, and a close
* angle bracket.
*
- * Returns non-negative value on success or negative value on fail
+ * @returns non-negative value on success or negative value on fail
*/
static int
xmlC14NProcessElementNode(xmlC14NCtxPtr ctx, xmlNodePtr cur, int visible)
@@ -1517,13 +1497,12 @@ xmlC14NProcessElementNode(xmlC14NCtxPtr ctx, xmlNodePtr cur, int visible)
}
/**
- * xmlC14NProcessNode:
- * @ctx: the pointer to C14N context object
- * @cur: the node to process
+ * @param ctx the pointer to C14N context object
+ * @param cur the node to process
*
* Processes the given node
*
- * Returns non-negative value on success or negative value on fail
+ * @returns non-negative value on success or negative value on fail
*/
static int
xmlC14NProcessNode(xmlC14NCtxPtr ctx, xmlNodePtr cur)
@@ -1705,13 +1684,12 @@ xmlC14NProcessNode(xmlC14NCtxPtr ctx, xmlNodePtr cur)
}
/**
- * xmlC14NProcessNodeList:
- * @ctx: the pointer to C14N context object
- * @cur: the node to start from
+ * @param ctx the pointer to C14N context object
+ * @param cur the node to start from
*
* Processes all nodes in the row starting from cur.
*
- * Returns non-negative value on success or negative value on fail
+ * @returns non-negative value on success or negative value on fail
*/
static int
xmlC14NProcessNodeList(xmlC14NCtxPtr ctx, xmlNodePtr cur)
@@ -1731,8 +1709,7 @@ xmlC14NProcessNodeList(xmlC14NCtxPtr ctx, xmlNodePtr cur)
/**
- * xmlC14NFreeCtx:
- * @ctx: the pointer to C14N context object
+ * @param ctx the pointer to C14N context object
*
* Cleanups the C14N context object.
*/
@@ -1752,25 +1729,24 @@ xmlC14NFreeCtx(xmlC14NCtxPtr ctx)
}
/**
- * xmlC14NNewCtx:
- * @doc: the XML document for canonization
- * @is_visible_callback:the function to use to determine is node visible
+ * @param doc the XML document for canonization
+ * @param is_visible_callback the function to use to determine is node visible
* or not
- * @user_data: the first parameter for @is_visible_callback function
+ * @param user_data the first parameter for `is_visible_callback` function
* (in most cases, it is nodes set)
- * @mode: the c14n mode (see @xmlC14NMode)
- * @inclusive_ns_prefixes: the list of inclusive namespace prefixes
+ * @param mode the c14n mode (see `xmlC14NMode`)
+ * @param inclusive_ns_prefixes the list of inclusive namespace prefixes
* ended with a NULL or NULL if there is no
* inclusive namespaces (only for `
* canonicalization)
- * @with_comments: include comments in the result (!=0) or not (==0)
- * @buf: the output buffer to store canonical XML; this
+ * @param with_comments include comments in the result (!=0) or not (==0)
+ * @param buf the output buffer to store canonical XML; this
* buffer MUST have encoder==NULL because C14N requires
* UTF-8 output
*
* Creates new C14N context object to store C14N parameters.
*
- * Returns pointer to newly created object (success) or NULL (fail)
+ * @returns pointer to newly created object (success) or NULL (fail)
*/
static xmlC14NCtxPtr
xmlC14NNewCtx(xmlDocPtr doc,
@@ -1835,19 +1811,18 @@ xmlC14NNewCtx(xmlDocPtr doc,
}
/**
- * xmlC14NExecute:
- * @doc: the XML document for canonization
- * @is_visible_callback:the function to use to determine is node visible
+ * @param doc the XML document for canonization
+ * @param is_visible_callback the function to use to determine is node visible
* or not
- * @user_data: the first parameter for @is_visible_callback function
+ * @param user_data the first parameter for `is_visible_callback` function
* (in most cases, it is nodes set)
- * @mode: the c14n mode (see @xmlC14NMode)
- * @inclusive_ns_prefixes: the list of inclusive namespace prefixes
+ * @param mode the c14n mode (see `xmlC14NMode`)
+ * @param inclusive_ns_prefixes the list of inclusive namespace prefixes
* ended with a NULL or NULL if there is no
* inclusive namespaces (only for exclusive
* canonicalization, ignored otherwise)
- * @with_comments: include comments in the result (!=0) or not (==0)
- * @buf: the output buffer to store canonical XML; this
+ * @param with_comments include comments in the result (!=0) or not (==0)
+ * @param buf the output buffer to store canonical XML; this
* buffer MUST have encoder==NULL because C14N requires
* UTF-8 output
*
@@ -1855,7 +1830,7 @@ xmlC14NNewCtx(xmlDocPtr doc,
* For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
* "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
*
- * Returns non-negative value on success or a negative value on fail
+ * @returns non-negative value on success or a negative value on fail
*/
int
xmlC14NExecute(xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback,
@@ -1938,17 +1913,16 @@ xmlC14NExecute(xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback,
}
/**
- * xmlC14NDocSaveTo:
- * @doc: the XML document for canonization
- * @nodes: the nodes set to be included in the canonized image
+ * @param doc the XML document for canonization
+ * @param nodes the nodes set to be included in the canonized image
* or NULL if all document nodes should be included
- * @mode: the c14n mode (see @xmlC14NMode)
- * @inclusive_ns_prefixes: the list of inclusive namespace prefixes
+ * @param mode the c14n mode (see `xmlC14NMode`)
+ * @param inclusive_ns_prefixes the list of inclusive namespace prefixes
* ended with a NULL or NULL if there is no
* inclusive namespaces (only for exclusive
* canonicalization, ignored otherwise)
- * @with_comments: include comments in the result (!=0) or not (==0)
- * @buf: the output buffer to store canonical XML; this
+ * @param with_comments include comments in the result (!=0) or not (==0)
+ * @param buf the output buffer to store canonical XML; this
* buffer MUST have encoder==NULL because C14N requires
* UTF-8 output
*
@@ -1956,7 +1930,7 @@ xmlC14NExecute(xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback,
* For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
* "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
*
- * Returns non-negative value on success or a negative value on fail
+ * @returns non-negative value on success or a negative value on fail
*/
int
xmlC14NDocSaveTo(xmlDocPtr doc, xmlNodeSetPtr nodes,
@@ -1973,17 +1947,16 @@ xmlC14NDocSaveTo(xmlDocPtr doc, xmlNodeSetPtr nodes,
/**
- * xmlC14NDocDumpMemory:
- * @doc: the XML document for canonization
- * @nodes: the nodes set to be included in the canonized image
+ * @param doc the XML document for canonization
+ * @param nodes the nodes set to be included in the canonized image
* or NULL if all document nodes should be included
- * @mode: the c14n mode (see @xmlC14NMode)
- * @inclusive_ns_prefixes: the list of inclusive namespace prefixes
+ * @param mode the c14n mode (see `xmlC14NMode`)
+ * @param inclusive_ns_prefixes the list of inclusive namespace prefixes
* ended with a NULL or NULL if there is no
* inclusive namespaces (only for exclusive
* canonicalization, ignored otherwise)
- * @with_comments: include comments in the result (!=0) or not (==0)
- * @doc_txt_ptr: the memory pointer for allocated canonical XML text;
+ * @param with_comments include comments in the result (!=0) or not (==0)
+ * @param doc_txt_ptr the memory pointer for allocated canonical XML text;
* the caller of this functions is responsible for calling
* xmlFree() to free allocated memory
*
@@ -1991,7 +1964,7 @@ xmlC14NDocSaveTo(xmlDocPtr doc, xmlNodeSetPtr nodes,
* For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
* "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
*
- * Returns the number of bytes written on success or a negative value on fail
+ * @returns the number of bytes written on success or a negative value on fail
*/
int
xmlC14NDocDumpMemory(xmlDocPtr doc, xmlNodeSetPtr nodes,
@@ -2041,18 +2014,17 @@ xmlC14NDocDumpMemory(xmlDocPtr doc, xmlNodeSetPtr nodes,
}
/**
- * xmlC14NDocSave:
- * @doc: the XML document for canonization
- * @nodes: the nodes set to be included in the canonized image
+ * @param doc the XML document for canonization
+ * @param nodes the nodes set to be included in the canonized image
* or NULL if all document nodes should be included
- * @mode: the c14n mode (see @xmlC14NMode)
- * @inclusive_ns_prefixes: the list of inclusive namespace prefixes
+ * @param mode the c14n mode (see `xmlC14NMode`)
+ * @param inclusive_ns_prefixes the list of inclusive namespace prefixes
* ended with a NULL or NULL if there is no
* inclusive namespaces (only for exclusive
* canonicalization, ignored otherwise)
- * @with_comments: include comments in the result (!=0) or not (==0)
- * @filename: the filename to store canonical XML image
- * @compression: the compression level (zlib required):
+ * @param with_comments include comments in the result (!=0) or not (==0)
+ * @param filename the filename to store canonical XML image
+ * @param compression the compression level (zlib required):
* -1 - libxml default,
* 0 - uncompressed,
* >0 - compression level
@@ -2061,7 +2033,7 @@ xmlC14NDocDumpMemory(xmlDocPtr doc, xmlNodeSetPtr nodes,
* For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
* "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
*
- * Returns the number of bytes written success or a negative value on fail
+ * @returns the number of bytes written success or a negative value on fail
*/
int
xmlC14NDocSave(xmlDocPtr doc, xmlNodeSetPtr nodes,
@@ -2107,15 +2079,14 @@ xmlC14NDocSave(xmlDocPtr doc, xmlNodeSetPtr nodes,
}
/**
- * xmlC11NNormalizeString:
- * @input: the input string
- * @mode: the normalization mode (attribute, comment, PI or text)
+ * @param input the input string
+ * @param mode the normalization mode (attribute, comment, PI or text)
*
* Converts a string to a canonical (normalized) format. The code is stolen
* from xmlEncodeEntitiesReentrant(). Added normalization of `\x09`, `\x0a`,
- * `\x0A` and the @mode parameter.
+ * `\x0A` and the `mode` parameter.
*
- * Returns a normalized string (caller is responsible for calling xmlFree())
+ * @returns a normalized string (caller is responsible for calling xmlFree())
* or NULL if an error occurs
*/
static xmlChar *
diff --git a/catalog.c b/catalog.c
index d76d6ed5..02f52b12 100644
--- a/catalog.c
+++ b/catalog.c
@@ -185,7 +185,6 @@ static int xmlCatalogInitialized = 0;
************************************************************************/
/**
- * xmlCatalogErrMemory:
*
* Handle an out of memory condition
*/
@@ -196,14 +195,13 @@ xmlCatalogErrMemory(void)
}
/**
- * xmlCatalogErr:
- * @catal: the Catalog entry
- * @node: the context node
- * @error: the error code
- * @msg: the error message
- * @str1: error string 1
- * @str2: error string 2
- * @str3: error string 3
+ * @param catal the Catalog entry
+ * @param node the context node
+ * @param error the error code
+ * @param msg the error message
+ * @param str1 error string 1
+ * @param str2 error string 2
+ * @param str3 error string 3
*
* Handle a catalog error
*/
@@ -239,18 +237,17 @@ xmlCatalogPrintDebug(const char *fmt, ...) {
************************************************************************/
/**
- * xmlNewCatalogEntry:
- * @type: type of entry
- * @name: name of the entry
- * @value: value of the entry
- * @URL: URL of the entry
- * @prefer: the PUBLIC vs. SYSTEM current preference value
- * @group: for members of a group, the group entry
+ * @param type type of entry
+ * @param name name of the entry
+ * @param value value of the entry
+ * @param URL URL of the entry
+ * @param prefer the PUBLIC vs. SYSTEM current preference value
+ * @param group for members of a group, the group entry
*
* create a new Catalog entry, this type is shared both by XML and
* SGML catalogs, but the acceptable types values differs.
*
- * Returns the xmlCatalogEntryPtr or NULL in case of error
+ * @returns the xmlCatalogEntryPtr or NULL in case of error
*/
static xmlCatalogEntryPtr
xmlNewCatalogEntry(xmlCatalogEntryType type, const xmlChar *name,
@@ -300,9 +297,8 @@ static void
xmlFreeCatalogEntryList(xmlCatalogEntryPtr ret);
/**
- * xmlFreeCatalogEntry:
- * @payload: a Catalog entry
- * @name: unused
+ * @param payload a Catalog entry
+ * @param name unused
*
* Free the memory allocated to a Catalog entry
*/
@@ -340,8 +336,7 @@ xmlFreeCatalogEntry(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlFreeCatalogEntryList:
- * @ret: a Catalog entry list
+ * @param ret a Catalog entry list
*
* Free the memory allocated to a full chained list of Catalog entries
*/
@@ -357,9 +352,8 @@ xmlFreeCatalogEntryList(xmlCatalogEntryPtr ret) {
}
/**
- * xmlFreeCatalogHashEntryList:
- * @payload: a Catalog entry list
- * @name: unused
+ * @param payload a Catalog entry list
+ * @param name unused
*
* Free the memory allocated to list of Catalog entries from the
* catalog file hash.
@@ -386,14 +380,13 @@ xmlFreeCatalogHashEntryList(void *payload,
}
/**
- * xmlCreateNewCatalog:
- * @type: type of catalog
- * @prefer: the PUBLIC vs. SYSTEM current preference value
+ * @param type type of catalog
+ * @param prefer the PUBLIC vs. SYSTEM current preference value
*
* create a new Catalog, this type is shared both by XML and
* SGML catalogs, but the acceptable types values differs.
*
- * Returns the xmlCatalogPtr or NULL in case of error
+ * @returns the xmlCatalogPtr or NULL in case of error
*/
static xmlCatalogPtr
xmlCreateNewCatalog(xmlCatalogType type, xmlCatalogPrefer prefer) {
@@ -415,8 +408,7 @@ xmlCreateNewCatalog(xmlCatalogType type, xmlCatalogPrefer prefer) {
}
/**
- * xmlFreeCatalog:
- * @catal: a Catalog
+ * @param catal a Catalog
*
* Free the memory allocated to a Catalog
*/
@@ -439,10 +431,9 @@ xmlFreeCatalog(xmlCatalogPtr catal) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlCatalogDumpEntry:
- * @payload: the catalog entry
- * @data: the file.
- * @name: unused
+ * @param payload the catalog entry
+ * @param data the file.
+ * @param name unused
*
* Serialize an SGML Catalog entry
*/
@@ -516,12 +507,11 @@ xmlCatalogDumpEntry(void *payload, void *data,
}
/**
- * xmlDumpXMLCatalogNode:
- * @catal: top catalog entry
- * @catalog: pointer to the xml tree
- * @doc: the containing document
- * @ns: the current namespace
- * @cgroup: group node for group members
+ * @param catal top catalog entry
+ * @param catalog pointer to the xml tree
+ * @param doc the containing document
+ * @param ns the current namespace
+ * @param cgroup group node for group members
*
* Serializes a Catalog entry, called by xmlDumpXMLCatalog and recursively
* for group entries
@@ -706,10 +696,9 @@ BAD_CAST "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd");
************************************************************************/
/**
- * xmlCatalogConvertEntry:
- * @payload: the entry
- * @data: pointer to the catalog being converted
- * @name: unused
+ * @param payload the entry
+ * @param data pointer to the catalog being converted
+ * @param name unused
*
* Convert one entry from the catalog
*/
@@ -773,12 +762,11 @@ xmlCatalogConvertEntry(void *payload, void *data,
}
/**
- * xmlConvertSGMLCatalog:
- * @catal: the catalog
+ * @param catal the catalog
*
* Convert all the SGML catalog entries as XML ones
*
- * Returns the number of entries converted if successful, -1 otherwise
+ * @returns the number of entries converted if successful, -1 otherwise
*/
int
xmlConvertSGMLCatalog(xmlCatalogPtr catal) {
@@ -801,12 +789,11 @@ xmlConvertSGMLCatalog(xmlCatalogPtr catal) {
************************************************************************/
/**
- * xmlCatalogUnWrapURN:
- * @urn: an "urn:publicid:" to unwrap
+ * @param urn an "urn:publicid:" to unwrap
*
* Expand the URN into the equivalent Public Identifier
*
- * Returns the new identifier or NULL, the string must be deallocated
+ * @returns the new identifier or NULL, the string must be deallocated
* by the caller.
*/
static xmlChar *
@@ -866,13 +853,12 @@ xmlCatalogUnWrapURN(const xmlChar *urn) {
}
/**
- * xmlParseCatalogFile:
- * @filename: the filename
+ * @param filename the filename
*
* parse an XML file and build a tree. It's like xmlParseFile()
* except it bypass all catalog lookups.
*
- * Returns the resulting document tree or NULL in case of error
+ * @returns the resulting document tree or NULL in case of error
*/
xmlDocPtr
@@ -932,12 +918,11 @@ xmlParseCatalogFile(const char *filename) {
}
/**
- * xmlLoadFileContent:
- * @filename: a file path
+ * @param filename a file path
*
* Load a file content into memory.
*
- * Returns a pointer to the 0 terminated string or NULL in case of error
+ * @returns a pointer to the 0 terminated string or NULL in case of error
*/
static xmlChar *
xmlLoadFileContent(const char *filename)
@@ -979,15 +964,14 @@ xmlLoadFileContent(const char *filename)
}
/**
- * xmlCatalogNormalizePublic:
- * @pubID: the public ID string
+ * @param pubID the public ID string
*
* Normalizes the Public Identifier
*
* Implements 6.2. Public Identifier Normalization
* from http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
*
- * Returns the new string or NULL, the string must be deallocated
+ * @returns the new string or NULL, the string must be deallocated
* by the caller.
*/
static xmlChar *
@@ -1052,12 +1036,11 @@ xmlCatalogListXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI);
/**
- * xmlGetXMLCatalogEntryType:
- * @name: the name
+ * @param name the name
*
* lookup the internal type associated to an XML catalog entry name
*
- * Returns the type associated with that name
+ * @returns the type associated with that name
*/
static xmlCatalogEntryType
xmlGetXMLCatalogEntryType(const xmlChar *name) {
@@ -1086,19 +1069,18 @@ xmlGetXMLCatalogEntryType(const xmlChar *name) {
}
/**
- * xmlParseXMLCatalogOneNode:
- * @cur: the XML node
- * @type: the type of Catalog entry
- * @name: the name of the node
- * @attrName: the attribute holding the value
- * @uriAttrName: the attribute holding the URI-Reference
- * @prefer: the PUBLIC vs. SYSTEM current preference value
- * @cgroup: the group which includes this node
+ * @param cur the XML node
+ * @param type the type of Catalog entry
+ * @param name the name of the node
+ * @param attrName the attribute holding the value
+ * @param uriAttrName the attribute holding the URI-Reference
+ * @param prefer the PUBLIC vs. SYSTEM current preference value
+ * @param cgroup the group which includes this node
*
* Finishes the examination of an XML tree node of a catalog and build
* a Catalog entry from it.
*
- * Returns the new Catalog entry node or NULL in case of error.
+ * @returns the new Catalog entry node or NULL in case of error.
*/
static xmlCatalogEntryPtr
xmlParseXMLCatalogOneNode(xmlNodePtr cur, xmlCatalogEntryType type,
@@ -1162,11 +1144,10 @@ xmlParseXMLCatalogOneNode(xmlNodePtr cur, xmlCatalogEntryType type,
}
/**
- * xmlParseXMLCatalogNode:
- * @cur: the XML node
- * @prefer: the PUBLIC vs. SYSTEM current preference value
- * @parent: the parent Catalog entry
- * @cgroup: the group which includes this node
+ * @param cur the XML node
+ * @param prefer the PUBLIC vs. SYSTEM current preference value
+ * @param parent the parent Catalog entry
+ * @param cgroup the group which includes this node
*
* Examines an XML tree node of a catalog and build
* a Catalog entry from it adding it to its parent. The examination can
@@ -1265,11 +1246,10 @@ xmlParseXMLCatalogNode(xmlNodePtr cur, xmlCatalogPrefer prefer,
}
/**
- * xmlParseXMLCatalogNodeList:
- * @cur: the XML node list of siblings
- * @prefer: the PUBLIC vs. SYSTEM current preference value
- * @parent: the parent Catalog entry
- * @cgroup: the group which includes this list
+ * @param cur the XML node list of siblings
+ * @param prefer the PUBLIC vs. SYSTEM current preference value
+ * @param parent the parent Catalog entry
+ * @param cgroup the group which includes this list
*
* Examines a list of XML sibling nodes of a catalog and build
* a list of Catalog entry from it adding it to the parent.
@@ -1289,14 +1269,13 @@ xmlParseXMLCatalogNodeList(xmlNodePtr cur, xmlCatalogPrefer prefer,
}
/**
- * xmlParseXMLCatalogFile:
- * @prefer: the PUBLIC vs. SYSTEM current preference value
- * @filename: the filename for the catalog
+ * @param prefer the PUBLIC vs. SYSTEM current preference value
+ * @param filename the filename for the catalog
*
* Parses the catalog file to extract the XML tree and then analyze the
* tree to build a list of Catalog entries corresponding to this catalog
*
- * Returns the resulting Catalog entries list
+ * @returns the resulting Catalog entries list
*/
static xmlCatalogEntryPtr
xmlParseXMLCatalogFile(xmlCatalogPrefer prefer, const xmlChar *filename) {
@@ -1359,12 +1338,11 @@ xmlParseXMLCatalogFile(xmlCatalogPrefer prefer, const xmlChar *filename) {
}
/**
- * xmlFetchXMLCatalogFile:
- * @catal: an existing but incomplete catalog entry
+ * @param catal an existing but incomplete catalog entry
*
* Fetch and parse the subcatalog referenced by an entry
*
- * Returns 0 in case of success, -1 otherwise
+ * @returns 0 in case of success, -1 otherwise
*/
static int
xmlFetchXMLCatalogFile(xmlCatalogEntryPtr catal) {
@@ -1444,16 +1422,15 @@ xmlFetchXMLCatalogFile(xmlCatalogEntryPtr catal) {
************************************************************************/
/**
- * xmlAddXMLCatalog:
- * @catal: top of an XML catalog
- * @type: the type of record to add to the catalog
- * @orig: the system, public or prefix to match (or NULL)
- * @replace: the replacement value for the match
+ * @param catal top of an XML catalog
+ * @param type the type of record to add to the catalog
+ * @param orig the system, public or prefix to match (or NULL)
+ * @param replace the replacement value for the match
*
* Add an entry in the XML catalog, it may overwrite existing but
* different entries.
*
- * Returns 0 if successful, -1 otherwise
+ * @returns 0 if successful, -1 otherwise
*/
static int
xmlAddXMLCatalog(xmlCatalogEntryPtr catal, const xmlChar *type,
@@ -1524,14 +1501,13 @@ xmlAddXMLCatalog(xmlCatalogEntryPtr catal, const xmlChar *type,
}
/**
- * xmlDelXMLCatalog:
- * @catal: top of an XML catalog
- * @value: the value to remove from the catalog
+ * @param catal top of an XML catalog
+ * @param value the value to remove from the catalog
*
* Remove entries in the XML catalog where the value or the URI
- * is equal to @value
+ * is equal to `value`
*
- * Returns the number of entries removed if successful, -1 otherwise
+ * @returns the number of entries removed if successful, -1 otherwise
*/
static int
xmlDelXMLCatalog(xmlCatalogEntryPtr catal, const xmlChar *value) {
@@ -1571,10 +1547,9 @@ xmlDelXMLCatalog(xmlCatalogEntryPtr catal, const xmlChar *value) {
}
/**
- * xmlCatalogXMLResolve:
- * @catal: a catalog list
- * @pubID: the public ID string
- * @sysID: the system ID string
+ * @param catal a catalog list
+ * @param pubID the public ID string
+ * @param sysID the system ID string
*
* Do a complete resolution lookup of an External Identifier for a
* list of catalog entries.
@@ -1582,7 +1557,7 @@ xmlDelXMLCatalog(xmlCatalogEntryPtr catal, const xmlChar *value) {
* Implements (or tries to) 7.1. External Identifier Resolution
* from http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
*
- * Returns the URI of the resource or NULL if not found
+ * @returns the URI of the resource or NULL if not found
*/
static xmlChar *
xmlCatalogXMLResolve(xmlCatalogEntryPtr catal, const xmlChar *pubID,
@@ -1804,9 +1779,8 @@ xmlCatalogXMLResolve(xmlCatalogEntryPtr catal, const xmlChar *pubID,
}
/**
- * xmlCatalogXMLResolveURI:
- * @catal: a catalog list
- * @URI: the URI
+ * @param catal a catalog list
+ * @param URI the URI
*
* Do a complete resolution lookup of an External Identifier for a
* list of catalog entries.
@@ -1814,7 +1788,7 @@ xmlCatalogXMLResolve(xmlCatalogEntryPtr catal, const xmlChar *pubID,
* Implements (or tries to) 7.2.2. URI Resolution
* from http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
*
- * Returns the URI of the resource or NULL if not found
+ * @returns the URI of the resource or NULL if not found
*/
static xmlChar *
xmlCatalogXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI) {
@@ -1946,10 +1920,9 @@ xmlCatalogXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI) {
}
/**
- * xmlCatalogListXMLResolve:
- * @catal: a catalog list
- * @pubID: the public ID string
- * @sysID: the system ID string
+ * @param catal a catalog list
+ * @param pubID the public ID string
+ * @param sysID the system ID string
*
* Do a complete resolution lookup of an External Identifier for a
* list of catalogs
@@ -1957,7 +1930,7 @@ xmlCatalogXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI) {
* Implements (or tries to) 7.1. External Identifier Resolution
* from http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
*
- * Returns the URI of the resource or NULL if not found
+ * @returns the URI of the resource or NULL if not found
*/
static xmlChar *
xmlCatalogListXMLResolve(xmlCatalogEntryPtr catal, const xmlChar *pubID,
@@ -2038,16 +2011,15 @@ xmlCatalogListXMLResolve(xmlCatalogEntryPtr catal, const xmlChar *pubID,
}
/**
- * xmlCatalogListXMLResolveURI:
- * @catal: a catalog list
- * @URI: the URI
+ * @param catal a catalog list
+ * @param URI the URI
*
* Do a complete resolution lookup of an URI for a list of catalogs
*
* Implements (or tries to) 7.2. URI Resolution
* from http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
*
- * Returns the URI of the resource or NULL if not found
+ * @returns the URI of the resource or NULL if not found
*/
static xmlChar *
xmlCatalogListXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI) {
@@ -2104,12 +2076,11 @@ xmlCatalogListXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI) {
#define SKIP_BLANKS while (IS_BLANK_CH(*cur)) NEXT;
/**
- * xmlParseSGMLCatalogComment:
- * @cur: the current character
+ * @param cur the current character
*
* Skip a comment in an SGML catalog
*
- * Returns new current character
+ * @returns new current character
*/
static const xmlChar *
xmlParseSGMLCatalogComment(const xmlChar *cur) {
@@ -2125,13 +2096,12 @@ xmlParseSGMLCatalogComment(const xmlChar *cur) {
}
/**
- * xmlParseSGMLCatalogPubid:
- * @cur: the current character
- * @id: the return location
+ * @param cur the current character
+ * @param id the return location
*
* Parse an SGML catalog ID
*
- * Returns new current character and store the value in @id
+ * @returns new current character and store the value in `id`
*/
static const xmlChar *
xmlParseSGMLCatalogPubid(const xmlChar *cur, xmlChar **id) {
@@ -2201,13 +2171,12 @@ xmlParseSGMLCatalogPubid(const xmlChar *cur, xmlChar **id) {
}
/**
- * xmlParseSGMLCatalogName:
- * @cur: the current character
- * @name: the return location
+ * @param cur the current character
+ * @param name the return location
*
* Parse an SGML catalog name
*
- * Returns new current character and store the value in @name
+ * @returns new current character and store the value in `name`
*/
static const xmlChar *
xmlParseSGMLCatalogName(const xmlChar *cur, xmlChar **name) {
@@ -2239,12 +2208,11 @@ xmlParseSGMLCatalogName(const xmlChar *cur, xmlChar **name) {
}
/**
- * xmlGetSGMLCatalogEntryType:
- * @name: the entry name
+ * @param name the entry name
*
* Get the Catalog entry type for a given SGML Catalog name
*
- * Returns Catalog entry type
+ * @returns Catalog entry type
*/
static xmlCatalogEntryType
xmlGetSGMLCatalogEntryType(const xmlChar *name) {
@@ -2275,17 +2243,16 @@ xmlGetSGMLCatalogEntryType(const xmlChar *name) {
}
/**
- * xmlParseSGMLCatalog:
- * @catal: the SGML Catalog
- * @value: the content of the SGML Catalog serialization
- * @file: the filepath for the catalog
- * @super: should this be handled as a Super Catalog in which case
+ * @param catal the SGML Catalog
+ * @param value the content of the SGML Catalog serialization
+ * @param file the filepath for the catalog
+ * @param super should this be handled as a Super Catalog in which case
* parsing is not recursive
*
- * Parse an SGML catalog content and fill up the @catal hash table with
+ * Parse an SGML catalog content and fill up the `catal` hash table with
* the new entries found.
*
- * Returns 0 in case of success, -1 in case of error.
+ * @returns 0 in case of success, -1 in case of error.
*/
static int
xmlParseSGMLCatalog(xmlCatalogPtr catal, const xmlChar *value,
@@ -2501,13 +2468,12 @@ xmlParseSGMLCatalog(xmlCatalogPtr catal, const xmlChar *value,
************************************************************************/
/**
- * xmlCatalogGetSGMLPublic:
- * @catal: an SGML catalog hash
- * @pubID: the public ID string
+ * @param catal an SGML catalog hash
+ * @param pubID the public ID string
*
* Try to lookup the catalog local reference associated to a public ID
*
- * Returns the local resource if found or NULL otherwise.
+ * @returns the local resource if found or NULL otherwise.
*/
static const xmlChar *
xmlCatalogGetSGMLPublic(xmlHashTablePtr catal, const xmlChar *pubID) {
@@ -2538,13 +2504,12 @@ xmlCatalogGetSGMLPublic(xmlHashTablePtr catal, const xmlChar *pubID) {
}
/**
- * xmlCatalogGetSGMLSystem:
- * @catal: an SGML catalog hash
- * @sysID: the system ID string
+ * @param catal an SGML catalog hash
+ * @param sysID the system ID string
*
* Try to lookup the catalog local reference for a system ID
*
- * Returns the local resource if found or NULL otherwise.
+ * @returns the local resource if found or NULL otherwise.
*/
static const xmlChar *
xmlCatalogGetSGMLSystem(xmlHashTablePtr catal, const xmlChar *sysID) {
@@ -2562,14 +2527,13 @@ xmlCatalogGetSGMLSystem(xmlHashTablePtr catal, const xmlChar *sysID) {
}
/**
- * xmlCatalogSGMLResolve:
- * @catal: the SGML catalog
- * @pubID: the public ID string
- * @sysID: the system ID string
+ * @param catal the SGML catalog
+ * @param pubID the public ID string
+ * @param sysID the system ID string
*
* Do a complete resolution lookup of an External Identifier
*
- * Returns the URI of the resource or NULL if not found
+ * @returns the URI of the resource or NULL if not found
*/
static const xmlChar *
xmlCatalogSGMLResolve(xmlCatalogPtr catal, const xmlChar *pubID,
@@ -2597,14 +2561,13 @@ xmlCatalogSGMLResolve(xmlCatalogPtr catal, const xmlChar *pubID,
************************************************************************/
/**
- * xmlLoadSGMLSuperCatalog:
- * @filename: a file path
+ * @param filename a file path
*
* Load an SGML super catalog. It won't expand CATALOG or DELEGATE
* references. This is only needed for manipulating SGML Super Catalogs
* like adding and removing CATALOG or DELEGATE entries.
*
- * Returns the catalog parsed or NULL in case of error
+ * @returns the catalog parsed or NULL in case of error
*/
xmlCatalogPtr
xmlLoadSGMLSuperCatalog(const char *filename)
@@ -2633,15 +2596,14 @@ xmlLoadSGMLSuperCatalog(const char *filename)
}
/**
- * xmlLoadACatalog:
- * @filename: a file path
+ * @param filename a file path
*
* Load the catalog and build the associated data structures.
* This can be either an XML Catalog or an SGML Catalog
* It will recurse in SGML CATALOG entries. On the other hand XML
* Catalogs are not handled recursively.
*
- * Returns the catalog parsed or NULL in case of error
+ * @returns the catalog parsed or NULL in case of error
*/
xmlCatalogPtr
xmlLoadACatalog(const char *filename)
@@ -2689,14 +2651,13 @@ xmlLoadACatalog(const char *filename)
}
/**
- * xmlExpandCatalog:
- * @catal: a catalog
- * @filename: a file path
+ * @param catal a catalog
+ * @param filename a file path
*
* Load the catalog and expand the existing catal structure.
* This can be either an XML Catalog or an SGML Catalog
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
static int
xmlExpandCatalog(xmlCatalogPtr catal, const char *filename)
@@ -2737,13 +2698,12 @@ xmlExpandCatalog(xmlCatalogPtr catal, const char *filename)
}
/**
- * xmlACatalogResolveSystem:
- * @catal: a Catalog
- * @sysID: the system ID string
+ * @param catal a Catalog
+ * @param sysID the system ID string
*
* Try to lookup the catalog resource for a system ID
*
- * Returns the resource if found or NULL otherwise, the value returned
+ * @returns the resource if found or NULL otherwise, the value returned
* must be freed by the caller.
*/
xmlChar *
@@ -2772,13 +2732,12 @@ xmlACatalogResolveSystem(xmlCatalogPtr catal, const xmlChar *sysID) {
}
/**
- * xmlACatalogResolvePublic:
- * @catal: a Catalog
- * @pubID: the public ID string
+ * @param catal a Catalog
+ * @param pubID the public ID string
*
* Try to lookup the catalog local reference associated to a public ID in that catalog
*
- * Returns the local resource if found or NULL otherwise, the value returned
+ * @returns the local resource if found or NULL otherwise, the value returned
* must be freed by the caller.
*/
xmlChar *
@@ -2807,14 +2766,13 @@ xmlACatalogResolvePublic(xmlCatalogPtr catal, const xmlChar *pubID) {
}
/**
- * xmlACatalogResolve:
- * @catal: a Catalog
- * @pubID: the public ID string
- * @sysID: the system ID string
+ * @param catal a Catalog
+ * @param pubID the public ID string
+ * @param sysID the system ID string
*
* Do a complete resolution lookup of an External Identifier
*
- * Returns the URI of the resource or NULL if not found, it must be freed
+ * @returns the URI of the resource or NULL if not found, it must be freed
* by the caller.
*/
xmlChar *
@@ -2854,13 +2812,12 @@ xmlACatalogResolve(xmlCatalogPtr catal, const xmlChar * pubID,
}
/**
- * xmlACatalogResolveURI:
- * @catal: a Catalog
- * @URI: the URI
+ * @param catal a Catalog
+ * @param URI the URI
*
* Do a complete resolution lookup of an URI
*
- * Returns the URI of the resource or NULL if not found, it must be freed
+ * @returns the URI of the resource or NULL if not found, it must be freed
* by the caller.
*/
xmlChar *
@@ -2890,9 +2847,8 @@ xmlACatalogResolveURI(xmlCatalogPtr catal, const xmlChar *URI) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlACatalogDump:
- * @catal: a Catalog
- * @out: the file.
+ * @param catal a Catalog
+ * @param out the file.
*
* Dump the given catalog to the given file.
*/
@@ -2910,16 +2866,15 @@ xmlACatalogDump(xmlCatalogPtr catal, FILE *out) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlACatalogAdd:
- * @catal: a Catalog
- * @type: the type of record to add to the catalog
- * @orig: the system, public or prefix to match
- * @replace: the replacement value for the match
+ * @param catal a Catalog
+ * @param type the type of record to add to the catalog
+ * @param orig the system, public or prefix to match
+ * @param replace the replacement value for the match
*
* Add an entry in the catalog, it may overwrite existing but
* different entries.
*
- * Returns 0 if successful, -1 otherwise
+ * @returns 0 if successful, -1 otherwise
*/
int
xmlACatalogAdd(xmlCatalogPtr catal, const xmlChar * type,
@@ -2952,13 +2907,12 @@ xmlACatalogAdd(xmlCatalogPtr catal, const xmlChar * type,
}
/**
- * xmlACatalogRemove:
- * @catal: a Catalog
- * @value: the value to remove
+ * @param catal a Catalog
+ * @param value the value to remove
*
* Remove an entry from the catalog
*
- * Returns the number of entries removed if successful, -1 otherwise
+ * @returns the number of entries removed if successful, -1 otherwise
*/
int
xmlACatalogRemove(xmlCatalogPtr catal, const xmlChar *value) {
@@ -2978,12 +2932,11 @@ xmlACatalogRemove(xmlCatalogPtr catal, const xmlChar *value) {
}
/**
- * xmlNewCatalog:
- * @sgml: should this create an SGML catalog
+ * @param sgml should this create an SGML catalog
*
* create a new Catalog.
*
- * Returns the xmlCatalogPtr or NULL in case of error
+ * @returns the xmlCatalogPtr or NULL in case of error
*/
xmlCatalogPtr
xmlNewCatalog(int sgml) {
@@ -3001,12 +2954,11 @@ xmlNewCatalog(int sgml) {
}
/**
- * xmlCatalogIsEmpty:
- * @catal: should this create an SGML catalog
+ * @param catal should this create an SGML catalog
*
* Check is a catalog is empty
*
- * Returns 1 if the catalog is empty, 0 if not, amd -1 in case of error.
+ * @returns 1 if the catalog is empty, 0 if not, amd -1 in case of error.
*/
int
xmlCatalogIsEmpty(xmlCatalogPtr catal) {
@@ -3043,7 +2995,6 @@ xmlCatalogIsEmpty(xmlCatalogPtr catal) {
************************************************************************/
/**
- * xmlInitCatalogInternal:
*
* Do the catalog initialization only of global data, doesn't try to load
* any catalog actually.
@@ -3056,7 +3007,6 @@ xmlInitCatalogInternal(void) {
}
/**
- * xmlInitializeCatalog:
*
* Load the default system catalog.
*/
@@ -3115,15 +3065,14 @@ xmlInitializeCatalog(void) {
/**
- * xmlLoadCatalog:
- * @filename: a file path
+ * @param filename a file path
*
* Load the catalog and makes its definitions effective for the default
* external entity loader. It will recurse in SGML CATALOG entries.
* this function is not thread safe, catalog initialization should
* preferably be done once at startup
*
- * Returns 0 in case of success -1 in case of error
+ * @returns 0 in case of success -1 in case of error
*/
int
xmlLoadCatalog(const char *filename)
@@ -3154,8 +3103,7 @@ xmlLoadCatalog(const char *filename)
}
/**
- * xmlLoadCatalogs:
- * @pathss: a list of directories separated by a colon or a space.
+ * @param pathss a list of directories separated by a colon or a space.
*
* Load the catalogs and makes their definitions effective for the default
* external entity loader.
@@ -3201,7 +3149,6 @@ xmlLoadCatalogs(const char *pathss) {
}
/**
- * xmlCatalogCleanup:
*
* Free up all the memory associated with catalogs
*/
@@ -3223,7 +3170,6 @@ xmlCatalogCleanup(void) {
}
/**
- * xmlCleanupCatalogInternal:
*
* Free global data.
*/
@@ -3233,12 +3179,11 @@ xmlCleanupCatalogInternal(void) {
}
/**
- * xmlCatalogResolveSystem:
- * @sysID: the system ID string
+ * @param sysID the system ID string
*
* Try to lookup the catalog resource for a system ID
*
- * Returns the resource if found or NULL otherwise, the value returned
+ * @returns the resource if found or NULL otherwise, the value returned
* must be freed by the caller.
*/
xmlChar *
@@ -3253,12 +3198,11 @@ xmlCatalogResolveSystem(const xmlChar *sysID) {
}
/**
- * xmlCatalogResolvePublic:
- * @pubID: the public ID string
+ * @param pubID the public ID string
*
* Try to lookup the catalog reference associated to a public ID
*
- * Returns the resource if found or NULL otherwise, the value returned
+ * @returns the resource if found or NULL otherwise, the value returned
* must be freed by the caller.
*/
xmlChar *
@@ -3273,13 +3217,12 @@ xmlCatalogResolvePublic(const xmlChar *pubID) {
}
/**
- * xmlCatalogResolve:
- * @pubID: the public ID string
- * @sysID: the system ID string
+ * @param pubID the public ID string
+ * @param sysID the system ID string
*
* Do a complete resolution lookup of an External Identifier
*
- * Returns the URI of the resource or NULL if not found, it must be freed
+ * @returns the URI of the resource or NULL if not found, it must be freed
* by the caller.
*/
xmlChar *
@@ -3294,12 +3237,11 @@ xmlCatalogResolve(const xmlChar *pubID, const xmlChar *sysID) {
}
/**
- * xmlCatalogResolveURI:
- * @URI: the URI
+ * @param URI the URI
*
* Do a complete resolution lookup of an URI
*
- * Returns the URI of the resource or NULL if not found, it must be freed
+ * @returns the URI of the resource or NULL if not found, it must be freed
* by the caller.
*/
xmlChar *
@@ -3315,8 +3257,7 @@ xmlCatalogResolveURI(const xmlChar *URI) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlCatalogDump:
- * @out: the file.
+ * @param out the file.
*
* Dump all the global catalog content to the given file.
*/
@@ -3333,17 +3274,16 @@ xmlCatalogDump(FILE *out) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlCatalogAdd:
- * @type: the type of record to add to the catalog
- * @orig: the system, public or prefix to match
- * @replace: the replacement value for the match
+ * @param type the type of record to add to the catalog
+ * @param orig the system, public or prefix to match
+ * @param replace the replacement value for the match
*
* Add an entry in the catalog, it may overwrite existing but
* different entries.
* If called before any other catalog routine, allows to override the
* default shared catalog put in place by xmlInitializeCatalog();
*
- * Returns 0 if successful, -1 otherwise
+ * @returns 0 if successful, -1 otherwise
*/
int
xmlCatalogAdd(const xmlChar *type, const xmlChar *orig, const xmlChar *replace) {
@@ -3375,12 +3315,11 @@ xmlCatalogAdd(const xmlChar *type, const xmlChar *orig, const xmlChar *replace)
}
/**
- * xmlCatalogRemove:
- * @value: the value to remove
+ * @param value the value to remove
*
* Remove an entry from the catalog
*
- * Returns the number of entries removed if successful, -1 otherwise
+ * @returns the number of entries removed if successful, -1 otherwise
*/
int
xmlCatalogRemove(const xmlChar *value) {
@@ -3396,11 +3335,10 @@ xmlCatalogRemove(const xmlChar *value) {
}
/**
- * xmlCatalogConvert:
*
* Convert all the SGML catalog entries as XML ones
*
- * Returns the number of entries converted if successful, -1 otherwise
+ * @returns the number of entries converted if successful, -1 otherwise
*/
int
xmlCatalogConvert(void) {
@@ -3422,15 +3360,14 @@ xmlCatalogConvert(void) {
************************************************************************/
/**
- * xmlCatalogGetDefaults:
*
- * DEPRECATED: Use XML_PARSE_NO_SYS_CATALOG and
+ * @deprecated Use XML_PARSE_NO_SYS_CATALOG and
* XML_PARSE_CATALOG_PI.
*
* Used to get the user preference w.r.t. to what catalogs should
* be accepted
*
- * Returns the current xmlCatalogAllow value
+ * @returns the current xmlCatalogAllow value
*/
xmlCatalogAllow
xmlCatalogGetDefaults(void) {
@@ -3438,10 +3375,9 @@ xmlCatalogGetDefaults(void) {
}
/**
- * xmlCatalogSetDefaults:
- * @allow: what catalogs should be accepted
+ * @param allow what catalogs should be accepted
*
- * DEPRECATED: Use XML_PARSE_NO_SYS_CATALOG and
+ * @deprecated Use XML_PARSE_NO_SYS_CATALOG and
* XML_PARSE_CATALOG_PI.
*
* Used to set the user preference w.r.t. to what catalogs should
@@ -3473,16 +3409,15 @@ xmlCatalogSetDefaults(xmlCatalogAllow allow) {
}
/**
- * xmlCatalogSetDefaultPrefer:
- * @prefer: the default preference for delegation
+ * @param prefer the default preference for delegation
*
- * DEPRECATED: This setting is global and not thread-safe.
+ * @deprecated This setting is global and not thread-safe.
*
* Allows to set the preference between public and system for deletion
* in XML Catalog resolution. C.f. section 4.1.1 of the spec
* Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM
*
- * Returns the previous value of the default preference for delegation
+ * @returns the previous value of the default preference for delegation
*/
xmlCatalogPrefer
xmlCatalogSetDefaultPrefer(xmlCatalogPrefer prefer) {
@@ -3510,13 +3445,12 @@ xmlCatalogSetDefaultPrefer(xmlCatalogPrefer prefer) {
}
/**
- * xmlCatalogSetDebug:
- * @level: the debug level of catalogs required
+ * @param level the debug level of catalogs required
*
* Used to set the debug level for catalog operation, 0 disable
* debugging, 1 enable it
*
- * Returns the previous value of the catalog debugging level
+ * @returns the previous value of the catalog debugging level
*/
int
xmlCatalogSetDebug(int level) {
@@ -3536,8 +3470,7 @@ xmlCatalogSetDebug(int level) {
************************************************************************/
/**
- * xmlCatalogFreeLocal:
- * @catalogs: a document's list of catalogs
+ * @param catalogs a document's list of catalogs
*
* Free up the memory associated to the catalog list
*/
@@ -3552,13 +3485,12 @@ xmlCatalogFreeLocal(void *catalogs) {
/**
- * xmlCatalogAddLocal:
- * @catalogs: a document's list of catalogs
- * @URL: the URL to a new local catalog
+ * @param catalogs a document's list of catalogs
+ * @param URL the URL to a new local catalog
*
* Add the new entry to the catalog list
*
- * Returns the updated list
+ * @returns the updated list
*/
void *
xmlCatalogAddLocal(void *catalogs, const xmlChar *URL) {
@@ -3589,15 +3521,14 @@ xmlCatalogAddLocal(void *catalogs, const xmlChar *URL) {
}
/**
- * xmlCatalogLocalResolve:
- * @catalogs: a document's list of catalogs
- * @pubID: the public ID string
- * @sysID: the system ID string
+ * @param catalogs a document's list of catalogs
+ * @param pubID the public ID string
+ * @param sysID the system ID string
*
* Do a complete resolution lookup of an External Identifier using a
* document's private catalog list
*
- * Returns the URI of the resource or NULL if not found, it must be freed
+ * @returns the URI of the resource or NULL if not found, it must be freed
* by the caller.
*/
xmlChar *
@@ -3632,14 +3563,13 @@ xmlCatalogLocalResolve(void *catalogs, const xmlChar *pubID,
}
/**
- * xmlCatalogLocalResolveURI:
- * @catalogs: a document's list of catalogs
- * @URI: the URI
+ * @param catalogs a document's list of catalogs
+ * @param URI the URI
*
* Do a complete resolution lookup of an URI using a
* document's private catalog list
*
- * Returns the URI of the resource or NULL if not found, it must be freed
+ * @returns the URI of the resource or NULL if not found, it must be freed
* by the caller.
*/
xmlChar *
@@ -3669,13 +3599,12 @@ xmlCatalogLocalResolveURI(void *catalogs, const xmlChar *URI) {
* *
************************************************************************/
/**
- * xmlCatalogGetSystem:
- * @sysID: the system ID string
+ * @param sysID the system ID string
*
* Try to lookup the catalog reference associated to a system ID
- * DEPRECATED, use xmlCatalogResolveSystem()
+ * @deprecated, use xmlCatalogResolveSystem()
*
- * Returns the resource if found or NULL otherwise.
+ * @returns the resource if found or NULL otherwise.
*/
const xmlChar *
xmlCatalogGetSystem(const xmlChar *sysID) {
@@ -3713,13 +3642,12 @@ xmlCatalogGetSystem(const xmlChar *sysID) {
}
/**
- * xmlCatalogGetPublic:
- * @pubID: the public ID string
+ * @param pubID the public ID string
*
* Try to lookup the catalog reference associated to a public ID
- * DEPRECATED, use xmlCatalogResolvePublic()
+ * @deprecated, use xmlCatalogResolvePublic()
*
- * Returns the resource if found or NULL otherwise.
+ * @returns the resource if found or NULL otherwise.
*/
const xmlChar *
xmlCatalogGetPublic(const xmlChar *pubID) {
diff --git a/chvalid.c b/chvalid.c
index a3a6c043..f78c49fc 100644
--- a/chvalid.c
+++ b/chvalid.c
@@ -156,14 +156,13 @@ const xmlChRangeGroup xmlIsIdeographicGroup =
/**
- * xmlCharInRange:
- * @val: character to be validated
- * @rptr: pointer to range to be used to validate
+ * @param val character to be validated
+ * @param rptr pointer to range to be used to validate
*
* Does a binary search of the range table to determine if char
* is valid
*
- * Returns: true if character valid, false otherwise
+ * @returns true if character valid, false otherwise
*/
int
xmlCharInRange (unsigned int val, const xmlChRangeGroup *rptr) {
@@ -215,13 +214,12 @@ xmlCharInRange (unsigned int val, const xmlChRangeGroup *rptr) {
/**
- * xmlIsBaseChar:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsBaseChar_ch or xmlIsBaseCharQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsBaseChar(unsigned int ch) {
@@ -230,13 +228,12 @@ xmlIsBaseChar(unsigned int ch) {
/**
- * xmlIsBlank:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsBlank_ch or xmlIsBlankQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsBlank(unsigned int ch) {
@@ -245,13 +242,12 @@ xmlIsBlank(unsigned int ch) {
/**
- * xmlIsChar:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsChar_ch or xmlIsCharQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsChar(unsigned int ch) {
@@ -260,13 +256,12 @@ xmlIsChar(unsigned int ch) {
/**
- * xmlIsCombining:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsCombiningQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsCombining(unsigned int ch) {
@@ -275,13 +270,12 @@ xmlIsCombining(unsigned int ch) {
/**
- * xmlIsDigit:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsDigit_ch or xmlIsDigitQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsDigit(unsigned int ch) {
@@ -290,13 +284,12 @@ xmlIsDigit(unsigned int ch) {
/**
- * xmlIsExtender:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsExtender_ch or xmlIsExtenderQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsExtender(unsigned int ch) {
@@ -305,13 +298,12 @@ xmlIsExtender(unsigned int ch) {
/**
- * xmlIsIdeographic:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsIdeographicQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsIdeographic(unsigned int ch) {
@@ -320,13 +312,12 @@ xmlIsIdeographic(unsigned int ch) {
/**
- * xmlIsPubidChar:
- * @ch: character to validate
+ * @param ch character to validate
*
* This function is DEPRECATED.
* Use xmlIsPubidChar_ch or xmlIsPubidCharQ instead
*
- * Returns true if argument valid, false otherwise
+ * @returns true if argument valid, false otherwise
*/
int
xmlIsPubidChar(unsigned int ch) {
diff --git a/debugXML.c b/debugXML.c
index 4e120311..7d63d6f7 100644
--- a/debugXML.c
+++ b/debugXML.c
@@ -70,13 +70,12 @@ xmlCtxtDumpCleanCtxt(xmlDebugCtxtPtr ctxt ATTRIBUTE_UNUSED)
}
/**
- * xmlNsCheckScope:
- * @node: the node
- * @ns: the namespace node
+ * @param node the node
+ * @param ns the namespace node
*
* Check that a given namespace is in scope on a node.
*
- * Returns 1 if in scope, -1 in case of argument error,
+ * @returns 1 if in scope, -1 in case of argument error,
* -2 if the namespace is not in scope, and -3 if not on
* an ancestor node.
*/
@@ -139,10 +138,9 @@ xmlCtxtDumpSpaces(xmlDebugCtxtPtr ctxt)
}
/**
- * xmlDebugErr:
- * @ctxt: a debug context
- * @error: the error code
- * @msg: the error message
+ * @param ctxt a debug context
+ * @param error the error code
+ * @param msg the error message
*
* Handle a debug error.
*/
@@ -168,10 +166,9 @@ xmlDebugErr3(xmlDebugCtxtPtr ctxt, int error, const char *msg, const char *extra
}
/**
- * xmlCtxtNsCheckScope:
- * @ctxt: the debugging context
- * @node: the node
- * @ns: the namespace node
+ * @param ctxt the debugging context
+ * @param node the node
+ * @param ns the namespace node
*
* Report if a given namespace is is not in scope.
*/
@@ -202,9 +199,8 @@ xmlCtxtNsCheckScope(xmlDebugCtxtPtr ctxt, xmlNodePtr node, xmlNsPtr ns)
}
/**
- * xmlCtxtCheckString:
- * @ctxt: the debug context
- * @str: the string
+ * @param ctxt the debug context
+ * @param str the string
*
* Do debugging on the string, currently it just checks the UTF-8 content
*/
@@ -221,9 +217,8 @@ xmlCtxtCheckString(xmlDebugCtxtPtr ctxt, const xmlChar * str)
}
/**
- * xmlCtxtCheckName:
- * @ctxt: the debug context
- * @name: the name
+ * @param ctxt the debug context
+ * @param name the name
*
* Do debugging on the name, for example the dictionary status and
* conformance to the Name production.
@@ -784,9 +779,8 @@ xmlCtxtDumpEntity(xmlDebugCtxtPtr ctxt, xmlEntityPtr ent)
}
/**
- * xmlCtxtDumpAttr:
- * @ctxt: the debug context
- * @attr: the attribute
+ * @param ctxt the debug context
+ * @param attr the attribute
*
* Dumps debug information for the attribute
*/
@@ -821,9 +815,8 @@ xmlCtxtDumpAttr(xmlDebugCtxtPtr ctxt, xmlAttrPtr attr)
}
/**
- * xmlCtxtDumpAttrList:
- * @ctxt: the debug context
- * @attr: the attribute list
+ * @param ctxt the debug context
+ * @param attr the attribute list
*
* Dumps debug information for the attribute list
*/
@@ -837,9 +830,8 @@ xmlCtxtDumpAttrList(xmlDebugCtxtPtr ctxt, xmlAttrPtr attr)
}
/**
- * xmlCtxtDumpOneNode:
- * @ctxt: the debug context
- * @node: the node
+ * @param ctxt the debug context
+ * @param node the node
*
* Dumps debug information for the element node, it is not recursive/
*/
@@ -1019,9 +1011,8 @@ xmlCtxtDumpOneNode(xmlDebugCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlCtxtDumpNode:
- * @ctxt: the debug context
- * @node: the node
+ * @param ctxt the debug context
+ * @param node the node
*
* Dumps debug information for the element node, it is recursive
*/
@@ -1045,9 +1036,8 @@ xmlCtxtDumpNode(xmlDebugCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlCtxtDumpNodeList:
- * @ctxt: the debug context
- * @node: the node list
+ * @param ctxt the debug context
+ * @param node the node list
*
* Dumps debug information for the list of element node, it is recursive
*/
@@ -1130,9 +1120,8 @@ xmlCtxtDumpDocHead(xmlDebugCtxtPtr ctxt, xmlDocPtr doc)
}
/**
- * xmlCtxtDumpDocumentHead:
- * @ctxt: the debug context
- * @doc: the document
+ * @param ctxt the debug context
+ * @param doc the document
*
* Dumps debug information concerning the document, not recursive
*/
@@ -1170,9 +1159,8 @@ xmlCtxtDumpDocumentHead(xmlDebugCtxtPtr ctxt, xmlDocPtr doc)
}
/**
- * xmlCtxtDumpDocument:
- * @ctxt: the debug context
- * @doc: the document
+ * @param ctxt the debug context
+ * @param doc the document
*
* Dumps debug information for the document, it's recursive
*/
@@ -1241,9 +1229,8 @@ xmlCtxtDumpEntityCallback(void *payload, void *data,
}
/**
- * xmlCtxtDumpEntities:
- * @ctxt: the debug context
- * @doc: the document
+ * @param ctxt the debug context
+ * @param doc the document
*
* Dumps debug information for all the entities in use by the document
*/
@@ -1273,9 +1260,8 @@ xmlCtxtDumpEntities(xmlDebugCtxtPtr ctxt, xmlDocPtr doc)
}
/**
- * xmlCtxtDumpDTD:
- * @ctxt: the debug context
- * @dtd: the DTD
+ * @param ctxt the debug context
+ * @param dtd the DTD
*
* Dumps debug information for the DTD
*/
@@ -1304,9 +1290,8 @@ xmlCtxtDumpDTD(xmlDebugCtxtPtr ctxt, xmlDtdPtr dtd)
************************************************************************/
/**
- * xmlDebugDumpString:
- * @output: the FILE * for the output
- * @str: the string
+ * @param output the FILE * for the output
+ * @param str the string
*
* Dumps information about the string, shorten it if necessary
*/
@@ -1334,10 +1319,9 @@ xmlDebugDumpString(FILE * output, const xmlChar * str)
}
/**
- * xmlDebugDumpAttr:
- * @output: the FILE * for the output
- * @attr: the attribute
- * @depth: the indentation level.
+ * @param output the FILE * for the output
+ * @param attr the attribute
+ * @param depth the indentation level.
*
* Dumps debug information for the attribute
*/
@@ -1355,9 +1339,8 @@ xmlDebugDumpAttr(FILE *output, xmlAttrPtr attr, int depth) {
/**
- * xmlDebugDumpEntities:
- * @output: the FILE * for the output
- * @doc: the document
+ * @param output the FILE * for the output
+ * @param doc the document
*
* Dumps debug information for all the entities in use by the document
*/
@@ -1374,10 +1357,9 @@ xmlDebugDumpEntities(FILE * output, xmlDocPtr doc)
}
/**
- * xmlDebugDumpAttrList:
- * @output: the FILE * for the output
- * @attr: the attribute list
- * @depth: the indentation level.
+ * @param output the FILE * for the output
+ * @param attr the attribute list
+ * @param depth the indentation level.
*
* Dumps debug information for the attribute list
*/
@@ -1395,10 +1377,9 @@ xmlDebugDumpAttrList(FILE * output, xmlAttrPtr attr, int depth)
}
/**
- * xmlDebugDumpOneNode:
- * @output: the FILE * for the output
- * @node: the node
- * @depth: the indentation level.
+ * @param output the FILE * for the output
+ * @param node the node
+ * @param depth the indentation level.
*
* Dumps debug information for the element node, it is not recursive
*/
@@ -1416,10 +1397,9 @@ xmlDebugDumpOneNode(FILE * output, xmlNodePtr node, int depth)
}
/**
- * xmlDebugDumpNode:
- * @output: the FILE * for the output
- * @node: the node
- * @depth: the indentation level.
+ * @param output the FILE * for the output
+ * @param node the node
+ * @param depth the indentation level.
*
* Dumps debug information for the element node, it is recursive
*/
@@ -1438,10 +1418,9 @@ xmlDebugDumpNode(FILE * output, xmlNodePtr node, int depth)
}
/**
- * xmlDebugDumpNodeList:
- * @output: the FILE * for the output
- * @node: the node list
- * @depth: the indentation level.
+ * @param output the FILE * for the output
+ * @param node the node list
+ * @param depth the indentation level.
*
* Dumps debug information for the list of element node, it is recursive
*/
@@ -1460,9 +1439,8 @@ xmlDebugDumpNodeList(FILE * output, xmlNodePtr node, int depth)
}
/**
- * xmlDebugDumpDocumentHead:
- * @output: the FILE * for the output
- * @doc: the document
+ * @param output the FILE * for the output
+ * @param doc the document
*
* Dumps debug information concerning the document, not recursive
*/
@@ -1481,9 +1459,8 @@ xmlDebugDumpDocumentHead(FILE * output, xmlDocPtr doc)
}
/**
- * xmlDebugDumpDocument:
- * @output: the FILE * for the output
- * @doc: the document
+ * @param output the FILE * for the output
+ * @param doc the document
*
* Dumps debug information for the document, it's recursive
*/
@@ -1502,9 +1479,8 @@ xmlDebugDumpDocument(FILE * output, xmlDocPtr doc)
}
/**
- * xmlDebugDumpDTD:
- * @output: the FILE * for the output
- * @dtd: the DTD
+ * @param output the FILE * for the output
+ * @param dtd the DTD
*
* Dumps debug information for the DTD
*/
@@ -1529,14 +1505,13 @@ xmlDebugDumpDTD(FILE * output, xmlDtdPtr dtd)
************************************************************************/
/**
- * xmlDebugCheckDocument:
- * @output: the FILE * for the output
- * @doc: the document
+ * @param output the FILE * for the output
+ * @param doc the document
*
* Check the document for potential content problems, and output
- * the errors to @output
+ * the errors to `output`
*
- * Returns the number of errors found
+ * @returns the number of errors found
*/
int
xmlDebugCheckDocument(FILE * output, xmlDocPtr doc)
diff --git a/dict.c b/dict.c
index 4bce6539..6a859e28 100644
--- a/dict.c
+++ b/dict.c
@@ -81,11 +81,10 @@ struct _xmlDict {
static xmlMutex xmlDictMutex;
/**
- * xmlInitializeDict:
*
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
*
- * Returns 0.
+ * @returns 0.
*/
int
xmlInitializeDict(void) {
@@ -94,7 +93,6 @@ xmlInitializeDict(void) {
}
/**
- * xmlInitDictInternal:
*
* Initialize mutex.
*/
@@ -104,9 +102,8 @@ xmlInitDictInternal(void) {
}
/**
- * xmlDictCleanup:
*
- * DEPRECATED: This function is a no-op. Call xmlCleanupParser
+ * @deprecated This function is a no-op. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have call cleanup functions at all.
@@ -116,7 +113,6 @@ xmlDictCleanup(void) {
}
/**
- * xmlCleanupDictInternal:
*
* Free the dictionary mutex.
*/
@@ -126,14 +122,13 @@ xmlCleanupDictInternal(void) {
}
/*
- * xmlDictAddString:
- * @dict: the dictionary
- * @name: the name of the userdata
- * @len: the length of the name
+ * @param dict the dictionary
+ * @param name the name of the userdata
+ * @param len the length of the name
*
* Add the string to the array[s]
*
- * Returns the pointer of the local string, or NULL in case of error.
+ * @returns the pointer of the local string, or NULL in case of error.
*/
static const xmlChar *
xmlDictAddString(xmlDictPtr dict, const xmlChar *name, unsigned int namelen) {
@@ -192,16 +187,15 @@ found_pool:
}
/*
- * xmlDictAddQString:
- * @dict: the dictionary
- * @prefix: the prefix of the userdata
- * @plen: the prefix length
- * @name: the name of the userdata
- * @len: the length of the name
+ * @param dict the dictionary
+ * @param prefix the prefix of the userdata
+ * @param plen the prefix length
+ * @param name the name of the userdata
+ * @param len the length of the name
*
* Add the QName to the array[s]
*
- * Returns the pointer of the local string, or NULL in case of error.
+ * @returns the pointer of the local string, or NULL in case of error.
*/
static const xmlChar *
xmlDictAddQString(xmlDictPtr dict, const xmlChar *prefix, unsigned int plen,
@@ -255,11 +249,10 @@ found_pool:
}
/**
- * xmlDictCreate:
*
* Create a new dictionary
*
- * Returns the newly created dictionary, or NULL if an error occurred.
+ * @returns the newly created dictionary, or NULL if an error occurred.
*/
xmlDictPtr
xmlDictCreate(void) {
@@ -286,15 +279,14 @@ xmlDictCreate(void) {
}
/**
- * xmlDictCreateSub:
- * @sub: an existing dictionary
+ * @param sub an existing dictionary
*
* Create a new dictionary, inheriting strings from the read-only
- * dictionary @sub. On lookup, strings are first searched in the
- * new dictionary, then in @sub, and if not found are created in the
+ * dictionary `sub`. On lookup, strings are first searched in the
+ * new dictionary, then in `sub`, and if not found are created in the
* new dictionary.
*
- * Returns the newly created dictionary, or NULL if an error occurred.
+ * @returns the newly created dictionary, or NULL if an error occurred.
*/
xmlDictPtr
xmlDictCreateSub(xmlDictPtr sub) {
@@ -309,12 +301,11 @@ xmlDictCreateSub(xmlDictPtr sub) {
}
/**
- * xmlDictReference:
- * @dict: the dictionary
+ * @param dict the dictionary
*
* Increment the reference counter of a dictionary
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlDictReference(xmlDictPtr dict) {
@@ -326,11 +317,10 @@ xmlDictReference(xmlDictPtr dict) {
}
/**
- * xmlDictFree:
- * @dict: the dictionary
+ * @param dict the dictionary
*
- * Free the hash @dict and its contents. The userdata is
- * deallocated with @f if provided.
+ * Free the hash `dict` and its contents. The userdata is
+ * deallocated with `f` if provided.
*/
void
xmlDictFree(xmlDictPtr dict) {
@@ -366,13 +356,12 @@ xmlDictFree(xmlDictPtr dict) {
}
/**
- * xmlDictOwns:
- * @dict: the dictionary
- * @str: the string
+ * @param dict the dictionary
+ * @param str the string
*
* check if a string is owned by the dictionary
*
- * Returns 1 if true, 0 if false and -1 in case of error
+ * @returns 1 if true, 0 if false and -1 in case of error
* -1 in case of error
*/
int
@@ -393,12 +382,11 @@ xmlDictOwns(xmlDictPtr dict, const xmlChar *str) {
}
/**
- * xmlDictSize:
- * @dict: the dictionary
+ * @param dict the dictionary
*
- * Query the number of elements installed in the hash @dict.
+ * Query the number of elements installed in the hash `dict`.
*
- * Returns the number of elements in the dictionary or
+ * @returns the number of elements in the dictionary or
* -1 in case of error
*/
int
@@ -411,14 +399,13 @@ xmlDictSize(xmlDictPtr dict) {
}
/**
- * xmlDictSetLimit:
- * @dict: the dictionary
- * @limit: the limit in bytes
+ * @param dict the dictionary
+ * @param limit the limit in bytes
*
* Set a size limit for the dictionary
* Added in 2.9.0
*
- * Returns the previous limit of the dictionary or 0
+ * @returns the previous limit of the dictionary or 0
*/
size_t
xmlDictSetLimit(xmlDictPtr dict, size_t limit) {
@@ -432,13 +419,12 @@ xmlDictSetLimit(xmlDictPtr dict, size_t limit) {
}
/**
- * xmlDictGetUsage:
- * @dict: the dictionary
+ * @param dict the dictionary
*
* Get how much memory is used by a dictionary for strings
* Added in 2.9.0
*
- * Returns the amount of strings allocated
+ * @returns the amount of strings allocated
*/
size_t
xmlDictGetUsage(xmlDictPtr dict) {
@@ -512,13 +498,12 @@ xmlDictHashQName(unsigned seed, const xmlChar *prefix, const xmlChar *name,
}
/**
- * xmlDictComputeHash:
- * @dict: dictionary
- * @string: C string
+ * @param dict dictionary
+ * @param string C string
*
* Compute the hash value of a C string.
*
- * Returns the hash value.
+ * @returns the hash value.
*/
unsigned
xmlDictComputeHash(const xmlDict *dict, const xmlChar *string) {
@@ -529,13 +514,12 @@ xmlDictComputeHash(const xmlDict *dict, const xmlChar *string) {
#define HASH_ROL31(x,n) ((x) << (n) | ((x) & 0x7FFFFFFF) >> (31 - (n)))
/**
- * xmlDictCombineHash:
- * @v1: first hash value
- * @v2: second hash value
+ * @param v1 first hash value
+ * @param v2 second hash value
*
* Combine two hash values.
*
- * Returns the combined hash value.
+ * @returns the combined hash value.
*/
ATTRIBUTE_NO_SANITIZE_INTEGER
unsigned
@@ -551,16 +535,15 @@ xmlDictCombineHash(unsigned v1, unsigned v2) {
}
/**
- * xmlDictFindEntry:
- * @dict: dict
- * @prefix: optional QName prefix
- * @name: string
- * @len: length of string
- * @hashValue: valid hash value of string
- * @pfound: result of search
+ * @param dict dict
+ * @param prefix optional QName prefix
+ * @param name string
+ * @param len length of string
+ * @param hashValue valid hash value of string
+ * @param pfound result of search
*
* Try to find a matching hash table entry. If an entry was found, set
- * @found to 1 and return the entry. Otherwise, set @found to 0 and return
+ * `found` to 1 and return the entry. Otherwise, set `found` to 0 and return
* the location where a new entry should be inserted.
*/
ATTRIBUTE_NO_SANITIZE_INTEGER
@@ -618,13 +601,12 @@ xmlDictFindEntry(const xmlDict *dict, const xmlChar *prefix,
}
/**
- * xmlDictGrow:
- * @dict: dictionary
- * @size: new size of the dictionary
+ * @param dict dictionary
+ * @param size new size of the dictionary
*
* Resize the dictionary hash table.
*
- * Returns 0 in case of success, -1 if a memory allocation failed.
+ * @returns 0 in case of success, -1 if a memory allocation failed.
*/
static int
xmlDictGrow(xmlDictPtr dict, unsigned size) {
@@ -685,12 +667,11 @@ done:
}
/**
- * xmlDictLookupInternal:
- * @dict: dict
- * @prefix: optional QName prefix
- * @name: string
- * @maybeLen: length of string or -1 if unknown
- * @update: whether the string should be added
+ * @param dict dict
+ * @param prefix optional QName prefix
+ * @param name string
+ * @param maybeLen length of string or -1 if unknown
+ * @param update whether the string should be added
*
* Internal lookup and update function.
*/
@@ -835,14 +816,13 @@ xmlDictLookupInternal(xmlDictPtr dict, const xmlChar *prefix,
}
/**
- * xmlDictLookup:
- * @dict: dictionary
- * @name: string key
- * @len: length of the key, if -1 it is recomputed
+ * @param dict dictionary
+ * @param name string key
+ * @param len length of the key, if -1 it is recomputed
*
* Lookup a string and add it to the dictionary if it wasn't found.
*
- * Returns the interned copy of the string or NULL if a memory allocation
+ * @returns the interned copy of the string or NULL if a memory allocation
* failed.
*/
const xmlChar *
@@ -856,15 +836,14 @@ xmlDictLookup(xmlDictPtr dict, const xmlChar *name, int len) {
}
/**
- * xmlDictLookupHashed:
- * @dict: dictionary
- * @name: string key
- * @len: length of the key, if -1 it is recomputed
+ * @param dict dictionary
+ * @param name string key
+ * @param len length of the key, if -1 it is recomputed
*
* Lookup a dictionary entry and add the string to the dictionary if
* it wasn't found.
*
- * Returns the dictionary entry.
+ * @returns the dictionary entry.
*/
xmlHashedString
xmlDictLookupHashed(xmlDictPtr dict, const xmlChar *name, int len) {
@@ -884,14 +863,13 @@ xmlDictLookupHashed(xmlDictPtr dict, const xmlChar *name, int len) {
}
/**
- * xmlDictExists:
- * @dict: the dictionary
- * @name: the name of the userdata
- * @len: the length of the name, if -1 it is recomputed
+ * @param dict the dictionary
+ * @param name the name of the userdata
+ * @param len the length of the name, if -1 it is recomputed
*
* Check if a string exists in the dictionary.
*
- * Returns the internal copy of the name or NULL if not found.
+ * @returns the internal copy of the name or NULL if not found.
*/
const xmlChar *
xmlDictExists(xmlDictPtr dict, const xmlChar *name, int len) {
@@ -904,15 +882,14 @@ xmlDictExists(xmlDictPtr dict, const xmlChar *name, int len) {
}
/**
- * xmlDictQLookup:
- * @dict: the dictionary
- * @prefix: the prefix
- * @name: the name
+ * @param dict the dictionary
+ * @param prefix the prefix
+ * @param name the name
*
* Lookup the QName `prefix:name` and add it to the dictionary if
* it wasn't found.
*
- * Returns the interned copy of the string or NULL if a memory allocation
+ * @returns the interned copy of the string or NULL if a memory allocation
* failed.
*/
const xmlChar *
@@ -948,7 +925,6 @@ static xmlMutex xmlRngMutex;
static unsigned globalRngState[2];
/*
- * xmlInitRandom:
*
* Initialize the PRNG.
*/
@@ -1016,7 +992,6 @@ xmlInitRandom(void) {
}
/*
- * xmlCleanupRandom:
*
* Clean up PRNG globals.
*/
@@ -1040,11 +1015,10 @@ xoroshiro64ss(unsigned *s) {
}
/*
- * xmlGlobalRandom:
*
* Generate a pseudo-random value using the global PRNG.
*
- * Returns a random value.
+ * @returns a random value.
*/
unsigned
xmlGlobalRandom(void) {
@@ -1058,11 +1032,10 @@ xmlGlobalRandom(void) {
}
/*
- * xmlRandom:
*
* Generate a pseudo-random value using the thread-local PRNG.
*
- * Returns a random value.
+ * @returns a random value.
*/
unsigned
xmlRandom(void) {
diff --git a/encoding.c b/encoding.c
index a8a35101..8529733d 100644
--- a/encoding.c
+++ b/encoding.c
@@ -9,7 +9,7 @@
* [UNICODE] The Unicode Consortium, "The Unicode Standard --
* Worldwide Character Encoding -- Version 1.0", Addison-
* Wesley, Volume 1, 1991, Volume 2, 1992. UTF-8 is
- * described in Unicode Technical Report #4.
+ * described in Unicode Technical Report \#4.
* [US-ASCII] Coded Character Set--7-bit American Standard Code for
* Information Interchange, ANSI X3.4-1986.
*
@@ -256,15 +256,14 @@ xmlCharEncUconv(const char *name, xmlCharEncFlags flags,
************************************************************************/
/**
- * xmlDetectCharEncoding:
- * @in: a pointer to the first bytes of the XML entity, must be at least
+ * @param in a pointer to the first bytes of the XML entity, must be at least
* 2 bytes long (at least 4 if encoding is UTF4 variant).
- * @len: pointer to the length of the buffer
+ * @param len pointer to the length of the buffer
*
* Guess the encoding of the entity using the first bytes of the entity content
* according to the non-normative appendix F of the XML-1.0 recommendation.
*
- * Returns one of the XML_CHAR_ENCODING_... values.
+ * @returns one of the XML_CHAR_ENCODING_... values.
*/
xmlCharEncoding
xmlDetectCharEncoding(const unsigned char* in, int len)
@@ -316,9 +315,8 @@ xmlDetectCharEncoding(const unsigned char* in, int len)
}
/**
- * xmlCleanupEncodingAliases:
*
- * DEPRECATED: This function modifies global state and is not
+ * @deprecated This function modifies global state and is not
* thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative.
*
* Unregisters all aliases
@@ -343,14 +341,13 @@ xmlCleanupEncodingAliases(void) {
}
/**
- * xmlGetEncodingAlias:
- * @alias: the alias name as parsed, in UTF-8 format (ASCII actually)
+ * @param alias the alias name as parsed, in UTF-8 format (ASCII actually)
*
- * DEPRECATED: This function is not thread-safe.
+ * @deprecated This function is not thread-safe.
*
* Lookup an encoding name for the given alias.
*
- * Returns NULL if not found, otherwise the original name
+ * @returns NULL if not found, otherwise the original name
*/
const char *
xmlGetEncodingAlias(const char *alias) {
@@ -381,17 +378,16 @@ xmlGetEncodingAlias(const char *alias) {
}
/**
- * xmlAddEncodingAlias:
- * @name: the encoding name as parsed, in UTF-8 format (ASCII actually)
- * @alias: the alias name as parsed, in UTF-8 format (ASCII actually)
+ * @param name the encoding name as parsed, in UTF-8 format (ASCII actually)
+ * @param alias the alias name as parsed, in UTF-8 format (ASCII actually)
*
- * DEPRECATED: This function modifies global state and is not
+ * @deprecated This function modifies global state and is not
* thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative.
*
- * Registers an alias @alias for an encoding named @name. Existing alias
+ * Registers an alias `alias` for an encoding named `name`. Existing alias
* will be overwritten.
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlAddEncodingAlias(const char *name, const char *alias) {
@@ -457,15 +453,14 @@ xmlAddEncodingAlias(const char *name, const char *alias) {
}
/**
- * xmlDelEncodingAlias:
- * @alias: the alias name as parsed, in UTF-8 format (ASCII actually)
+ * @param alias the alias name as parsed, in UTF-8 format (ASCII actually)
*
- * DEPRECATED: This function modifies global state and is not
+ * @deprecated This function modifies global state and is not
* thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative.
*
- * Unregisters an encoding alias @alias
+ * Unregisters an encoding alias `alias`
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlDelEncodingAlias(const char *alias) {
@@ -518,14 +513,13 @@ xmlParseCharEncodingInternal(const char *name)
}
/**
- * xmlParseCharEncoding:
- * @name: the encoding name as parsed, in UTF-8 format (ASCII actually)
+ * @param name the encoding name as parsed, in UTF-8 format (ASCII actually)
*
* Compare the string to the encoding schemes already known. Note
* that the comparison is case insensitive accordingly to the section
* [XML] 4.3.3 Character Encoding in Entities.
*
- * Returns one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE
+ * @returns one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE
* if not recognized.
*/
xmlCharEncoding
@@ -541,14 +535,13 @@ xmlParseCharEncoding(const char *name)
}
/**
- * xmlGetCharEncodingName:
- * @enc: the encoding
+ * @param enc the encoding
*
* The "canonical" name for XML encoding.
- * C.f. http://www.w3.org/TR/REC-xml#charencoding
+ * C.f. http://www.w3.org/TR/REC-xml\#charencoding
* Section 4.3.3 Character Encoding in Entities
*
- * Returns the canonical name for the given encoding
+ * @returns the canonical name for the given encoding
*/
const char*
xmlGetCharEncodingName(xmlCharEncoding enc) {
@@ -578,17 +571,16 @@ xmlGetCharEncodingName(xmlCharEncoding enc) {
************************************************************************/
/**
- * xmlNewCharEncodingHandler:
- * @name: the encoding name, in UTF-8 format (ASCII actually)
- * @input: the xmlCharEncodingInputFunc to read that encoding
- * @output: the xmlCharEncodingOutputFunc to write that encoding
+ * @param name the encoding name, in UTF-8 format (ASCII actually)
+ * @param input the xmlCharEncodingInputFunc to read that encoding
+ * @param output the xmlCharEncodingOutputFunc to write that encoding
*
- * DEPRECATED: This function modifies global state and is not
+ * @deprecated This function modifies global state and is not
* thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative.
*
* Create and registers an xmlCharEncodingHandler.
*
- * Returns the xmlCharEncodingHandlerPtr created (or NULL in case of error).
+ * @returns the xmlCharEncodingHandlerPtr created (or NULL in case of error).
*/
xmlCharEncodingHandlerPtr
xmlNewCharEncodingHandler(const char *name,
@@ -644,18 +636,17 @@ xmlNewCharEncodingHandler(const char *name,
}
/**
- * xmlCharEncNewCustomHandler:
- * @name: the encoding name
- * @input: input callback which converts to UTF-8
- * @output: output callback which converts from UTF-8
- * @ctxtDtor: context destructor
- * @inputCtxt: context for input callback
- * @outputCtxt: context for output callback
- * @out: pointer to resulting handler
+ * @param name the encoding name
+ * @param input input callback which converts to UTF-8
+ * @param output output callback which converts from UTF-8
+ * @param ctxtDtor context destructor
+ * @param inputCtxt context for input callback
+ * @param outputCtxt context for output callback
+ * @param out pointer to resulting handler
*
* Create a custom xmlCharEncodingHandler.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
xmlParserErrors
xmlCharEncNewCustomHandler(const char *name,
@@ -702,9 +693,8 @@ error:
}
/**
- * xmlInitCharEncodingHandlers:
*
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
*/
void
xmlInitCharEncodingHandlers(void) {
@@ -712,7 +702,6 @@ xmlInitCharEncodingHandlers(void) {
}
/**
- * xmlInitEncodingInternal:
*
* Initialize the char encoding support.
*/
@@ -726,9 +715,8 @@ xmlInitEncodingInternal(void) {
}
/**
- * xmlCleanupCharEncodingHandlers:
*
- * DEPRECATED: This function will be made private. Call xmlCleanupParser
+ * @deprecated This function will be made private. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have call cleanup functions at all.
@@ -759,10 +747,9 @@ xmlCleanupCharEncodingHandlers(void) {
}
/**
- * xmlRegisterCharEncodingHandler:
- * @handler: the xmlCharEncodingHandlerPtr handler block
+ * @param handler the xmlCharEncodingHandlerPtr handler block
*
- * DEPRECATED: This function modifies global state and is not
+ * @deprecated This function modifies global state and is not
* thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative.
*
* Register the char encoding handler.
@@ -793,17 +780,16 @@ free_handler:
}
/**
- * xmlFindExtraHandler:
- * @norig: name of the char encoding
- * @name: potentially aliased name of the encoding
- * @flags: bit mask of flags
- * @impl: a conversion implementation (optional)
- * @implCtxt: user data for conversion implementation (optional)
- * @out: pointer to resulting handler
+ * @param norig name of the char encoding
+ * @param name potentially aliased name of the encoding
+ * @param flags bit mask of flags
+ * @param impl a conversion implementation (optional)
+ * @param implCtxt user data for conversion implementation (optional)
+ * @param out pointer to resulting handler
*
* Search the non-default handlers for an exact match.
*
- * Returns an xmlParserErrors error code.
+ * @returns an xmlParserErrors error code.
*/
static xmlParserErrors
xmlFindExtraHandler(const char *norig, const char *name, xmlCharEncFlags flags,
@@ -864,9 +850,8 @@ xmlFindExtraHandler(const char *norig, const char *name, xmlCharEncFlags flags,
}
/**
- * xmlLookupCharEncodingHandler:
- * @enc: an xmlCharEncoding value.
- * @out: pointer to result
+ * @param enc an xmlCharEncoding value.
+ * @param out pointer to result
*
* Find or create a handler matching the encoding. The following
* converters are looked up in order:
@@ -883,7 +868,7 @@ xmlFindExtraHandler(const char *norig, const char *name, xmlCharEncFlags flags,
*
* Available since 2.13.0.
*
- * Returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another
+ * @returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another
* xmlParserErrors error code.
*/
xmlParserErrors
@@ -923,13 +908,12 @@ xmlLookupCharEncodingHandler(xmlCharEncoding enc,
}
/**
- * xmlGetCharEncodingHandler:
- * @enc: an xmlCharEncoding value.
+ * @param enc an xmlCharEncoding value.
*
- * DEPRECATED: Use xmlLookupCharEncodingHandler which has better error
+ * @deprecated Use xmlLookupCharEncodingHandler which has better error
* reporting.
*
- * Returns the handler or NULL if no handler was found or an error
+ * @returns the handler or NULL if no handler was found or an error
* occurred.
*/
xmlCharEncodingHandlerPtr
@@ -941,12 +925,11 @@ xmlGetCharEncodingHandler(xmlCharEncoding enc) {
}
/**
- * xmlCreateCharEncodingHandler:
- * @name: a string describing the char encoding.
- * @flags: bit mask of flags
- * @impl: a conversion implementation (optional)
- * @implCtxt: user data for conversion implementation (optional)
- * @out: pointer to result
+ * @param name a string describing the char encoding.
+ * @param flags bit mask of flags
+ * @param impl a conversion implementation (optional)
+ * @param implCtxt user data for conversion implementation (optional)
+ * @param out pointer to result
*
* Find or create a handler matching the encoding. The following
* converters are looked up in order:
@@ -962,11 +945,11 @@ xmlGetCharEncodingHandler(xmlCharEncoding enc) {
* If the encoding is UTF-8, a NULL handler and no error code will
* be returned.
*
- * @flags can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
+ * `flags` can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
*
* Available since 2.14.0.
*
- * Returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another
+ * @returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another
* xmlParserErrors error code.
*/
xmlParserErrors
@@ -1008,10 +991,9 @@ xmlCreateCharEncodingHandler(const char *name, xmlCharEncFlags flags,
}
/**
- * xmlOpenCharEncodingHandler:
- * @name: a string describing the char encoding.
- * @output: boolean, use handler for output
- * @out: pointer to result
+ * @param name a string describing the char encoding.
+ * @param output boolean, use handler for output
+ * @param out pointer to result
*
* Find or create a handler matching the encoding. The following
* converters are looked up in order:
@@ -1028,7 +1010,7 @@ xmlCreateCharEncodingHandler(const char *name, xmlCharEncFlags flags,
*
* Available since 2.13.0.
*
- * Returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another
+ * @returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another
* xmlParserErrors error code.
*/
xmlParserErrors
@@ -1040,16 +1022,15 @@ xmlOpenCharEncodingHandler(const char *name, int output,
}
/**
- * xmlFindCharEncodingHandler:
- * @name: a string describing the char encoding.
+ * @param name a string describing the char encoding.
*
- * DEPRECATED: Use xmlOpenCharEncodingHandler which has better error
+ * @deprecated Use xmlOpenCharEncodingHandler which has better error
* reporting.
*
* If the encoding is UTF-8, this will return a no-op handler that
* shouldn't be used.
*
- * Returns the handler or NULL if no handler was found or an error
+ * @returns the handler or NULL if no handler was found or an error
* occurred.
*/
xmlCharEncodingHandlerPtr
@@ -1086,19 +1067,18 @@ typedef struct {
} xmlIconvCtxt;
/**
- * xmlIconvConvert:
- * @vctxt: conversion context
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of input bytes
- * @inlen: the length of @in
- * @flush: end of input
+ * @param vctxt conversion context
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of input bytes
+ * @param inlen the length of `in`
+ * @param flush end of input
*
- * The value of @inlen after return is the number of octets consumed
+ * The value of `inlen` after return is the number of octets consumed
* as the return value is positive, else unpredictable.
- * The value of @outlen after return is the number of octets produced.
+ * The value of `outlen` after return is the number of octets produced.
*
- * Returns an XML_ENC_ERR code.
+ * @returns an XML_ENC_ERR code.
*/
static xmlCharEncError
xmlIconvConvert(void *vctxt, unsigned char *out, int *outlen,
@@ -1320,19 +1300,18 @@ struct _uconv_t {
};
/**
- * xmlUconvConvert:
- * @vctxt: conversion context
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of input bytes
- * @inlen: the length of @in
- * @flush: end of input
+ * @param vctxt conversion context
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of input bytes
+ * @param inlen the length of `in`
+ * @param flush end of input
*
- * Returns an XML_ENC_ERR code.
+ * @returns an XML_ENC_ERR code.
*
- * The value of @inlen after return is the number of octets consumed
+ * The value of `inlen` after return is the number of octets consumed
* as the return value is positive, else unpredictable.
- * The value of @outlen after return is the number of octets produced.
+ * The value of `outlen` after return is the number of octets produced.
*/
static xmlCharEncError
xmlUconvConvert(void *vctxt, unsigned char *out, int *outlen,
@@ -1515,8 +1494,7 @@ error:
************************************************************************/
/**
- * xmlEncConvertError:
- * @code: XML_ENC_ERR code
+ * @param code XML_ENC_ERR code
*
* Convert XML_ENC_ERR to libxml2 error codes.
*/
@@ -1543,19 +1521,18 @@ xmlEncConvertError(xmlCharEncError code) {
}
/**
- * xmlEncInputChunk:
- * @handler: encoding handler
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of input bytes
- * @inlen: the length of @in
- * @flush: end of input
+ * @param handler encoding handler
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of input bytes
+ * @param inlen the length of `in`
+ * @param flush end of input
*
- * The value of @inlen after return is the number of octets consumed
+ * The value of `inlen` after return is the number of octets consumed
* as the return value is 0, else unpredictable.
- * The value of @outlen after return is the number of octets produced.
+ * The value of `outlen` after return is the number of octets produced.
*
- * Returns an XML_ENC_ERR code.
+ * @returns an XML_ENC_ERR code.
*/
xmlCharEncError
xmlEncInputChunk(xmlCharEncodingHandler *handler, unsigned char *out,
@@ -1600,18 +1577,17 @@ xmlEncInputChunk(xmlCharEncodingHandler *handler, unsigned char *out,
}
/**
- * xmlEncOutputChunk:
- * @handler: encoding handler
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of input bytes
- * @inlen: the length of @in
+ * @param handler encoding handler
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of input bytes
+ * @param inlen the length of `in`
*
- * Returns an XML_ENC_ERR code.
+ * @returns an XML_ENC_ERR code.
*
- * The value of @inlen after return is the number of octets consumed
+ * The value of `inlen` after return is the number of octets consumed
* as the return value is 0, else unpredictable.
- * The value of @outlen after return is the number of octets produced.
+ * The value of `outlen` after return is the number of octets produced.
*/
static xmlCharEncError
xmlEncOutputChunk(xmlCharEncodingHandler *handler, unsigned char *out,
@@ -1647,14 +1623,13 @@ xmlEncOutputChunk(xmlCharEncodingHandler *handler, unsigned char *out,
}
/**
- * xmlCharEncFirstLine:
- * @handler: char encoding transformation data structure
- * @out: an xmlBuffer for the output.
- * @in: an xmlBuffer for the input
+ * @param handler char encoding transformation data structure
+ * @param out an xmlBuffer for the output.
+ * @param in an xmlBuffer for the input
*
* DEPERECATED: Don't use.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*/
int
xmlCharEncFirstLine(xmlCharEncodingHandler *handler, xmlBufferPtr out,
@@ -1663,17 +1638,16 @@ xmlCharEncFirstLine(xmlCharEncodingHandler *handler, xmlBufferPtr out,
}
/**
- * xmlCharEncInput:
- * @input: a parser input buffer
- * @sizeOut: pointer to output size
- * @flush: end of input
+ * @param input a parser input buffer
+ * @param sizeOut pointer to output size
+ * @param flush end of input
*
- * @sizeOut should be set to the maximum output size (or SIZE_MAX).
+ * `sizeOut` should be set to the maximum output size (or SIZE_MAX).
* After return, it is set to the number of bytes written.
*
* Generic front-end for the encoding handler on parser input
*
- * Returns an XML_ENC_ERR code.
+ * @returns an XML_ENC_ERR code.
*/
xmlCharEncError
xmlCharEncInput(xmlParserInputBufferPtr input, size_t *sizeOut, int flush)
@@ -1767,14 +1741,13 @@ xmlCharEncInput(xmlParserInputBufferPtr input, size_t *sizeOut, int flush)
}
/**
- * xmlCharEncInFunc:
- * @handler: char encoding transformation data structure
- * @out: an xmlBuffer for the output.
- * @in: an xmlBuffer for the input
+ * @param handler char encoding transformation data structure
+ * @param out an xmlBuffer for the output.
+ * @param in an xmlBuffer for the input
*
* Generic front-end for the encoding handler input function
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*/
int
xmlCharEncInFunc(xmlCharEncodingHandler * handler, xmlBufferPtr out,
@@ -1810,18 +1783,17 @@ xmlCharEncInFunc(xmlCharEncodingHandler * handler, xmlBufferPtr out,
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlCharEncOutput:
- * @output: a parser output buffer
- * @init: is this an initialization call without data
+ * @param output a parser output buffer
+ * @param init is this an initialization call without data
*
* Generic front-end for the encoding handler on parser output
- * a first call with @init == 1 has to be made first to initiate the
+ * a first call with `init` == 1 has to be made first to initiate the
* output in case of non-stateless encoding needing to initiate their
* state or the output (like the BOM in UTF16).
* In case of UTF8 sequence conversion errors for the given encoder,
* the content will be automatically remapped to a CharRef sequence.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*/
int
xmlCharEncOutput(xmlOutputBufferPtr output, int init)
@@ -1933,19 +1905,18 @@ error:
#endif
/**
- * xmlCharEncOutFunc:
- * @handler: char encoding transformation data structure
- * @out: an xmlBuffer for the output.
- * @in: an xmlBuffer for the input
+ * @param handler char encoding transformation data structure
+ * @param out an xmlBuffer for the output.
+ * @param in an xmlBuffer for the input
*
* Generic front-end for the encoding handler output function
- * a first call with @in == NULL has to be made firs to initiate the
+ * a first call with `in` == NULL has to be made firs to initiate the
* output in case of non-stateless encoding needing to initiate their
* state or the output (like the BOM in UTF16).
* In case of UTF8 sequence conversion errors for the given encoder,
* the content will be automatically remapped to a CharRef sequence.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*/
int
xmlCharEncOutFunc(xmlCharEncodingHandler *handler, xmlBufferPtr out,
@@ -2033,13 +2004,12 @@ retry:
}
/**
- * xmlCharEncCloseFunc:
- * @handler: char encoding transformation data structure
+ * @param handler char encoding transformation data structure
*
* Releases an xmlCharEncodingHandler. Must be called after
* a handler is no longer in use.
*
- * Returns 0.
+ * @returns 0.
*/
int
xmlCharEncCloseFunc(xmlCharEncodingHandler *handler) {
@@ -2059,10 +2029,9 @@ xmlCharEncCloseFunc(xmlCharEncodingHandler *handler) {
}
/**
- * xmlByteConsumed:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This function provides the current index of the parser relative
* to the start of the current entity. This function is computed in
@@ -2071,7 +2040,7 @@ xmlCharEncCloseFunc(xmlCharEncodingHandler *handler) {
* of constant cost if the input is UTF-8 but can be costly if run
* on non-UTF-8 input.
*
- * Returns the index in bytes from the beginning of the entity or -1
+ * @returns the index in bytes from the beginning of the entity or -1
* in case the index could not be computed.
*/
long
@@ -2214,20 +2183,19 @@ done:
}
/**
- * xmlIsolat1ToUTF8:
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of ISO Latin 1 chars
- * @inlen: the length of @in
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of ISO Latin 1 chars
+ * @param inlen the length of `in`
*
* Take a block of ISO Latin 1 chars in and try to convert it to an UTF-8
* block of chars out.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*
- * The value of @inlen after return is the number of octets consumed
+ * The value of `inlen` after return is the number of octets consumed
* if the return value is positive, else unpredictable.
- * The value of @outlen after return is the number of octets produced.
+ * The value of `outlen` after return is the number of octets produced.
*/
int
xmlIsolat1ToUTF8(unsigned char* out, int *outlen,
@@ -2320,20 +2288,19 @@ done:
}
/**
- * xmlUTF8ToIsolat1:
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of UTF-8 chars
- * @inlen: the length of @in
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of UTF-8 chars
+ * @param inlen the length of `in`
*
* Take a block of UTF-8 chars in and try to convert it to an ISO Latin 1
* block of chars out.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*
- * The value of @inlen after return is the number of octets consumed
+ * The value of `inlen` after return is the number of octets consumed
* if the return value is positive, else unpredictable.
- * The value of @outlen after return is the number of octets produced.
+ * The value of `outlen` after return is the number of octets produced.
*/
int
xmlUTF8ToIsolat1(unsigned char* out, int *outlen,
diff --git a/entities.c b/entities.c
index a5804133..822f8503 100644
--- a/entities.c
+++ b/entities.c
@@ -74,8 +74,7 @@ static xmlEntity xmlEntityApos = {
};
/*
- * xmlFreeEntity:
- * @entity: an entity
+ * @param entity an entity
*
* Frees the entity.
*/
@@ -111,7 +110,6 @@ xmlFreeEntity(xmlEntityPtr entity)
}
/*
- * xmlCreateEntity:
*
* internal routine doing the entity node structures allocations
*/
@@ -169,21 +167,20 @@ error:
}
/**
- * xmlAddEntity:
- * @doc: the document
- * @extSubset: add to the external or internal subset
- * @name: the entity name
- * @type: the entity type XML_xxx_yyy_ENTITY
- * @ExternalID: the entity external ID if available
- * @SystemID: the entity system ID if available
- * @content: the entity content
- * @out: pointer to resulting entity (optional)
+ * @param doc the document
+ * @param extSubset add to the external or internal subset
+ * @param name the entity name
+ * @param type the entity type XML_xxx_yyy_ENTITY
+ * @param ExternalID the entity external ID if available
+ * @param SystemID the entity system ID if available
+ * @param content the entity content
+ * @param out pointer to resulting entity (optional)
*
* Register a new entity for this document.
*
* Available since 2.13.0.
*
- * Returns an xmlParserErrors error code.
+ * @returns an xmlParserErrors error code.
*/
int
xmlAddEntity(xmlDocPtr doc, int extSubset, const xmlChar *name, int type,
@@ -300,12 +297,11 @@ xmlAddEntity(xmlDocPtr doc, int extSubset, const xmlChar *name, int type,
}
/**
- * xmlGetPredefinedEntity:
- * @name: the entity name
+ * @param name the entity name
*
* Check whether this name is an predefined entity.
*
- * Returns NULL if not, otherwise the entity
+ * @returns NULL if not, otherwise the entity
*/
xmlEntityPtr
xmlGetPredefinedEntity(const xmlChar *name) {
@@ -336,17 +332,16 @@ xmlGetPredefinedEntity(const xmlChar *name) {
}
/**
- * xmlAddDtdEntity:
- * @doc: the document
- * @name: the entity name
- * @type: the entity type XML_xxx_yyy_ENTITY
- * @ExternalID: the entity external ID if available
- * @SystemID: the entity system ID if available
- * @content: the entity content
+ * @param doc the document
+ * @param name the entity name
+ * @param type the entity type XML_xxx_yyy_ENTITY
+ * @param ExternalID the entity external ID if available
+ * @param SystemID the entity system ID if available
+ * @param content the entity content
*
* Register a new entity for this document DTD external subset.
*
- * Returns a pointer to the entity or NULL in case of error
+ * @returns a pointer to the entity or NULL in case of error
*/
xmlEntityPtr
xmlAddDtdEntity(xmlDocPtr doc, const xmlChar *name, int type,
@@ -359,17 +354,16 @@ xmlAddDtdEntity(xmlDocPtr doc, const xmlChar *name, int type,
}
/**
- * xmlAddDocEntity:
- * @doc: the document
- * @name: the entity name
- * @type: the entity type XML_xxx_yyy_ENTITY
- * @ExternalID: the entity external ID if available
- * @SystemID: the entity system ID if available
- * @content: the entity content
+ * @param doc the document
+ * @param name the entity name
+ * @param type the entity type XML_xxx_yyy_ENTITY
+ * @param ExternalID the entity external ID if available
+ * @param SystemID the entity system ID if available
+ * @param content the entity content
*
* Register a new entity for this document.
*
- * Returns a pointer to the entity or NULL in case of error
+ * @returns a pointer to the entity or NULL in case of error
*/
xmlEntityPtr
xmlAddDocEntity(xmlDocPtr doc, const xmlChar *name, int type,
@@ -382,13 +376,12 @@ xmlAddDocEntity(xmlDocPtr doc, const xmlChar *name, int type,
}
/**
- * xmlNewEntity:
- * @doc: the document
- * @name: the entity name
- * @type: the entity type XML_xxx_yyy_ENTITY
- * @ExternalID: the entity external ID if available
- * @SystemID: the entity system ID if available
- * @content: the entity content
+ * @param doc the document
+ * @param name the entity name
+ * @param type the entity type XML_xxx_yyy_ENTITY
+ * @param ExternalID the entity external ID if available
+ * @param SystemID the entity system ID if available
+ * @param content the entity content
*
* Create a new entity, this differs from xmlAddDocEntity() that if
* the document is NULL or has no internal subset defined, then an
@@ -396,7 +389,7 @@ xmlAddDocEntity(xmlDocPtr doc, const xmlChar *name, int type,
* of the caller to link it to the document later or free it when not needed
* anymore.
*
- * Returns a pointer to the entity or NULL in case of error
+ * @returns a pointer to the entity or NULL in case of error
*/
xmlEntityPtr
xmlNewEntity(xmlDocPtr doc, const xmlChar *name, int type,
@@ -411,14 +404,13 @@ xmlNewEntity(xmlDocPtr doc, const xmlChar *name, int type,
}
/**
- * xmlGetEntityFromTable:
- * @table: an entity table
- * @name: the entity name
+ * @param table an entity table
+ * @param name the entity name
*
* Do an entity lookup in the table.
- * returns the corresponding parameter entity, if found.
+ * @returns the corresponding parameter entity, if found.
*
- * Returns A pointer to the entity structure or NULL if not found.
+ * @returns A pointer to the entity structure or NULL if not found.
*/
static xmlEntityPtr
xmlGetEntityFromTable(xmlEntitiesTablePtr table, const xmlChar *name) {
@@ -426,14 +418,13 @@ xmlGetEntityFromTable(xmlEntitiesTablePtr table, const xmlChar *name) {
}
/**
- * xmlGetParameterEntity:
- * @doc: the document referencing the entity
- * @name: the entity name
+ * @param doc the document referencing the entity
+ * @param name the entity name
*
* Do an entity lookup in the internal and external subsets and
- * returns the corresponding parameter entity, if found.
+ * @returns the corresponding parameter entity, if found.
*
- * Returns A pointer to the entity structure or NULL if not found.
+ * @returns A pointer to the entity structure or NULL if not found.
*/
xmlEntityPtr
xmlGetParameterEntity(xmlDocPtr doc, const xmlChar *name) {
@@ -456,15 +447,14 @@ xmlGetParameterEntity(xmlDocPtr doc, const xmlChar *name) {
}
/**
- * xmlGetDtdEntity:
- * @doc: the document referencing the entity
- * @name: the entity name
+ * @param doc the document referencing the entity
+ * @param name the entity name
*
* Do an entity lookup in the DTD entity hash table and
- * returns the corresponding entity, if found.
+ * @returns the corresponding entity, if found.
* Note: the first argument is the document node, not the DTD node.
*
- * Returns A pointer to the entity structure or NULL if not found.
+ * @returns A pointer to the entity structure or NULL if not found.
*/
xmlEntityPtr
xmlGetDtdEntity(xmlDocPtr doc, const xmlChar *name) {
@@ -480,15 +470,14 @@ xmlGetDtdEntity(xmlDocPtr doc, const xmlChar *name) {
}
/**
- * xmlGetDocEntity:
- * @doc: the document referencing the entity
- * @name: the entity name
+ * @param doc the document referencing the entity
+ * @param name the entity name
*
* Do an entity lookup in the document entity hash table and
- * returns the corresponding entity, otherwise a lookup is done
+ * @returns the corresponding entity, otherwise a lookup is done
* in the predefined entities too.
*
- * Returns A pointer to the entity structure or NULL if not found.
+ * @returns A pointer to the entity structure or NULL if not found.
*/
xmlEntityPtr
xmlGetDocEntity(const xmlDoc *doc, const xmlChar *name) {
@@ -516,15 +505,14 @@ xmlGetDocEntity(const xmlDoc *doc, const xmlChar *name) {
}
/*
- * xmlSerializeHexCharRef:
- * @buf: a char buffer
- * @val: a codepoint
+ * @param buf a char buffer
+ * @param val a codepoint
*
- * Serializes a hex char ref like
+ * Serializes a hex char ref like &\#xA0;
*
* Writes at most 9 bytes. Does not include a terminating zero byte.
*
- * Returns the number of bytes written.
+ * @returns the number of bytes written.
*/
int
xmlSerializeHexCharRef(char *buf, int val) {
@@ -564,15 +552,14 @@ xmlSerializeHexCharRef(char *buf, int val) {
}
/*
- * xmlSerializeDecCharRef:
- * @buf: a char buffer
- * @val: a codepoint
+ * @param buf a char buffer
+ * @param val a codepoint
*
- * Serializes a decimal char ref like &
+ * Serializes a decimal char ref like &\#38;
*
* Writes at most 10 bytes. Does not include a terminating zero byte.
*
- * Returns the number of bytes written.
+ * @returns the number of bytes written.
*/
int
xmlSerializeDecCharRef(char *buf, int val) {
@@ -614,9 +601,8 @@ static const char xmlEscapeSafe[128] = {
};
/*
- * xmlEscapeText:
- * @text: input text
- * @flags: XML_ESCAPE flags
+ * @param text input text
+ * @param flags XML_ESCAPE flags
*
* Escapes certain characters with char refs.
*
@@ -626,7 +612,7 @@ static const char xmlEscapeSafe[128] = {
* XML_ESCAPE_QUOT: escape double quotes.
* XML_ESCAPE_ALLOW_INVALID: allow invalid characters.
*
- * Returns an escaped string or NULL if a memory allocation failed.
+ * @returns an escaped string or NULL if a memory allocation failed.
*/
xmlChar *
xmlEscapeText(const xmlChar *text, int flags) {
@@ -783,17 +769,16 @@ xmlEscapeText(const xmlChar *text, int flags) {
}
/**
- * xmlEncodeEntitiesInternal:
- * @doc: the document containing the string
- * @input: A string to convert to XML.
- * @flags: XML_ESCAPE flags
+ * @param doc the document containing the string
+ * @param input A string to convert to XML.
+ * @param flags XML_ESCAPE flags
*
* Do a global encoding of a string, replacing the predefined entities
* and non ASCII values with their entities and CharRef counterparts.
* Contrary to xmlEncodeEntities, this routine is reentrant, and result
* must be deallocated.
*
- * Returns A newly allocated string with the substitution done.
+ * @returns A newly allocated string with the substitution done.
*/
xmlChar *
xmlEncodeEntitiesInternal(xmlDocPtr doc, const xmlChar *input,
@@ -810,9 +795,8 @@ xmlEncodeEntitiesInternal(xmlDocPtr doc, const xmlChar *input,
}
/**
- * xmlEncodeEntitiesReentrant:
- * @doc: the document containing the string
- * @input: A string to convert to XML.
+ * @param doc the document containing the string
+ * @param input A string to convert to XML.
*
* Do a global encoding of a string, replacing the predefined entities
* and non ASCII values with their entities and CharRef counterparts.
@@ -823,7 +807,7 @@ xmlEncodeEntitiesInternal(xmlDocPtr doc, const xmlChar *input,
* non-ASCII codepoints are escaped. There is some special handling for
* HTML documents.
*
- * Returns A newly allocated string with the substitution done.
+ * @returns A newly allocated string with the substitution done.
*/
xmlChar *
xmlEncodeEntitiesReentrant(xmlDocPtr doc, const xmlChar *input) {
@@ -831,16 +815,15 @@ xmlEncodeEntitiesReentrant(xmlDocPtr doc, const xmlChar *input) {
}
/**
- * xmlEncodeSpecialChars:
- * @doc: unused
- * @input: A string to convert to XML.
+ * @param doc unused
+ * @param input A string to convert to XML.
*
* Do a global encoding of a string, replacing the predefined entities
* this routine is reentrant, and result must be deallocated.
*
* This escapes `<`, `>`, `&`, `"` and `\r` chars.
*
- * Returns A newly allocated string with the substitution done.
+ * @returns A newly allocated string with the substitution done.
*/
xmlChar *
xmlEncodeSpecialChars(const xmlDoc *doc ATTRIBUTE_UNUSED,
@@ -852,12 +835,11 @@ xmlEncodeSpecialChars(const xmlDoc *doc ATTRIBUTE_UNUSED,
}
/**
- * xmlCreateEntitiesTable:
*
* create and initialize an empty entities hash table.
* This really doesn't make sense and should be deprecated
*
- * Returns the xmlEntitiesTablePtr just created or NULL in case of error.
+ * @returns the xmlEntitiesTablePtr just created or NULL in case of error.
*/
xmlEntitiesTablePtr
xmlCreateEntitiesTable(void) {
@@ -865,9 +847,8 @@ xmlCreateEntitiesTable(void) {
}
/**
- * xmlFreeEntityWrapper:
- * @entity: An entity
- * @name: its name
+ * @param entity An entity
+ * @param name its name
*
* Deallocate the memory used by an entities in the hash table.
*/
@@ -878,8 +859,7 @@ xmlFreeEntityWrapper(void *entity, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlFreeEntitiesTable:
- * @table: An entity table
+ * @param table An entity table
*
* Deallocate the memory used by an entities hash table.
*/
@@ -889,13 +869,12 @@ xmlFreeEntitiesTable(xmlEntitiesTablePtr table) {
}
/**
- * xmlCopyEntity:
- * @payload: An entity
- * @name: unused
+ * @param payload An entity
+ * @param name unused
*
* Build a copy of an entity
*
- * Returns the new xmlEntitiesPtr or NULL in case of error.
+ * @returns the new xmlEntitiesPtr or NULL in case of error.
*/
static void *
xmlCopyEntity(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
@@ -947,12 +926,11 @@ error:
}
/**
- * xmlCopyEntitiesTable:
- * @table: An entity table
+ * @param table An entity table
*
* Build a copy of an entity table.
*
- * Returns the new xmlEntitiesTablePtr or NULL in case of error.
+ * @returns the new xmlEntitiesTablePtr or NULL in case of error.
*/
xmlEntitiesTablePtr
xmlCopyEntitiesTable(xmlEntitiesTablePtr table) {
@@ -962,9 +940,8 @@ xmlCopyEntitiesTable(xmlEntitiesTablePtr table) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlDumpEntityDecl:
- * @buf: An XML buffer.
- * @ent: An entity table
+ * @param buf An XML buffer.
+ * @param ent An entity table
*
* This will dump the content of the entity table as an XML DTD definition
*/
@@ -982,10 +959,9 @@ xmlDumpEntityDecl(xmlBufferPtr buf, xmlEntityPtr ent) {
}
/**
- * xmlDumpEntityDeclScan:
- * @ent: an entity table
- * @save: a save context
- * @name: unused
+ * @param ent an entity table
+ * @param save a save context
+ * @param name unused
*
* When using the hash table scan function, arguments need to be reversed
*/
@@ -996,9 +972,8 @@ xmlDumpEntityDeclScan(void *ent, void *save,
}
/**
- * xmlDumpEntitiesTable:
- * @buf: An XML buffer.
- * @table: An entity table
+ * @param buf An XML buffer.
+ * @param table An entity table
*
* This will dump the content of the entity table as an XML DTD definition
*/
diff --git a/error.c b/error.c
index 4c09587c..c3b89c92 100644
--- a/error.c
+++ b/error.c
@@ -21,11 +21,10 @@
#include "private/string.h"
/**
- * xmlIsCatastrophicError:
- * @level: error level
- * @code: error code
+ * @param level error level
+ * @param code error code
*
- * Returns true if an error is catastrophic.
+ * @returns true if an error is catastrophic.
*/
int
xmlIsCatastrophicError(int level, int code) {
@@ -215,9 +214,8 @@ xmlVUpdateError(xmlError *err,
************************************************************************/
/**
- * xmlGenericErrorDefaultFunc:
- * @ctx: an error context
- * @msg: the message to display/transmit
+ * @param ctx an error context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Default handler for out of context error messages.
@@ -235,11 +233,10 @@ xmlGenericErrorDefaultFunc(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...) {
}
/**
- * xmlSetGenericErrorFunc:
- * @ctx: the new error handling context
- * @handler: the new handler function
+ * @param ctx the new error handling context
+ * @param handler the new handler function
*
- * DEPRECATED: See xmlSetStructuredErrorFunc for alternatives.
+ * @deprecated See xmlSetStructuredErrorFunc for alternatives.
*
* Set the global "generic" handler and context for error messages.
* The generic error handler will only receive fragments of error
@@ -265,11 +262,10 @@ xmlSetGenericErrorFunc(void *ctx, xmlGenericErrorFunc handler) {
}
/**
- * xmlSetStructuredErrorFunc:
- * @ctx: the new error handling context
- * @handler: the new handler function
+ * @param ctx the new error handling context
+ * @param handler the new handler function
*
- * DEPRECATED: Use a per-context error handler.
+ * @deprecated Use a per-context error handler.
*
* It's recommended to use the per-context error handlers instead:
*
@@ -307,10 +303,9 @@ xmlSetStructuredErrorFunc(void *ctx, xmlStructuredErrorFunc handler) {
************************************************************************/
/**
- * xmlParserPrintFileInfo:
- * @input: an xmlParserInputPtr input
+ * @param input an xmlParserInputPtr input
*
- * DEPRECATED: Use xmlFormatError.
+ * @deprecated Use xmlFormatError.
*
* Displays the associated file and line information for the current input
*/
@@ -329,10 +324,9 @@ xmlParserPrintFileInfo(xmlParserInputPtr input) {
}
/**
- * xmlParserPrintFileContextInternal:
- * @input: an xmlParserInputPtr input
- * @channel: output callback
- * @data: user data for output callback
+ * @param input an xmlParserInputPtr input
+ * @param channel output callback
+ * @param data user data for output callback
*
* Displays current context within the input content for error tracking
*/
@@ -402,10 +396,9 @@ xmlParserPrintFileContextInternal(xmlParserInputPtr input ,
}
/**
- * xmlParserPrintFileContext:
- * @input: an xmlParserInputPtr input
+ * @param input an xmlParserInputPtr input
*
- * DEPRECATED: Use xmlFormatError.
+ * @deprecated Use xmlFormatError.
*
* Displays current context within the input content for error tracking
*/
@@ -416,10 +409,9 @@ xmlParserPrintFileContext(xmlParserInputPtr input) {
}
/**
- * xmlFormatError:
- * @err: the error
- * @channel: callback
- * @data: user data for callback
+ * @param err the error
+ * @param channel callback
+ * @param data user data for callback
*
* Report a formatted error to a printf-like callback.
*
@@ -634,12 +626,11 @@ xmlFormatError(const xmlError *err, xmlGenericErrorFunc channel, void *data)
}
/**
- * xmlRaiseMemoryError:
- * @schannel: the structured callback channel
- * @channel: the old callback channel
- * @data: the callback data
- * @domain: the domain for the error
- * @error: optional error struct to be filled
+ * @param schannel the structured callback channel
+ * @param channel the old callback channel
+ * @param data the callback data
+ * @param domain the domain for the error
+ * @param error optional error struct to be filled
*
* Update the global and optional error structure, then forward the
* error to an error handler.
@@ -675,30 +666,29 @@ xmlRaiseMemoryError(xmlStructuredErrorFunc schannel, xmlGenericErrorFunc channel
}
/**
- * xmlVRaiseError:
- * @schannel: the structured callback channel
- * @channel: the old callback channel
- * @data: the callback data
- * @ctx: the parser context or NULL
- * @node: the current node or NULL
- * @domain: the domain for the error
- * @code: the code for the error
- * @level: the xmlErrorLevel for the error
- * @file: the file source of the error (or NULL)
- * @line: the line of the error or 0 if N/A
- * @str1: extra string info
- * @str2: extra string info
- * @str3: extra string info
- * @int1: extra int info
- * @col: column number of the error or 0 if N/A
- * @msg: the message to display/transmit
- * @ap: extra parameters for the message display
+ * @param schannel the structured callback channel
+ * @param channel the old callback channel
+ * @param data the callback data
+ * @param ctx the parser context or NULL
+ * @param node the current node or NULL
+ * @param domain the domain for the error
+ * @param code the code for the error
+ * @param level the xmlErrorLevel for the error
+ * @param file the file source of the error (or NULL)
+ * @param line the line of the error or 0 if N/A
+ * @param str1 extra string info
+ * @param str2 extra string info
+ * @param str3 extra string info
+ * @param int1 extra int info
+ * @param col column number of the error or 0 if N/A
+ * @param msg the message to display/transmit
+ * @param ap extra parameters for the message display
*
* Update the appropriate global or contextual error structure,
* then forward the error message down the parser or generic
* error callback handler
*
- * Returns 0 on success, -1 if a memory allocation failed.
+ * @returns 0 on success, -1 if a memory allocation failed.
*/
int
xmlVRaiseError(xmlStructuredErrorFunc schannel,
@@ -760,30 +750,29 @@ xmlVRaiseError(xmlStructuredErrorFunc schannel,
}
/**
- * xmlRaiseError:
- * @schannel: the structured callback channel
- * @channel: the old callback channel
- * @data: the callback data
- * @ctx: the parser context or NULL
- * @node: the node or NULL
- * @domain: the domain for the error
- * @code: the code for the error
- * @level: the xmlErrorLevel for the error
- * @file: the file source of the error (or NULL)
- * @line: the line of the error or 0 if N/A
- * @str1: extra string info
- * @str2: extra string info
- * @str3: extra string info
- * @int1: extra int info
- * @col: column number of the error or 0 if N/A
- * @msg: the message to display/transmit
+ * @param schannel the structured callback channel
+ * @param channel the old callback channel
+ * @param data the callback data
+ * @param ctx the parser context or NULL
+ * @param node the node or NULL
+ * @param domain the domain for the error
+ * @param code the code for the error
+ * @param level the xmlErrorLevel for the error
+ * @param file the file source of the error (or NULL)
+ * @param line the line of the error or 0 if N/A
+ * @param str1 extra string info
+ * @param str2 extra string info
+ * @param str3 extra string info
+ * @param int1 extra int info
+ * @param col column number of the error or 0 if N/A
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Update the appropriate global or contextual error structure,
* then forward the error message down the parser or generic
* error callback handler
*
- * Returns 0 on success, -1 if a memory allocation failed.
+ * @returns 0 on success, -1 if a memory allocation failed.
*/
int
xmlRaiseError(xmlStructuredErrorFunc schannel,
@@ -842,9 +831,8 @@ xmlVFormatLegacyError(void *ctx, const char *level,
}
/**
- * xmlParserError:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format an error messages, gives file, line, position and
@@ -861,9 +849,8 @@ xmlParserError(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...)
}
/**
- * xmlParserWarning:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a warning messages, gives file, line, position and
@@ -880,9 +867,8 @@ xmlParserWarning(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...)
}
/**
- * xmlParserValidityError:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format an validity error messages, gives file,
@@ -899,9 +885,8 @@ xmlParserValidityError(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...)
}
/**
- * xmlParserValidityWarning:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a validity warning messages, gives file, line,
@@ -925,12 +910,11 @@ xmlParserValidityWarning(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...)
************************************************************************/
/**
- * xmlGetLastError:
*
* Get the last global error registered. This is per thread if compiled
* with thread support.
*
- * Returns a pointer to the error
+ * @returns a pointer to the error
*/
const xmlError *
xmlGetLastError(void)
@@ -943,8 +927,7 @@ xmlGetLastError(void)
}
/**
- * xmlResetError:
- * @err: pointer to the error.
+ * @param err pointer to the error.
*
* Cleanup the error.
*/
@@ -970,7 +953,6 @@ xmlResetError(xmlErrorPtr err)
}
/**
- * xmlResetLastError:
*
* Cleanup the last global error registered. For parsing error
* this does not change the well-formedness result.
@@ -985,13 +967,12 @@ xmlResetLastError(void)
}
/**
- * xmlCopyError:
- * @from: a source error
- * @to: a target error
+ * @param from a source error
+ * @param to a target error
*
* Save the original error to the new place.
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlCopyError(const xmlError *from, xmlErrorPtr to) {
@@ -1012,10 +993,9 @@ xmlCopyError(const xmlError *from, xmlErrorPtr to) {
}
/**
- * xmlErrString:
- * @code: an xmlParserErrors code
+ * @param code an xmlParserErrors code
*
- * Returns an error message for a code.
+ * @returns an error message for a code.
*/
const char *
xmlErrString(xmlParserErrors code) {
@@ -1345,9 +1325,8 @@ xmlErrString(xmlParserErrors code) {
}
/**
- * xmlVPrintErrorMessage:
- * @fmt: printf format string
- * @ap: arguments
+ * @param fmt printf format string
+ * @param ap arguments
*
* Prints to stderr.
*/
@@ -1357,8 +1336,7 @@ xmlVPrintErrorMessage(const char *fmt, va_list ap) {
}
/**
- * xmlPrintErrorMessage:
- * @fmt: printf format string
+ * @param fmt printf format string
* @...: arguments
*
* Prints to stderr.
@@ -1373,8 +1351,7 @@ xmlPrintErrorMessage(const char *fmt, ...) {
}
/**
- * xmlAbort:
- * @fmt: printf format string
+ * @param fmt printf format string
* @...: arguments
*
* Print message to stderr and abort.
diff --git a/globals.c b/globals.c
index ed347879..e2706d3c 100644
--- a/globals.c
+++ b/globals.c
@@ -43,7 +43,7 @@ static xmlMutex xmlThrDefMutex;
* thread-local storage:
*
* xmlError *__xmlLastError(void);
- * #define xmlError (*__xmlLastError());
+ * \#define xmlError (*__xmlLastError());
*
* The code can operate in a multitude of ways depending on the environment.
* First we support POSIX and Windows threads. Then we support both
@@ -190,61 +190,56 @@ static xmlGlobalState globalState;
*/
/**
- * xmlFree:
- * @mem: an already allocated block of memory
+ * @param mem an already allocated block of memory
*
* The variable holding the libxml free() implementation
*/
xmlFreeFunc xmlFree = free;
/**
- * xmlMalloc:
- * @size: the size requested in bytes
+ * @param size the size requested in bytes
*
* The variable holding the libxml malloc() implementation
*
- * Returns a pointer to the newly allocated block or NULL in case of error
+ * @returns a pointer to the newly allocated block or NULL in case of error
*/
xmlMallocFunc xmlMalloc = malloc;
/**
- * xmlMallocAtomic:
- * @size: the size requested in bytes
+ * @param size the size requested in bytes
*
* The variable holding the libxml malloc() implementation for atomic
* data (i.e. blocks not containing pointers), useful when using a
* garbage collecting allocator.
*
- * Returns a pointer to the newly allocated block or NULL in case of error
+ * @returns a pointer to the newly allocated block or NULL in case of error
*/
xmlMallocFunc xmlMallocAtomic = malloc;
/**
- * xmlRealloc:
- * @mem: an already allocated block of memory
- * @size: the new size requested in bytes
+ * @param mem an already allocated block of memory
+ * @param size the new size requested in bytes
*
* The variable holding the libxml realloc() implementation
*
- * Returns a pointer to the newly reallocated block or NULL in case of error
+ * @returns a pointer to the newly reallocated block or NULL in case of error
*/
xmlReallocFunc xmlRealloc = realloc;
/**
* xmlPosixStrdup
- * @cur: the input char *
+ * @param cur the input char *
*
* a strdup implementation with a type signature matching POSIX
*
- * Returns a new xmlChar * or NULL
+ * @returns a new xmlChar * or NULL
*/
static char *
xmlPosixStrdup(const char *cur) {
return((char*) xmlCharStrdup(cur));
}
/**
- * xmlMemStrdup:
- * @str: a zero terminated string
+ * @param str a zero terminated string
*
* The variable holding the libxml strdup() implementation
*
- * Returns the copy of the string or NULL in case of error
+ * @returns the copy of the string or NULL in case of error
*/
xmlStrdupFunc xmlMemStrdup = xmlPosixStrdup;
@@ -281,9 +276,8 @@ static int xmlSaveNoEmptyTagsThrDef = 0;
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlDefaultSAXHandler:
*
- * DEPRECATED: This handler is unused and will be removed from future
+ * @deprecated This handler is unused and will be removed from future
* versions.
*
* Default SAX version1 handler for XML, builds the DOM tree
@@ -321,9 +315,8 @@ const xmlSAXHandlerV1 xmlDefaultSAXHandler = {
#endif /* LIBXML_SAX1_ENABLED */
/**
- * xmlDefaultSAXLocator:
*
- * DEPRECATED: Don't use
+ * @deprecated Don't use
*
* The default SAX Locator
* { getPublicId, getSystemId, getLineNumber, getColumnNumber}
@@ -337,9 +330,8 @@ const xmlSAXLocator xmlDefaultSAXLocator = {
#if defined(LIBXML_HTML_ENABLED) && defined(LIBXML_SAX1_ENABLED)
/**
- * htmlDefaultSAXHandler:
*
- * DEPRECATED: This handler is unused and will be removed from future
+ * @deprecated This handler is unused and will be removed from future
* versions.
*
* Default old SAX v1 handler for HTML, builds the DOM tree
@@ -386,16 +378,14 @@ xmlInitGlobalState(xmlGlobalStatePtr gs);
************************************************************************/
/**
- * xmlInitGlobals:
*
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
*/
void xmlInitGlobals(void) {
xmlInitParser();
}
/**
- * xmlInitGlobalsInternal:
*
* Additional initialisation for multi-threading
*/
@@ -415,9 +405,8 @@ void xmlInitGlobalsInternal(void) {
}
/**
- * xmlCleanupGlobals:
*
- * DEPRECATED: This function is a no-op. Call xmlCleanupParser
+ * @deprecated This function is a no-op. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have call cleanup functions at all.
@@ -426,7 +415,6 @@ void xmlCleanupGlobals(void) {
}
/**
- * xmlCleanupGlobalsInternal:
*
* Additional cleanup for multi-threading
*/
@@ -513,13 +501,12 @@ xmlRegisterGlobalStateDtor(xmlGlobalState *gs) {
#ifndef USE_TLS
/**
- * xmlNewGlobalState:
*
* xmlNewGlobalState() allocates a global state. This structure is used to
* hold all data for use by a thread when supporting backwards compatibility
* of libxml2 to pre-thread-safe behaviour.
*
- * Returns the newly allocated xmlGlobalStatePtr or NULL in case of error
+ * @returns the newly allocated xmlGlobalStatePtr or NULL in case of error
*/
static xmlGlobalStatePtr
xmlNewGlobalState(int allowFailure)
@@ -779,9 +766,8 @@ __xmlMemStrdup(void) {
#endif /* LIBXML_THREAD_ALLOC_ENABLED */
/**
- * xmlGetLocalRngState:
*
- * Returns the local RNG state.
+ * @returns the local RNG state.
*/
unsigned *
xmlGetLocalRngState(void) {
@@ -789,7 +775,6 @@ xmlGetLocalRngState(void) {
}
/**
- * xmlCheckThreadLocalStorage:
*
* Check whether thread-local storage could be allocated.
*
@@ -798,7 +783,7 @@ xmlGetLocalRngState(void) {
* library functions to make sure that thread-local storage was
* allocated properly.
*
- * Returns 0 on success or -1 if a memory allocation failed. A failed
+ * @returns 0 on success or -1 if a memory allocation failed. A failed
* allocation signals a typically fatal and irrecoverable out-of-memory
* situation. Don't call any library functions in this case.
*
@@ -814,27 +799,26 @@ xmlCheckThreadLocalStorage(void) {
}
/**
- * xmlGetLastErrorInternal:
*
- * Returns a pointer to the global error struct.
+ * @returns a pointer to the global error struct.
*/
xmlError *
xmlGetLastErrorInternal(void) {
return(&xmlGetThreadLocalStorage(0)->lastError);
}
-/** DOC_DISABLE */
+/** @cond IGNORE */
/**
* DllMain:
- * @hinstDLL: handle to DLL instance
- * @fdwReason: Reason code for entry
- * @lpvReserved: generic pointer (depends upon reason code)
+ * @param hinstDLL handle to DLL instance
+ * @param fdwReason Reason code for entry
+ * @param lpvReserved generic pointer (depends upon reason code)
*
* Entry point for Windows library. It is being used to free thread-specific
* storage.
*
- * Returns TRUE always
+ * @returns TRUE always
*/
#ifdef USE_DLL_MAIN
#if defined(LIBXML_STATIC_FOR_DLL)
@@ -1065,5 +1049,5 @@ xmlThrDefOutputBufferCreateFilenameDefault(xmlOutputBufferCreateFilenameFunc fun
return(old);
}
-/** DOC_ENABLE */
+/** @endcond */
diff --git a/hash.c b/hash.c
index a5005f16..7b807e56 100644
--- a/hash.c
+++ b/hash.c
@@ -148,13 +148,12 @@ xmlHashQNameValue(unsigned seed,
}
/**
- * xmlHashCreate:
- * @size: initial size of the hash table
+ * @param size initial size of the hash table
*
* Create a new hash table. Set size to zero if the number of entries
* can't be estimated.
*
- * Returns the newly created object, or NULL if a memory allocation failed.
+ * @returns the newly created object, or NULL if a memory allocation failed.
*/
xmlHashTablePtr
xmlHashCreate(int size) {
@@ -195,15 +194,14 @@ xmlHashCreate(int size) {
}
/**
- * xmlHashCreateDict:
- * @size: the size of the hash table
- * @dict: a dictionary to use for the hash
+ * @param size the size of the hash table
+ * @param dict a dictionary to use for the hash
*
* Create a new hash table backed by a dictionary. This can reduce
* resource usage considerably if most keys passed to API functions
* originate from this dictionary.
*
- * Returns the newly created object, or NULL if a memory allocation failed.
+ * @returns the newly created object, or NULL if a memory allocation failed.
*/
xmlHashTablePtr
xmlHashCreateDict(int size, xmlDictPtr dict) {
@@ -218,12 +216,11 @@ xmlHashCreateDict(int size, xmlDictPtr dict) {
}
/**
- * xmlHashFree:
- * @hash: hash table
- * @dealloc: deallocator function or NULL
+ * @param hash hash table
+ * @param dealloc deallocator function or NULL
*
* Free the hash and its contents. The payload is deallocated with
- * @dealloc if provided.
+ * `dealloc` if provided.
*/
void
xmlHashFree(xmlHashTablePtr hash, xmlHashDeallocator dealloc) {
@@ -259,9 +256,8 @@ xmlHashFree(xmlHashTablePtr hash, xmlHashDeallocator dealloc) {
}
/**
- * xmlFastStrEqual:
- * @s1: string
- * @s2: string
+ * @param s1 string
+ * @param s2 string
*
* Compare two strings for equality, allowing NULL values.
*/
@@ -275,16 +271,15 @@ xmlFastStrEqual(const xmlChar *s1, const xmlChar *s2) {
}
/**
- * xmlHashFindEntry:
- * @hash: hash table, non-NULL, size > 0
- * @key: first string key, non-NULL
- * @key2: second string key
- * @key3: third string key
- * @hashValue: valid hash value of keys
- * @pfound: result of search
+ * @param hash hash table, non-NULL, size > 0
+ * @param key first string key, non-NULL
+ * @param key2 second string key
+ * @param key3 third string key
+ * @param hashValue valid hash value of keys
+ * @param pfound result of search
*
* Try to find a matching hash table entry. If an entry was found, set
- * @found to 1 and return the entry. Otherwise, set @found to 0 and return
+ * `found` to 1 and return the entry. Otherwise, set `found` to 0 and return
* the location where a new entry should be inserted.
*/
ATTRIBUTE_NO_SANITIZE_INTEGER
@@ -342,13 +337,12 @@ xmlHashFindEntry(const xmlHashTable *hash, const xmlChar *key,
}
/**
- * xmlHashGrow:
- * @hash: hash table
- * @size: new size of the hash table
+ * @param hash hash table
+ * @param size new size of the hash table
*
* Resize the hash table.
*
- * Returns 0 in case of success, -1 if a memory allocation failed.
+ * @returns 0 in case of success, -1 if a memory allocation failed.
*/
static int
xmlHashGrow(xmlHashTablePtr hash, unsigned size) {
@@ -409,14 +403,13 @@ done:
}
/**
- * xmlHashUpdateInternal:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @key3: third string key
- * @payload: pointer to the payload
- * @dealloc: deallocator function for replaced item or NULL
- * @update: whether existing entries should be updated
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param key3 third string key
+ * @param payload pointer to the payload
+ * @param dealloc deallocator function for replaced item or NULL
+ * @param update whether existing entries should be updated
*
* Internal function to add or update hash entries.
*/
@@ -593,9 +586,8 @@ xmlHashUpdateInternal(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashDefaultDeallocator:
- * @entry: hash table entry
- * @key: the entry's string key
+ * @param entry hash table entry
+ * @param key the entry's string key
*
* Free a hash table entry with xmlFree.
*/
@@ -605,10 +597,9 @@ xmlHashDefaultDeallocator(void *entry, const xmlChar *key ATTRIBUTE_UNUSED) {
}
/**
- * xmlHashAdd:
- * @hash: hash table
- * @key: string key
- * @payload: pointer to the payload
+ * @param hash hash table
+ * @param key string key
+ * @param payload pointer to the payload
*
* Add a hash table entry. If an entry with this key already exists,
* payload will not be updated and 0 is returned. This return value
@@ -617,7 +608,7 @@ xmlHashDefaultDeallocator(void *entry, const xmlChar *key ATTRIBUTE_UNUSED) {
*
* Available since 2.13.0.
*
- * Returns 1 on success, 0 if an entry exists and -1 in case of error.
+ * @returns 1 on success, 0 if an entry exists and -1 in case of error.
*/
int
xmlHashAdd(xmlHashTablePtr hash, const xmlChar *key, void *payload) {
@@ -625,11 +616,10 @@ xmlHashAdd(xmlHashTablePtr hash, const xmlChar *key, void *payload) {
}
/**
- * xmlHashAdd2:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @payload: pointer to the payload
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param payload pointer to the payload
*
* Add a hash table entry with two strings as key.
*
@@ -637,7 +627,7 @@ xmlHashAdd(xmlHashTablePtr hash, const xmlChar *key, void *payload) {
*
* Available since 2.13.0.
*
- * Returns 1 on success, 0 if an entry exists and -1 in case of error.
+ * @returns 1 on success, 0 if an entry exists and -1 in case of error.
*/
int
xmlHashAdd2(xmlHashTablePtr hash, const xmlChar *key,
@@ -646,12 +636,11 @@ xmlHashAdd2(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashAdd3:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @key3: third string key
- * @payload: pointer to the payload
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param key3 third string key
+ * @param payload pointer to the payload
*
* Add a hash table entry with three strings as key.
*
@@ -659,7 +648,7 @@ xmlHashAdd2(xmlHashTablePtr hash, const xmlChar *key,
*
* Available since 2.13.0.
*
- * Returns 1 on success, 0 if an entry exists and -1 in case of error.
+ * @returns 1 on success, 0 if an entry exists and -1 in case of error.
*/
int
xmlHashAdd3(xmlHashTablePtr hash, const xmlChar *key,
@@ -669,10 +658,9 @@ xmlHashAdd3(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashAddEntry:
- * @hash: hash table
- * @key: string key
- * @payload: pointer to the payload
+ * @param hash hash table
+ * @param key string key
+ * @param payload pointer to the payload
*
* Add a hash table entry. If an entry with this key already exists,
* payload will not be updated and -1 is returned. This return value
@@ -682,7 +670,7 @@ xmlHashAdd3(xmlHashTablePtr hash, const xmlChar *key,
* NOTE: This function doesn't allow to distinguish malloc failures from
* existing entries. Use xmlHashAdd instead.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
int
xmlHashAddEntry(xmlHashTablePtr hash, const xmlChar *key, void *payload) {
@@ -697,17 +685,16 @@ xmlHashAddEntry(xmlHashTablePtr hash, const xmlChar *key, void *payload) {
}
/**
- * xmlHashAddEntry2:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @payload: pointer to the payload
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param payload pointer to the payload
*
* Add a hash table entry with two strings as key.
*
* See xmlHashAddEntry.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
int
xmlHashAddEntry2(xmlHashTablePtr hash, const xmlChar *key,
@@ -723,18 +710,17 @@ xmlHashAddEntry2(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashAddEntry3:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @key3: third string key
- * @payload: pointer to the payload
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param key3 third string key
+ * @param payload pointer to the payload
*
* Add a hash table entry with three strings as key.
*
* See xmlHashAddEntry.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
int
xmlHashAddEntry3(xmlHashTablePtr hash, const xmlChar *key,
@@ -751,16 +737,15 @@ xmlHashAddEntry3(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashUpdateEntry:
- * @hash: hash table
- * @key: string key
- * @payload: pointer to the payload
- * @dealloc: deallocator function for replaced item or NULL
+ * @param hash hash table
+ * @param key string key
+ * @param payload pointer to the payload
+ * @param dealloc deallocator function for replaced item or NULL
*
* Add a hash table entry. If an entry with this key already exists,
* the old payload will be freed and updated with the new value.
*
- * Returns 0 in case of success, -1 if a memory allocation failed.
+ * @returns 0 in case of success, -1 if a memory allocation failed.
*/
int
xmlHashUpdateEntry(xmlHashTablePtr hash, const xmlChar *key,
@@ -775,18 +760,17 @@ xmlHashUpdateEntry(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashUpdateEntry2:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @payload: pointer to the payload
- * @dealloc: deallocator function for replaced item or NULL
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param payload pointer to the payload
+ * @param dealloc deallocator function for replaced item or NULL
*
* Add a hash table entry with two strings as key.
*
* See xmlHashUpdateEntry.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
int
xmlHashUpdateEntry2(xmlHashTablePtr hash, const xmlChar *key,
@@ -802,19 +786,18 @@ xmlHashUpdateEntry2(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashUpdateEntry3:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @key3: third string key
- * @payload: pointer to the payload
- * @dealloc: deallocator function for replaced item or NULL
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param key3 third string key
+ * @param payload pointer to the payload
+ * @param dealloc deallocator function for replaced item or NULL
*
* Add a hash table entry with three strings as key.
*
* See xmlHashUpdateEntry.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
int
xmlHashUpdateEntry3(xmlHashTablePtr hash, const xmlChar *key,
@@ -830,13 +813,12 @@ xmlHashUpdateEntry3(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashLookup:
- * @hash: hash table
- * @key: string key
+ * @param hash hash table
+ * @param key string key
*
- * Find the entry specified by @key.
+ * Find the entry specified by `key`.
*
- * Returns a pointer to the payload or NULL if no entry was found.
+ * @returns a pointer to the payload or NULL if no entry was found.
*/
void *
xmlHashLookup(xmlHashTablePtr hash, const xmlChar *key) {
@@ -844,14 +826,13 @@ xmlHashLookup(xmlHashTablePtr hash, const xmlChar *key) {
}
/**
- * xmlHashLookup2:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
*
- * Find the payload specified by the (@key, @key2) tuple.
+ * Find the payload specified by the (`key`, `key2`) tuple.
*
- * Returns a pointer to the payload or NULL if no entry was found.
+ * @returns a pointer to the payload or NULL if no entry was found.
*/
void *
xmlHashLookup2(xmlHashTablePtr hash, const xmlChar *key,
@@ -860,14 +841,13 @@ xmlHashLookup2(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashQLookup:
- * @hash: hash table
- * @prefix: prefix of the string key
- * @name: local name of the string key
+ * @param hash hash table
+ * @param prefix prefix of the string key
+ * @param name local name of the string key
*
- * Find the payload specified by the QName `prefix:name` or @name.
+ * Find the payload specified by the QName `prefix:name` or `name`.
*
- * Returns a pointer to the payload or NULL if no entry was found.
+ * @returns a pointer to the payload or NULL if no entry was found.
*/
void *
xmlHashQLookup(xmlHashTablePtr hash, const xmlChar *prefix,
@@ -876,16 +856,15 @@ xmlHashQLookup(xmlHashTablePtr hash, const xmlChar *prefix,
}
/**
- * xmlHashQLookup2:
- * @hash: hash table
- * @prefix: first prefix
- * @name: first local name
- * @prefix2: second prefix
- * @name2: second local name
+ * @param hash hash table
+ * @param prefix first prefix
+ * @param name first local name
+ * @param prefix2 second prefix
+ * @param name2 second local name
*
* Find the payload specified by the QNames tuple.
*
- * Returns a pointer to the payload or NULL if no entry was found.
+ * @returns a pointer to the payload or NULL if no entry was found.
*/
void *
xmlHashQLookup2(xmlHashTablePtr hash, const xmlChar *prefix,
@@ -895,15 +874,14 @@ xmlHashQLookup2(xmlHashTablePtr hash, const xmlChar *prefix,
}
/**
- * xmlHashLookup3:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @key3: third string key
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param key3 third string key
*
- * Find the payload specified by the (@key, @key2, @key3) tuple.
+ * Find the payload specified by the (`key`, `key2`, `key3`) tuple.
*
- * Returns a pointer to the payload or NULL if no entry was found.
+ * @returns a pointer to the payload or NULL if no entry was found.
*/
void *
xmlHashLookup3(xmlHashTablePtr hash, const xmlChar *key,
@@ -922,18 +900,17 @@ xmlHashLookup3(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashQLookup3:
- * @hash: hash table
- * @prefix: first prefix
- * @name: first local name
- * @prefix2: second prefix
- * @name2: second local name
- * @prefix3: third prefix
- * @name3: third local name
+ * @param hash hash table
+ * @param prefix first prefix
+ * @param name first local name
+ * @param prefix2 second prefix
+ * @param name2 second local name
+ * @param prefix3 third prefix
+ * @param name3 third local name
*
* Find the payload specified by the QNames tuple.
*
- * Returns a pointer to the payload or NULL if no entry was found.
+ * @returns a pointer to the payload or NULL if no entry was found.
*/
ATTRIBUTE_NO_SANITIZE_INTEGER
void *
@@ -990,12 +967,11 @@ stubHashScannerFull(void *payload, void *data, const xmlChar *key,
}
/**
- * xmlHashScan:
- * @hash: hash table
- * @scan: scanner function for items in the hash
- * @data: extra data passed to @scan
+ * @param hash hash table
+ * @param scan scanner function for items in the hash
+ * @param data extra data passed to `scan`
*
- * Scan the hash @table and apply @scan to each value.
+ * Scan the hash `table` and apply `scan` to each value.
*/
void
xmlHashScan(xmlHashTablePtr hash, xmlHashScanner scan, void *data) {
@@ -1006,12 +982,11 @@ xmlHashScan(xmlHashTablePtr hash, xmlHashScanner scan, void *data) {
}
/**
- * xmlHashScanFull:
- * @hash: hash table
- * @scan: scanner function for items in the hash
- * @data: extra data passed to @scan
+ * @param hash hash table
+ * @param scan scanner function for items in the hash
+ * @param data extra data passed to `scan`
*
- * Scan the hash @table and apply @scan to each value.
+ * Scan the hash `table` and apply `scan` to each value.
*/
void
xmlHashScanFull(xmlHashTablePtr hash, xmlHashScannerFull scan, void *data) {
@@ -1056,16 +1031,15 @@ xmlHashScanFull(xmlHashTablePtr hash, xmlHashScannerFull scan, void *data) {
}
/**
- * xmlHashScan3:
- * @hash: hash table
- * @key: first string key or NULL
- * @key2: second string key or NULL
- * @key3: third string key or NULL
- * @scan: scanner function for items in the hash
- * @data: extra data passed to @scan
+ * @param hash hash table
+ * @param key first string key or NULL
+ * @param key2 second string key or NULL
+ * @param key3 third string key or NULL
+ * @param scan scanner function for items in the hash
+ * @param data extra data passed to `scan`
*
- * Scan the hash @table and apply @scan to each value matching
- * (@key, @key2, @key3) tuple. If one of the keys is null,
+ * Scan the hash `table` and apply `scan` to each value matching
+ * (`key`, `key2`, `key3`) tuple. If one of the keys is null,
* the comparison is considered to match.
*/
void
@@ -1079,16 +1053,15 @@ xmlHashScan3(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashScanFull3:
- * @hash: hash table
- * @key: first string key or NULL
- * @key2: second string key or NULL
- * @key3: third string key or NULL
- * @scan: scanner function for items in the hash
- * @data: extra data passed to @scan
+ * @param hash hash table
+ * @param key first string key or NULL
+ * @param key2 second string key or NULL
+ * @param key3 third string key or NULL
+ * @param scan scanner function for items in the hash
+ * @param data extra data passed to `scan`
*
- * Scan the hash @table and apply @scan to each value matching
- * (@key, @key2, @key3) tuple. If one of the keys is null,
+ * Scan the hash `table` and apply `scan` to each value matching
+ * (`key`, `key2`, `key3`) tuple. If one of the keys is null,
* the comparison is considered to match.
*/
void
@@ -1141,16 +1114,15 @@ xmlHashScanFull3(xmlHashTablePtr hash, const xmlChar *key,
}
/*
- * xmlHashCopySafe:
- * @hash: hash table
- * @copyFunc: copier function for items in the hash
- * @deallocFunc: deallocation function in case of errors
+ * @param hash hash table
+ * @param copyFunc copier function for items in the hash
+ * @param deallocFunc deallocation function in case of errors
*
- * Copy the hash table using @copyFunc to copy payloads.
+ * Copy the hash table using `copyFunc` to copy payloads.
*
* Available since 2.13.0.
*
- * Returns the new table or NULL if a memory allocation failed.
+ * @returns the new table or NULL if a memory allocation failed.
*/
xmlHashTablePtr
xmlHashCopySafe(xmlHashTablePtr hash, xmlHashCopier copyFunc,
@@ -1194,15 +1166,14 @@ error:
}
/*
- * xmlHashCopy:
- * @hash: hash table
- * @copy: copier function for items in the hash
+ * @param hash hash table
+ * @param copy copier function for items in the hash
*
- * DEPRECATED: Leaks memory in error case.
+ * @deprecated Leaks memory in error case.
*
- * Copy the hash table using @copy to copy payloads.
+ * Copy the hash table using `copy` to copy payloads.
*
- * Returns the new table or NULL if a memory allocation failed.
+ * @returns the new table or NULL if a memory allocation failed.
*/
xmlHashTablePtr
xmlHashCopy(xmlHashTablePtr hash, xmlHashCopier copy) {
@@ -1210,12 +1181,11 @@ xmlHashCopy(xmlHashTablePtr hash, xmlHashCopier copy) {
}
/**
- * xmlHashSize:
- * @hash: hash table
+ * @param hash hash table
*
* Query the number of elements in the hash table.
*
- * Returns the number of elements in the hash table or
+ * @returns the number of elements in the hash table or
* -1 in case of error.
*/
int
@@ -1226,15 +1196,14 @@ xmlHashSize(xmlHashTablePtr hash) {
}
/**
- * xmlHashRemoveEntry:
- * @hash: hash table
- * @key: string key
- * @dealloc: deallocator function for removed item or NULL
+ * @param hash hash table
+ * @param key string key
+ * @param dealloc deallocator function for removed item or NULL
*
- * Find the entry specified by the @key and remove it from the hash table.
- * Payload will be freed with @dealloc.
+ * Find the entry specified by the `key` and remove it from the hash table.
+ * Payload will be freed with `dealloc`.
*
- * Returns 0 on success and -1 if no entry was found.
+ * @returns 0 on success and -1 if no entry was found.
*/
int xmlHashRemoveEntry(xmlHashTablePtr hash, const xmlChar *key,
xmlHashDeallocator dealloc) {
@@ -1242,17 +1211,16 @@ int xmlHashRemoveEntry(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashRemoveEntry2:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @dealloc: deallocator function for removed item or NULL
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param dealloc deallocator function for removed item or NULL
*
* Remove an entry with two strings as key.
*
* See xmlHashRemoveEntry.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
int
xmlHashRemoveEntry2(xmlHashTablePtr hash, const xmlChar *key,
@@ -1261,18 +1229,17 @@ xmlHashRemoveEntry2(xmlHashTablePtr hash, const xmlChar *key,
}
/**
- * xmlHashRemoveEntry3:
- * @hash: hash table
- * @key: first string key
- * @key2: second string key
- * @key3: third string key
- * @dealloc: deallocator function for removed item or NULL
+ * @param hash hash table
+ * @param key first string key
+ * @param key2 second string key
+ * @param key3 third string key
+ * @param dealloc deallocator function for removed item or NULL
*
* Remove an entry with three strings as key.
*
* See xmlHashRemoveEntry.
*
- * Returns 0 on success and -1 in case of error.
+ * @returns 0 on success and -1 in case of error.
*/
ATTRIBUTE_NO_SANITIZE_INTEGER
int
diff --git a/include/libxml/HTMLparser.h b/include/libxml/HTMLparser.h
index d78b066a..74ed035f 100644
--- a/include/libxml/HTMLparser.h
+++ b/include/libxml/HTMLparser.h
@@ -1,13 +1,16 @@
-/*
- * Summary: interface for an HTML 4.0 non-verifying parser
- * Description: this module implements an HTML 4.0 non-verifying parser
+/**
+ * @file
+ *
+ * @brief interface for an HTML 4.0 non-verifying parser
+ *
+ * this module implements an HTML 4.0 non-verifying parser
* with API compatible with the XML parser ones. It should
* be able to parse "real world" HTML, even if severely
* broken from a specification point of view.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __HTML_PARSER_H__
@@ -196,7 +199,6 @@ XMLPUBFUN void
* New set of simpler/more flexible APIs
*/
/**
- * xmlParserOption:
*
* This is the set of XML parser options that can be passed down
* to the xmlReadDoc() and similar calls.
@@ -310,29 +312,26 @@ XMLPUBFUN htmlStatus htmlElementStatusHere(const htmlElemDesc*, const htmlElemDe
XML_DEPRECATED
XMLPUBFUN htmlStatus htmlNodeStatus(htmlNodePtr, int) ;
/**
- * htmlDefaultSubelement:
- * @elt: HTML element
+ * @param elt HTML element
*
- * Returns the default subelement for this element
+ * @returns the default subelement for this element
*/
#define htmlDefaultSubelement(elt) elt->defaultsubelt
/**
- * htmlElementAllowedHereDesc:
- * @parent: HTML parent element
- * @elt: HTML element
+ * @param parent HTML parent element
+ * @param elt HTML element
*
* Checks whether an HTML element description may be a
* direct child of the specified element.
*
- * Returns 1 if allowed; 0 otherwise.
+ * @returns 1 if allowed; 0 otherwise.
*/
#define htmlElementAllowedHereDesc(parent,elt) \
htmlElementAllowedHere((parent), (elt)->name)
/**
- * htmlRequiredAttrs:
- * @elt: HTML element
+ * @param elt HTML element
*
- * Returns the attributes required for the specified element.
+ * @returns the attributes required for the specified element.
*/
#define htmlRequiredAttrs(elt) (elt)->attrs_req
diff --git a/include/libxml/HTMLtree.h b/include/libxml/HTMLtree.h
index 065254f4..46c2f7ad 100644
--- a/include/libxml/HTMLtree.h
+++ b/include/libxml/HTMLtree.h
@@ -1,11 +1,14 @@
-/*
- * Summary: specific APIs to process HTML tree, especially serialization
- * Description: this module implements a few function needed to process
+/**
+ * @file
+ *
+ * @brief specific APIs to process HTML tree, especially serialization
+ *
+ * this module implements a few function needed to process
* tree in an HTML specific way.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __HTML_TREE_H__
diff --git a/include/libxml/SAX.h b/include/libxml/SAX.h
index c1ab58d7..308efc15 100644
--- a/include/libxml/SAX.h
+++ b/include/libxml/SAX.h
@@ -1,11 +1,14 @@
-/*
- * Summary: Old SAX version 1 handler, deprecated
- * Description: DEPRECATED set of SAX version 1 interfaces used to
+/**
+ * @file
+ *
+ * @brief Old SAX version 1 handler, deprecated
+ *
+ * @deprecated set of SAX version 1 interfaces used to
* build the DOM tree.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_SAX_H__
diff --git a/include/libxml/SAX2.h b/include/libxml/SAX2.h
index 657acb02..45228b3e 100644
--- a/include/libxml/SAX2.h
+++ b/include/libxml/SAX2.h
@@ -1,11 +1,14 @@
-/*
- * Summary: SAX2 parser interface used to build the DOM tree
- * Description: those are the default SAX2 interfaces used by
+/**
+ * @file
+ *
+ * @brief SAX2 parser interface used to build the DOM tree
+ *
+ * those are the default SAX2 interfaces used by
* the library when building DOM tree.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
diff --git a/include/libxml/c14n.h b/include/libxml/c14n.h
index c8493648..e35c636a 100644
--- a/include/libxml/c14n.h
+++ b/include/libxml/c14n.h
@@ -1,6 +1,9 @@
-/*
- * Summary: Provide Canonical XML and Exclusive XML Canonicalization
- * Description: the c14n modules provides a
+/**
+ * @file
+ *
+ * @brief Provide Canonical XML and Exclusive XML Canonicalization
+ *
+ * the c14n modules provides a
*
* "Canonical XML" implementation
* http://www.w3.org/TR/xml-c14n
@@ -10,9 +13,9 @@
* "Exclusive XML Canonicalization" implementation
* http://www.w3.org/TR/xml-exc-c14n
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Aleksey Sanin
+ * @author Aleksey Sanin
*/
#ifndef __XML_C14N_H__
#define __XML_C14N_H__
@@ -43,7 +46,6 @@ extern "C" {
*/
/*
- * xmlC14NMode:
*
* Predefined values for C14N modes
*
@@ -84,14 +86,13 @@ XMLPUBFUN int
* This is the core C14N function
*/
/**
- * xmlC14NIsVisibleCallback:
- * @user_data: user data
- * @node: the current node
- * @parent: the parent node
+ * @param user_data user data
+ * @param node the current node
+ * @param parent the parent node
*
* Signature for a C14N callback on visible nodes
*
- * Returns 1 if the node should be included
+ * @returns 1 if the node should be included
*/
typedef int (*xmlC14NIsVisibleCallback) (void* user_data,
xmlNodePtr node,
diff --git a/include/libxml/catalog.h b/include/libxml/catalog.h
index 442092a4..0d68e3c0 100644
--- a/include/libxml/catalog.h
+++ b/include/libxml/catalog.h
@@ -1,6 +1,9 @@
/**
- * Summary: interfaces to the Catalog handling system
- * Description: the catalog module implements the support for
+ * @file
+ * *
+ * @brief interfaces to the Catalog handling system
+ *
+ * the catalog module implements the support for
* XML Catalogs and SGML catalogs
*
* SGML Open Technical Resolution TR9401:1997.
@@ -9,9 +12,9 @@
* XML Catalogs Working Draft 06 August 2001
* http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_CATALOG_H__
diff --git a/include/libxml/chvalid.h b/include/libxml/chvalid.h
index bca624df..8c8b86ad 100644
--- a/include/libxml/chvalid.h
+++ b/include/libxml/chvalid.h
@@ -1,6 +1,9 @@
-/*
- * Summary: Unicode character range checking
- * Description: this module exports interfaces for the character
+/**
+ * @file
+ *
+ * @brief Unicode character range checking
+ *
+ * this module exports interfaces for the character
* range validation APIs
*
* This file is automatically generated from the cvs source
@@ -55,8 +58,7 @@ XMLPUBFUN int
/**
- * xmlIsBaseChar_ch:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -67,8 +69,7 @@ XMLPUBFUN int
(0xf8 <= (c)))
/**
- * xmlIsBaseCharQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -79,8 +80,7 @@ XMLPUBFUN int
XMLPUBVAR const xmlChRangeGroup xmlIsBaseCharGroup;
/**
- * xmlIsBlank_ch:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -89,8 +89,7 @@ XMLPUBVAR const xmlChRangeGroup xmlIsBaseCharGroup;
((c) == 0xd))
/**
- * xmlIsBlankQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -99,8 +98,7 @@ XMLPUBVAR const xmlChRangeGroup xmlIsBaseCharGroup;
/**
- * xmlIsChar_ch:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -109,8 +107,7 @@ XMLPUBVAR const xmlChRangeGroup xmlIsBaseCharGroup;
(0x20 <= (c)))
/**
- * xmlIsCharQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -123,8 +120,7 @@ XMLPUBVAR const xmlChRangeGroup xmlIsBaseCharGroup;
XMLPUBVAR const xmlChRangeGroup xmlIsCharGroup;
/**
- * xmlIsCombiningQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -135,16 +131,14 @@ XMLPUBVAR const xmlChRangeGroup xmlIsCharGroup;
XMLPUBVAR const xmlChRangeGroup xmlIsCombiningGroup;
/**
- * xmlIsDigit_ch:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
#define xmlIsDigit_ch(c) (((0x30 <= (c)) && ((c) <= 0x39)))
/**
- * xmlIsDigitQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -155,16 +149,14 @@ XMLPUBVAR const xmlChRangeGroup xmlIsCombiningGroup;
XMLPUBVAR const xmlChRangeGroup xmlIsDigitGroup;
/**
- * xmlIsExtender_ch:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
#define xmlIsExtender_ch(c) (((c) == 0xb7))
/**
- * xmlIsExtenderQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -175,8 +167,7 @@ XMLPUBVAR const xmlChRangeGroup xmlIsDigitGroup;
XMLPUBVAR const xmlChRangeGroup xmlIsExtenderGroup;
/**
- * xmlIsIdeographicQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
@@ -190,16 +181,14 @@ XMLPUBVAR const xmlChRangeGroup xmlIsIdeographicGroup;
XMLPUBVAR const unsigned char xmlIsPubidChar_tab[256];
/**
- * xmlIsPubidChar_ch:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
#define xmlIsPubidChar_ch(c) (xmlIsPubidChar_tab[(c)])
/**
- * xmlIsPubidCharQ:
- * @c: char to validate
+ * @param c char to validate
*
* Automatically generated by genChRanges.py
*/
diff --git a/include/libxml/debugXML.h b/include/libxml/debugXML.h
index 55148d9d..5344c6d6 100644
--- a/include/libxml/debugXML.h
+++ b/include/libxml/debugXML.h
@@ -1,11 +1,14 @@
-/*
- * Summary: Tree debugging APIs
- * Description: Interfaces to a set of routines used for debugging the tree
+/**
+ * @file
+ *
+ * @brief Tree debugging APIs
+ *
+ * Interfaces to a set of routines used for debugging the tree
* produced by the XML parser.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __DEBUG_XML__
diff --git a/include/libxml/dict.h b/include/libxml/dict.h
index 22aa3d9d..36ff6798 100644
--- a/include/libxml/dict.h
+++ b/include/libxml/dict.h
@@ -1,11 +1,14 @@
-/*
- * Summary: string dictionary
- * Description: dictionary of reusable strings, just used to avoid allocation
+/**
+ * @file
+ *
+ * @brief string dictionary
+ *
+ * dictionary of reusable strings, just used to avoid allocation
* and freeing operations.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_DICT_H__
diff --git a/include/libxml/encoding.h b/include/libxml/encoding.h
index 6b353a55..66e058d6 100644
--- a/include/libxml/encoding.h
+++ b/include/libxml/encoding.h
@@ -1,6 +1,9 @@
-/*
- * Summary: interface for the encoding conversion functions
- * Description: interface for the encoding conversion functions needed for
+/**
+ * @file
+ *
+ * @brief interface for the encoding conversion functions
+ *
+ * interface for the encoding conversion functions needed for
* XML basic encoding and iconv() support.
*
* Related specs are
@@ -10,13 +13,13 @@
* [UNICODE] The Unicode Consortium, "The Unicode Standard --
* Worldwide Character Encoding -- Version 1.0", Addison-
* Wesley, Volume 1, 1991, Volume 2, 1992. UTF-8 is
- * described in Unicode Technical Report #4.
+ * described in Unicode Technical Report \#4.
* [US-ASCII] Coded Character Set--7-bit American Standard Code for
* Information Interchange, ANSI X3.4-1986.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_CHAR_ENCODING_H__
@@ -44,7 +47,6 @@ typedef enum {
} xmlCharEncError;
/*
- * xmlCharEncoding:
*
* Predefined values for some standard encodings.
*/
@@ -90,68 +92,64 @@ typedef enum {
} xmlCharEncFlags;
/**
- * xmlCharEncodingInputFunc:
- * @out: a pointer to an array of bytes to store the UTF-8 result
- * @outlen: the length of @out
- * @in: a pointer to an array of chars in the original encoding
- * @inlen: the length of @in
+ * @param out a pointer to an array of bytes to store the UTF-8 result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of chars in the original encoding
+ * @param inlen the length of `in`
*
* Convert characters to UTF-8.
*
- * On success, the value of @inlen after return is the number of
- * bytes consumed and @outlen is the number of bytes produced.
+ * On success, the value of `inlen` after return is the number of
+ * bytes consumed and `outlen` is the number of bytes produced.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*/
typedef int (*xmlCharEncodingInputFunc)(unsigned char *out, int *outlen,
const unsigned char *in, int *inlen);
/**
- * xmlCharEncodingOutputFunc:
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of UTF-8 chars
- * @inlen: the length of @in
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of UTF-8 chars
+ * @param inlen the length of `in`
*
* Convert characters from UTF-8.
*
- * On success, the value of @inlen after return is the number of
- * bytes consumed and @outlen is the number of bytes produced.
+ * On success, the value of `inlen` after return is the number of
+ * bytes consumed and `outlen` is the number of bytes produced.
*
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @returns the number of bytes written or an XML_ENC_ERR code.
*/
typedef int (*xmlCharEncodingOutputFunc)(unsigned char *out, int *outlen,
const unsigned char *in, int *inlen);
/**
- * xmlCharEncConvFunc:
- * @vctxt: conversion context
- * @out: a pointer to an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer to an array of input bytes
- * @inlen: the length of @in
- * @flush: end of input
+ * @param vctxt conversion context
+ * @param out a pointer to an array of bytes to store the result
+ * @param outlen the length of `out`
+ * @param in a pointer to an array of input bytes
+ * @param inlen the length of `in`
+ * @param flush end of input
*
* Convert between character encodings.
*
- * The value of @inlen after return is the number of bytes consumed
- * and @outlen is the number of bytes produced.
+ * The value of `inlen` after return is the number of bytes consumed
+ * and `outlen` is the number of bytes produced.
*
* If the converter can consume partial multi-byte sequences, the
- * @flush flag can be used to detect truncated sequences at EOF.
+ * `flush` flag can be used to detect truncated sequences at EOF.
* Otherwise, the flag can be ignored.
*
- * Returns an XML_ENC_ERR code.
+ * @returns an XML_ENC_ERR code.
*/
typedef xmlCharEncError
(*xmlCharEncConvFunc)(void *vctxt, unsigned char *out, int *outlen,
const unsigned char *in, int *inlen, int flush);
/**
- * xmlCharEncConvCtxtDtor:
- * @vctxt: conversion context
+ * @param vctxt conversion context
*
* Free a conversion context.
*/
@@ -182,19 +180,18 @@ struct _xmlCharEncodingHandler {
};
/**
- * xmlCharEncConvImpl:
- * @vctxt: user data
- * @name: encoding name
- * @flags: bit mask of flags
- * @out: pointer to resulting handler
+ * @param vctxt user data
+ * @param name encoding name
+ * @param flags bit mask of flags
+ * @param out pointer to resulting handler
*
- * If this function returns XML_ERR_OK, it must fill the @out
+ * If this function returns XML_ERR_OK, it must fill the `out`
* pointer with an encoding handler. The handler can be obtained
* from xmlCharEncNewCustomHandler.
*
- * @flags can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
+ * `flags` can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
typedef xmlParserErrors
(*xmlCharEncConvImpl)(void *vctxt, const char *name, xmlCharEncFlags flags,
@@ -271,9 +268,9 @@ XMLPUBFUN xmlCharEncoding
xmlDetectCharEncoding (const unsigned char *in,
int len);
-/** DOC_DISABLE */
+/** @cond IGNORE */
struct _xmlBuffer;
-/** DOC_ENABLE */
+/** @endcond */
XMLPUBFUN int
xmlCharEncOutFunc (xmlCharEncodingHandler *handler,
struct _xmlBuffer *out,
diff --git a/include/libxml/entities.h b/include/libxml/entities.h
index 3c2079a7..1aee3069 100644
--- a/include/libxml/entities.h
+++ b/include/libxml/entities.h
@@ -1,11 +1,14 @@
-/*
- * Summary: interface for the XML entities handling
- * Description: this module provides some of the entity API needed
+/**
+ * @file
+ *
+ * @brief interface for the XML entities handling
+ *
+ * this module provides some of the entity API needed
* for the parser and applications.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_ENTITIES_H__
diff --git a/include/libxml/globals.h b/include/libxml/globals.h
index a5db8026..4831a45a 100644
--- a/include/libxml/globals.h
+++ b/include/libxml/globals.h
@@ -1,8 +1,11 @@
-/*
- * Summary: interface for all global variables of the library
- * Description: Deprecated, don't use
+/**
+ * @file
+ *
+ * @brief interface for all global variables of the library
+ *
+ * Deprecated, don't use
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*/
#ifndef __XML_GLOBALS_H
diff --git a/include/libxml/hash.h b/include/libxml/hash.h
index a5f2c562..6fae338d 100644
--- a/include/libxml/hash.h
+++ b/include/libxml/hash.h
@@ -1,9 +1,12 @@
-/*
- * Summary: Chained hash tables
- * Description: This module implements the hash table support used in
+/**
+ * @file
+ *
+ * @brief Chained hash tables
+ *
+ * This module implements the hash table support used in
* various places in the library.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*/
#ifndef __XML_HASH_H__
@@ -32,13 +35,13 @@ typedef xmlHashTable *xmlHashTablePtr;
*/
/**
* XML_CAST_FPTR:
- * @fptr: pointer to a function
+ * @param fptr pointer to a function
*
* Macro to do a casting from an object pointer to a
* function pointer without encountering a warning from
* gcc
*
- * #define XML_CAST_FPTR(fptr) (*(void **)(&fptr))
+ * \#define XML_CAST_FPTR(fptr) (*(void **)(&fptr))
* This macro violated ISO C aliasing rules (gcc4 on s390 broke)
* so it is disabled now
*/
@@ -49,39 +52,35 @@ typedef xmlHashTable *xmlHashTablePtr;
* function types:
*/
/**
- * xmlHashDeallocator:
- * @payload: the data in the hash
- * @name: the name associated
+ * @param payload the data in the hash
+ * @param name the name associated
*
* Callback to free data from a hash.
*/
typedef void (*xmlHashDeallocator)(void *payload, const xmlChar *name);
/**
- * xmlHashCopier:
- * @payload: the data in the hash
- * @name: the name associated
+ * @param payload the data in the hash
+ * @param name the name associated
*
* Callback to copy data from a hash.
*
- * Returns a copy of the data or NULL in case of error.
+ * @returns a copy of the data or NULL in case of error.
*/
typedef void *(*xmlHashCopier)(void *payload, const xmlChar *name);
/**
- * xmlHashScanner:
- * @payload: the data in the hash
- * @data: extra scanner data
- * @name: the name associated
+ * @param payload the data in the hash
+ * @param data extra scanner data
+ * @param name the name associated
*
* Callback when scanning data in a hash with the simple scanner.
*/
typedef void (*xmlHashScanner)(void *payload, void *data, const xmlChar *name);
/**
- * xmlHashScannerFull:
- * @payload: the data in the hash
- * @data: extra scanner data
- * @name: the name associated
- * @name2: the second name associated
- * @name3: the third name associated
+ * @param payload the data in the hash
+ * @param data extra scanner data
+ * @param name the name associated
+ * @param name2 the second name associated
+ * @param name3 the third name associated
*
* Callback when scanning data in a hash with the full scanner.
*/
diff --git a/include/libxml/list.h b/include/libxml/list.h
index b48025a4..b7cdc0ba 100644
--- a/include/libxml/list.h
+++ b/include/libxml/list.h
@@ -1,11 +1,14 @@
-/*
- * Summary: lists interfaces
- * Description: this module implement the list support used in
+/**
+ * @file
+ *
+ * @brief lists interfaces
+ *
+ * this module implement the list support used in
* various place in the library.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Gary Pennington
+ * @author Gary Pennington
*/
#ifndef __XML_LINK_INCLUDE__
@@ -24,30 +27,27 @@ typedef struct _xmlList xmlList;
typedef xmlList *xmlListPtr;
/**
- * xmlListDeallocator:
- * @lk: the data to deallocate
+ * @param lk the data to deallocate
*
* Callback function used to free data from a list.
*/
typedef void (*xmlListDeallocator) (xmlLinkPtr lk);
/**
- * xmlListDataCompare:
- * @data0: the first data
- * @data1: the second data
+ * @param data0 the first data
+ * @param data1 the second data
*
* Callback function used to compare 2 data.
*
- * Returns 0 is equality, -1 or 1 otherwise depending on the ordering.
+ * @returns 0 is equality, -1 or 1 otherwise depending on the ordering.
*/
typedef int (*xmlListDataCompare) (const void *data0, const void *data1);
/**
- * xmlListWalker:
- * @data: the data found in the list
- * @user: extra user provided data to the walker
+ * @param data the data found in the list
+ * @param user extra user provided data to the walker
*
* Callback function used when walking a list with xmlListWalk().
*
- * Returns 0 to stop walking the list, 1 otherwise.
+ * @returns 0 to stop walking the list, 1 otherwise.
*/
typedef int (*xmlListWalker) (const void *data, void *user);
diff --git a/include/libxml/nanoftp.h b/include/libxml/nanoftp.h
index 5dda6349..baaedc58 100644
--- a/include/libxml/nanoftp.h
+++ b/include/libxml/nanoftp.h
@@ -1,9 +1,12 @@
-/*
- * Summary: Removed legacy symbols for an outdated FTP client
+/**
+ * @file
+ *
+ * @brief Removed legacy symbols for an outdated FTP client
+ *
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __NANO_FTP_H__
diff --git a/include/libxml/nanohttp.h b/include/libxml/nanohttp.h
index a01680e1..6ed3a2fc 100644
--- a/include/libxml/nanohttp.h
+++ b/include/libxml/nanohttp.h
@@ -1,11 +1,14 @@
-/*
- * Summary: minimal HTTP implementation
- * Description: minimal HTTP implementation allowing to fetch resources
+/**
+ * @file
+ *
+ * @brief minimal HTTP implementation
+ *
+ * minimal HTTP implementation allowing to fetch resources
* like external subset.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __NANO_HTTP_H__
diff --git a/include/libxml/parser.h b/include/libxml/parser.h
index 29b6eb1d..5464b0d2 100644
--- a/include/libxml/parser.h
+++ b/include/libxml/parser.h
@@ -1,10 +1,13 @@
-/*
- * Summary: the core parser module
- * Description: Interfaces, constants and types related to the XML parser
+/**
+ * @file
+ *
+ * @brief the core parser module
+ *
+ * Interfaces, constants and types related to the XML parser
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_PARSER_H__
@@ -63,7 +66,6 @@ typedef enum {
} xmlParserInputFlags;
/**
- * xmlParserInput:
*
* An xmlParserInput is an input flow for the XML processor.
* Each entity parsed is associated an xmlParserInput (except the
@@ -74,8 +76,7 @@ typedef enum {
*/
/**
- * xmlParserInputDeallocate:
- * @str: the string to deallocate
+ * @param str the string to deallocate
*
* Callback for freeing some parser input allocations.
*/
@@ -119,7 +120,6 @@ struct _xmlParserInput {
};
/**
- * xmlParserNodeInfo:
*
* The parser can be asked to collect Node information, i.e. at what
* place in the file they were detected.
@@ -146,7 +146,6 @@ struct _xmlParserNodeInfoSeq {
};
/**
- * xmlParserInputState:
*
* The parser is now working also as a state based parser.
* The recursive one use the state info for entities processing.
@@ -173,17 +172,16 @@ typedef enum {
XML_PARSER_XML_DECL /* before XML decl (but after BOM) */
} xmlParserInputState;
-/** DOC_DISABLE */
+/** @cond IGNORE */
/*
* Internal bits in the 'loadsubset' context member
*/
#define XML_DETECT_IDS 2
#define XML_COMPLETE_ATTRS 4
#define XML_SKIP_IDS 8
-/** DOC_ENABLE */
+/** @endcond */
/**
- * xmlParserMode:
*
* A parser can operate in various modes
*/
@@ -201,22 +199,21 @@ typedef struct _xmlParserNsData xmlParserNsData;
typedef struct _xmlAttrHashBucket xmlAttrHashBucket;
/**
- * xmlResourceLoader:
- * @ctxt: parser context
- * @url: URL to load
- * @publicId: publid ID from DTD (optional)
- * @type: resource type
- * @flags: flags
- * @out: result pointer
+ * @param ctxt parser context
+ * @param url URL to load
+ * @param publicId publid ID from DTD (optional)
+ * @param type resource type
+ * @param flags flags
+ * @param out result pointer
*
* Callback for custom resource loaders.
*
- * @flags can contain XML_INPUT_UNZIP and XML_INPUT_NETWORK.
+ * `flags` can contain XML_INPUT_UNZIP and XML_INPUT_NETWORK.
*
- * On success, @out should be set to a new parser input object and
+ * On success, `out` should be set to a new parser input object and
* XML_ERR_OK should be returned.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
typedef xmlParserErrors
(*xmlResourceLoader)(void *ctxt, const char *url, const char *publicId,
@@ -224,7 +221,6 @@ typedef xmlParserErrors
xmlParserInputPtr *out);
/**
- * xmlParserCtxt:
*
* The parser context.
* NOTE This doesn't completely define the parser state, the (current ?)
@@ -484,7 +480,6 @@ struct _xmlParserCtxt {
};
/**
- * xmlSAXLocator:
*
* A SAX Locator.
*/
@@ -496,7 +491,6 @@ struct _xmlSAXLocator {
};
/**
- * xmlSAXHandler:
*
* A SAX handler is bunch of callbacks called by the parser when processing
* of the input generate data or structure information.
@@ -504,9 +498,9 @@ struct _xmlSAXLocator {
/**
* resolveEntitySAXFunc:
- * @ctx: the user data (XML parser context)
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctx the user data (XML parser context)
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* Callback:
* The entity loader, to control the loading of external entities,
@@ -515,17 +509,17 @@ struct _xmlSAXLocator {
* - or better use the xmlSetExternalEntityLoader() function to
* set up it's own entity resolution routine
*
- * Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
+ * @returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
*/
typedef xmlParserInputPtr (*resolveEntitySAXFunc) (void *ctx,
const xmlChar *publicId,
const xmlChar *systemId);
/**
* internalSubsetSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: the root element name
- * @ExternalID: the external ID
- * @SystemID: the SYSTEM ID (e.g. filename or URL)
+ * @param ctx the user data (XML parser context)
+ * @param name the root element name
+ * @param ExternalID the external ID
+ * @param SystemID the SYSTEM ID (e.g. filename or URL)
*
* Callback on internal subset declaration.
*/
@@ -535,10 +529,10 @@ typedef void (*internalSubsetSAXFunc) (void *ctx,
const xmlChar *SystemID);
/**
* externalSubsetSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: the root element name
- * @ExternalID: the external ID
- * @SystemID: the SYSTEM ID (e.g. filename or URL)
+ * @param ctx the user data (XML parser context)
+ * @param name the root element name
+ * @param ExternalID the external ID
+ * @param SystemID the SYSTEM ID (e.g. filename or URL)
*
* Callback on external subset declaration.
*/
@@ -548,34 +542,34 @@ typedef void (*externalSubsetSAXFunc) (void *ctx,
const xmlChar *SystemID);
/**
* getEntitySAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The entity name
+ * @param ctx the user data (XML parser context)
+ * @param name The entity name
*
* Get an entity by name.
*
- * Returns the xmlEntityPtr if found.
+ * @returns the xmlEntityPtr if found.
*/
typedef xmlEntityPtr (*getEntitySAXFunc) (void *ctx,
const xmlChar *name);
/**
* getParameterEntitySAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The entity name
+ * @param ctx the user data (XML parser context)
+ * @param name The entity name
*
* Get a parameter entity by name.
*
- * Returns the xmlEntityPtr if found.
+ * @returns the xmlEntityPtr if found.
*/
typedef xmlEntityPtr (*getParameterEntitySAXFunc) (void *ctx,
const xmlChar *name);
/**
* entityDeclSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: the entity name
- * @type: the entity type
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @content: the entity value (without processing).
+ * @param ctx the user data (XML parser context)
+ * @param name the entity name
+ * @param type the entity type
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param content the entity value (without processing).
*
* An entity definition has been parsed.
*/
@@ -587,10 +581,10 @@ typedef void (*entityDeclSAXFunc) (void *ctx,
xmlChar *content);
/**
* notationDeclSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The name of the notation
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctx the user data (XML parser context)
+ * @param name The name of the notation
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* What to do when a notation declaration has been parsed.
*/
@@ -600,13 +594,13 @@ typedef void (*notationDeclSAXFunc)(void *ctx,
const xmlChar *systemId);
/**
* attributeDeclSAXFunc:
- * @ctx: the user data (XML parser context)
- * @elem: the name of the element
- * @fullname: the attribute name
- * @type: the attribute type
- * @def: the type of default value
- * @defaultValue: the attribute default value
- * @tree: the tree of enumerated value set
+ * @param ctx the user data (XML parser context)
+ * @param elem the name of the element
+ * @param fullname the attribute name
+ * @param type the attribute type
+ * @param def the type of default value
+ * @param defaultValue the attribute default value
+ * @param tree the tree of enumerated value set
*
* An attribute definition has been parsed.
*/
@@ -619,10 +613,10 @@ typedef void (*attributeDeclSAXFunc)(void *ctx,
xmlEnumerationPtr tree);
/**
* elementDeclSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: the element name
- * @type: the element type
- * @content: the element value tree
+ * @param ctx the user data (XML parser context)
+ * @param name the element name
+ * @param type the element type
+ * @param content the element value tree
*
* An element definition has been parsed.
*/
@@ -632,11 +626,11 @@ typedef void (*elementDeclSAXFunc)(void *ctx,
xmlElementContentPtr content);
/**
* unparsedEntityDeclSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The name of the entity
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @notationName: the name of the notation
+ * @param ctx the user data (XML parser context)
+ * @param name The name of the entity
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param notationName the name of the notation
*
* What to do when an unparsed entity declaration is parsed.
*/
@@ -647,8 +641,8 @@ typedef void (*unparsedEntityDeclSAXFunc)(void *ctx,
const xmlChar *notationName);
/**
* setDocumentLocatorSAXFunc:
- * @ctx: the user data (XML parser context)
- * @loc: A SAX Locator
+ * @param ctx the user data (XML parser context)
+ * @param loc A SAX Locator
*
* Receive the document locator at startup, actually xmlDefaultSAXLocator.
* Everything is available on the context, so this is useless in our case.
@@ -657,23 +651,23 @@ typedef void (*setDocumentLocatorSAXFunc) (void *ctx,
xmlSAXLocatorPtr loc);
/**
* startDocumentSAXFunc:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Called when the document start being processed.
*/
typedef void (*startDocumentSAXFunc) (void *ctx);
/**
* endDocumentSAXFunc:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Called when the document end has been detected.
*/
typedef void (*endDocumentSAXFunc) (void *ctx);
/**
* startElementSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The element name, including namespace prefix
- * @atts: An array of name/value attributes pairs, NULL terminated
+ * @param ctx the user data (XML parser context)
+ * @param name The element name, including namespace prefix
+ * @param atts An array of name/value attributes pairs, NULL terminated
*
* Called when an opening tag has been processed.
*/
@@ -682,8 +676,8 @@ typedef void (*startElementSAXFunc) (void *ctx,
const xmlChar **atts);
/**
* endElementSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The element name
+ * @param ctx the user data (XML parser context)
+ * @param name The element name
*
* Called when the end of an element has been detected.
*/
@@ -691,9 +685,9 @@ typedef void (*endElementSAXFunc) (void *ctx,
const xmlChar *name);
/**
* attributeSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The attribute name, including namespace prefix
- * @value: The attribute value
+ * @param ctx the user data (XML parser context)
+ * @param name The attribute name, including namespace prefix
+ * @param value The attribute value
*
* Handle an attribute that has been read by the parser.
* The default handling is to convert the attribute into an
@@ -705,8 +699,8 @@ typedef void (*attributeSAXFunc) (void *ctx,
const xmlChar *value);
/**
* referenceSAXFunc:
- * @ctx: the user data (XML parser context)
- * @name: The entity name
+ * @param ctx the user data (XML parser context)
+ * @param name The entity name
*
* Called when an entity reference is detected.
*/
@@ -714,9 +708,9 @@ typedef void (*referenceSAXFunc) (void *ctx,
const xmlChar *name);
/**
* charactersSAXFunc:
- * @ctx: the user data (XML parser context)
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctx the user data (XML parser context)
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* Receiving some chars from the parser.
*/
@@ -725,9 +719,9 @@ typedef void (*charactersSAXFunc) (void *ctx,
int len);
/**
* ignorableWhitespaceSAXFunc:
- * @ctx: the user data (XML parser context)
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctx the user data (XML parser context)
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* Receiving some ignorable whitespaces from the parser.
* UNUSED: by default the DOM building will use characters.
@@ -737,9 +731,9 @@ typedef void (*ignorableWhitespaceSAXFunc) (void *ctx,
int len);
/**
* processingInstructionSAXFunc:
- * @ctx: the user data (XML parser context)
- * @target: the target name
- * @data: the PI data's
+ * @param ctx the user data (XML parser context)
+ * @param target the target name
+ * @param data the PI data's
*
* A processing instruction has been parsed.
*/
@@ -748,8 +742,8 @@ typedef void (*processingInstructionSAXFunc) (void *ctx,
const xmlChar *data);
/**
* commentSAXFunc:
- * @ctx: the user data (XML parser context)
- * @value: the comment content
+ * @param ctx the user data (XML parser context)
+ * @param value the comment content
*
* A comment has been parsed.
*/
@@ -757,9 +751,9 @@ typedef void (*commentSAXFunc) (void *ctx,
const xmlChar *value);
/**
* cdataBlockSAXFunc:
- * @ctx: the user data (XML parser context)
- * @value: The pcdata content
- * @len: the block length
+ * @param ctx the user data (XML parser context)
+ * @param value The pcdata content
+ * @param len the block length
*
* Called when a pcdata block has been parsed.
*/
@@ -769,8 +763,8 @@ typedef void (*cdataBlockSAXFunc) (
int len);
/**
* warningSAXFunc:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a warning messages, callback.
@@ -779,8 +773,8 @@ typedef void (*warningSAXFunc) (void *ctx,
const char *msg, ...) LIBXML_ATTR_FORMAT(2,3);
/**
* errorSAXFunc:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format an error messages, callback.
@@ -789,8 +783,8 @@ typedef void (*errorSAXFunc) (void *ctx,
const char *msg, ...) LIBXML_ATTR_FORMAT(2,3);
/**
* fatalErrorSAXFunc:
- * @ctx: an XML parser context
- * @msg: the message to display/transmit
+ * @param ctx an XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format fatal error messages, callback.
@@ -801,30 +795,30 @@ typedef void (*fatalErrorSAXFunc) (void *ctx,
const char *msg, ...) LIBXML_ATTR_FORMAT(2,3);
/**
* isStandaloneSAXFunc:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Is this document tagged standalone?
*
- * Returns 1 if true
+ * @returns 1 if true
*/
typedef int (*isStandaloneSAXFunc) (void *ctx);
/**
* hasInternalSubsetSAXFunc:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Does this document has an internal subset.
*
- * Returns 1 if true
+ * @returns 1 if true
*/
typedef int (*hasInternalSubsetSAXFunc) (void *ctx);
/**
* hasExternalSubsetSAXFunc:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* Does this document has an external subset?
*
- * Returns 1 if true
+ * @returns 1 if true
*/
typedef int (*hasExternalSubsetSAXFunc) (void *ctx);
@@ -842,16 +836,16 @@ typedef int (*hasExternalSubsetSAXFunc) (void *ctx);
/**
* startElementNsSAX2Func:
- * @ctx: the user data (XML parser context)
- * @localname: the local name of the element
- * @prefix: the element namespace prefix if available
- * @URI: the element namespace name if available
- * @nb_namespaces: number of namespace definitions on that node
- * @namespaces: pointer to the array of prefix/URI pairs namespace definitions
- * @nb_attributes: the number of attributes on that node
- * @nb_defaulted: the number of defaulted attributes. The defaulted
+ * @param ctx the user data (XML parser context)
+ * @param localname the local name of the element
+ * @param prefix the element namespace prefix if available
+ * @param URI the element namespace name if available
+ * @param nb_namespaces number of namespace definitions on that node
+ * @param namespaces pointer to the array of prefix/URI pairs namespace definitions
+ * @param nb_attributes the number of attributes on that node
+ * @param nb_defaulted the number of defaulted attributes. The defaulted
* ones are at the end of the array
- * @attributes: pointer to the array of (localname/prefix/URI/value/end)
+ * @param attributes pointer to the array of (localname/prefix/URI/value/end)
* attribute values.
*
* SAX2 callback when an element start has been detected by the parser.
@@ -871,10 +865,10 @@ typedef void (*startElementNsSAX2Func) (void *ctx,
/**
* endElementNsSAX2Func:
- * @ctx: the user data (XML parser context)
- * @localname: the local name of the element
- * @prefix: the element namespace prefix if available
- * @URI: the element namespace name if available
+ * @param ctx the user data (XML parser context)
+ * @param localname the local name of the element
+ * @param prefix the element namespace prefix if available
+ * @param URI the element namespace name if available
*
* SAX2 callback when an element end has been detected by the parser.
* It provides the namespace information for the element.
@@ -993,14 +987,13 @@ struct _xmlSAXHandlerV1 {
/**
- * xmlExternalEntityLoader:
- * @URL: The System ID of the resource requested
- * @ID: The Public ID of the resource requested
- * @context: the XML parser context
+ * @param URL The System ID of the resource requested
+ * @param ID The Public ID of the resource requested
+ * @param context the XML parser context
*
* External entity loaders types.
*
- * Returns the entity input parser.
+ * @returns the entity input parser.
*/
typedef xmlParserInputPtr (*xmlExternalEntityLoader) (const char *URL,
const char *ID,
@@ -1012,7 +1005,7 @@ typedef xmlParserInputPtr (*xmlExternalEntityLoader) (const char *URL,
XMLPUBVAR const char *const xmlParserVersion;
-/** DOC_DISABLE */
+/** @cond IGNORE */
XML_DEPRECATED
XMLPUBVAR const xmlSAXLocator xmlDefaultSAXLocator;
#ifdef LIBXML_SAX1_ENABLED
@@ -1063,7 +1056,7 @@ XMLPUBFUN int *__xmlSaveNoEmptyTags(void);
#define xmlSaveNoEmptyTags (*__xmlSaveNoEmptyTags())
#endif
#endif
-/** DOC_ENABLE */
+/** @endcond */
/*
* Init/Cleanup
@@ -1378,7 +1371,6 @@ XMLPUBFUN long
* New set of simpler/more flexible APIs
*/
/**
- * xmlParserOption:
*
* This is the set of XML parser options that can be passed down
* to the xmlReadDoc() and similar calls.
@@ -1581,7 +1573,6 @@ xmlInputSetEncodingHandler(xmlParserInputPtr input,
* Library wide options
*/
/**
- * xmlFeature:
*
* Used to examine the existence of features that can be enabled
* or disabled at compile-time.
diff --git a/include/libxml/parserInternals.h b/include/libxml/parserInternals.h
index 3d259fc1..20511dc8 100644
--- a/include/libxml/parserInternals.h
+++ b/include/libxml/parserInternals.h
@@ -1,12 +1,15 @@
-/*
- * Summary: internals routines and limits exported by the parser.
- * Description: this module exports a number of internal parsing routines
+/**
+ * @file
+ *
+ * @brief internals routines and limits exported by the parser.
+ *
+ * this module exports a number of internal parsing routines
* they are not really all intended for applications but
* can prove useful doing low level processing.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_PARSER_INTERNALS_H__
@@ -93,30 +96,30 @@ extern "C" {
************************************************************************/
/**
* IS_BYTE_CHAR:
- * @c: an byte value (int)
+ * @param c an byte value (int)
*
* Macro to check the following production in the XML spec:
*
- * [2] Char ::= #x9 | #xA | #xD | [#x20...]
+ * [2] Char ::= \#x9 | \#xA | \#xD | [\#x20...]
* any byte character in the accepted range
*/
#define IS_BYTE_CHAR(c) xmlIsChar_ch(c)
/**
* IS_CHAR:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
- * [2] Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
- * | [#x10000-#x10FFFF]
+ * [2] Char ::= \#x9 | \#xA | \#xD | [\#x20-\#xD7FF] | [\#xE000-\#xFFFD]
+ * | [\#x10000-\#x10FFFF]
* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.
*/
#define IS_CHAR(c) xmlIsCharQ(c)
/**
* IS_CHAR_CH:
- * @c: an xmlChar (usually an unsigned char)
+ * @param c an xmlChar (usually an unsigned char)
*
* Behaves like IS_CHAR on single-byte value
*/
@@ -124,17 +127,17 @@ extern "C" {
/**
* IS_BLANK:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
- * [3] S ::= (#x20 | #x9 | #xD | #xA)+
+ * [3] S ::= (\#x20 | \#x9 | \#xD | \#xA)+
*/
#define IS_BLANK(c) xmlIsBlankQ(c)
/**
* IS_BLANK_CH:
- * @c: an xmlChar value (normally unsigned char)
+ * @param c an xmlChar value (normally unsigned char)
*
* Behaviour same as IS_BLANK
*/
@@ -142,7 +145,7 @@ extern "C" {
/**
* IS_BASECHAR:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
@@ -152,7 +155,7 @@ extern "C" {
/**
* IS_DIGIT:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
@@ -162,7 +165,7 @@ extern "C" {
/**
* IS_DIGIT_CH:
- * @c: an xmlChar value (usually an unsigned char)
+ * @param c an xmlChar value (usually an unsigned char)
*
* Behaves like IS_DIGIT but with a single byte argument
*/
@@ -170,7 +173,7 @@ extern "C" {
/**
* IS_COMBINING:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
@@ -180,7 +183,7 @@ extern "C" {
/**
* IS_COMBINING_CH:
- * @c: an xmlChar (usually an unsigned char)
+ * @param c an xmlChar (usually an unsigned char)
*
* Always false (all combining chars > 0xff)
*/
@@ -188,20 +191,20 @@ extern "C" {
/**
* IS_EXTENDER:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
*
- * [89] Extender ::= #x00B7 | #x02D0 | #x02D1 | #x0387 | #x0640 |
- * #x0E46 | #x0EC6 | #x3005 | [#x3031-#x3035] |
- * [#x309D-#x309E] | [#x30FC-#x30FE]
+ * [89] Extender ::= \#x00B7 | \#x02D0 | \#x02D1 | \#x0387 | \#x0640 |
+ * \#x0E46 | \#x0EC6 | \#x3005 | [\#x3031-\#x3035] |
+ * [\#x309D-\#x309E] | [\#x30FC-\#x30FE]
*/
#define IS_EXTENDER(c) xmlIsExtenderQ(c)
/**
* IS_EXTENDER_CH:
- * @c: an xmlChar value (usually an unsigned char)
+ * @param c an xmlChar value (usually an unsigned char)
*
* Behaves like IS_EXTENDER but with a single-byte argument
*/
@@ -209,18 +212,18 @@ extern "C" {
/**
* IS_IDEOGRAPHIC:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
*
- * [86] Ideographic ::= [#x4E00-#x9FA5] | #x3007 | [#x3021-#x3029]
+ * [86] Ideographic ::= [\#x4E00-\#x9FA5] | \#x3007 | [\#x3021-\#x3029]
*/
#define IS_IDEOGRAPHIC(c) xmlIsIdeographicQ(c)
/**
* IS_LETTER:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
@@ -231,7 +234,7 @@ extern "C" {
/**
* IS_LETTER_CH:
- * @c: an xmlChar value (normally unsigned char)
+ * @param c an xmlChar value (normally unsigned char)
*
* Macro behaves like IS_LETTER, but only check base chars
*
@@ -240,7 +243,7 @@ extern "C" {
/**
* IS_ASCII_LETTER:
- * @c: an xmlChar value
+ * @param c an xmlChar value
*
* Macro to check [a-zA-Z]
*
@@ -250,7 +253,7 @@ extern "C" {
/**
* IS_ASCII_DIGIT:
- * @c: an xmlChar value
+ * @param c an xmlChar value
*
* Macro to check [0-9]
*
@@ -259,18 +262,18 @@ extern "C" {
/**
* IS_PUBIDCHAR:
- * @c: an UNICODE value (int)
+ * @param c an UNICODE value (int)
*
* Macro to check the following production in the XML spec:
*
*
- * [13] PubidChar ::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]
+ * [13] PubidChar ::= \#x20 | \#xD | \#xA | [a-zA-Z0-9] | [-'()+,./:=?;!*\#@$_%]
*/
#define IS_PUBIDCHAR(c) xmlIsPubidCharQ(c)
/**
* IS_PUBIDCHAR_CH:
- * @c: an xmlChar value (normally unsigned char)
+ * @param c an xmlChar value (normally unsigned char)
*
* Same as IS_PUBIDCHAR but for single-byte value
*/
diff --git a/include/libxml/pattern.h b/include/libxml/pattern.h
index 947f0900..c14f490b 100644
--- a/include/libxml/pattern.h
+++ b/include/libxml/pattern.h
@@ -1,11 +1,14 @@
-/*
- * Summary: pattern expression handling
- * Description: allows to compile and test pattern expressions for nodes
+/**
+ * @file
+ *
+ * @brief pattern expression handling
+ *
+ * allows to compile and test pattern expressions for nodes
* either in a tree or based on a parser state.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_PATTERN_H__
@@ -22,7 +25,6 @@ extern "C" {
#endif
/**
- * xmlPattern:
*
* A compiled (XPath based) pattern to select nodes
*/
@@ -30,7 +32,6 @@ typedef struct _xmlPattern xmlPattern;
typedef xmlPattern *xmlPatternPtr;
/**
- * xmlPatternFlags:
*
* This is the set of options affecting the behaviour of pattern
* matching with this module
diff --git a/include/libxml/relaxng.h b/include/libxml/relaxng.h
index e9cb1ec9..0654e1a6 100644
--- a/include/libxml/relaxng.h
+++ b/include/libxml/relaxng.h
@@ -1,10 +1,13 @@
-/*
- * Summary: implementation of the Relax-NG validation
- * Description: implementation of the Relax-NG validation
+/**
+ * @file
+ *
+ * @brief implementation of the Relax-NG validation
+ *
+ * implementation of the Relax-NG validation
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_RELAX_NG__
@@ -27,9 +30,8 @@ typedef xmlRelaxNG *xmlRelaxNGPtr;
/**
- * xmlRelaxNGValidityErrorFunc:
- * @ctx: the validation context
- * @msg: the message
+ * @param ctx the validation context
+ * @param msg the message
* @...: extra arguments
*
* Signature of an error callback from a Relax-NG validation
@@ -39,9 +41,8 @@ typedef void (*xmlRelaxNGValidityErrorFunc) (void *ctx,
...) LIBXML_ATTR_FORMAT(2,3);
/**
- * xmlRelaxNGValidityWarningFunc:
- * @ctx: the validation context
- * @msg: the message
+ * @param ctx the validation context
+ * @param msg the message
* @...: extra arguments
*
* Signature of a warning callback from a Relax-NG validation
@@ -60,7 +61,6 @@ typedef struct _xmlRelaxNGValidCtxt xmlRelaxNGValidCtxt;
typedef xmlRelaxNGValidCtxt *xmlRelaxNGValidCtxtPtr;
/*
- * xmlRelaxNGValidErr:
*
* List of possible Relax NG validation errors
*/
@@ -108,7 +108,6 @@ typedef enum {
} xmlRelaxNGValidErr;
/*
- * xmlRelaxNGParserFlags:
*
* List of possible Relax NG Parser flags
*/
diff --git a/include/libxml/schemasInternals.h b/include/libxml/schemasInternals.h
index eeb21b21..cd0f13e2 100644
--- a/include/libxml/schemasInternals.h
+++ b/include/libxml/schemasInternals.h
@@ -1,13 +1,16 @@
-/*
- * Summary: internal interfaces for XML Schemas
- * Description: internal interfaces for the XML Schemas handling
+/**
+ * @file
+ *
+ * @brief internal interfaces for XML Schemas
+ *
+ * internal interfaces for the XML Schemas handling
* and schema validity checking
* The Schemas development is a Work In Progress.
* Some of those interfaces are not guaranteed to be API or ABI stable !
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
@@ -240,7 +243,6 @@ struct _xmlSchemaAnnot {
#define XML_SCHEMAS_ATTR_FIXED 1 << 9
/**
- * xmlSchemaAttribute:
* An attribute definition.
*/
@@ -270,7 +272,6 @@ struct _xmlSchemaAttribute {
};
/**
- * xmlSchemaAttributeLink:
* Used to build a list of attribute uses on complexType definitions.
* WARNING: Deprecated; not used.
*/
@@ -289,7 +290,6 @@ struct _xmlSchemaAttributeLink {
#define XML_SCHEMAS_WILDCARD_COMPLETE 1 << 0
/**
- * xmlSchemaCharValueLink:
* Used to build a list of namespaces on wildcards.
*/
typedef struct _xmlSchemaWildcardNs xmlSchemaWildcardNs;
@@ -379,7 +379,6 @@ struct _xmlSchemaAttributeGroup {
};
/**
- * xmlSchemaTypeLink:
* Used to build a list of types (e.g. member types of
* simpleType with variety "union").
*/
@@ -391,7 +390,6 @@ struct _xmlSchemaTypeLink {
};
/**
- * xmlSchemaFacetLink:
* Used to build a list of facets.
*/
typedef struct _xmlSchemaFacetLink xmlSchemaFacetLink;
@@ -636,7 +634,6 @@ struct _xmlSchemaType {
};
/*
- * xmlSchemaElement:
* An element definition.
*
* xmlSchemaType, xmlSchemaFacet and xmlSchemaElement start of
diff --git a/include/libxml/schematron.h b/include/libxml/schematron.h
index 8dd8d25c..a1dd90fc 100644
--- a/include/libxml/schematron.h
+++ b/include/libxml/schematron.h
@@ -1,10 +1,13 @@
-/*
- * Summary: XML Schematron implementation
- * Description: interface to the XML Schematron validity checking.
+/**
+ * @file
+ *
+ * @brief XML Schematron implementation
+ *
+ * interface to the XML Schematron validity checking.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
@@ -39,9 +42,8 @@ typedef struct _xmlSchematron xmlSchematron;
typedef xmlSchematron *xmlSchematronPtr;
/**
- * xmlSchematronValidityErrorFunc:
- * @ctx: the validation context
- * @msg: the message
+ * @param ctx the validation context
+ * @param msg the message
* @...: extra arguments
*
* Signature of an error callback from a Schematron validation
@@ -49,9 +51,8 @@ typedef xmlSchematron *xmlSchematronPtr;
typedef void (*xmlSchematronValidityErrorFunc) (void *ctx, const char *msg, ...);
/**
- * xmlSchematronValidityWarningFunc:
- * @ctx: the validation context
- * @msg: the message
+ * @param ctx the validation context
+ * @param msg the message
* @...: extra arguments
*
* Signature of a warning callback from a Schematron validation
diff --git a/include/libxml/threads.h b/include/libxml/threads.h
index ec2b16b1..ffd6293a 100644
--- a/include/libxml/threads.h
+++ b/include/libxml/threads.h
@@ -1,11 +1,14 @@
/**
- * Summary: interfaces for thread handling
- * Description: set of generic threading related routines
+ * @file
+ * *
+ * @brief interfaces for thread handling
+ *
+ * set of generic threading related routines
* should work with pthreads, Windows native or TLS threads
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_THREADS_H__
@@ -64,14 +67,14 @@ XML_DEPRECATED
XMLPUBFUN void
xmlCleanupThreads(void);
-/** DOC_DISABLE */
+/** @cond IGNORE */
#if defined(LIBXML_THREAD_ENABLED) && defined(_WIN32) && \
defined(LIBXML_STATIC_FOR_DLL)
int
xmlDllMain(void *hinstDLL, unsigned long fdwReason,
void *lpvReserved);
#endif
-/** DOC_ENABLE */
+/** @endcond */
#ifdef __cplusplus
}
diff --git a/include/libxml/tree.h b/include/libxml/tree.h
index e5a8fb70..239bda0c 100644
--- a/include/libxml/tree.h
+++ b/include/libxml/tree.h
@@ -1,12 +1,15 @@
-/*
- * Summary: interfaces for tree manipulation
- * Description: this module describes the structures found in an tree resulting
+/**
+ * @file
+ *
+ * @brief interfaces for tree manipulation
+ *
+ * this module describes the structures found in an tree resulting
* from an XML or HTML parsing, as well as the API provided for
* various processing on that tree
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef XML_TREE_INTERNALS
@@ -69,13 +72,12 @@ typedef xmlEntity *xmlEntityPtr;
* LIBXML_NAMESPACE_DICT:
*
* Defines experimental behaviour:
- * 1) xmlNs gets an additional field @context (a xmlDoc)
+ * 1) xmlNs gets an additional field `context` (a xmlDoc)
* 2) when creating a tree, xmlNs->href is stored in the dict of xmlDoc.
*/
/* #define LIBXML_NAMESPACE_DICT */
/**
- * xmlBufferAllocationScheme:
*
* A buffer allocation scheme can be defined to either match exactly the
* need or double it's allocated size each time it is found too small.
@@ -91,7 +93,6 @@ typedef enum {
} xmlBufferAllocationScheme;
/**
- * xmlBuffer:
*
* A buffer structure, this old construct is limited to 2GB and
* is being deprecated, use API with xmlBuf instead
@@ -112,7 +113,6 @@ struct _xmlBuffer {
};
/**
- * xmlBuf:
*
* A buffer structure, new one, the actual structure internals are not public
*/
@@ -120,7 +120,6 @@ struct _xmlBuffer {
typedef struct _xmlBuf xmlBuf;
/**
- * xmlBufPtr:
*
* A pointer to a buffer structure, the actual structure internals are not
* public
@@ -195,13 +194,12 @@ typedef enum {
/* XML_DOCB_DOCUMENT_NODE= 21 */ /* removed */
} xmlElementType;
-/** DOC_DISABLE */
+/** @cond IGNORE */
/* For backward compatibility */
#define XML_DOCB_DOCUMENT_NODE 21
-/** DOC_ENABLE */
+/** @endcond */
/**
- * xmlNotation:
*
* A DTD Notation definition.
*/
@@ -215,7 +213,6 @@ struct _xmlNotation {
};
/**
- * xmlAttributeType:
*
* A DTD Attribute type definition.
*/
@@ -234,7 +231,6 @@ typedef enum {
} xmlAttributeType;
/**
- * xmlAttributeDefault:
*
* A DTD Attribute default definition.
*/
@@ -247,7 +243,6 @@ typedef enum {
} xmlAttributeDefault;
/**
- * xmlEnumeration:
*
* List structure used when there is an enumeration in DTDs.
*/
@@ -260,7 +255,6 @@ struct _xmlEnumeration {
};
/**
- * xmlAttribute:
*
* An Attribute declaration in a DTD.
*/
@@ -288,7 +282,6 @@ struct _xmlAttribute {
};
/**
- * xmlElementContentType:
*
* Possible definitions of element content types.
*/
@@ -300,7 +293,6 @@ typedef enum {
} xmlElementContentType;
/**
- * xmlElementContentOccur:
*
* Possible definitions of element content occurrences.
*/
@@ -312,7 +304,6 @@ typedef enum {
} xmlElementContentOccur;
/**
- * xmlElementContent:
*
* An XML Element content as stored after parsing an element definition
* in a DTD.
@@ -331,7 +322,6 @@ struct _xmlElementContent {
};
/**
- * xmlElementTypeVal:
*
* The different possibilities for an element content type.
*/
@@ -345,7 +335,6 @@ typedef enum {
} xmlElementTypeVal;
/**
- * xmlElement:
*
* An XML Element declaration from a DTD.
*/
@@ -384,7 +373,6 @@ struct _xmlElement {
typedef xmlElementType xmlNsType;
/**
- * xmlNs:
*
* An XML namespace.
* Note that prefix == NULL is valid, it defines the default namespace
@@ -405,7 +393,6 @@ struct _xmlNs {
};
/**
- * xmlDtd:
*
* An XML DTD, as defined by userData (which normally contains such
* a pointer); ctxt->userData can be changed by the user.
- * @msg: the string to format *printf like vararg
+ * @param msg the string to format *printf like vararg
* @...: remaining arguments to the format
*
* Callback called when a validity error is found. This is a message
@@ -46,11 +48,10 @@ typedef void (*xmlValidityErrorFunc) (void *ctx,
...) LIBXML_ATTR_FORMAT(2,3);
/**
- * xmlValidityWarningFunc:
- * @ctx: usually an xmlValidCtxtPtr to a validity error context,
+ * @param ctx usually an xmlValidCtxtPtr to a validity error context,
* but comes from ctxt->userData (which normally contains such
* a pointer); ctxt->userData can be changed by the user.
- * @msg: the string to format *printf like vararg
+ * @param msg the string to format *printf like vararg
* @...: remaining arguments to the format
*
* Callback called when a validity warning is found. This is a message
@@ -61,7 +62,6 @@ typedef void (*xmlValidityWarningFunc) (void *ctx,
...) LIBXML_ATTR_FORMAT(2,3);
/*
- * xmlValidCtxt:
* An xmlValidCtxt is used for error reporting when validating.
*/
typedef struct _xmlValidCtxt xmlValidCtxt;
diff --git a/include/libxml/xinclude.h b/include/libxml/xinclude.h
index e1cb39fe..b0d042ba 100644
--- a/include/libxml/xinclude.h
+++ b/include/libxml/xinclude.h
@@ -1,13 +1,16 @@
-/*
- * Summary: implementation of XInclude
- * Description: API to handle XInclude processing,
+/**
+ * @file
+ *
+ * @brief implementation of XInclude
+ *
+ * API to handle XInclude processing,
* implements the
* World Wide Web Consortium Last Call Working Draft 10 November 2003
* http://www.w3.org/TR/2003/WD-xinclude-20031110
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XINCLUDE_H__
diff --git a/include/libxml/xlink.h b/include/libxml/xlink.h
index 454d0884..11c4fc29 100644
--- a/include/libxml/xlink.h
+++ b/include/libxml/xlink.h
@@ -1,10 +1,13 @@
-/*
- * Summary: unfinished XLink detection module
- * Description: unfinished XLink detection module
+/**
+ * @file
+ *
+ * @brief unfinished XLink detection module
+ *
+ * unfinished XLink detection module
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XLINK_H__
@@ -54,9 +57,8 @@ typedef enum {
} xlinkActuate;
/**
- * xlinkNodeDetectFunc:
- * @ctx: user data pointer
- * @node: the node to check
+ * @param ctx user data pointer
+ * @param node the node to check
*
* This is the prototype for the link detection routine.
* It calls the default link detection callbacks upon link detection.
@@ -69,12 +71,11 @@ typedef void (*xlinkNodeDetectFunc) (void *ctx, xmlNodePtr node);
*/
/**
- * xlinkSimpleLinkFunk:
- * @ctx: user data pointer
- * @node: the node carrying the link
- * @href: the target of the link
- * @role: the role string
- * @title: the link title
+ * @param ctx user data pointer
+ * @param node the node carrying the link
+ * @param href the target of the link
+ * @param role the role string
+ * @param title the link title
*
* This is the prototype for a simple link detection callback.
*/
@@ -86,20 +87,19 @@ typedef void
const xlinkTitle title);
/**
- * xlinkExtendedLinkFunk:
- * @ctx: user data pointer
- * @node: the node carrying the link
- * @nbLocators: the number of locators detected on the link
- * @hrefs: pointer to the array of locator hrefs
- * @roles: pointer to the array of locator roles
- * @nbArcs: the number of arcs detected on the link
- * @from: pointer to the array of source roles found on the arcs
- * @to: pointer to the array of target roles found on the arcs
- * @show: array of values for the show attributes found on the arcs
- * @actuate: array of values for the actuate attributes found on the arcs
- * @nbTitles: the number of titles detected on the link
- * @titles: array of titles detected on the link
- * @langs: array of xml:lang values for the titles
+ * @param ctx user data pointer
+ * @param node the node carrying the link
+ * @param nbLocators the number of locators detected on the link
+ * @param hrefs pointer to the array of locator hrefs
+ * @param roles pointer to the array of locator roles
+ * @param nbArcs the number of arcs detected on the link
+ * @param from pointer to the array of source roles found on the arcs
+ * @param to pointer to the array of target roles found on the arcs
+ * @param show array of values for the show attributes found on the arcs
+ * @param actuate array of values for the actuate attributes found on the arcs
+ * @param nbTitles the number of titles detected on the link
+ * @param titles array of titles detected on the link
+ * @param langs array of xml:lang values for the titles
*
* This is the prototype for a extended link detection callback.
*/
@@ -119,15 +119,14 @@ typedef void
const xmlChar **langs);
/**
- * xlinkExtendedLinkSetFunk:
- * @ctx: user data pointer
- * @node: the node carrying the link
- * @nbLocators: the number of locators detected on the link
- * @hrefs: pointer to the array of locator hrefs
- * @roles: pointer to the array of locator roles
- * @nbTitles: the number of titles detected on the link
- * @titles: array of titles detected on the link
- * @langs: array of xml:lang values for the titles
+ * @param ctx user data pointer
+ * @param node the node carrying the link
+ * @param nbLocators the number of locators detected on the link
+ * @param hrefs pointer to the array of locator hrefs
+ * @param roles pointer to the array of locator roles
+ * @param nbTitles the number of titles detected on the link
+ * @param titles array of titles detected on the link
+ * @param langs array of xml:lang values for the titles
*
* This is the prototype for a extended link set detection callback.
*/
diff --git a/include/libxml/xmlIO.h b/include/libxml/xmlIO.h
index fe13190c..68f52fb1 100644
--- a/include/libxml/xmlIO.h
+++ b/include/libxml/xmlIO.h
@@ -1,10 +1,13 @@
-/*
- * Summary: interface for the I/O interfaces used by the parser
- * Description: interface for the I/O interfaces used by the parser
+/**
+ * @file
+ *
+ * @brief interface for the I/O interfaces used by the parser
+ *
+ * interface for the I/O interfaces used by the parser
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_IO_H__
@@ -27,42 +30,38 @@ extern "C" {
*/
/**
- * xmlInputMatchCallback:
- * @filename: the filename or URI
+ * @param filename the filename or URI
*
* Callback used in the I/O Input API to detect if the current handler
* can provide input functionality for this resource.
*
- * Returns 1 if yes and 0 if another Input module should be used
+ * @returns 1 if yes and 0 if another Input module should be used
*/
typedef int (*xmlInputMatchCallback) (char const *filename);
/**
- * xmlInputOpenCallback:
- * @filename: the filename or URI
+ * @param filename the filename or URI
*
* Callback used in the I/O Input API to open the resource
*
- * Returns an Input context or NULL in case or error
+ * @returns an Input context or NULL in case or error
*/
typedef void * (*xmlInputOpenCallback) (char const *filename);
/**
- * xmlInputReadCallback:
- * @context: an Input context
- * @buffer: the buffer to store data read
- * @len: the length of the buffer in bytes
+ * @param context an Input context
+ * @param buffer the buffer to store data read
+ * @param len the length of the buffer in bytes
*
* Callback used in the I/O Input API to read the resource
*
- * Returns the number of bytes read or -1 in case of error
+ * @returns the number of bytes read or -1 in case of error
*/
typedef int (*xmlInputReadCallback) (void * context, char * buffer, int len);
/**
- * xmlInputCloseCallback:
- * @context: an Input context
+ * @param context an Input context
*
* Callback used in the I/O Input API to close the resource
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
typedef int (*xmlInputCloseCallback) (void * context);
@@ -73,71 +72,65 @@ typedef int (*xmlInputCloseCallback) (void * context);
*/
/**
- * xmlOutputMatchCallback:
- * @filename: the filename or URI
+ * @param filename the filename or URI
*
* Callback used in the I/O Output API to detect if the current handler
* can provide output functionality for this resource.
*
- * Returns 1 if yes and 0 if another Output module should be used
+ * @returns 1 if yes and 0 if another Output module should be used
*/
typedef int (*xmlOutputMatchCallback) (char const *filename);
/**
- * xmlOutputOpenCallback:
- * @filename: the filename or URI
+ * @param filename the filename or URI
*
* Callback used in the I/O Output API to open the resource
*
- * Returns an Output context or NULL in case or error
+ * @returns an Output context or NULL in case or error
*/
typedef void * (*xmlOutputOpenCallback) (char const *filename);
/**
- * xmlOutputWriteCallback:
- * @context: an Output context
- * @buffer: the buffer of data to write
- * @len: the length of the buffer in bytes
+ * @param context an Output context
+ * @param buffer the buffer of data to write
+ * @param len the length of the buffer in bytes
*
* Callback used in the I/O Output API to write to the resource
*
- * Returns the number of bytes written or -1 in case of error
+ * @returns the number of bytes written or -1 in case of error
*/
typedef int (*xmlOutputWriteCallback) (void * context, const char * buffer,
int len);
/**
- * xmlOutputCloseCallback:
- * @context: an Output context
+ * @param context an Output context
*
* Callback used in the I/O Output API to close the resource
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
typedef int (*xmlOutputCloseCallback) (void * context);
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserInputBufferCreateFilenameFunc:
- * @URI: the URI to read from
- * @enc: the requested source encoding
+ * @param URI the URI to read from
+ * @param enc the requested source encoding
*
* Signature for the function doing the lookup for a suitable input method
* corresponding to an URI.
*
- * Returns the new xmlParserInputBufferPtr in case of success or NULL if no
+ * @returns the new xmlParserInputBufferPtr in case of success or NULL if no
* method was found.
*/
typedef xmlParserInputBufferPtr
(*xmlParserInputBufferCreateFilenameFunc)(const char *URI, xmlCharEncoding enc);
/**
- * xmlOutputBufferCreateFilenameFunc:
- * @URI: the URI to write to
- * @encoder: the requested target encoding
- * @compression: compression level
+ * @param URI the URI to write to
+ * @param encoder the requested target encoding
+ * @param compression compression level
*
* Signature for the function doing the lookup for a suitable output method
* corresponding to an URI.
*
- * Returns the new xmlOutputBufferPtr in case of success or NULL if no
+ * @returns the new xmlOutputBufferPtr in case of success or NULL if no
* method was found.
*/
typedef xmlOutputBufferPtr
@@ -174,7 +167,7 @@ struct _xmlOutputBuffer {
};
#endif /* LIBXML_OUTPUT_ENABLED */
-/** DOC_DISABLE */
+/** @cond IGNORE */
XML_DEPRECATED
XMLPUBFUN xmlParserInputBufferCreateFilenameFunc *
__xmlParserInputBufferCreateFilenameValue(void);
@@ -188,7 +181,7 @@ __xmlOutputBufferCreateFilenameValue(void);
#define xmlOutputBufferCreateFilenameValue \
(*__xmlOutputBufferCreateFilenameValue())
#endif
-/** DOC_ENABLE */
+/** @endcond */
/*
* Interfaces for input
@@ -364,7 +357,7 @@ XMLPUBFUN int
* Default 'http://' protocol callbacks
*/
#ifdef LIBXML_HTTP_STUBS_ENABLED
-/** DOC_DISABLE */
+/** @cond IGNORE */
XML_DEPRECATED
XMLPUBFUN int
xmlIOHTTPMatch (const char *filename);
@@ -388,7 +381,7 @@ XMLPUBFUN int
XML_DEPRECATED
XMLPUBFUN int
xmlIOHTTPClose (void * context);
-/** DOC_ENABLE */
+/** @endcond */
#endif /* LIBXML_HTTP_STUBS_ENABLED */
XMLPUBFUN xmlParserInputBufferCreateFilenameFunc
diff --git a/include/libxml/xmlautomata.h b/include/libxml/xmlautomata.h
index 97d0abf9..b352d35f 100644
--- a/include/libxml/xmlautomata.h
+++ b/include/libxml/xmlautomata.h
@@ -1,10 +1,13 @@
-/*
- * Summary: API to build regexp automata
- * Description: the API to build regexp automata
+/**
+ * @file
+ *
+ * @brief API to build regexp automata
+ *
+ * the API to build regexp automata
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_AUTOMATA_H__
@@ -21,7 +24,6 @@ extern "C" {
#endif
/**
- * xmlAutomataPtr:
*
* A libxml automata description, It can be compiled into a regexp
*/
@@ -29,7 +31,6 @@ typedef struct _xmlAutomata xmlAutomata;
typedef xmlAutomata *xmlAutomataPtr;
/**
- * xmlAutomataStatePtr:
*
* A state int the automata description,
*/
diff --git a/include/libxml/xmlerror.h b/include/libxml/xmlerror.h
index f59ce632..433d48ab 100644
--- a/include/libxml/xmlerror.h
+++ b/include/libxml/xmlerror.h
@@ -1,10 +1,13 @@
-/*
- * Summary: error handling
- * Description: the API used to report errors
+/**
+ * @file
+ *
+ * @brief error handling
+ *
+ * the API used to report errors
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_ERROR_H__
@@ -22,7 +25,6 @@ extern "C" {
#define initGenericErrorDefaultFunc(h) xmlSetGenericErrorFunc(NULL, *(h))
/**
- * xmlErrorLevel:
*
* Indicates the level of an error
*/
@@ -34,7 +36,6 @@ typedef enum {
} xmlErrorLevel;
/**
- * xmlErrorDomain:
*
* Indicates where an error may have come from
*/
@@ -73,7 +74,6 @@ typedef enum {
} xmlErrorDomain;
/**
- * xmlError:
*
* An XML Error instance.
*/
@@ -97,7 +97,6 @@ struct _xmlError {
};
/**
- * xmlParserError:
*
* This is an error that the XML (or HTML) parser can generate
*/
@@ -848,9 +847,8 @@ typedef enum {
} xmlParserErrors;
/**
- * xmlGenericErrorFunc:
- * @ctx: a parsing context
- * @msg: the message
+ * @param ctx a parsing context
+ * @param msg the message
* @...: the extra arguments of the varargs to format the message
*
* Signature of the function to use when there is an error and
@@ -860,16 +858,15 @@ typedef void (*xmlGenericErrorFunc) (void *ctx,
const char *msg,
...) LIBXML_ATTR_FORMAT(2,3);
/**
- * xmlStructuredErrorFunc:
- * @userData: user provided data for the error callback
- * @error: the error being raised.
+ * @param userData user provided data for the error callback
+ * @param error the error being raised.
*
* Signature of the function to use when there is an error and
* the module handles the new error reporting mechanism.
*/
typedef void (*xmlStructuredErrorFunc) (void *userData, const xmlError *error);
-/** DOC_DISABLE */
+/** @cond IGNORE */
XML_DEPRECATED
XMLPUBFUN const xmlError *__xmlLastError(void);
@@ -885,7 +882,7 @@ XMLPUBFUN void **__xmlStructuredErrorContext(void);
#define xmlStructuredError (*__xmlStructuredError())
#define xmlStructuredErrorContext (*__xmlStructuredErrorContext())
#endif
-/** DOC_ENABLE */
+/** @endcond */
/*
* Use the following function to reset the two global variables
@@ -926,9 +923,9 @@ XMLPUBFUN void
xmlParserValidityWarning (void *ctx,
const char *msg,
...) LIBXML_ATTR_FORMAT(2,3);
-/** DOC_DISABLE */
+/** @cond IGNORE */
struct _xmlParserInput;
-/** DOC_ENABLE */
+/** @endcond */
XMLPUBFUN void
xmlParserPrintFileInfo (struct _xmlParserInput *input);
XMLPUBFUN void
diff --git a/include/libxml/xmlexports.h b/include/libxml/xmlexports.h
index 036671b8..5e233965 100644
--- a/include/libxml/xmlexports.h
+++ b/include/libxml/xmlexports.h
@@ -1,8 +1,11 @@
-/*
- * Summary: macros for marking symbols as exportable/importable.
- * Description: macros for marking symbols as exportable/importable.
+/**
+ * @file
+ *
+ * @brief macros for marking symbols as exportable/importable.
+ *
+ * macros for marking symbols as exportable/importable.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*/
#ifndef __XML_EXPORTS_H__
diff --git a/include/libxml/xmlmemory.h b/include/libxml/xmlmemory.h
index 9292a4c5..d9607ec1 100644
--- a/include/libxml/xmlmemory.h
+++ b/include/libxml/xmlmemory.h
@@ -1,11 +1,14 @@
-/*
- * Summary: interface for the memory allocator
- * Description: provides interfaces for the memory allocator,
+/**
+ * @file
+ *
+ * @brief interface for the memory allocator
+ *
+ * provides interfaces for the memory allocator,
* including debugging capabilities.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
@@ -23,40 +26,36 @@ extern "C" {
* The XML memory wrapper support 4 basic overloadable functions.
*/
/**
- * xmlFreeFunc:
- * @mem: an already allocated block of memory
+ * @param mem an already allocated block of memory
*
* Signature for a free() implementation.
*/
typedef void (*xmlFreeFunc)(void *mem);
/**
- * xmlMallocFunc:
- * @size: the size requested in bytes
+ * @param size the size requested in bytes
*
* Signature for a malloc() implementation.
*
- * Returns a pointer to the newly allocated block or NULL in case of error.
+ * @returns a pointer to the newly allocated block or NULL in case of error.
*/
typedef void *(*xmlMallocFunc)(size_t size) LIBXML_ATTR_ALLOC_SIZE(1);
/**
- * xmlReallocFunc:
- * @mem: an already allocated block of memory
- * @size: the new size requested in bytes
+ * @param mem an already allocated block of memory
+ * @param size the new size requested in bytes
*
* Signature for a realloc() implementation.
*
- * Returns a pointer to the newly reallocated block or NULL in case of error.
+ * @returns a pointer to the newly reallocated block or NULL in case of error.
*/
typedef void *(*xmlReallocFunc)(void *mem, size_t size);
/**
- * xmlStrdupFunc:
- * @str: a zero terminated string
+ * @param str a zero terminated string
*
* Signature for an strdup() implementation.
*
- * Returns the copy of the string or NULL in case of error.
+ * @returns the copy of the string or NULL in case of error.
*/
typedef char *(*xmlStrdupFunc)(const char *str);
@@ -71,7 +70,7 @@ typedef char *(*xmlStrdupFunc)(const char *str);
*/
#ifdef LIBXML_THREAD_ALLOC_ENABLED
-/** DOC_DISABLE */
+/** @cond IGNORE */
XMLPUBFUN xmlMallocFunc *__xmlMalloc(void);
XMLPUBFUN xmlMallocFunc *__xmlMallocAtomic(void);
XMLPUBFUN xmlReallocFunc *__xmlRealloc(void);
@@ -85,7 +84,7 @@ XMLPUBFUN xmlStrdupFunc *__xmlMemStrdup(void);
#define xmlFree (*__xmlFree())
#define xmlMemStrdup (*__xmlMemStrdup())
#endif
-/** DOC_ENABLE */
+/** @endcond */
#else
XMLPUBVAR xmlMallocFunc xmlMalloc;
diff --git a/include/libxml/xmlmodule.h b/include/libxml/xmlmodule.h
index 5db55856..458fc33c 100644
--- a/include/libxml/xmlmodule.h
+++ b/include/libxml/xmlmodule.h
@@ -1,11 +1,14 @@
-/*
- * Summary: dynamic module loading
- * Description: basic API for dynamic module loading, used by
+/**
+ * @file
+ *
+ * @brief dynamic module loading
+ *
+ * basic API for dynamic module loading, used by
* libexslt added in 2.6.17
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Joel W. Reed
+ * @author Joel W. Reed
*/
#ifndef __XML_MODULE_H__
@@ -20,7 +23,6 @@ extern "C" {
#endif
/**
- * xmlModulePtr:
*
* A handle to a dynamically loaded module
*/
@@ -28,7 +30,6 @@ typedef struct _xmlModule xmlModule;
typedef xmlModule *xmlModulePtr;
/**
- * xmlModuleOption:
*
* enumeration of options that can be passed down to xmlModuleOpen()
*/
diff --git a/include/libxml/xmlreader.h b/include/libxml/xmlreader.h
index 2344901d..317e648b 100644
--- a/include/libxml/xmlreader.h
+++ b/include/libxml/xmlreader.h
@@ -1,10 +1,13 @@
-/*
- * Summary: the XMLReader implementation
- * Description: API of the XML streaming API based on C# interfaces.
+/**
+ * @file
+ *
+ * @brief the XMLReader implementation
+ *
+ * API of the XML streaming API based on C\# interfaces.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XMLREADER_H__
@@ -27,7 +30,6 @@ extern "C" {
#endif
/**
- * xmlParserSeverities:
*
* How severe an error callback is when the per-reader error callback API
* is used.
@@ -42,7 +44,6 @@ typedef enum {
#ifdef LIBXML_READER_ENABLED
/**
- * xmlTextReaderMode:
*
* Internal state values for the reader.
*/
@@ -56,7 +57,6 @@ typedef enum {
} xmlTextReaderMode;
/**
- * xmlParserProperties:
*
* Some common options to use with xmlTextReaderSetParserProp, but it
* is better to use xmlParserOption and the xmlReaderNewxxx and
@@ -70,7 +70,6 @@ typedef enum {
} xmlParserProperties;
/**
- * xmlReaderTypes:
*
* Predefined constants for the different types of nodes.
*/
@@ -96,14 +95,12 @@ typedef enum {
} xmlReaderTypes;
/**
- * xmlTextReader:
*
* Structure for an xmlReader context.
*/
typedef struct _xmlTextReader xmlTextReader;
/**
- * xmlTextReaderPtr:
*
* Pointer to an xmlReader context.
*/
@@ -400,11 +397,10 @@ XMLPUBFUN int
typedef void * xmlTextReaderLocatorPtr;
/**
- * xmlTextReaderErrorFunc:
- * @arg: the user argument
- * @msg: the message
- * @severity: the severity of the error
- * @locator: a locator indicating where the error occurred
+ * @param arg the user argument
+ * @param msg the message
+ * @param severity the severity of the error
+ * @param locator a locator indicating where the error occurred
*
* Signature of an error callback from a reader parser
*/
diff --git a/include/libxml/xmlregexp.h b/include/libxml/xmlregexp.h
index f7e10c32..18311944 100644
--- a/include/libxml/xmlregexp.h
+++ b/include/libxml/xmlregexp.h
@@ -1,11 +1,14 @@
-/*
- * Summary: regular expressions handling
- * Description: basic API for libxml regular expressions handling used
+/**
+ * @file
+ *
+ * @brief regular expressions handling
+ *
+ * basic API for libxml regular expressions handling used
* for XML Schemas and validation.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_REGEXP_H__
@@ -22,7 +25,6 @@ extern "C" {
#endif
/**
- * xmlRegexpPtr:
*
* A libxml regular expression, they can actually be far more complex
* thank the POSIX regex expressions.
@@ -31,7 +33,6 @@ typedef struct _xmlRegexp xmlRegexp;
typedef xmlRegexp *xmlRegexpPtr;
/**
- * xmlRegExecCtxtPtr:
*
* A libxml progressive regular expression evaluation context
*/
@@ -55,11 +56,10 @@ XMLPUBFUN int
xmlRegexpIsDeterminist(xmlRegexpPtr comp);
/**
- * xmlRegExecCallbacks:
- * @exec: the regular expression context
- * @token: the current token string
- * @transdata: transition data
- * @inputdata: input data
+ * @param exec the regular expression context
+ * @param token the current token string
+ * @param transdata transition data
+ * @param inputdata input data
*
* Callback function when doing a transition in the automata
*/
diff --git a/include/libxml/xmlsave.h b/include/libxml/xmlsave.h
index 91d6ef9f..381a2dde 100644
--- a/include/libxml/xmlsave.h
+++ b/include/libxml/xmlsave.h
@@ -1,10 +1,13 @@
-/*
- * Summary: the XML document serializer
- * Description: API to save document or subtree of document
+/**
+ * @file
+ *
+ * @brief the XML document serializer
+ *
+ * API to save document or subtree of document
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XMLSAVE_H__
@@ -21,7 +24,6 @@ extern "C" {
#endif
/**
- * xmlSaveOption:
*
* This is the set of XML save options that can be passed down
* to the xmlSaveToFd() and similar calls.
diff --git a/include/libxml/xmlschemas.h b/include/libxml/xmlschemas.h
index 78073cd2..59c7a951 100644
--- a/include/libxml/xmlschemas.h
+++ b/include/libxml/xmlschemas.h
@@ -1,11 +1,14 @@
-/*
- * Summary: incomplete XML Schemas structure implementation
- * Description: interface to the XML Schemas handling and schema validity
+/**
+ * @file
+ *
+ * @brief incomplete XML Schemas structure implementation
+ *
+ * interface to the XML Schemas handling and schema validity
* checking, it is incomplete right now.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
@@ -64,7 +67,6 @@ typedef enum {
* options below.
*/
/**
- * xmlSchemaValidOption:
*
* This is the set of XML Schema validation options.
*/
@@ -89,9 +91,8 @@ typedef struct _xmlSchema xmlSchema;
typedef xmlSchema *xmlSchemaPtr;
/**
- * xmlSchemaValidityErrorFunc:
- * @ctx: the validation context
- * @msg: the message
+ * @param ctx the validation context
+ * @param msg the message
* @...: extra arguments
*
* Signature of an error callback from an XSD validation
@@ -100,9 +101,8 @@ typedef void (*xmlSchemaValidityErrorFunc)
(void *ctx, const char *msg, ...) LIBXML_ATTR_FORMAT(2,3);
/**
- * xmlSchemaValidityWarningFunc:
- * @ctx: the validation context
- * @msg: the message
+ * @param ctx the validation context
+ * @param msg the message
* @...: extra arguments
*
* Signature of a warning callback from an XSD validation
@@ -120,16 +120,15 @@ typedef struct _xmlSchemaValidCtxt xmlSchemaValidCtxt;
typedef xmlSchemaValidCtxt *xmlSchemaValidCtxtPtr;
/**
- * xmlSchemaValidityLocatorFunc:
- * @ctx: user provided context
- * @file: returned file information
- * @line: returned line information
+ * @param ctx user provided context
+ * @param file returned file information
+ * @param line returned line information
*
* A schemas validation locator, a callback called by the validator.
* This is used when file or node information are not available
* to find out what file and line number are affected
*
- * Returns: 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
typedef int (*xmlSchemaValidityLocatorFunc) (void *ctx,
diff --git a/include/libxml/xmlschemastypes.h b/include/libxml/xmlschemastypes.h
index e2cde357..dfafe1ed 100644
--- a/include/libxml/xmlschemastypes.h
+++ b/include/libxml/xmlschemastypes.h
@@ -1,11 +1,14 @@
-/*
- * Summary: implementation of XML Schema Datatypes
- * Description: module providing the XML Schema Datatypes implementation
+/**
+ * @file
+ *
+ * @brief implementation of XML Schema Datatypes
+ *
+ * module providing the XML Schema Datatypes implementation
* both definition and validity checking
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
diff --git a/include/libxml/xmlstring.h b/include/libxml/xmlstring.h
index db11a0b0..c465b64e 100644
--- a/include/libxml/xmlstring.h
+++ b/include/libxml/xmlstring.h
@@ -1,11 +1,14 @@
-/*
- * Summary: set of routines to process strings
- * Description: type and interfaces needed for the internal string handling
+/**
+ * @file
+ *
+ * @brief set of routines to process strings
+ *
+ * type and interfaces needed for the internal string handling
* of the library, especially UTF8 processing.
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_STRING_H__
@@ -19,7 +22,6 @@ extern "C" {
#endif
/**
- * xmlChar:
*
* This is a basic byte in an UTF-8 encoded string.
* It's unsigned allowing to pinpoint case where char * are assigned
diff --git a/include/libxml/xmlunicode.h b/include/libxml/xmlunicode.h
index efda81b2..db2911b6 100644
--- a/include/libxml/xmlunicode.h
+++ b/include/libxml/xmlunicode.h
@@ -1,6 +1,9 @@
-/*
- * Summary: Unicode character APIs
- * Description: API for the Unicode character APIs
+/**
+ * @file
+ *
+ * @brief Unicode character APIs
+ *
+ * API for the Unicode character APIs
*
* Deprecated, don't use.
*/
diff --git a/include/libxml/xmlwriter.h b/include/libxml/xmlwriter.h
index 69e25563..304572e1 100644
--- a/include/libxml/xmlwriter.h
+++ b/include/libxml/xmlwriter.h
@@ -1,10 +1,13 @@
-/*
- * Summary: text writing API for XML
- * Description: text writing API for XML
+/**
+ * @file
+ *
+ * @brief text writing API for XML
+ *
+ * text writing API for XML
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Alfred Mickautsch
+ * @author Alfred Mickautsch
*/
#ifndef __XML_XMLWRITER_H__
@@ -268,7 +271,6 @@ extern "C" {
const xmlChar * content);
/**
- * xmlTextWriterWriteProcessingInstruction:
*
* This macro maps to xmlTextWriterWritePI
*/
@@ -330,7 +332,6 @@ extern "C" {
const xmlChar * subset);
/**
- * xmlTextWriterWriteDocType:
*
* this macro maps to xmlTextWriterWriteDTD
*/
diff --git a/include/libxml/xpath.h b/include/libxml/xpath.h
index e03e97df..ea4effc4 100644
--- a/include/libxml/xpath.h
+++ b/include/libxml/xpath.h
@@ -1,6 +1,9 @@
-/*
- * Summary: XML Path Language implementation
- * Description: API for the XML Path Language implementation
+/**
+ * @file
+ *
+ * @brief XML Path Language implementation
+ *
+ * API for the XML Path Language implementation
*
* XML Path Language implementation
* XPath is a language for addressing parts of an XML document,
@@ -11,9 +14,9 @@
* W3C Recommendation 16 November 1999
* http://www.w3.org/TR/1999/REC-xpath-19991116
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XPATH_H__
@@ -103,11 +106,11 @@ typedef enum {
XPATH_XSLT_TREE = 9 /* An XSLT value tree, non modifiable */
} xmlXPathObjectType;
-/** DOC_DISABLE */
+/** @cond IGNORE */
#define XPATH_POINT 5
#define XPATH_RANGE 6
#define XPATH_LOCATIONSET 7
-/** DOC_ENABLE */
+/** @endcond */
typedef struct _xmlXPathObject xmlXPathObject;
typedef xmlXPathObject *xmlXPathObjectPtr;
@@ -124,14 +127,13 @@ struct _xmlXPathObject {
};
/**
- * xmlXPathConvertFunc:
- * @obj: an XPath object
- * @type: the number of the target type
+ * @param obj an XPath object
+ * @param type the number of the target type
*
* A conversion function is associated to a type and used to cast
* the new type to primitive values.
*
- * Returns -1 in case of error, 0 otherwise
+ * @returns -1 in case of error, 0 otherwise
*/
typedef int (*xmlXPathConvertFunc) (xmlXPathObjectPtr obj, int type);
@@ -158,9 +160,8 @@ struct _xmlXPathVariable {
};
/**
- * xmlXPathEvalFunc:
- * @ctxt: an XPath parser context
- * @nargs: the number of arguments passed to the function
+ * @param ctxt an XPath parser context
+ * @param nargs the number of arguments passed to the function
*
* An XPath evaluation function, the parameters are on the XPath context stack.
*/
@@ -180,15 +181,14 @@ struct _xmlXPathFunct {
};
/**
- * xmlXPathAxisFunc:
- * @ctxt: the XPath interpreter context
- * @cur: the previous node being explored on that axis
+ * @param ctxt the XPath interpreter context
+ * @param cur the previous node being explored on that axis
*
* An axis traversal function. To traverse an axis, the engine calls
* 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,
@@ -206,9 +206,8 @@ struct _xmlXPathAxis {
};
/**
- * xmlXPathFunction:
- * @ctxt: the XPath interprestation context
- * @nargs: the number of arguments
+ * @param ctxt the XPath interprestation context
+ * @param nargs the number of arguments
*
* An XPath function.
* The arguments (if any) are popped out from the context stack
@@ -222,37 +221,34 @@ typedef void (*xmlXPathFunction) (xmlXPathParserContextPtr ctxt, int nargs);
*/
/**
- * xmlXPathVariableLookupFunc:
- * @ctxt: an XPath context
- * @name: name of the variable
- * @ns_uri: the namespace name hosting this variable
+ * @param ctxt an XPath context
+ * @param name name of the variable
+ * @param ns_uri the namespace name hosting this variable
*
* Prototype for callbacks used to plug variable lookup in the XPath
* engine.
*
- * Returns the XPath object value or NULL if not found.
+ * @returns the XPath object value or NULL if not found.
*/
typedef xmlXPathObjectPtr (*xmlXPathVariableLookupFunc) (void *ctxt,
const xmlChar *name,
const xmlChar *ns_uri);
/**
- * xmlXPathFuncLookupFunc:
- * @ctxt: an XPath context
- * @name: name of the function
- * @ns_uri: the namespace name hosting this function
+ * @param ctxt an XPath context
+ * @param name name of the function
+ * @param ns_uri the namespace name hosting this function
*
* Prototype for callbacks used to plug function lookup in the XPath
* engine.
*
- * Returns the XPath function or NULL if not found.
+ * @returns the XPath function or NULL if not found.
*/
typedef xmlXPathFunction (*xmlXPathFuncLookupFunc) (void *ctxt,
const xmlChar *name,
const xmlChar *ns_uri);
/**
- * xmlXPathFlags:
* Flags for XPath engine compilation and runtime
*/
/**
@@ -269,7 +265,6 @@ typedef xmlXPathFunction (*xmlXPathFuncLookupFunc) (void *ctxt,
#define XML_XPATH_NOVAR (1<<1)
/**
- * xmlXPathContext:
*
* Expression evaluation occurs with respect to a context.
* he context consists of:
@@ -367,7 +362,6 @@ typedef struct _xmlXPathCompExpr xmlXPathCompExpr;
typedef xmlXPathCompExpr *xmlXPathCompExprPtr;
/**
- * xmlXPathParserContext:
*
* An XPath parser context. It contains pure parsing information,
* an xmlXPathContext, and the stack of objects.
@@ -410,23 +404,21 @@ XMLPUBVAR double xmlXPathNINF;
/* These macros may later turn into functions */
/**
- * xmlXPathNodeSetGetLength:
- * @ns: a node-set
+ * @param ns a node-set
*
* Implement a functionality similar to the DOM NodeList.length.
*
- * Returns the number of nodes in the node-set.
+ * @returns the number of nodes in the node-set.
*/
#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)
/**
- * xmlXPathNodeSetItem:
- * @ns: a node-set
- * @index: index of a node in the set
+ * @param ns a node-set
+ * @param index index of a node in the set
*
* 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)
+ * @returns the xmlNodePtr at the given `index` in `ns` or NULL if
+ * `index` is out of range (0 to length-1)
*/
#define xmlXPathNodeSetItem(ns, index) \
((((ns) != NULL) && \
@@ -434,12 +426,11 @@ XMLPUBVAR double xmlXPathNINF;
(ns)->nodeTab[(index)] \
: NULL)
/**
- * xmlXPathNodeSetIsEmpty:
- * @ns: a node-set
+ * @param 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))
diff --git a/include/libxml/xpathInternals.h b/include/libxml/xpathInternals.h
index 88b487af..04b562bb 100644
--- a/include/libxml/xpathInternals.h
+++ b/include/libxml/xpathInternals.h
@@ -1,12 +1,15 @@
-/*
- * Summary: internal interfaces for XML Path Language implementation
- * Description: internal interfaces for XML Path Language implementation
+/**
+ * @file
+ *
+ * @brief internal interfaces for XML Path Language implementation
+ *
+ * internal interfaces for XML Path Language implementation
* used to build new modules on top of XPath like XPointer and
* XSLT
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XPATH_INTERNALS_H__
@@ -36,12 +39,11 @@ extern "C" {
/*
* Many of these macros may later turn into functions. They
- * shouldn't be used in #ifdef's preprocessor instructions.
+ * shouldn't be used in \#ifdef's preprocessor instructions.
*/
/**
- * xmlXPathSetError:
- * @ctxt: an XPath parser context
- * @err: an xmlXPathError code
+ * @param ctxt an XPath parser context
+ * @param err an xmlXPathError code
*
* Raises an error.
*/
@@ -50,8 +52,7 @@ extern "C" {
if ((ctxt) != NULL) (ctxt)->error = (err); }
/**
- * xmlXPathSetArityError:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Raises an XPATH_INVALID_ARITY error.
*/
@@ -59,8 +60,7 @@ extern "C" {
xmlXPathSetError((ctxt), XPATH_INVALID_ARITY)
/**
- * xmlXPathSetTypeError:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Raises an XPATH_INVALID_TYPE error.
*/
@@ -68,42 +68,38 @@ extern "C" {
xmlXPathSetError((ctxt), XPATH_INVALID_TYPE)
/**
- * xmlXPathGetError:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Get the error code of an XPath context.
*
- * Returns the context error.
+ * @returns the context error.
*/
#define xmlXPathGetError(ctxt) ((ctxt)->error)
/**
- * xmlXPathCheckError:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Check if an XPath error was raised.
*
- * Returns true if an error has been raised, false otherwise.
+ * @returns true if an error has been raised, false otherwise.
*/
#define xmlXPathCheckError(ctxt) ((ctxt)->error != XPATH_EXPRESSION_OK)
/**
- * xmlXPathGetDocument:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Get the document of an XPath context.
*
- * Returns the context document.
+ * @returns the context document.
*/
#define xmlXPathGetDocument(ctxt) ((ctxt)->context->doc)
/**
- * xmlXPathGetContextNode:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Get the context node of an XPath context.
*
- * Returns the context node.
+ * @returns the context node.
*/
#define xmlXPathGetContextNode(ctxt) ((ctxt)->context->node)
@@ -119,54 +115,48 @@ XMLPUBFUN void *
xmlXPathPopExternal (xmlXPathParserContextPtr ctxt);
/**
- * xmlXPathReturnBoolean:
- * @ctxt: an XPath parser context
- * @val: a boolean
+ * @param ctxt an XPath parser context
+ * @param val a boolean
*
- * Pushes the boolean @val on the context stack.
+ * Pushes the boolean `val` on the context stack.
*/
#define xmlXPathReturnBoolean(ctxt, val) \
valuePush((ctxt), xmlXPathNewBoolean(val))
/**
- * xmlXPathReturnTrue:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pushes true on the context stack.
*/
#define xmlXPathReturnTrue(ctxt) xmlXPathReturnBoolean((ctxt), 1)
/**
- * xmlXPathReturnFalse:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pushes false on the context stack.
*/
#define xmlXPathReturnFalse(ctxt) xmlXPathReturnBoolean((ctxt), 0)
/**
- * xmlXPathReturnNumber:
- * @ctxt: an XPath parser context
- * @val: a double
+ * @param ctxt an XPath parser context
+ * @param val a double
*
- * Pushes the double @val on the context stack.
+ * Pushes the double `val` on the context stack.
*/
#define xmlXPathReturnNumber(ctxt, val) \
valuePush((ctxt), xmlXPathNewFloat(val))
/**
- * xmlXPathReturnString:
- * @ctxt: an XPath parser context
- * @str: a string
+ * @param ctxt an XPath parser context
+ * @param str a string
*
- * Pushes the string @str on the context stack.
+ * Pushes the string `str` on the context stack.
*/
#define xmlXPathReturnString(ctxt, str) \
valuePush((ctxt), xmlXPathWrapString(str))
/**
- * xmlXPathReturnEmptyString:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pushes an empty string on the stack.
*/
@@ -174,18 +164,16 @@ XMLPUBFUN void *
valuePush((ctxt), xmlXPathNewCString(""))
/**
- * xmlXPathReturnNodeSet:
- * @ctxt: an XPath parser context
- * @ns: a node-set
+ * @param ctxt an XPath parser context
+ * @param ns a node-set
*
- * Pushes the node-set @ns on the context stack.
+ * Pushes the node-set `ns` on the context stack.
*/
#define xmlXPathReturnNodeSet(ctxt, ns) \
valuePush((ctxt), xmlXPathWrapNodeSet(ns))
/**
- * xmlXPathReturnEmptyNodeSet:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pushes an empty node-set on the context stack.
*/
@@ -193,9 +181,8 @@ XMLPUBFUN void *
valuePush((ctxt), xmlXPathNewNodeSet(NULL))
/**
- * xmlXPathReturnExternal:
- * @ctxt: an XPath parser context
- * @val: user data
+ * @param ctxt an XPath parser context
+ * @param val user data
*
* Pushes user data on the context stack.
*/
@@ -203,13 +190,12 @@ XMLPUBFUN void *
valuePush((ctxt), xmlXPathWrapExternal(val))
/**
- * xmlXPathStackIsNodeSet:
- * @ctxt: an XPath parser context
+ * @param 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.
+ * @returns true if the current object on the stack is a node-set.
*/
#define xmlXPathStackIsNodeSet(ctxt) \
(((ctxt)->value != NULL) \
@@ -217,21 +203,19 @@ XMLPUBFUN void *
|| ((ctxt)->value->type == XPATH_XSLT_TREE)))
/**
- * xmlXPathStackIsExternal:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Checks if the current value on the XPath stack is an external
* object.
*
- * Returns true if the current object on the stack is an external
+ * @returns true if the current object on the stack is an external
* object.
*/
#define xmlXPathStackIsExternal(ctxt) \
((ctxt->value != NULL) && (ctxt->value->type == XPATH_USERS))
/**
- * xmlXPathEmptyNodeSet:
- * @ns: a node-set
+ * @param ns a node-set
*
* Empties a node-set.
*/
@@ -256,7 +240,7 @@ XMLPUBFUN void *
/**
* XP_ERROR:
- * @X: the error code
+ * @param X the error code
*
* Macro to raise an XPath error and return.
*/
@@ -265,7 +249,7 @@ XMLPUBFUN void *
/**
* XP_ERROR0:
- * @X: the error code
+ * @param X the error code
*
* Macro to raise an XPath error and return 0.
*/
@@ -274,7 +258,7 @@ XMLPUBFUN void *
/**
* CHECK_TYPE:
- * @typeval: the XPath type
+ * @param typeval the XPath type
*
* Macro to check that the value on top of the XPath stack is of a given
* type.
@@ -285,7 +269,7 @@ XMLPUBFUN void *
/**
* CHECK_TYPE0:
- * @typeval: the XPath type
+ * @param typeval the XPath type
*
* Macro to check that the value on top of the XPath stack is of a given
* type. Return(0) in case of failure
@@ -296,7 +280,7 @@ XMLPUBFUN void *
/**
* CHECK_ARITY:
- * @x: the number of expected args
+ * @param x the number of expected args
*
* Macro to check that the number of args passed to an XPath function matches.
*/
diff --git a/include/libxml/xpointer.h b/include/libxml/xpointer.h
index 16bd5b9f..ebad18b7 100644
--- a/include/libxml/xpointer.h
+++ b/include/libxml/xpointer.h
@@ -1,6 +1,9 @@
-/*
- * Summary: API to handle XML Pointers
- * Description: API to handle XML Pointers
+/**
+ * @file
+ *
+ * @brief API to handle XML Pointers
+ *
+ * API to handle XML Pointers
* Base implementation was made accordingly to
* W3C Candidate Recommendation 7 June 2000
* http://www.w3.org/TR/2000/CR-xptr-20000607
@@ -9,9 +12,9 @@
* W3C Proposed Recommendation 13 November 2002
* http://www.w3.org/TR/2002/PR-xptr-element-20021113/
*
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
*
- * Author: Daniel Veillard
+ * @author Daniel Veillard
*/
#ifndef __XML_XPTR_H__
diff --git a/list.c b/list.c
index a6fc2caa..67fdbcfb 100644
--- a/list.c
+++ b/list.c
@@ -49,11 +49,10 @@ struct _xmlList
************************************************************************/
/**
- * xmlLinkDeallocator:
- * @l: a list
- * @lk: a link
+ * @param l a list
+ * @param lk a link
*
- * Unlink and deallocate @lk from list @l
+ * Unlink and deallocate `lk` from list `l`
*/
static void
xmlLinkDeallocator(xmlListPtr l, xmlLinkPtr lk)
@@ -66,13 +65,12 @@ xmlLinkDeallocator(xmlListPtr l, xmlLinkPtr lk)
}
/**
- * xmlLinkCompare:
- * @data0: first data
- * @data1: second data
+ * @param data0 first data
+ * @param data1 second data
*
* Compares two arbitrary data
*
- * Returns -1, 0 or 1 depending on whether data1 is greater equal or smaller
+ * @returns -1, 0 or 1 depending on whether data1 is greater equal or smaller
* than data0
*/
static int
@@ -86,13 +84,12 @@ xmlLinkCompare(const void *data0, const void *data1)
}
/**
- * xmlListLowerSearch:
- * @l: a list
- * @data: a data
+ * @param l a list
+ * @param data a data
*
* Search data in the ordered list walking from the beginning
*
- * Returns the link containing the data or NULL
+ * @returns the link containing the data or NULL
*/
static xmlLinkPtr
xmlListLowerSearch(xmlListPtr l, void *data)
@@ -106,13 +103,12 @@ xmlListLowerSearch(xmlListPtr l, void *data)
}
/**
- * xmlListHigherSearch:
- * @l: a list
- * @data: a data
+ * @param l a list
+ * @param data a data
*
* Search data in the ordered list walking backward from the end
*
- * Returns the link containing the data or NULL
+ * @returns the link containing the data or NULL
*/
static xmlLinkPtr
xmlListHigherSearch(xmlListPtr l, void *data)
@@ -126,13 +122,12 @@ xmlListHigherSearch(xmlListPtr l, void *data)
}
/**
- * xmlListSearch:
- * @l: a list
- * @data: a data
+ * @param l a list
+ * @param data a data
*
* Search data in the list
*
- * Returns the link containing the data or NULL
+ * @returns the link containing the data or NULL
*/
static xmlLinkPtr
xmlListLinkSearch(xmlListPtr l, void *data)
@@ -151,13 +146,12 @@ xmlListLinkSearch(xmlListPtr l, void *data)
}
/**
- * xmlListLinkReverseSearch:
- * @l: a list
- * @data: a data
+ * @param l a list
+ * @param data a data
*
* Search data in the list processing backward
*
- * Returns the link containing the data or NULL
+ * @returns the link containing the data or NULL
*/
static xmlLinkPtr
xmlListLinkReverseSearch(xmlListPtr l, void *data)
@@ -176,13 +170,12 @@ xmlListLinkReverseSearch(xmlListPtr l, void *data)
}
/**
- * xmlListCreate:
- * @deallocator: an optional deallocator function
- * @compare: an optional comparison function
+ * @param deallocator an optional deallocator function
+ * @param compare an optional comparison function
*
* Create a new list
*
- * Returns the new list or NULL in case of error
+ * @returns the new list or NULL in case of error
*/
xmlListPtr
xmlListCreate(xmlListDeallocator deallocator, xmlListDataCompare compare)
@@ -216,13 +209,12 @@ xmlListCreate(xmlListDeallocator deallocator, xmlListDataCompare compare)
}
/**
- * xmlListSearch:
- * @l: a list
- * @data: a search value
+ * @param l a list
+ * @param data a search value
*
- * Search the list for an existing value of @data
+ * Search the list for an existing value of `data`
*
- * Returns the value associated to @data or NULL in case of error
+ * @returns the value associated to `data` or NULL in case of error
*/
void *
xmlListSearch(xmlListPtr l, void *data)
@@ -237,13 +229,12 @@ xmlListSearch(xmlListPtr l, void *data)
}
/**
- * xmlListReverseSearch:
- * @l: a list
- * @data: a search value
+ * @param l a list
+ * @param data a search value
*
- * Search the list in reverse order for an existing value of @data
+ * Search the list in reverse order for an existing value of `data`
*
- * Returns the value associated to @data or NULL in case of error
+ * @returns the value associated to `data` or NULL in case of error
*/
void *
xmlListReverseSearch(xmlListPtr l, void *data)
@@ -258,13 +249,12 @@ xmlListReverseSearch(xmlListPtr l, void *data)
}
/**
- * xmlListInsert:
- * @l: a list
- * @data: the data
+ * @param l a list
+ * @param data the data
*
* Insert data in the ordered list at the beginning for this value
*
- * Returns 0 in case of success, 1 in case of failure
+ * @returns 0 in case of success, 1 in case of failure
*/
int
xmlListInsert(xmlListPtr l, void *data)
@@ -288,13 +278,12 @@ xmlListInsert(xmlListPtr l, void *data)
}
/**
- * xmlListAppend:
- * @l: a list
- * @data: the data
+ * @param l a list
+ * @param data the data
*
* Insert data in the ordered list at the end for this value
*
- * Returns 0 in case of success, 1 in case of failure
+ * @returns 0 in case of success, 1 in case of failure
*/
int xmlListAppend(xmlListPtr l, void *data)
{
@@ -316,8 +305,7 @@ int xmlListAppend(xmlListPtr l, void *data)
}
/**
- * xmlListDelete:
- * @l: a list
+ * @param l a list
*
* Deletes the list and its associated data
*/
@@ -332,13 +320,12 @@ void xmlListDelete(xmlListPtr l)
}
/**
- * xmlListRemoveFirst:
- * @l: a list
- * @data: list data
+ * @param l a list
+ * @param data list data
*
* Remove the first instance associated to data in the list
*
- * Returns 1 if a deallocation occurred, or 0 if not found
+ * @returns 1 if a deallocation occurred, or 0 if not found
*/
int
xmlListRemoveFirst(xmlListPtr l, void *data)
@@ -357,13 +344,12 @@ xmlListRemoveFirst(xmlListPtr l, void *data)
}
/**
- * xmlListRemoveLast:
- * @l: a list
- * @data: list data
+ * @param l a list
+ * @param data list data
*
* Remove the last instance associated to data in the list
*
- * Returns 1 if a deallocation occurred, or 0 if not found
+ * @returns 1 if a deallocation occurred, or 0 if not found
*/
int
xmlListRemoveLast(xmlListPtr l, void *data)
@@ -382,13 +368,12 @@ xmlListRemoveLast(xmlListPtr l, void *data)
}
/**
- * xmlListRemoveAll:
- * @l: a list
- * @data: list data
+ * @param l a list
+ * @param data list data
*
* Remove the all instance associated to data in the list
*
- * Returns the number of deallocation, or 0 if not found
+ * @returns the number of deallocation, or 0 if not found
*/
int
xmlListRemoveAll(xmlListPtr l, void *data)
@@ -404,8 +389,7 @@ xmlListRemoveAll(xmlListPtr l, void *data)
}
/**
- * xmlListClear:
- * @l: a list
+ * @param l a list
*
* Remove the all data in the list
*/
@@ -426,12 +410,11 @@ xmlListClear(xmlListPtr l)
}
/**
- * xmlListEmpty:
- * @l: a list
+ * @param l a list
*
* Is the list empty ?
*
- * Returns 1 if the list is empty, 0 if not empty and -1 in case of error
+ * @returns 1 if the list is empty, 0 if not empty and -1 in case of error
*/
int
xmlListEmpty(xmlListPtr l)
@@ -442,12 +425,11 @@ xmlListEmpty(xmlListPtr l)
}
/**
- * xmlListFront:
- * @l: a list
+ * @param l a list
*
* Get the first element in the list
*
- * Returns the first element in the list, or NULL
+ * @returns the first element in the list, or NULL
*/
xmlLinkPtr
xmlListFront(xmlListPtr l)
@@ -458,12 +440,11 @@ xmlListFront(xmlListPtr l)
}
/**
- * xmlListEnd:
- * @l: a list
+ * @param l a list
*
* Get the last element in the list
*
- * Returns the last element in the list, or NULL
+ * @returns the last element in the list, or NULL
*/
xmlLinkPtr
xmlListEnd(xmlListPtr l)
@@ -474,12 +455,11 @@ xmlListEnd(xmlListPtr l)
}
/**
- * xmlListSize:
- * @l: a list
+ * @param l a list
*
* Get the number of elements in the list
*
- * Returns the number of elements in the list or -1 in case of error
+ * @returns the number of elements in the list or -1 in case of error
*/
int
xmlListSize(xmlListPtr l)
@@ -495,8 +475,7 @@ xmlListSize(xmlListPtr l)
}
/**
- * xmlListPopFront:
- * @l: a list
+ * @param l a list
*
* Removes the first element in the list
*/
@@ -508,8 +487,7 @@ xmlListPopFront(xmlListPtr l)
}
/**
- * xmlListPopBack:
- * @l: a list
+ * @param l a list
*
* Removes the last element in the list
*/
@@ -521,13 +499,12 @@ xmlListPopBack(xmlListPtr l)
}
/**
- * xmlListPushFront:
- * @l: a list
- * @data: new data
+ * @param l a list
+ * @param data new data
*
* add the new data at the beginning of the list
*
- * Returns 1 if successful, 0 otherwise
+ * @returns 1 if successful, 0 otherwise
*/
int
xmlListPushFront(xmlListPtr l, void *data)
@@ -550,13 +527,12 @@ xmlListPushFront(xmlListPtr l, void *data)
}
/**
- * xmlListPushBack:
- * @l: a list
- * @data: new data
+ * @param l a list
+ * @param data new data
*
* add the new data at the end of the list
*
- * Returns 1 if successful, 0 otherwise
+ * @returns 1 if successful, 0 otherwise
*/
int
xmlListPushBack(xmlListPtr l, void *data)
@@ -579,12 +555,11 @@ xmlListPushBack(xmlListPtr l, void *data)
}
/**
- * xmlLinkGetData:
- * @lk: a link
+ * @param lk a link
*
* See Returns.
*
- * Returns a pointer to the data referenced from this link
+ * @returns a pointer to the data referenced from this link
*/
void *
xmlLinkGetData(xmlLinkPtr lk)
@@ -595,8 +570,7 @@ xmlLinkGetData(xmlLinkPtr lk)
}
/**
- * xmlListReverse:
- * @l: a list
+ * @param l a list
*
* Reverse the order of the elements in the list
*/
@@ -620,8 +594,7 @@ xmlListReverse(xmlListPtr l)
}
/**
- * xmlListSort:
- * @l: a list
+ * @param l a list
*
* Sort all the elements in the list
*/
@@ -650,10 +623,9 @@ xmlListSort(xmlListPtr l)
}
/**
- * xmlListWalk:
- * @l: a list
- * @walker: a processing function
- * @user: a user parameter passed to the walker function
+ * @param l a list
+ * @param walker a processing function
+ * @param user a user parameter passed to the walker function
*
* Walk all the element of the first from first to last and
* apply the walker function to it
@@ -671,10 +643,9 @@ xmlListWalk(xmlListPtr l, xmlListWalker walker, void *user) {
}
/**
- * xmlListReverseWalk:
- * @l: a list
- * @walker: a processing function
- * @user: a user parameter passed to the walker function
+ * @param l a list
+ * @param walker a processing function
+ * @param user a user parameter passed to the walker function
*
* Walk all the element of the list in reverse order and
* apply the walker function to it
@@ -692,9 +663,8 @@ xmlListReverseWalk(xmlListPtr l, xmlListWalker walker, void *user) {
}
/**
- * xmlListMerge:
- * @l1: the original list
- * @l2: the new list
+ * @param l1 the original list
+ * @param l2 the new list
*
* include all the elements of the second list in the first one and
* clear the second list
@@ -707,12 +677,11 @@ xmlListMerge(xmlListPtr l1, xmlListPtr l2)
}
/**
- * xmlListDup:
- * @old: the list
+ * @param old the list
*
* Duplicate the list
*
- * Returns a new copy of the list or NULL in case of error
+ * @returns a new copy of the list or NULL in case of error
*/
xmlListPtr
xmlListDup(xmlListPtr old)
@@ -736,13 +705,12 @@ xmlListDup(xmlListPtr old)
}
/**
- * xmlListCopy:
- * @cur: the new list
- * @old: the old list
+ * @param cur the new list
+ * @param old the old list
*
* Move all the element from the old list in the new list
*
- * Returns 0 in case of success 1 in case of error
+ * @returns 0 in case of success 1 in case of error
*/
int
xmlListCopy(xmlListPtr cur, xmlListPtr old)
diff --git a/nanohttp.c b/nanohttp.c
index e1168eb5..c8771a4c 100644
--- a/nanohttp.c
+++ b/nanohttp.c
@@ -15,42 +15,38 @@
#include
/**
- * xmlNanoHTTPInit:
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*/
void
xmlNanoHTTPInit(void) {
}
/**
- * xmlNanoHTTPCleanup:
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*/
void
xmlNanoHTTPCleanup(void) {
}
/**
- * xmlNanoHTTPScanProxy:
- * @URL: The proxy URL used to initialize the proxy context
+ * @param URL The proxy URL used to initialize the proxy context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*/
void
xmlNanoHTTPScanProxy(const char *URL ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPOpen:
- * @URL: The URL to load
- * @contentType: if available the Content-Type information will be
+ * @param URL The URL to load
+ * @param contentType if available the Content-Type information will be
* returned at that location
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
void*
xmlNanoHTTPOpen(const char *URL ATTRIBUTE_UNUSED, char **contentType) {
@@ -59,15 +55,14 @@ xmlNanoHTTPOpen(const char *URL ATTRIBUTE_UNUSED, char **contentType) {
}
/**
- * xmlNanoHTTPOpenRedir:
- * @URL: The URL to load
- * @contentType: if available the Content-Type information will be
+ * @param URL The URL to load
+ * @param contentType if available the Content-Type information will be
* returned at that location
- * @redir: if available the redirected URL will be returned
+ * @param redir if available the redirected URL will be returned
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
void*
xmlNanoHTTPOpenRedir(const char *URL ATTRIBUTE_UNUSED, char **contentType,
@@ -78,14 +73,13 @@ xmlNanoHTTPOpenRedir(const char *URL ATTRIBUTE_UNUSED, char **contentType,
}
/**
- * xmlNanoHTTPRead:
- * @ctx: the HTTP context
- * @dest: a buffer
- * @len: the buffer length
+ * @param ctx the HTTP context
+ * @param dest a buffer
+ * @param len the buffer length
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns -1.
+ * @returns -1.
*/
int
xmlNanoHTTPRead(void *ctx ATTRIBUTE_UNUSED, void *dest ATTRIBUTE_UNUSED,
@@ -94,28 +88,26 @@ xmlNanoHTTPRead(void *ctx ATTRIBUTE_UNUSED, void *dest ATTRIBUTE_UNUSED,
}
/**
- * xmlNanoHTTPClose:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*/
void
xmlNanoHTTPClose(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPMethodRedir:
- * @URL: The URL to load
- * @method: the HTTP method to use
- * @input: the input string if any
- * @contentType: the Content-Type information IN and OUT
- * @redir: the redirected URL OUT
- * @headers: the extra headers
- * @ilen: input length
+ * @param URL The URL to load
+ * @param method the HTTP method to use
+ * @param input the input string if any
+ * @param contentType the Content-Type information IN and OUT
+ * @param redir the redirected URL OUT
+ * @param headers the extra headers
+ * @param ilen input length
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
void*
xmlNanoHTTPMethodRedir(const char *URL ATTRIBUTE_UNUSED,
@@ -130,17 +122,16 @@ xmlNanoHTTPMethodRedir(const char *URL ATTRIBUTE_UNUSED,
}
/**
- * xmlNanoHTTPMethod:
- * @URL: The URL to load
- * @method: the HTTP method to use
- * @input: the input string if any
- * @contentType: the Content-Type information IN and OUT
- * @headers: the extra headers
- * @ilen: input length
+ * @param URL The URL to load
+ * @param method the HTTP method to use
+ * @param input the input string if any
+ * @param contentType the Content-Type information IN and OUT
+ * @param headers the extra headers
+ * @param ilen input length
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
void*
xmlNanoHTTPMethod(const char *URL ATTRIBUTE_UNUSED,
@@ -153,15 +144,14 @@ xmlNanoHTTPMethod(const char *URL ATTRIBUTE_UNUSED,
}
/**
- * xmlNanoHTTPFetch:
- * @URL: The URL to load
- * @filename: the filename where the content should be saved
- * @contentType: if available the Content-Type information will be
+ * @param URL The URL to load
+ * @param filename the filename where the content should be saved
+ * @param contentType if available the Content-Type information will be
* returned at that location
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns -1.
+ * @returns -1.
*/
int
xmlNanoHTTPFetch(const char *URL ATTRIBUTE_UNUSED,
@@ -172,13 +162,12 @@ xmlNanoHTTPFetch(const char *URL ATTRIBUTE_UNUSED,
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlNanoHTTPSave:
- * @ctxt: the HTTP context
- * @filename: the filename where the content should be saved
+ * @param ctxt the HTTP context
+ * @param filename the filename where the content should be saved
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns -1.
+ * @returns -1.
*/
int
xmlNanoHTTPSave(void *ctxt ATTRIBUTE_UNUSED,
@@ -188,12 +177,11 @@ xmlNanoHTTPSave(void *ctxt ATTRIBUTE_UNUSED,
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlNanoHTTPReturnCode:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns -1.
+ * @returns -1.
*/
int
xmlNanoHTTPReturnCode(void *ctx ATTRIBUTE_UNUSED) {
@@ -201,12 +189,11 @@ xmlNanoHTTPReturnCode(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPAuthHeader:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
const char *
xmlNanoHTTPAuthHeader(void *ctx ATTRIBUTE_UNUSED) {
@@ -214,12 +201,11 @@ xmlNanoHTTPAuthHeader(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPContentLength:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns -1.
+ * @returns -1.
*/
int
xmlNanoHTTPContentLength(void *ctx ATTRIBUTE_UNUSED) {
@@ -227,12 +213,11 @@ xmlNanoHTTPContentLength(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPRedir:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
const char *
xmlNanoHTTPRedir(void *ctx ATTRIBUTE_UNUSED) {
@@ -240,12 +225,11 @@ xmlNanoHTTPRedir(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPEncoding:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
const char *
xmlNanoHTTPEncoding(void *ctx ATTRIBUTE_UNUSED) {
@@ -253,12 +237,11 @@ xmlNanoHTTPEncoding(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlNanoHTTPMimeType:
- * @ctx: the HTTP context
+ * @param ctx the HTTP context
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
const char *
xmlNanoHTTPMimeType(void *ctx ATTRIBUTE_UNUSED) {
@@ -266,12 +249,11 @@ xmlNanoHTTPMimeType(void *ctx ATTRIBUTE_UNUSED) {
}
/**
- * xmlIOHTTPMatch:
- * @filename: the URI for matching
+ * @param filename the URI for matching
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns 0.
+ * @returns 0.
*/
int
xmlIOHTTPMatch(const char *filename ATTRIBUTE_UNUSED) {
@@ -279,12 +261,11 @@ xmlIOHTTPMatch(const char *filename ATTRIBUTE_UNUSED) {
}
/**
- * xmlIOHTTPOpen:
- * @filename: the URI for matching
+ * @param filename the URI for matching
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
void *
xmlIOHTTPOpen(const char *filename ATTRIBUTE_UNUSED) {
@@ -293,13 +274,12 @@ xmlIOHTTPOpen(const char *filename ATTRIBUTE_UNUSED) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlIOHTTPOpenW:
- * @post_uri: The destination URI for the document
- * @compression: The compression desired for the document.
+ * @param post_uri The destination URI for the document
+ * @param compression The compression desired for the document.
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns NULL.
+ * @returns NULL.
*/
void *
xmlIOHTTPOpenW(const char *post_uri ATTRIBUTE_UNUSED,
@@ -310,14 +290,13 @@ xmlIOHTTPOpenW(const char *post_uri ATTRIBUTE_UNUSED,
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlIOHTTPRead:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to write
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*
- * Returns -1.
+ * @returns -1.
*/
int
xmlIOHTTPRead(void *context ATTRIBUTE_UNUSED, char *buffer ATTRIBUTE_UNUSED,
@@ -326,12 +305,11 @@ xmlIOHTTPRead(void *context ATTRIBUTE_UNUSED, char *buffer ATTRIBUTE_UNUSED,
}
/**
- * xmlIOHTTPClose:
- * @context: the I/O context
+ * @param context the I/O context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns 0
+ * @returns 0
*/
int
xmlIOHTTPClose (void *context ATTRIBUTE_UNUSED) {
@@ -339,9 +317,8 @@ xmlIOHTTPClose (void *context ATTRIBUTE_UNUSED) {
}
/**
- * xmlRegisterHTTPPostCallbacks:
*
- * DEPRECATED: HTTP support was removed in 2.15.
+ * @deprecated HTTP support was removed in 2.15.
*/
void
xmlRegisterHTTPPostCallbacks(void) {
diff --git a/parser.c b/parser.c
index 977782f1..bfebd75b 100644
--- a/parser.c
+++ b/parser.c
@@ -177,7 +177,6 @@ xmlParseEntityRefInternal(xmlParserCtxtPtr ctxt);
#define XML_PARSER_CHUNK_SIZE 100
/**
- * xmlParserVersion:
*
* Constant string describing the internal version of the library
*/
@@ -217,10 +216,9 @@ xmlErrMemory(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlErrAttributeDup:
- * @ctxt: an XML parser context
- * @prefix: the attribute prefix
- * @localname: the attribute localname
+ * @param ctxt an XML parser context
+ * @param prefix the attribute prefix
+ * @param localname the attribute localname
*
* Handle a redefinition of attribute error
*/
@@ -239,10 +237,9 @@ xmlErrAttributeDup(xmlParserCtxtPtr ctxt, const xmlChar * prefix,
}
/**
- * xmlFatalErrMsg:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -255,12 +252,11 @@ xmlFatalErrMsg(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlWarningMsg:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Handle a warning.
*/
@@ -273,12 +269,11 @@ xmlWarningMsg(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlValidityError:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Handle a validity error.
*/
@@ -293,11 +288,10 @@ xmlValidityError(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlFatalErrMsgInt:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @val: an integer value
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param val an integer value
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -310,13 +304,12 @@ xmlFatalErrMsgInt(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlFatalErrMsgStrIntStr:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @str1: an string info
- * @val: an integer value
- * @str2: an string info
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 an string info
+ * @param val an integer value
+ * @param str2 an string info
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -330,11 +323,10 @@ xmlFatalErrMsgStrIntStr(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlFatalErrMsgStr:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @val: a string value
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param val a string value
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -347,11 +339,10 @@ xmlFatalErrMsgStr(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlErrMsgStr:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the error message
- * @val: a string value
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param val a string value
*
* Handle a non fatal parser error
*/
@@ -364,13 +355,12 @@ xmlErrMsgStr(xmlParserCtxtPtr ctxt, xmlParserErrors error,
}
/**
- * xmlNsErr:
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the message
- * @info1: extra information string
- * @info2: extra information string
- * @info3: extra information string
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the message
+ * @param info1 extra information string
+ * @param info2 extra information string
+ * @param info3 extra information string
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -388,12 +378,12 @@ xmlNsErr(xmlParserCtxtPtr ctxt, xmlParserErrors error,
/**
* xmlNsWarn
- * @ctxt: an XML parser context
- * @error: the error number
- * @msg: the message
- * @info1: extra information string
- * @info2: extra information string
- * @info3: extra information string
+ * @param ctxt an XML parser context
+ * @param error the error number
+ * @param msg the message
+ * @param info1 extra information string
+ * @param info2 extra information string
+ * @param info3 extra information string
*
* Handle a namespace warning error
*/
@@ -424,9 +414,8 @@ xmlSaturatedAddSizeT(unsigned long *dst, unsigned long val) {
}
/**
- * xmlParserEntityCheck:
- * @ctxt: parser context
- * @extra: sum of unexpanded entity sizes
+ * @param ctxt parser context
+ * @param extra sum of unexpanded entity sizes
*
* Check for non-linear entity expansion behaviour.
*
@@ -445,7 +434,7 @@ xmlSaturatedAddSizeT(unsigned long *dst, unsigned long val) {
* adds some fixed cost XML_ENT_FIXED_COST to discourage attacks with
* short entities.
*
- * Returns 1 on error, 0 on success.
+ * @returns 1 on error, 0 on success.
*/
static int
xmlParserEntityCheck(xmlParserCtxtPtr ctxt, unsigned long extra)
@@ -502,13 +491,12 @@ xmlParserEntityCheck(xmlParserCtxtPtr ctxt, unsigned long extra)
************************************************************************/
/**
- * xmlHasFeature:
- * @feature: the feature to be examined
+ * @param feature the feature to be examined
*
* Examines if the library has been compiled with a given feature.
*
- * Returns a non-zero value if the feature exist, otherwise zero.
- * Returns zero (0) if the feature does not exist or an unknown
+ * @returns a non-zero value if the feature exist, otherwise zero.
+ * @returns zero (0) if the feature does not exist or an unknown
* unknown feature is requested, non-zero otherwise.
*/
int
@@ -914,8 +902,7 @@ encoding_error:
************************************************************************/
/**
- * xmlCtxtInitializeLate:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Final initialization of the parser context before starting to parse.
*
@@ -992,20 +979,19 @@ struct _xmlDefAttrs {
};
/**
- * xmlAttrNormalizeSpace:
- * @src: the source string
- * @dst: the target string
+ * @param src the source string
+ * @param dst the target string
*
* Normalize the space in non CDATA attribute values:
* If the attribute type is not CDATA, then the XML processor MUST further
* process the normalized attribute value by discarding any leading and
- * trailing space (#x20) characters, and by replacing sequences of space
- * (#x20) characters by a single space (#x20) character.
+ * trailing space (\#x20) characters, and by replacing sequences of space
+ * (\#x20) characters by a single space (\#x20) character.
* Note that the size of dst need to be at least src, and if one doesn't need
* to preserve dst (and it doesn't come from a dictionary or read-only) then
* passing src as dst is just fine.
*
- * Returns a pointer to the normalized value (dst) or NULL if no conversion
+ * @returns a pointer to the normalized value (dst) or NULL if no conversion
* is needed.
*/
static xmlChar *
@@ -1031,11 +1017,10 @@ xmlAttrNormalizeSpace(const xmlChar *src, xmlChar *dst)
}
/**
- * xmlAddDefAttrs:
- * @ctxt: an XML parser context
- * @fullname: the element fullname
- * @fullattr: the attribute fullname
- * @value: the attribute value
+ * @param ctxt an XML parser context
+ * @param fullname the element fullname
+ * @param fullattr the attribute fullname
+ * @param value the attribute value
*
* Add a defaulted attribute for an element
*/
@@ -1163,11 +1148,10 @@ mem_error:
}
/**
- * xmlAddSpecialAttr:
- * @ctxt: an XML parser context
- * @fullname: the element fullname
- * @fullattr: the attribute fullname
- * @type: the attribute type
+ * @param ctxt an XML parser context
+ * @param fullname the element fullname
+ * @param fullattr the attribute fullname
+ * @param type the attribute type
*
* Register this attribute type
*/
@@ -1193,7 +1177,6 @@ mem_error:
}
/**
- * xmlCleanSpecialAttrCallback:
*
* Removes CDATA attributes from the special attribute table
*/
@@ -1209,8 +1192,7 @@ xmlCleanSpecialAttrCallback(void *payload, void *data,
}
/**
- * xmlCleanSpecialAttr:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Trim the list of attributes defined to remove all those of type
* CDATA as they are not special. This call should be done when finishing
@@ -1231,10 +1213,9 @@ xmlCleanSpecialAttr(xmlParserCtxtPtr ctxt)
}
/**
- * xmlCheckLanguageID:
- * @lang: pointer to the string value
+ * @param lang pointer to the string value
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Checks that the value conforms to the LanguageID production:
*
@@ -1288,7 +1269,7 @@ xmlCleanSpecialAttr(xmlParserCtxtPtr ctxt)
* The parser below doesn't try to cope with extension or privateuse
* that could be added but that's not interoperable anyway
*
- * Returns 1 if correct 0 otherwise
+ * @returns 1 if correct 0 otherwise
**/
int
xmlCheckLanguageID(const xmlChar * lang)
@@ -1436,11 +1417,10 @@ static xmlChar *
xmlParseStringEntityRef(xmlParserCtxtPtr ctxt, const xmlChar **str);
/**
- * xmlParserNsCreate:
*
* Create a new namespace database.
*
- * Returns the new obejct.
+ * @returns the new obejct.
*/
xmlParserNsData *
xmlParserNsCreate(void) {
@@ -1455,8 +1435,7 @@ xmlParserNsCreate(void) {
}
/**
- * xmlParserNsFree:
- * @nsdb: namespace database
+ * @param nsdb namespace database
*
* Free a namespace database.
*/
@@ -1471,8 +1450,7 @@ xmlParserNsFree(xmlParserNsData *nsdb) {
}
/**
- * xmlParserNsReset:
- * @nsdb: namespace database
+ * @param nsdb namespace database
*
* Reset a namespace database.
*/
@@ -1490,12 +1468,11 @@ xmlParserNsReset(xmlParserNsData *nsdb) {
}
/**
- * xmlParserStartElement:
- * @nsdb: namespace database
+ * @param nsdb namespace database
*
* Signal that a new element has started.
*
- * Returns 0 on success, -1 if the element counter overflowed.
+ * @returns 0 on success, -1 if the element counter overflowed.
*/
static int
xmlParserNsStartElement(xmlParserNsData *nsdb) {
@@ -1507,16 +1484,15 @@ xmlParserNsStartElement(xmlParserNsData *nsdb) {
}
/**
- * xmlParserNsLookup:
- * @ctxt: parser context
- * @prefix: namespace prefix
- * @bucketPtr: optional bucket (return value)
+ * @param ctxt parser context
+ * @param prefix namespace prefix
+ * @param bucketPtr optional bucket (return value)
*
- * Lookup namespace with given prefix. If @bucketPtr is non-NULL, it will
+ * Lookup namespace with given prefix. If `bucketPtr` is non-NULL, it will
* be set to the matching bucket, or the first empty bucket if no match
* was found.
*
- * Returns the namespace index on success, INT_MAX if no namespace was
+ * @returns the namespace index on success, INT_MAX if no namespace was
* found.
*/
static int
@@ -1562,13 +1538,12 @@ xmlParserNsLookup(xmlParserCtxtPtr ctxt, const xmlHashedString *prefix,
}
/**
- * xmlParserNsLookupUri:
- * @ctxt: parser context
- * @prefix: namespace prefix
+ * @param ctxt parser context
+ * @param prefix namespace prefix
*
* Lookup namespace URI with given prefix.
*
- * Returns the namespace URI on success, NULL if no namespace was found.
+ * @returns the namespace URI on success, NULL if no namespace was found.
*/
static const xmlChar *
xmlParserNsLookupUri(xmlParserCtxtPtr ctxt, const xmlHashedString *prefix) {
@@ -1593,14 +1568,13 @@ xmlParserNsLookupUri(xmlParserCtxtPtr ctxt, const xmlHashedString *prefix) {
}
/**
- * xmlParserNsLookupSax:
- * @ctxt: parser context
- * @prefix: namespace prefix
+ * @param ctxt parser context
+ * @param prefix namespace prefix
*
* Lookup extra data for the given prefix. This returns data stored
* with xmlParserNsUdpateSax.
*
- * Returns the data on success, NULL if no namespace was found.
+ * @returns the data on success, NULL if no namespace was found.
*/
void *
xmlParserNsLookupSax(xmlParserCtxtPtr ctxt, const xmlChar *prefix) {
@@ -1623,16 +1597,15 @@ xmlParserNsLookupSax(xmlParserCtxtPtr ctxt, const xmlChar *prefix) {
}
/**
- * xmlParserNsUpdateSax:
- * @ctxt: parser context
- * @prefix: namespace prefix
- * @saxData: extra data for SAX handler
+ * @param ctxt parser context
+ * @param prefix namespace prefix
+ * @param saxData extra data for SAX handler
*
* Sets or updates extra data for the given prefix. This value will be
* returned by xmlParserNsLookupSax as long as the namespace with the
* given prefix is in scope.
*
- * Returns the data on success, NULL if no namespace was found.
+ * @returns the data on success, NULL if no namespace was found.
*/
int
xmlParserNsUpdateSax(xmlParserCtxtPtr ctxt, const xmlChar *prefix,
@@ -1657,12 +1630,11 @@ xmlParserNsUpdateSax(xmlParserCtxtPtr ctxt, const xmlChar *prefix,
}
/**
- * xmlParserNsGrow:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Grows the namespace tables.
*
- * Returns 0 on success, -1 if a memory allocation failed.
+ * @returns 0 on success, -1 if a memory allocation failed.
*/
static int
xmlParserNsGrow(xmlParserCtxtPtr ctxt) {
@@ -1695,16 +1667,15 @@ error:
}
/**
- * xmlParserNsPush:
- * @ctxt: parser context
- * @prefix: prefix with hash value
- * @uri: uri with hash value
- * @saxData: extra data for SAX handler
- * @defAttr: whether the namespace comes from a default attribute
+ * @param ctxt parser context
+ * @param prefix prefix with hash value
+ * @param uri uri with hash value
+ * @param saxData extra data for SAX handler
+ * @param defAttr whether the namespace comes from a default attribute
*
* Push a new namespace on the table.
*
- * Returns 1 if the namespace was pushed, 0 if the namespace was ignored,
+ * @returns 1 if the namespace was pushed, 0 if the namespace was ignored,
* -1 if a memory allocation failed.
*/
static int
@@ -1856,13 +1827,12 @@ populate_entry:
}
/**
- * xmlParserNsPop:
- * @ctxt: an XML parser context
- * @nr: the number to pop
+ * @param ctxt an XML parser context
+ * @param nr the number to pop
*
- * Pops the top @nr namespaces and restores the hash table.
+ * Pops the top `nr` namespaces and restores the hash table.
*
- * Returns the number of namespaces popped.
+ * @returns the number of namespaces popped.
*/
static int
xmlParserNsPop(xmlParserCtxtPtr ctxt, int nr)
@@ -1929,13 +1899,12 @@ mem_error:
}
/**
- * xmlCtxtPushInput:
- * @ctxt: an XML parser context
- * @value: the parser input
+ * @param ctxt an XML parser context
+ * @param value the parser input
*
* Pushes a new parser input on top of the input stack
*
- * Returns -1 in case of error, the index in the stack otherwise
+ * @returns -1 in case of error, the index in the stack otherwise
*/
int
xmlCtxtPushInput(xmlParserCtxtPtr ctxt, xmlParserInputPtr value)
@@ -2001,12 +1970,11 @@ xmlCtxtPushInput(xmlParserCtxtPtr ctxt, xmlParserInputPtr value)
}
/**
- * xmlCtxtPopInput:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Pops the top parser input from the input stack
*
- * Returns the input just removed
+ * @returns the input just removed
*/
xmlParserInputPtr
xmlCtxtPopInput(xmlParserCtxtPtr ctxt)
@@ -2029,14 +1997,14 @@ xmlCtxtPopInput(xmlParserCtxtPtr ctxt)
/**
* nodePush:
- * @ctxt: an XML parser context
- * @value: the element node
+ * @param ctxt an XML parser context
+ * @param value the element node
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Pushes a new element node on top of the node stack
*
- * Returns -1 in case of error, the index in the stack otherwise
+ * @returns -1 in case of error, the index in the stack otherwise
*/
int
nodePush(xmlParserCtxtPtr ctxt, xmlNodePtr value)
@@ -2076,13 +2044,13 @@ nodePush(xmlParserCtxtPtr ctxt, xmlNodePtr value)
/**
* nodePop:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Pops the top element node from the node stack
*
- * Returns the node just removed
+ * @returns the node just removed
*/
xmlNodePtr
nodePop(xmlParserCtxtPtr ctxt)
@@ -2104,16 +2072,16 @@ nodePop(xmlParserCtxtPtr ctxt)
/**
* nameNsPush:
- * @ctxt: an XML parser context
- * @value: the element name
- * @prefix: the element prefix
- * @URI: the element namespace name
- * @line: the current line number for error messages
- * @nsNr: the number of namespaces pushed on the namespace table
+ * @param ctxt an XML parser context
+ * @param value the element name
+ * @param prefix the element prefix
+ * @param URI the element namespace name
+ * @param line the current line number for error messages
+ * @param nsNr the number of namespaces pushed on the namespace table
*
* Pushes a new element name/prefix/URL on top of the name stack
*
- * Returns -1 in case of error, the index in the stack otherwise
+ * @returns -1 in case of error, the index in the stack otherwise
*/
static int
nameNsPush(xmlParserCtxtPtr ctxt, const xmlChar * value,
@@ -2163,11 +2131,11 @@ mem_error:
#ifdef LIBXML_PUSH_ENABLED
/**
* nameNsPop:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Pops the top element/prefix/URI name from the name stack
*
- * Returns the name just removed
+ * @returns the name just removed
*/
static const xmlChar *
nameNsPop(xmlParserCtxtPtr ctxt)
@@ -2189,13 +2157,13 @@ nameNsPop(xmlParserCtxtPtr ctxt)
/**
* namePop:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Pops the top element name from the name stack
*
- * Returns the name just removed
+ * @returns the name just removed
*/
static const xmlChar *
namePop(xmlParserCtxtPtr ctxt)
@@ -2374,14 +2342,13 @@ xmlCurrentCharRecover(xmlParserCtxtPtr ctxt, int *len) {
}
/**
- * xmlSkipBlankChars:
- * @ctxt: the XML parser context
+ * @param ctxt the XML parser context
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Skip whitespace in the input stream.
*
- * Returns the number of space chars skipped
+ * @returns the number of space chars skipped
*/
int
xmlSkipBlankChars(xmlParserCtxtPtr ctxt) {
@@ -2459,13 +2426,12 @@ xmlPopPE(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlSkipBlankCharsPE:
- * @ctxt: the XML parser context
+ * @param ctxt the XML parser context
*
* Skip whitespace in the input stream, also handling parameter
* entities.
*
- * Returns the number of space chars skipped
+ * @returns the number of space chars skipped
*/
static int
xmlSkipBlankCharsPE(xmlParserCtxtPtr ctxt) {
@@ -2534,12 +2500,11 @@ xmlSkipBlankCharsPE(xmlParserCtxtPtr ctxt) {
************************************************************************/
/**
- * xmlPopInput:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns the current xmlChar in the parser context
+ * @returns the current xmlChar in the parser context
*/
xmlChar
xmlPopInput(xmlParserCtxtPtr ctxt) {
@@ -2554,15 +2519,14 @@ xmlPopInput(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlPushInput:
- * @ctxt: an XML parser context
- * @input: an XML parser input fragment (entity, XML fragment ...).
+ * @param ctxt an XML parser context
+ * @param input an XML parser input fragment (entity, XML fragment ...).
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Push an input stream onto the stack.
*
- * Returns -1 in case of error or the index in the input stack
+ * @returns -1 in case of error or the index in the input stack
*/
int
xmlPushInput(xmlParserCtxtPtr ctxt, xmlParserInputPtr input) {
@@ -2578,21 +2542,20 @@ xmlPushInput(xmlParserCtxtPtr ctxt, xmlParserInputPtr input) {
}
/**
- * xmlParseCharRef:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Parse a numeric character reference. Always consumes '&'.
*
- * [66] CharRef ::= '&#' [0-9]+ ';' |
- * '&#x' [0-9a-fA-F]+ ';'
+ * [66] CharRef ::= '&\#' [0-9]+ ';' |
+ * '&\#x' [0-9a-fA-F]+ ';'
*
* [ WFC: Legal Character ]
* Characters referred to using character references must match the
* production for Char.
*
- * Returns the value parsed (as an int), 0 in case of error
+ * @returns the value parsed (as an int), 0 in case of error
*/
int
xmlParseCharRef(xmlParserCtxtPtr ctxt) {
@@ -2685,21 +2648,20 @@ xmlParseCharRef(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParseStringCharRef:
- * @ctxt: an XML parser context
- * @str: a pointer to an index in the string
+ * @param ctxt an XML parser context
+ * @param str a pointer to an index in the string
*
* parse Reference declarations, variant parsing from a string rather
* than an an input flow.
*
- * [66] CharRef ::= '&#' [0-9]+ ';' |
- * '&#x' [0-9a-fA-F]+ ';'
+ * [66] CharRef ::= '&\#' [0-9]+ ';' |
+ * '&\#x' [0-9a-fA-F]+ ';'
*
* [ WFC: Legal Character ]
* Characters referred to using character references must match the
* production for Char.
*
- * Returns the value parsed (as an int), 0 in case of error, str will be
+ * @returns the value parsed (as an int), 0 in case of error, str will be
* updated to the current value of the index
*/
static int
@@ -2779,10 +2741,9 @@ xmlParseStringCharRef(xmlParserCtxtPtr ctxt, const xmlChar **str) {
}
/**
- * xmlParserHandlePEReference:
- * @ctxt: the parser context
+ * @param ctxt the parser context
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* [69] PEReference ::= '%' Name ';'
*
@@ -2807,7 +2768,7 @@ xmlParseStringCharRef(xmlParserCtxtPtr ctxt, const xmlChar **str) {
*
* A PEReference may have been detected in the current input stream
* the handling is done accordingly to
- * http://www.w3.org/TR/REC-xml#entproc
+ * http://www.w3.org/TR/REC-xml\#entproc
* i.e.
* - Included in literal in entity values
* - Included as Parameter Entity reference within DTDs
@@ -2818,18 +2779,17 @@ xmlParserHandlePEReference(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlStringLenDecodeEntities:
- * @ctxt: the parser context
- * @str: the input string
- * @len: the string length
- * @what: combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
- * @end: an end marker xmlChar, 0 if none
- * @end2: an end marker xmlChar, 0 if none
- * @end3: an end marker xmlChar, 0 if none
+ * @param ctxt the parser context
+ * @param str the input string
+ * @param len the string length
+ * @param what combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
+ * @param end an end marker xmlChar, 0 if none
+ * @param end2 an end marker xmlChar, 0 if none
+ * @param end3 an end marker xmlChar, 0 if none
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns A newly allocated string with the substitution done. The caller
+ * @returns A newly allocated string with the substitution done. The caller
* must deallocate it !
*/
xmlChar *
@@ -2847,17 +2807,16 @@ xmlStringLenDecodeEntities(xmlParserCtxtPtr ctxt, const xmlChar *str, int len,
}
/**
- * xmlStringDecodeEntities:
- * @ctxt: the parser context
- * @str: the input string
- * @what: combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
- * @end: an end marker xmlChar, 0 if none
- * @end2: an end marker xmlChar, 0 if none
- * @end3: an end marker xmlChar, 0 if none
+ * @param ctxt the parser context
+ * @param str the input string
+ * @param what combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
+ * @param end an end marker xmlChar, 0 if none
+ * @param end2 an end marker xmlChar, 0 if none
+ * @param end3 an end marker xmlChar, 0 if none
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns A newly allocated string with the substitution done. The caller
+ * @returns A newly allocated string with the substitution done. The caller
* must deallocate it !
*/
xmlChar *
@@ -2881,14 +2840,14 @@ xmlStringDecodeEntities(xmlParserCtxtPtr ctxt, const xmlChar *str,
/**
* areBlanks:
- * @ctxt: an XML parser context
- * @str: a xmlChar *
- * @len: the size of @str
- * @blank_chars: we know the chars are blanks
+ * @param ctxt an XML parser context
+ * @param str a xmlChar *
+ * @param len the size of `str`
+ * @param blank_chars we know the chars are blanks
*
* Is this a sequence of blank chars that one can ignore ?
*
- * Returns 1 if ignorable 0 otherwise.
+ * @returns 1 if ignorable 0 otherwise.
*/
static int areBlanks(xmlParserCtxtPtr ctxt, const xmlChar *str, int len,
@@ -2968,12 +2927,11 @@ static int areBlanks(xmlParserCtxtPtr ctxt, const xmlChar *str, int len,
************************************************************************/
/**
- * xmlSplitQName:
- * @ctxt: an XML parser context
- * @name: an XML parser context
- * @prefixOut: a xmlChar **
+ * @param ctxt an XML parser context
+ * @param name an XML parser context
+ * @param prefixOut a xmlChar **
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* parse an UTF8 encoded XML qualified name string
*
@@ -2983,7 +2941,7 @@ static int areBlanks(xmlParserCtxtPtr ctxt, const xmlChar *str, int len,
*
* [NS 7] LocalPart ::= NCName
*
- * Returns the local part, and prefix is updated
+ * @returns the local part, and prefix is updated
* to get the Prefix if any.
*/
@@ -3367,10 +3325,9 @@ xmlParseNameComplex(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParseName:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse an XML name.
*
@@ -3379,9 +3336,9 @@ xmlParseNameComplex(xmlParserCtxtPtr ctxt) {
*
* [5] Name ::= (Letter | '_' | ':') (NameChar)*
*
- * [6] Names ::= Name (#x20 Name)*
+ * [6] Names ::= Name (\#x20 Name)*
*
- * Returns the Name parsed or NULL
+ * @returns the Name parsed or NULL
*/
const xmlChar *
@@ -3468,8 +3425,7 @@ xmlParseNCNameComplex(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParseNCName:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* parse an XML name.
*
@@ -3478,7 +3434,7 @@ xmlParseNCNameComplex(xmlParserCtxtPtr ctxt) {
*
* [5NS] NCName ::= (Letter | '_') (NCNameChar)*
*
- * Returns the Name parsed or NULL
+ * @returns the Name parsed or NULL
*/
static xmlHashedString
@@ -3529,14 +3485,13 @@ complex:
}
/**
- * xmlParseNameAndCompare:
- * @ctxt: an XML parser context
- * @other: the name to compare with
+ * @param ctxt an XML parser context
+ * @param other the name to compare with
*
* parse an XML name and compares for match
* (specialized for endtag parsing)
*
- * Returns NULL for an illegal name, (xmlChar*) 1 for success
+ * @returns NULL for an illegal name, (xmlChar*) 1 for success
* and the name for mismatch
*/
@@ -3569,9 +3524,8 @@ xmlParseNameAndCompare(xmlParserCtxtPtr ctxt, xmlChar const *other) {
}
/**
- * xmlParseStringName:
- * @ctxt: an XML parser context
- * @str: a pointer to the string pointer (IN/OUT)
+ * @param ctxt an XML parser context
+ * @param str a pointer to the string pointer (IN/OUT)
*
* parse an XML name.
*
@@ -3580,9 +3534,9 @@ xmlParseNameAndCompare(xmlParserCtxtPtr ctxt, xmlChar const *other) {
*
* [5] Name ::= (Letter | '_' | ':') (NameChar)*
*
- * [6] Names ::= Name (#x20 Name)*
+ * [6] Names ::= Name (\#x20 Name)*
*
- * Returns the Name parsed or NULL. The @str pointer
+ * @returns the Name parsed or NULL. The `str` pointer
* is updated to the current location in the string.
*/
@@ -3664,18 +3618,17 @@ xmlParseStringName(xmlParserCtxtPtr ctxt, const xmlChar** str) {
}
/**
- * xmlParseNmtoken:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse an XML Nmtoken.
*
* [7] Nmtoken ::= (NameChar)+
*
- * [8] Nmtokens ::= Nmtoken (#x20 Nmtoken)*
+ * [8] Nmtokens ::= Nmtoken (\#x20 Nmtoken)*
*
- * Returns the Nmtoken parsed or NULL
+ * @returns the Nmtoken parsed or NULL
*/
xmlChar *
@@ -3749,12 +3702,11 @@ xmlParseNmtoken(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlExpandPEsInEntityValue:
- * @ctxt: parser context
- * @buf: string buffer
- * @str: entity value
- * @length: size of entity value
- * @depth: nesting depth
+ * @param ctxt parser context
+ * @param buf string buffer
+ * @param str entity value
+ * @param length size of entity value
+ * @param depth nesting depth
*
* Validate an entity value and expand parameter entities.
*/
@@ -3898,18 +3850,17 @@ xmlExpandPEsInEntityValue(xmlParserCtxtPtr ctxt, xmlSBuf *buf,
}
/**
- * xmlParseEntityValue:
- * @ctxt: an XML parser context
- * @orig: if non-NULL store a copy of the original entity value
+ * @param ctxt an XML parser context
+ * @param orig if non-NULL store a copy of the original entity value
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse a value for ENTITY declarations
*
* [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' |
* "'" ([^%&'] | PEReference | Reference)* "'"
*
- * Returns the EntityValue parsed with reference substituted or NULL
+ * @returns the EntityValue parsed with reference substituted or NULL
*/
xmlChar *
xmlParseEntityValue(xmlParserCtxtPtr ctxt, xmlChar **orig) {
@@ -3986,10 +3937,9 @@ error:
}
/**
- * xmlCheckEntityInAttValue:
- * @ctxt: parser context
- * @pent: entity
- * @depth: nesting depth
+ * @param ctxt parser context
+ * @param pent entity
+ * @param depth nesting depth
*
* Check an entity reference in an attribute value for validity
* without expanding it.
@@ -4090,15 +4040,14 @@ done:
}
/**
- * xmlExpandEntityInAttValue:
- * @ctxt: parser context
- * @buf: string buffer
- * @str: entity or attribute value
- * @pent: entity for entity value, NULL for attribute values
- * @normalize: whether to collapse whitespace
- * @inSpace: whitespace state
- * @depth: nesting depth
- * @check: whether to check for amplification
+ * @param ctxt parser context
+ * @param buf string buffer
+ * @param str entity or attribute value
+ * @param pent entity for entity value, NULL for attribute values
+ * @param normalize whether to collapse whitespace
+ * @param inSpace whitespace state
+ * @param depth nesting depth
+ * @param check whether to check for amplification
*
* Expand general entity references in an entity or attribute value.
* Perform attribute value normalization.
@@ -4252,15 +4201,14 @@ xmlExpandEntityInAttValue(xmlParserCtxtPtr ctxt, xmlSBuf *buf,
}
/**
- * xmlExpandEntitiesInAttValue:
- * @ctxt: parser context
- * @str: entity or attribute value
- * @normalize: whether to collapse whitespace
+ * @param ctxt parser context
+ * @param str entity or attribute value
+ * @param normalize whether to collapse whitespace
*
* Expand general entity references in an entity or attribute value.
* Perform attribute value normalization.
*
- * Returns the expanded attribtue value.
+ * @returns the expanded attribtue value.
*/
xmlChar *
xmlExpandEntitiesInAttValue(xmlParserCtxtPtr ctxt, const xmlChar *str,
@@ -4283,12 +4231,11 @@ xmlExpandEntitiesInAttValue(xmlParserCtxtPtr ctxt, const xmlChar *str,
}
/**
- * xmlParseAttValueInternal:
- * @ctxt: an XML parser context
- * @attlen: attribute len result
- * @alloc: whether the attribute was reallocated as a new string
- * @normalize: if 1 then further non-CDATA normalization must be done
- * @isNamespace: whether this is a namespace declaration
+ * @param ctxt an XML parser context
+ * @param attlen attribute len result
+ * @param alloc whether the attribute was reallocated as a new string
+ * @param normalize if 1 then further non-CDATA normalization must be done
+ * @param isNamespace whether this is a namespace declaration
*
* parse a value for an attribute.
* NOTE: if no normalization is needed, the routine will return pointers
@@ -4301,19 +4248,19 @@ xmlExpandEntitiesInAttValue(xmlParserCtxtPtr ctxt, const xmlChar *str,
* character to the attribute value
* - an entity reference is processed by recursively processing the
* replacement text of the entity
- * - a whitespace character (#x20, #xD, #xA, #x9) is processed by
- * appending #x20 to the normalized value, except that only a single
- * #x20 is appended for a "#xD#xA" sequence that is part of an external
+ * - a whitespace character (\#x20, \#xD, \#xA, \#x9) is processed by
+ * appending \#x20 to the normalized value, except that only a single
+ * \#x20 is appended for a "\#xD\#xA" sequence that is part of an external
* parsed entity or the literal entity value of an internal parsed entity
* - other characters are processed by appending them to the normalized value
* If the declared value is not CDATA, then the XML processor must further
* process the normalized attribute value by discarding any leading and
- * trailing space (#x20) characters, and by replacing sequences of space
- * (#x20) characters by a single space (#x20) character.
+ * trailing space (\#x20) characters, and by replacing sequences of space
+ * (\#x20) characters by a single space (\#x20) character.
* All attributes for which no declaration has been read should be treated
* by a non-validating parser as if declared CDATA.
*
- * Returns the AttValue parsed or NULL. The value has to be freed by the
+ * @returns the AttValue parsed or NULL. The value has to be freed by the
* caller if it was copied, this can be detected by val[*len] == 0.
*/
static xmlChar *
@@ -4548,10 +4495,9 @@ error:
}
/**
- * xmlParseAttValue:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse a value for an attribute
* Note: the parser won't do substitution of entities here, this
@@ -4567,19 +4513,19 @@ error:
* character to the attribute value
* - an entity reference is processed by recursively processing the
* replacement text of the entity
- * - a whitespace character (#x20, #xD, #xA, #x9) is processed by
- * appending #x20 to the normalized value, except that only a single
- * #x20 is appended for a "#xD#xA" sequence that is part of an external
+ * - a whitespace character (\#x20, \#xD, \#xA, \#x9) is processed by
+ * appending \#x20 to the normalized value, except that only a single
+ * \#x20 is appended for a "\#xD\#xA" sequence that is part of an external
* parsed entity or the literal entity value of an internal parsed entity
* - other characters are processed by appending them to the normalized value
* If the declared value is not CDATA, then the XML processor must further
* process the normalized attribute value by discarding any leading and
- * trailing space (#x20) characters, and by replacing sequences of space
- * (#x20) characters by a single space (#x20) character.
+ * trailing space (\#x20) characters, and by replacing sequences of space
+ * (\#x20) characters by a single space (\#x20) character.
* All attributes for which no declaration has been read should be treated
* by a non-validating parser as if declared CDATA.
*
- * Returns the AttValue parsed or NULL. The value has to be freed by the caller.
+ * @returns the AttValue parsed or NULL. The value has to be freed by the caller.
*/
@@ -4590,16 +4536,15 @@ xmlParseAttValue(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParseSystemLiteral:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse an XML Literal
*
* [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")
*
- * Returns the SystemLiteral parsed or NULL
+ * @returns the SystemLiteral parsed or NULL
*/
xmlChar *
@@ -4664,16 +4609,15 @@ xmlParseSystemLiteral(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParsePubidLiteral:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* parse an XML public literal
*
* [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"
*
- * Returns the PubidLiteral parsed or NULL.
+ * @returns the PubidLiteral parsed or NULL.
*/
xmlChar *
@@ -4812,9 +4756,8 @@ xmlCharacters(xmlParserCtxtPtr ctxt, const xmlChar *buf, int size,
}
/**
- * xmlParseCharDataInternal:
- * @ctxt: an XML parser context
- * @partial: buffer may contain partial UTF-8 sequences
+ * @param ctxt an XML parser context
+ * @param partial buffer may contain partial UTF-8 sequences
*
* Parse character data. Always makes progress if the first char isn't
* '<' or '&'.
@@ -4928,9 +4871,8 @@ get_more:
}
/**
- * xmlParseCharDataComplex:
- * @ctxt: an XML parser context
- * @partial: whether the input can end with truncated UTF-8
+ * @param ctxt an XML parser context
+ * @param partial whether the input can end with truncated UTF-8
*
* Always makes progress if the first char isn't '<' or '&'.
*
@@ -4994,11 +4936,10 @@ xmlParseCharDataComplex(xmlParserCtxtPtr ctxt, int partial) {
}
/**
- * xmlParseCharData:
- * @ctxt: an XML parser context
- * @cdata: unused
+ * @param ctxt an XML parser context
+ * @param cdata unused
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*/
void
xmlParseCharData(xmlParserCtxtPtr ctxt, ATTRIBUTE_UNUSED int cdata) {
@@ -5006,13 +4947,12 @@ xmlParseCharData(xmlParserCtxtPtr ctxt, ATTRIBUTE_UNUSED int cdata) {
}
/**
- * xmlParseExternalID:
- * @ctxt: an XML parser context
- * @publicID: a xmlChar** receiving PubidLiteral
- * @strict: indicate whether we should restrict parsing to only
+ * @param ctxt an XML parser context
+ * @param publicID a xmlChar** receiving PubidLiteral
+ * @param strict indicate whether we should restrict parsing to only
* production [75], see NOTE below
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Parse an External ID or a Public ID
*
@@ -5024,7 +4964,7 @@ xmlParseCharData(xmlParserCtxtPtr ctxt, ATTRIBUTE_UNUSED int cdata) {
*
* [83] PublicID ::= 'PUBLIC' S PubidLiteral
*
- * Returns the function returns SystemLiteral and in the second
+ * @returns the function returns SystemLiteral and in the second
* case publicID receives PubidLiteral, is strict is off
* it is possible to return NULL and have publicID set.
*/
@@ -5081,11 +5021,10 @@ xmlParseExternalID(xmlParserCtxtPtr ctxt, xmlChar **publicID, int strict) {
}
/**
- * xmlParseCommentComplex:
- * @ctxt: an XML parser context
- * @buf: the already parsed part of the buffer
- * @len: number of bytes in the buffer
- * @size: allocated size of the buffer
+ * @param ctxt an XML parser context
+ * @param buf the already parsed part of the buffer
+ * @param len number of bytes in the buffer
+ * @param size allocated size of the buffer
*
* Skip an XML (SGML) comment
* The spec says that "For compatibility, the string "--" (double-hyphen)
@@ -5198,10 +5137,9 @@ not_terminated:
}
/**
- * xmlParseComment:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Parse an XML (SGML) comment. Always consumes ''
*
- * Returns the element name parsed
+ * @returns the element name parsed
*/
const xmlChar *
@@ -8516,9 +8424,8 @@ failed:
}
/**
- * xmlParseEndTag1:
- * @ctxt: an XML parser context
- * @line: line of the start tag
+ * @param ctxt an XML parser context
+ * @param line line of the start tag
*
* Parse an end tag. Always consumes ''
*
- * Returns the element name parsed
+ * @returns the element name parsed
*/
static const xmlChar *
@@ -9580,9 +9480,8 @@ done:
}
/**
- * xmlParseEndTag2:
- * @ctxt: an XML parser context
- * @tag: the corresponding start tag
+ * @param ctxt an XML parser context
+ * @param tag the corresponding start tag
*
* Parse an end tag. Always consumes 'myDoc. This pointer will not
* be freed when calling xmlFreeParserCtxt and must be freed by the
* caller. If the document isn't well-formed, it will still be returned
@@ -11500,7 +11375,7 @@ done:
* ctxt->myDoc. So ctxt->myDoc should be set to NULL after extracting
* the document.
*
- * Returns an xmlParserErrors code (0 on success).
+ * @returns an xmlParserErrors code (0 on success).
*/
int
xmlParseChunk(xmlParserCtxtPtr ctxt, const char *chunk, int size,
@@ -11606,12 +11481,11 @@ xmlParseChunk(xmlParserCtxtPtr ctxt, const char *chunk, int size,
************************************************************************/
/**
- * xmlCreatePushParserCtxt:
- * @sax: a SAX handler (optional)
- * @user_data: user data for SAX callbacks (optional)
- * @chunk: initial chunk (optional, deprecated)
- * @size: size of initial chunk in bytes
- * @filename: file name or URI (optional)
+ * @param sax a SAX handler (optional)
+ * @param user_data user data for SAX callbacks (optional)
+ * @param chunk initial chunk (optional, deprecated)
+ * @param size size of initial chunk in bytes
+ * @param filename file name or URI (optional)
*
* Create a parser context for using the XML parser in push mode.
* See xmlParseChunk.
@@ -11621,10 +11495,10 @@ xmlParseChunk(xmlParserCtxtPtr ctxt, const char *chunk, int size,
* The push parser doesn't support recovery mode or the
* XML_PARSE_NOBLANKS option.
*
- * @filename is used as base URI to fetch external entities and for
+ * `filename` is used as base URI to fetch external entities and for
* error reports.
*
- * Returns the new parser context or NULL if a memory allocation
+ * @returns the new parser context or NULL if a memory allocation
* failed.
*/
@@ -11657,8 +11531,7 @@ xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax, void *user_data,
#endif /* LIBXML_PUSH_ENABLED */
/**
- * xmlStopParser:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Blocks further parser processing
*/
@@ -11672,18 +11545,17 @@ xmlStopParser(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCreateIOParserCtxt:
- * @sax: a SAX handler (optional)
- * @user_data: user data for SAX callbacks (optional)
- * @ioread: an I/O read function
- * @ioclose: an I/O close function (optional)
- * @ioctx: an I/O handler
- * @enc: the charset encoding if known (deprecated)
+ * @param sax a SAX handler (optional)
+ * @param user_data user data for SAX callbacks (optional)
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function (optional)
+ * @param ioctx an I/O handler
+ * @param enc the charset encoding if known (deprecated)
*
* Create a parser context for using the XML parser with an existing
* I/O stream
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
xmlParserCtxtPtr
xmlCreateIOParserCtxt(xmlSAXHandlerPtr sax, void *user_data,
@@ -11722,11 +11594,10 @@ xmlCreateIOParserCtxt(xmlSAXHandlerPtr sax, void *user_data,
************************************************************************/
/**
- * xmlCtxtParseDtd:
- * @ctxt: a parser context
- * @input: a parser input
- * @publicId: public ID of the DTD (optional)
- * @systemId: system ID of the DTD (optional)
+ * @param ctxt a parser context
+ * @param input a parser input
+ * @param publicId public ID of the DTD (optional)
+ * @param systemId system ID of the DTD (optional)
*
* Parse a DTD.
*
@@ -11735,8 +11606,8 @@ xmlCreateIOParserCtxt(xmlSAXHandlerPtr sax, void *user_data,
*
* Availabe since 2.14.0.
*
- * Returns the resulting xmlDtdPtr or NULL in case of error.
- * @input will be freed by the function in any case.
+ * @returns the resulting xmlDtdPtr or NULL in case of error.
+ * `input` will be freed by the function in any case.
*/
xmlDtdPtr
xmlCtxtParseDtd(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
@@ -11801,17 +11672,16 @@ error:
}
/**
- * xmlIOParseDTD:
- * @sax: the SAX handler block or NULL
- * @input: an Input Buffer
- * @enc: the charset encoding if known
+ * @param sax the SAX handler block or NULL
+ * @param input an Input Buffer
+ * @param enc the charset encoding if known
*
- * DEPRECATED: Use xmlCtxtParseDtd.
+ * @deprecated Use xmlCtxtParseDtd.
*
* Load and parse a DTD
*
- * Returns the resulting xmlDtdPtr or NULL in case of error.
- * @input will be freed by the function in any case.
+ * @returns the resulting xmlDtdPtr or NULL in case of error.
+ * `input` will be freed by the function in any case.
*/
xmlDtdPtr
@@ -11853,16 +11723,15 @@ xmlIOParseDTD(xmlSAXHandlerPtr sax, xmlParserInputBufferPtr input,
}
/**
- * xmlSAXParseDTD:
- * @sax: the SAX handler block
- * @ExternalID: a NAME* containing the External ID of the DTD
- * @SystemID: a NAME* containing the URL to the DTD
+ * @param sax the SAX handler block
+ * @param ExternalID a NAME* containing the External ID of the DTD
+ * @param SystemID a NAME* containing the URL to the DTD
*
- * DEPRECATED: Use xmlCtxtParseDtd.
+ * @deprecated Use xmlCtxtParseDtd.
*
* Load and parse an external subset.
*
- * Returns the resulting xmlDtdPtr or NULL in case of error.
+ * @returns the resulting xmlDtdPtr or NULL in case of error.
*/
xmlDtdPtr
@@ -11917,13 +11786,12 @@ xmlSAXParseDTD(xmlSAXHandlerPtr sax, const xmlChar *ExternalID,
/**
- * xmlParseDTD:
- * @ExternalID: a NAME* containing the External ID of the DTD
- * @SystemID: a NAME* containing the URL to the DTD
+ * @param ExternalID a NAME* containing the External ID of the DTD
+ * @param SystemID a NAME* containing the URL to the DTD
*
* Load and parse an external subset.
*
- * Returns the resulting xmlDtdPtr or NULL in case of error.
+ * @returns the resulting xmlDtdPtr or NULL in case of error.
*/
xmlDtdPtr
@@ -12140,11 +12008,10 @@ error:
}
/**
- * xmlParseCtxtExternalEntity:
- * @ctxt: the existing parsing context
- * @URL: the URL for the entity to load
- * @ID: the System ID for the entity to load
- * @listOut: the return value for the set of parsed nodes
+ * @param ctxt the existing parsing context
+ * @param URL the URL for the entity to load
+ * @param ID the System ID for the entity to load
+ * @param listOut the return value for the set of parsed nodes
*
* Parse an external general entity within an existing parsing context
* An external general parsed entity is well-formed if it matches the
@@ -12152,7 +12019,7 @@ error:
*
* [78] extParsedEnt ::= TextDecl? content
*
- * Returns 0 if the entity is well formed, -1 in case of args problem and
+ * @returns 0 if the entity is well formed, -1 in case of args problem and
* the parser error code otherwise
*/
@@ -12187,16 +12054,15 @@ xmlParseCtxtExternalEntity(xmlParserCtxtPtr ctxt, const xmlChar *URL,
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlParseExternalEntity:
- * @doc: the document the chunk pertains to
- * @sax: the SAX handler block (possibly NULL)
- * @user_data: The user data returned on SAX callbacks (possibly NULL)
- * @depth: Used for loop detection, use 0
- * @URL: the URL for the entity to load
- * @ID: the System ID for the entity to load
- * @list: the return value for the set of parsed nodes
+ * @param doc the document the chunk pertains to
+ * @param sax the SAX handler block (possibly NULL)
+ * @param user_data The user data returned on SAX callbacks (possibly NULL)
+ * @param depth Used for loop detection, use 0
+ * @param URL the URL for the entity to load
+ * @param ID the System ID for the entity to load
+ * @param list the return value for the set of parsed nodes
*
- * DEPRECATED: Use xmlParseCtxtExternalEntity.
+ * @deprecated Use xmlParseCtxtExternalEntity.
*
* Parse an external general entity
* An external general parsed entity is well-formed if it matches the
@@ -12204,7 +12070,7 @@ xmlParseCtxtExternalEntity(xmlParserCtxtPtr ctxt, const xmlChar *URL,
*
* [78] extParsedEnt ::= TextDecl? content
*
- * Returns 0 if the entity is well formed, -1 in case of args problem and
+ * @returns 0 if the entity is well formed, -1 in case of args problem and
* the parser error code otherwise
*/
@@ -12233,13 +12099,12 @@ xmlParseExternalEntity(xmlDocPtr doc, xmlSAXHandlerPtr sax, void *user_data,
}
/**
- * xmlParseBalancedChunkMemory:
- * @doc: the document the chunk pertains to (must not be NULL)
- * @sax: the SAX handler block (possibly NULL)
- * @user_data: The user data returned on SAX callbacks (possibly NULL)
- * @depth: Used for loop detection, use 0
- * @string: the input string in UTF8 or ISO-Latin (zero terminated)
- * @lst: the return value for the set of parsed nodes
+ * @param doc the document the chunk pertains to (must not be NULL)
+ * @param sax the SAX handler block (possibly NULL)
+ * @param user_data The user data returned on SAX callbacks (possibly NULL)
+ * @param depth Used for loop detection, use 0
+ * @param string the input string in UTF8 or ISO-Latin (zero terminated)
+ * @param lst the return value for the set of parsed nodes
*
* Parse a well-balanced chunk of an XML document
* called by the parser
@@ -12248,7 +12113,7 @@ xmlParseExternalEntity(xmlDocPtr doc, xmlSAXHandlerPtr sax, void *user_data,
*
* [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*
*
- * Returns 0 if the chunk is well balanced, -1 in case of args problem and
+ * @returns 0 if the chunk is well balanced, -1 in case of args problem and
* the parser error code otherwise
*/
@@ -12261,22 +12126,21 @@ xmlParseBalancedChunkMemory(xmlDocPtr doc, xmlSAXHandlerPtr sax,
#endif /* LIBXML_SAX1_ENABLED */
/**
- * xmlCtxtParseContent:
- * @ctxt: parser context
- * @input: parser input
- * @node: target node or document
- * @hasTextDecl: whether to parse text declaration
+ * @param ctxt parser context
+ * @param input parser input
+ * @param node target node or document
+ * @param hasTextDecl whether to parse text declaration
*
* Parse a well-balanced chunk of XML matching the 'content' production.
*
- * Namespaces in scope of @node and entities of @node's document are
- * recognized. When validating, the DTD of @node's document is used.
+ * Namespaces in scope of `node` and entities of `node`'s document are
+ * recognized. When validating, the DTD of `node`'s document is used.
*
- * Always consumes @input even in error case.
+ * Always consumes `input` even in error case.
*
* Available since 2.14.0.
*
- * Returns a node list or NULL in case of error.
+ * @returns a node list or NULL in case of error.
*/
xmlNodePtr
xmlCtxtParseContent(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
@@ -12405,12 +12269,11 @@ exit:
}
/**
- * xmlParseInNodeContext:
- * @node: the context node
- * @data: the input string
- * @datalen: the input string length in bytes
- * @options: a combination of xmlParserOption
- * @listOut: the return value for the set of parsed nodes
+ * @param node the context node
+ * @param data the input string
+ * @param datalen the input string length in bytes
+ * @param options a combination of xmlParserOption
+ * @param listOut the return value for the set of parsed nodes
*
* Parse a well-balanced chunk of an XML document
* within the context (DTD, namespaces, etc ...) of the given node.
@@ -12420,11 +12283,11 @@ exit:
*
* [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*
*
- * This function assumes the encoding of @node's document which is
+ * This function assumes the encoding of `node`'s document which is
* typically not what you want. A better alternative is
* xmlCtxtParseContent.
*
- * Returns XML_ERR_OK if the chunk is well balanced, and the parser
+ * @returns XML_ERR_OK if the chunk is well balanced, and the parser
* error code otherwise
*/
xmlParserErrors
@@ -12486,14 +12349,13 @@ xmlParseInNodeContext(xmlNodePtr node, const char *data, int datalen,
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlParseBalancedChunkMemoryRecover:
- * @doc: the document the chunk pertains to (must not be NULL)
- * @sax: the SAX handler block (possibly NULL)
- * @user_data: The user data returned on SAX callbacks (possibly NULL)
- * @depth: Used for loop detection, use 0
- * @string: the input string in UTF8 or ISO-Latin (zero terminated)
- * @listOut: the return value for the set of parsed nodes
- * @recover: return nodes even if the data is broken (use 0)
+ * @param doc the document the chunk pertains to (must not be NULL)
+ * @param sax the SAX handler block (possibly NULL)
+ * @param user_data The user data returned on SAX callbacks (possibly NULL)
+ * @param depth Used for loop detection, use 0
+ * @param string the input string in UTF8 or ISO-Latin (zero terminated)
+ * @param listOut the return value for the set of parsed nodes
+ * @param recover return nodes even if the data is broken (use 0)
*
* Parse a well-balanced chunk of an XML document
*
@@ -12502,7 +12364,7 @@ xmlParseInNodeContext(xmlNodePtr node, const char *data, int datalen,
*
* [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*
*
- * Returns 0 if the chunk is well balanced, or thehe parser error code
+ * @returns 0 if the chunk is well balanced, or thehe parser error code
* otherwise.
*
* In case recover is set to 1, the nodelist will not be empty even if
@@ -12561,11 +12423,10 @@ error:
}
/**
- * xmlSAXParseEntity:
- * @sax: the SAX handler block
- * @filename: the filename
+ * @param sax the SAX handler block
+ * @param filename the filename
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* parse an XML external entity out of context and build a tree.
* It use the given SAX function block to handle the parsing callback.
@@ -12575,7 +12436,7 @@ error:
*
* This correspond to a "Well Balanced" chunk
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -12612,8 +12473,7 @@ xmlSAXParseEntity(xmlSAXHandlerPtr sax, const char *filename) {
}
/**
- * xmlParseEntity:
- * @filename: the filename
+ * @param filename the filename
*
* parse an XML external entity out of context and build a tree.
*
@@ -12621,7 +12481,7 @@ xmlSAXParseEntity(xmlSAXHandlerPtr sax, const char *filename) {
*
* This correspond to a "Well Balanced" chunk
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -12631,18 +12491,17 @@ xmlParseEntity(const char *filename) {
#endif /* LIBXML_SAX1_ENABLED */
/**
- * xmlCreateEntityParserCtxt:
- * @URL: the entity URL
- * @ID: the entity PUBLIC ID
- * @base: a possible base for the target URI
+ * @param URL the entity URL
+ * @param ID the entity PUBLIC ID
+ * @param base a possible base for the target URI
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Create a parser context for an external entity
* Automatic support for ZLIB/Compress compressed document is provided
* by default if found at compile-time.
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
xmlParserCtxtPtr
xmlCreateEntityParserCtxt(const xmlChar *URL, const xmlChar *ID,
@@ -12688,17 +12547,16 @@ error:
************************************************************************/
/**
- * xmlCreateURLParserCtxt:
- * @filename: the filename or URL
- * @options: a combination of xmlParserOption
+ * @param filename the filename or URL
+ * @param options a combination of xmlParserOption
*
- * DEPRECATED: Use xmlNewParserCtxt and xmlCtxtReadFile.
+ * @deprecated Use xmlNewParserCtxt and xmlCtxtReadFile.
*
* Create a parser context for a file or URL content.
* Automatic support for ZLIB/Compress compressed document is provided
* by default if found at compile-time and for file accesses
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
xmlParserCtxtPtr
xmlCreateURLParserCtxt(const char *filename, int options)
@@ -12730,16 +12588,15 @@ xmlCreateURLParserCtxt(const char *filename, int options)
}
/**
- * xmlCreateFileParserCtxt:
- * @filename: the filename
+ * @param filename the filename
*
- * DEPRECATED: Use xmlNewParserCtxt and xmlCtxtReadFile.
+ * @deprecated Use xmlNewParserCtxt and xmlCtxtReadFile.
*
* Create a parser context for a file content.
* Automatic support for ZLIB/Compress compressed document is provided
* by default if found at compile-time.
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
xmlParserCtxtPtr
xmlCreateFileParserCtxt(const char *filename)
@@ -12749,14 +12606,13 @@ xmlCreateFileParserCtxt(const char *filename)
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlSAXParseFileWithData:
- * @sax: the SAX handler block
- * @filename: the filename
- * @recovery: work in recovery mode, i.e. tries to read no Well Formed
+ * @param sax the SAX handler block
+ * @param filename the filename
+ * @param recovery work in recovery mode, i.e. tries to read no Well Formed
* documents
- * @data: the userdata
+ * @param data the userdata
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadFile.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadFile.
*
* parse an XML file and build a tree. Automatic support for ZLIB/Compress
* compressed document is provided by default if found at compile-time.
@@ -12766,7 +12622,7 @@ xmlCreateFileParserCtxt(const char *filename)
* User data (void *) is stored within the parser context in the
* context's _private member, so it is available nearly everywhere in libxml
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -12801,20 +12657,19 @@ xmlSAXParseFileWithData(xmlSAXHandlerPtr sax, const char *filename,
}
/**
- * xmlSAXParseFile:
- * @sax: the SAX handler block
- * @filename: the filename
- * @recovery: work in recovery mode, i.e. tries to read no Well Formed
+ * @param sax the SAX handler block
+ * @param filename the filename
+ * @param recovery work in recovery mode, i.e. tries to read no Well Formed
* documents
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadFile.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadFile.
*
* parse an XML file and build a tree. Automatic support for ZLIB/Compress
* compressed document is provided by default if found at compile-time.
* It use the given SAX function block to handle the parsing callback.
* If sax is NULL, fallback to the default DOM tree building routines.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -12824,16 +12679,15 @@ xmlSAXParseFile(xmlSAXHandlerPtr sax, const char *filename,
}
/**
- * xmlRecoverDoc:
- * @cur: a pointer to an array of xmlChar
+ * @param cur a pointer to an array of xmlChar
*
- * DEPRECATED: Use xmlReadDoc with XML_PARSE_RECOVER.
+ * @deprecated Use xmlReadDoc with XML_PARSE_RECOVER.
*
* parse an XML in-memory document and build a tree.
* In the case the document is not Well Formed, a attempt to build a
* tree is tried anyway
*
- * Returns the resulting document tree or NULL in case of failure
+ * @returns the resulting document tree or NULL in case of failure
*/
xmlDocPtr
@@ -12842,15 +12696,14 @@ xmlRecoverDoc(const xmlChar *cur) {
}
/**
- * xmlParseFile:
- * @filename: the filename
+ * @param filename the filename
*
- * DEPRECATED: Use xmlReadFile.
+ * @deprecated Use xmlReadFile.
*
* parse an XML file and build a tree. Automatic support for ZLIB/Compress
* compressed document is provided by default if found at compile-time.
*
- * Returns the resulting document tree if the file was wellformed,
+ * @returns the resulting document tree if the file was wellformed,
* NULL otherwise.
*/
@@ -12860,17 +12713,16 @@ xmlParseFile(const char *filename) {
}
/**
- * xmlRecoverFile:
- * @filename: the filename
+ * @param filename the filename
*
- * DEPRECATED: Use xmlReadFile with XML_PARSE_RECOVER.
+ * @deprecated Use xmlReadFile with XML_PARSE_RECOVER.
*
* parse an XML file and build a tree. Automatic support for ZLIB/Compress
* compressed document is provided by default if found at compile-time.
* In the case the document is not Well Formed, it attempts to build
* a tree anyway
*
- * Returns the resulting document tree or NULL in case of failure
+ * @returns the resulting document tree or NULL in case of failure
*/
xmlDocPtr
@@ -12880,12 +12732,11 @@ xmlRecoverFile(const char *filename) {
/**
- * xmlSetupParserForBuffer:
- * @ctxt: an XML parser context
- * @buffer: a xmlChar * buffer
- * @filename: a file name
+ * @param ctxt an XML parser context
+ * @param buffer a xmlChar * buffer
+ * @param filename a file name
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Setup the parser context to parse a new buffer; Clears any prior
* contents from the parser context. The buffer parameter must not be
@@ -12911,17 +12762,16 @@ xmlSetupParserForBuffer(xmlParserCtxtPtr ctxt, const xmlChar* buffer,
}
/**
- * xmlSAXUserParseFile:
- * @sax: a SAX handler
- * @user_data: The user data returned on SAX callbacks
- * @filename: a file name
+ * @param sax a SAX handler
+ * @param user_data The user data returned on SAX callbacks
+ * @param filename a file name
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadFile.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadFile.
*
* parse an XML file and call the given SAX handler routines.
* Automatic support for ZLIB/Compress compressed document is provided
*
- * Returns 0 in case of success or a error number otherwise
+ * @returns 0 in case of success or a error number otherwise
*/
int
xmlSAXUserParseFile(xmlSAXHandlerPtr sax, void *user_data,
@@ -12968,14 +12818,13 @@ xmlSAXUserParseFile(xmlSAXHandlerPtr sax, void *user_data,
************************************************************************/
/**
- * xmlCreateMemoryParserCtxt:
- * @buffer: a pointer to a char array
- * @size: the size of the array
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
*
* Create a parser context for an XML in-memory document. The input buffer
* must not contain a terminating null byte.
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
xmlParserCtxtPtr
xmlCreateMemoryParserCtxt(const char *buffer, int size) {
@@ -13005,15 +12854,14 @@ xmlCreateMemoryParserCtxt(const char *buffer, int size) {
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlSAXParseMemoryWithData:
- * @sax: the SAX handler block
- * @buffer: an pointer to a char array
- * @size: the size of the array
- * @recovery: work in recovery mode, i.e. tries to read no Well Formed
+ * @param sax the SAX handler block
+ * @param buffer an pointer to a char array
+ * @param size the size of the array
+ * @param recovery work in recovery mode, i.e. tries to read no Well Formed
* documents
- * @data: the userdata
+ * @param data the userdata
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadMemory.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadMemory.
*
* parse an XML in-memory block and use the given SAX function block
* to handle the parsing callback. If sax is NULL, fallback to the default
@@ -13022,7 +12870,7 @@ xmlCreateMemoryParserCtxt(const char *buffer, int size) {
* User data (void *) is stored within the parser context in the
* context's _private member, so it is available nearly everywhere in libxml
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -13058,20 +12906,19 @@ xmlSAXParseMemoryWithData(xmlSAXHandlerPtr sax, const char *buffer,
}
/**
- * xmlSAXParseMemory:
- * @sax: the SAX handler block
- * @buffer: an pointer to a char array
- * @size: the size of the array
- * @recovery: work in recovery mode, i.e. tries to read not Well Formed
+ * @param sax the SAX handler block
+ * @param buffer an pointer to a char array
+ * @param size the size of the array
+ * @param recovery work in recovery mode, i.e. tries to read not Well Formed
* documents
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadMemory.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadMemory.
*
* parse an XML in-memory block and use the given SAX function block
* to handle the parsing callback. If sax is NULL, fallback to the default
* DOM tree building routines.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlSAXParseMemory(xmlSAXHandlerPtr sax, const char *buffer,
@@ -13080,15 +12927,14 @@ xmlSAXParseMemory(xmlSAXHandlerPtr sax, const char *buffer,
}
/**
- * xmlParseMemory:
- * @buffer: an pointer to a char array
- * @size: the size of the array
+ * @param buffer an pointer to a char array
+ * @param size the size of the array
*
- * DEPRECATED: Use xmlReadMemory.
+ * @deprecated Use xmlReadMemory.
*
* parse an XML in-memory block and build a tree.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr xmlParseMemory(const char *buffer, int size) {
@@ -13096,17 +12942,16 @@ xmlDocPtr xmlParseMemory(const char *buffer, int size) {
}
/**
- * xmlRecoverMemory:
- * @buffer: an pointer to a char array
- * @size: the size of the array
+ * @param buffer an pointer to a char array
+ * @param size the size of the array
*
- * DEPRECATED: Use xmlReadMemory with XML_PARSE_RECOVER.
+ * @deprecated Use xmlReadMemory with XML_PARSE_RECOVER.
*
* parse an XML in-memory block and build a tree.
* In the case the document is not Well Formed, an attempt to
* build a tree is tried anyway
*
- * Returns the resulting document tree or NULL in case of error
+ * @returns the resulting document tree or NULL in case of error
*/
xmlDocPtr xmlRecoverMemory(const char *buffer, int size) {
@@ -13114,17 +12959,16 @@ xmlDocPtr xmlRecoverMemory(const char *buffer, int size) {
}
/**
- * xmlSAXUserParseMemory:
- * @sax: a SAX handler
- * @user_data: The user data returned on SAX callbacks
- * @buffer: an in-memory XML document input
- * @size: the length of the XML document in bytes
+ * @param sax a SAX handler
+ * @param user_data The user data returned on SAX callbacks
+ * @param buffer an in-memory XML document input
+ * @param size the length of the XML document in bytes
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadMemory.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadMemory.
*
* parse an XML in-memory buffer and call the given SAX handler routines.
*
- * Returns 0 in case of success or a error number otherwise
+ * @returns 0 in case of success or a error number otherwise
*/
int xmlSAXUserParseMemory(xmlSAXHandlerPtr sax, void *user_data,
const char *buffer, int size) {
@@ -13164,12 +13008,11 @@ int xmlSAXUserParseMemory(xmlSAXHandlerPtr sax, void *user_data,
#endif /* LIBXML_SAX1_ENABLED */
/**
- * xmlCreateDocParserCtxt:
- * @str: a pointer to an array of xmlChar
+ * @param str a pointer to an array of xmlChar
*
* Creates a parser context for an XML in-memory document.
*
- * Returns the new parser context or NULL
+ * @returns the new parser context or NULL
*/
xmlParserCtxtPtr
xmlCreateDocParserCtxt(const xmlChar *str) {
@@ -13196,19 +13039,18 @@ xmlCreateDocParserCtxt(const xmlChar *str) {
#ifdef LIBXML_SAX1_ENABLED
/**
- * xmlSAXParseDoc:
- * @sax: the SAX handler block
- * @cur: a pointer to an array of xmlChar
- * @recovery: work in recovery mode, i.e. tries to read no Well Formed
+ * @param sax the SAX handler block
+ * @param cur a pointer to an array of xmlChar
+ * @param recovery work in recovery mode, i.e. tries to read no Well Formed
* documents
*
- * DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadDoc.
+ * @deprecated Use xmlNewSAXParserCtxt and xmlCtxtReadDoc.
*
* parse an XML in-memory document and build a tree.
* It use the given SAX function block to handle the parsing callback.
* If sax is NULL, fallback to the default DOM tree building routines.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -13243,14 +13085,13 @@ xmlSAXParseDoc(xmlSAXHandlerPtr sax, const xmlChar *cur, int recovery) {
}
/**
- * xmlParseDoc:
- * @cur: a pointer to an array of xmlChar
+ * @param cur a pointer to an array of xmlChar
*
- * DEPRECATED: Use xmlReadDoc.
+ * @deprecated Use xmlReadDoc.
*
* parse an XML in-memory document and build a tree.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
@@ -13267,7 +13108,7 @@ xmlParseDoc(const xmlChar *cur) {
/**
* DICT_FREE:
- * @str: a string
+ * @param str a string
*
* Free a string if it is not owned by the "dict" dictionary in the
* current scope
@@ -13278,8 +13119,7 @@ xmlParseDoc(const xmlChar *cur) {
xmlFree((char *)(str));
/**
- * xmlCtxtReset:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Reset a parser context
*/
@@ -13377,16 +13217,15 @@ xmlCtxtReset(xmlParserCtxtPtr ctxt)
}
/**
- * xmlCtxtResetPush:
- * @ctxt: an XML parser context
- * @chunk: a pointer to an array of chars
- * @size: number of chars in the array
- * @filename: an optional file name or URI
- * @encoding: the document encoding, or NULL
+ * @param ctxt an XML parser context
+ * @param chunk a pointer to an array of chars
+ * @param size number of chars in the array
+ * @param filename an optional file name or URI
+ * @param encoding the document encoding, or NULL
*
* Reset a push parser context
*
- * Returns 0 in case of success and 1 in case of error
+ * @returns 0 in case of success and 1 in case of error
*/
int
xmlCtxtResetPush(xmlParserCtxtPtr ctxt, const char *chunk,
@@ -13492,9 +13331,8 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask)
}
/**
- * xmlCtxtSetOptions:
- * @ctxt: an XML parser context
- * @options: a bitmask of xmlParserOption values
+ * @param ctxt an XML parser context
+ * @param options a bitmask of xmlParserOption values
*
* Applies the options to the parser context. Unset options are
* cleared.
@@ -13665,7 +13503,7 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask)
*
* Available since 2.14.0.
*
- * Returns 0 in case of success, the set of unknown or unimplemented options
+ * @returns 0 in case of success, the set of unknown or unimplemented options
* in case of error.
*/
int
@@ -13680,14 +13518,13 @@ xmlCtxtSetOptions(xmlParserCtxtPtr ctxt, int options)
}
/**
- * xmlCtxtGetOptions:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Get the current options of the parser context.
*
* Available since 2.14.0.
*
- * Returns the current options set in the parser context, or -1 if ctxt is NULL.
+ * @returns the current options set in the parser context, or -1 if ctxt is NULL.
*/
int
xmlCtxtGetOptions(xmlParserCtxtPtr ctxt)
@@ -13699,11 +13536,10 @@ xmlCtxtGetOptions(xmlParserCtxtPtr ctxt)
}
/**
- * xmlCtxtUseOptions:
- * @ctxt: an XML parser context
- * @options: a combination of xmlParserOption
+ * @param ctxt an XML parser context
+ * @param options a combination of xmlParserOption
*
- * DEPRECATED: Use xmlCtxtSetOptions.
+ * @deprecated Use xmlCtxtSetOptions.
*
* Applies the options to the parser context. The following options
* are never cleared and can only be enabled:
@@ -13720,7 +13556,7 @@ xmlCtxtGetOptions(xmlParserCtxtPtr ctxt)
* XML_PARSE_IGNORE_ENC
* XML_PARSE_BIG_LINES
*
- * Returns 0 in case of success, the set of unknown or unimplemented options
+ * @returns 0 in case of success, the set of unknown or unimplemented options
* in case of error.
*/
int
@@ -13752,9 +13588,8 @@ xmlCtxtUseOptions(xmlParserCtxtPtr ctxt, int options)
}
/**
- * xmlCtxtSetMaxAmplification:
- * @ctxt: an XML parser context
- * @maxAmpl: maximum amplification factor
+ * @param ctxt an XML parser context
+ * @param maxAmpl maximum amplification factor
*
* To protect against exponential entity expansion ("billion laughs"), the
* size of serialized output is (roughly) limited to the input size
@@ -13773,16 +13608,15 @@ xmlCtxtSetMaxAmplification(xmlParserCtxtPtr ctxt, unsigned maxAmpl)
}
/**
- * xmlCtxtParseDocument:
- * @ctxt: an XML parser context
- * @input: parser input
+ * @param ctxt an XML parser context
+ * @param input parser input
*
* Parse an XML document and return the resulting document tree.
* Takes ownership of the input object.
*
* Available since 2.13.0.
*
- * Returns the resulting document tree or NULL
+ * @returns the resulting document tree or NULL
*/
xmlDocPtr
xmlCtxtParseDocument(xmlParserCtxtPtr ctxt, xmlParserInputPtr input)
@@ -13816,18 +13650,17 @@ xmlCtxtParseDocument(xmlParserCtxtPtr ctxt, xmlParserInputPtr input)
}
/**
- * xmlReadDoc:
- * @cur: a pointer to a zero terminated string
- * @URL: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param cur a pointer to a zero terminated string
+ * @param URL base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Convenience function to parse an XML document from a
* zero-terminated string.
*
* See xmlCtxtReadDoc for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlReadDoc(const xmlChar *cur, const char *URL, const char *encoding,
@@ -13854,10 +13687,9 @@ xmlReadDoc(const xmlChar *cur, const char *URL, const char *encoding,
}
/**
- * xmlReadFile:
- * @filename: a file or URL
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param filename a file or URL
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Convenience function to parse an XML file from the filesystem,
* the network or a global user-define resource loader.
@@ -13869,7 +13701,7 @@ xmlReadDoc(const xmlChar *cur, const char *URL, const char *encoding,
*
* See xmlCtxtReadFile for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlReadFile(const char *filename, const char *encoding, int options)
@@ -13905,19 +13737,18 @@ xmlReadFile(const char *filename, const char *encoding, int options)
}
/**
- * xmlReadMemory:
- * @buffer: a pointer to a char array
- * @size: the size of the array
- * @url: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
+ * @param url base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML in-memory document and build a tree. The input buffer must
* not contain a terminating null byte.
*
* See xmlCtxtReadMemory for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlReadMemory(const char *buffer, int size, const char *url,
@@ -13947,11 +13778,10 @@ xmlReadMemory(const char *buffer, int size, const char *url,
}
/**
- * xmlReadFd:
- * @fd: an open file descriptor
- * @URL: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param fd an open file descriptor
+ * @param URL base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML from a file descriptor and build a tree.
*
@@ -13960,7 +13790,7 @@ xmlReadMemory(const char *buffer, int size, const char *url,
* NOTE that the file descriptor will not be closed when the
* context is freed or reset.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlReadFd(int fd, const char *URL, const char *encoding, int options)
@@ -13985,19 +13815,18 @@ xmlReadFd(int fd, const char *URL, const char *encoding, int options)
}
/**
- * xmlReadIO:
- * @ioread: an I/O read function
- * @ioclose: an I/O close function (optional)
- * @ioctx: an I/O handler
- * @URL: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function (optional)
+ * @param ioctx an I/O handler
+ * @param URL base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML document from I/O functions and context and build a tree.
*
* See xmlCtxtReadIO for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose,
@@ -14024,21 +13853,20 @@ xmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose,
}
/**
- * xmlCtxtReadDoc:
- * @ctxt: an XML parser context
- * @str: a pointer to a zero terminated string
- * @URL: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param ctxt an XML parser context
+ * @param str a pointer to a zero terminated string
+ * @param URL base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML in-memory document and build a tree.
*
- * @URL is used as base to resolve external entities and for error
+ * `URL` is used as base to resolve external entities and for error
* reporting.
*
* See xmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlCtxtReadDoc(xmlParserCtxtPtr ctxt, const xmlChar *str,
@@ -14061,11 +13889,10 @@ xmlCtxtReadDoc(xmlParserCtxtPtr ctxt, const xmlChar *str,
}
/**
- * xmlCtxtReadFile:
- * @ctxt: an XML parser context
- * @filename: a file or URL
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param ctxt an XML parser context
+ * @param filename a file or URL
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML file from the filesystem, the network or a user-defined
* resource loader.
@@ -14074,7 +13901,7 @@ xmlCtxtReadDoc(xmlParserCtxtPtr ctxt, const xmlChar *str,
* backward compatibility. This feature is potentially insecure
* and might be removed from later versions.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlCtxtReadFile(xmlParserCtxtPtr ctxt, const char *filename,
@@ -14098,23 +13925,22 @@ xmlCtxtReadFile(xmlParserCtxtPtr ctxt, const char *filename,
}
/**
- * xmlCtxtReadMemory:
- * @ctxt: an XML parser context
- * @buffer: a pointer to a char array
- * @size: the size of the array
- * @URL: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param ctxt an XML parser context
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
+ * @param URL base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML in-memory document and build a tree. The input buffer must
* not contain a terminating null byte.
*
- * @URL is used as base to resolve external entities and for error
+ * `URL` is used as base to resolve external entities and for error
* reporting.
*
* See xmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlCtxtReadMemory(xmlParserCtxtPtr ctxt, const char *buffer, int size,
@@ -14137,24 +13963,23 @@ xmlCtxtReadMemory(xmlParserCtxtPtr ctxt, const char *buffer, int size,
}
/**
- * xmlCtxtReadFd:
- * @ctxt: an XML parser context
- * @fd: an open file descriptor
- * @URL: base URL (optional)
- * @encoding: the document encoding (optional)
- * @options: a combination of xmlParserOption
+ * @param ctxt an XML parser context
+ * @param fd an open file descriptor
+ * @param URL base URL (optional)
+ * @param encoding the document encoding (optional)
+ * @param options a combination of xmlParserOption
*
* Parse an XML document from a file descriptor and build a tree.
*
* NOTE that the file descriptor will not be closed when the
* context is freed or reset.
*
- * @URL is used as base to resolve external entities and for error
+ * `URL` is used as base to resolve external entities and for error
* reporting.
*
* See xmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlCtxtReadFd(xmlParserCtxtPtr ctxt, int fd,
@@ -14176,24 +14001,23 @@ xmlCtxtReadFd(xmlParserCtxtPtr ctxt, int fd,
}
/**
- * xmlCtxtReadIO:
- * @ctxt: an XML parser context
- * @ioread: an I/O read function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param ctxt an XML parser context
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* parse an XML document from I/O functions and source and build a tree.
- * This reuses the existing @ctxt parser context
+ * This reuses the existing `ctxt` parser context
*
- * @URL is used as base to resolve external entities and for error
+ * `URL` is used as base to resolve external entities and for error
* reporting.
*
* See xmlCtxtUseOptions for details.
*
- * Returns the resulting document tree
+ * @returns the resulting document tree
*/
xmlDocPtr
xmlCtxtReadIO(xmlParserCtxtPtr ctxt, xmlInputReadCallback ioread,
diff --git a/parserInternals.c b/parserInternals.c
index bcec6b76..6382f924 100644
--- a/parserInternals.c
+++ b/parserInternals.c
@@ -63,8 +63,7 @@
*/
/**
- * xmlCheckVersion:
- * @version: the include version number
+ * @param version the include version number
*
* check the compiled lib version against the include one.
*/
@@ -94,10 +93,9 @@ xmlCheckVersion(int version) {
/**
- * xmlCtxtSetErrorHandler:
- * @ctxt: an XML parser context
- * @handler: error handler
- * @data: data for error handler
+ * @param ctxt an XML parser context
+ * @param handler error handler
+ * @param data data for error handler
*
* Register a callback function that will be called on errors and
* warnings. If handler is NULL, the error handler will be deactivated.
@@ -126,12 +124,11 @@ xmlCtxtSetErrorHandler(xmlParserCtxtPtr ctxt, xmlStructuredErrorFunc handler,
}
/**
- * xmlCtxtGetLastError:
- * @ctx: an XML parser context
+ * @param ctx an XML parser context
*
* Get the last parsing error registered.
*
- * Returns NULL if no error occurred or a pointer to the error
+ * @returns NULL if no error occurred or a pointer to the error
*/
const xmlError *
xmlCtxtGetLastError(void *ctx)
@@ -146,8 +143,7 @@ xmlCtxtGetLastError(void *ctx)
}
/**
- * xmlCtxtResetLastError:
- * @ctx: an XML parser context
+ * @param ctx an XML parser context
*
* Cleanup the last global error registered. For parsing error
* this does not change the well-formedness result.
@@ -166,8 +162,7 @@ xmlCtxtResetLastError(void *ctx)
}
/**
- * xmlCtxtErrMemory:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Handle an out-of-memory error.
*
@@ -207,10 +202,9 @@ xmlCtxtErrMemory(xmlParserCtxtPtr ctxt)
}
/**
- * xmlCtxtErrIO:
- * @ctxt: parser context
- * @code: xmlParserErrors code
- * @uri: filename or URI (optional)
+ * @param ctxt parser context
+ * @param code xmlParserErrors code
+ * @param uri filename or URI (optional)
*
* If filename is empty, use the one from context input if available.
*
@@ -261,10 +255,9 @@ xmlCtxtErrIO(xmlParserCtxtPtr ctxt, int code, const char *uri)
}
/**
- * xmlCtxtIsCatastrophicError:
- * @ctxt: parser context
+ * @param ctxt parser context
*
- * Returns true if the last error is catastrophic.
+ * @returns true if the last error is catastrophic.
*/
int
xmlCtxtIsCatastrophicError(xmlParserCtxtPtr ctxt) {
@@ -276,18 +269,17 @@ xmlCtxtIsCatastrophicError(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtVErr:
- * @ctxt: a parser context
- * @node: the current node or NULL
- * @domain: the domain for the error
- * @code: the code for the error
- * @level: the xmlErrorLevel for the error
- * @str1: extra string info
- * @str2: extra string info
- * @str3: extra string info
- * @int1: extra int info
- * @msg: the message to display/transmit
- * @ap: extra parameters for the message display
+ * @param ctxt a parser context
+ * @param node the current node or NULL
+ * @param domain the domain for the error
+ * @param code the code for the error
+ * @param level the xmlErrorLevel for the error
+ * @param str1 extra string info
+ * @param str2 extra string info
+ * @param str3 extra string info
+ * @param int1 extra int info
+ * @param msg the message to display/transmit
+ * @param ap extra parameters for the message display
*
* Raise a parser error.
*/
@@ -401,17 +393,16 @@ xmlCtxtVErr(xmlParserCtxtPtr ctxt, xmlNodePtr node, xmlErrorDomain domain,
}
/**
- * xmlCtxtErr:
- * @ctxt: a parser context
- * @node: the current node or NULL
- * @domain: the domain for the error
- * @code: the code for the error
- * @level: the xmlErrorLevel for the error
- * @str1: extra string info
- * @str2: extra string info
- * @str3: extra string info
- * @int1: extra int info
- * @msg: the message to display/transmit
+ * @param ctxt a parser context
+ * @param node the current node or NULL
+ * @param domain the domain for the error
+ * @param code the code for the error
+ * @param level the xmlErrorLevel for the error
+ * @param str1 extra string info
+ * @param str2 extra string info
+ * @param str3 extra string info
+ * @param int1 extra int info
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Raise a parser error.
@@ -431,8 +422,7 @@ xmlCtxtErr(xmlParserCtxtPtr ctxt, xmlNodePtr node, xmlErrorDomain domain,
}
/**
- * xmlCtxtGetStatus:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Get well-formedness and validation status after parsing. Also
* reports catastrophic errors which are not related to parsing
@@ -440,7 +430,7 @@ xmlCtxtErr(xmlParserCtxtPtr ctxt, xmlNodePtr node, xmlErrorDomain domain,
*
* Available since 2.14.0.
*
- * Returns a bitmask of XML_STATUS_* flags ORed together.
+ * @returns a bitmask of XML_STATUS_* flags ORed together.
*/
xmlParserStatus
xmlCtxtGetStatus(xmlParserCtxt *ctxt) {
@@ -467,10 +457,9 @@ xmlCtxtGetStatus(xmlParserCtxt *ctxt) {
}
/**
- * xmlFatalErr:
- * @ctxt: an XML parser context
- * @code: the error number
- * @info: extra information string
+ * @param ctxt an XML parser context
+ * @param code the error number
+ * @param info extra information string
*
* Handle a fatal parser error, i.e. violating Well-Formedness constraints
*/
@@ -492,15 +481,14 @@ xmlFatalErr(xmlParserCtxtPtr ctxt, xmlParserErrors code, const char *info)
}
/**
- * xmlIsLetter:
- * @c: an unicode character (int)
+ * @param c an unicode character (int)
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Check whether the character is allowed by the production
* [84] Letter ::= BaseChar | Ideographic
*
- * Returns 0 if not, non-zero otherwise
+ * @returns 0 if not, non-zero otherwise
*/
int
xmlIsLetter(int c) {
@@ -517,8 +505,7 @@ xmlIsLetter(int c) {
#define LINE_LEN 80
/**
- * xmlHaltParser:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Blocks further parser processing don't override error
* for internal use
@@ -532,13 +519,12 @@ xmlHaltParser(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParserInputRead:
- * @in: an XML parser input
- * @len: an indicative size for the lookahead
+ * @param in an XML parser input
+ * @param len an indicative size for the lookahead
*
- * DEPRECATED: This function was internal and is deprecated.
+ * @deprecated This function was internal and is deprecated.
*
- * Returns -1 as this is an error to use it.
+ * @returns -1 as this is an error to use it.
*/
int
xmlParserInputRead(xmlParserInputPtr in ATTRIBUTE_UNUSED, int len ATTRIBUTE_UNUSED) {
@@ -546,12 +532,11 @@ xmlParserInputRead(xmlParserInputPtr in ATTRIBUTE_UNUSED, int len ATTRIBUTE_UNUS
}
/**
- * xmlParserGrow:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Grow the input buffer.
*
- * Returns the number of bytes read or -1 in case of error.
+ * @returns the number of bytes read or -1 in case of error.
*/
int
xmlParserGrow(xmlParserCtxtPtr ctxt) {
@@ -596,11 +581,10 @@ xmlParserGrow(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParserCheckEOF:
- * @ctxt: parser ctxt
- * @code: error code
+ * @param ctxt parser ctxt
+ * @param code error code
*
- * Raises an error with @code if the input wasn't consumed
+ * Raises an error with `code` if the input wasn't consumed
* completely.
*/
void
@@ -639,16 +623,15 @@ xmlParserCheckEOF(xmlParserCtxtPtr ctxt, xmlParserErrors code) {
}
/**
- * xmlParserInputGrow:
- * @in: an XML parser input
- * @len: an indicative size for the lookahead
+ * @param in an XML parser input
+ * @param len an indicative size for the lookahead
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This function increase the input for the parser. It tries to
* preserve pointers to the input buffer, and keep already read data
*
- * Returns the amount of char read, or -1 in case of error, 0 indicate the
+ * @returns the amount of char read, or -1 in case of error, 0 indicate the
* end of this entity
*/
int
@@ -686,8 +669,7 @@ xmlParserInputGrow(xmlParserInputPtr in, int len) {
}
/**
- * xmlParserShrink:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Shrink the input buffer.
*/
@@ -719,10 +701,9 @@ xmlParserShrink(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlParserInputShrink:
- * @in: an XML parser input
+ * @param in an XML parser input
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This function removes used input for the parser.
*/
@@ -761,10 +742,9 @@ xmlParserInputShrink(xmlParserInputPtr in) {
************************************************************************/
/**
- * xmlNextChar:
- * @ctxt: the XML parser context
+ * @param ctxt the XML parser context
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Skip to the next char input char.
*/
@@ -857,23 +837,22 @@ encoding_error:
}
/**
- * xmlCurrentChar:
- * @ctxt: the XML parser context
- * @len: pointer to the length of the char read
+ * @param ctxt the XML parser context
+ * @param len pointer to the length of the char read
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* The current char value, if using UTF-8 this may actually span multiple
* bytes in the input buffer. Implement the end of line normalization:
* 2.11 End-of-Line Handling
* Wherever an external parsed entity or the literal entity value
* of an internal parsed entity contains either the literal two-character
- * sequence "#xD#xA" or a standalone literal #xD, an XML processor
- * must pass to the application the single character #xA.
+ * sequence "\#xD\#xA" or a standalone literal \#xD, an XML processor
+ * must pass to the application the single character \#xA.
* This behavior can conveniently be produced by normalizing all
- * line breaks to #xA on input, before parsing.)
+ * line breaks to \#xA on input, before parsing.)
*
- * Returns the current char value and its length
+ * @returns the current char value and its length
*/
int
@@ -1003,17 +982,16 @@ incomplete_sequence:
}
/**
- * xmlStringCurrentChar:
- * @ctxt: the XML parser context
- * @cur: pointer to the beginning of the char
- * @len: pointer to the length of the char read
+ * @param ctxt the XML parser context
+ * @param cur pointer to the beginning of the char
+ * @param len pointer to the length of the char read
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* The current char value, if using UTF-8 this may actually span multiple
* bytes in the input buffer.
*
- * Returns the current char value and its length
+ * @returns the current char value and its length
*/
int
@@ -1032,15 +1010,14 @@ xmlStringCurrentChar(xmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlCopyCharMultiByte:
- * @out: pointer to an array of xmlChar
- * @val: the char value
+ * @param out pointer to an array of xmlChar
+ * @param val the char value
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* append the char value in the array
*
- * Returns the number of xmlChar written
+ * @returns the number of xmlChar written
*/
int
xmlCopyCharMultiByte(xmlChar *out, int val) {
@@ -1075,16 +1052,15 @@ xmlCopyCharMultiByte(xmlChar *out, int val) {
}
/**
- * xmlCopyChar:
- * @len: Ignored, compatibility
- * @out: pointer to an array of xmlChar
- * @val: the char value
+ * @param len Ignored, compatibility
+ * @param out pointer to an array of xmlChar
+ * @param val the char value
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* append the char value in the array
*
- * Returns the number of xmlChar written
+ * @returns the number of xmlChar written
*/
int
@@ -1105,10 +1081,9 @@ xmlCopyChar(int len ATTRIBUTE_UNUSED, xmlChar *out, int val) {
************************************************************************/
/**
- * xmlCtxtSetCharEncConvImpl:
- * @ctxt: parser context
- * @impl: callback
- * @vctxt: user data
+ * @param ctxt parser context
+ * @param impl callback
+ * @param vctxt user data
*
* Installs a custom implementation to convert between character
* encodings.
@@ -1212,9 +1187,8 @@ done:
}
/**
- * xmlSwitchEncoding:
- * @ctxt: the parser context
- * @enc: the encoding value (number)
+ * @param ctxt the parser context
+ * @param enc the encoding value (number)
*
* Use encoding specified by enum to decode input data. This overrides
* the encoding found in the XML declaration.
@@ -1222,7 +1196,7 @@ done:
* This function can also be used to override the encoding of chunks
* passed to xmlParseChunk.
*
- * Returns 0 in case of success, -1 otherwise
+ * @returns 0 in case of success, -1 otherwise
*/
int
xmlSwitchEncoding(xmlParserCtxtPtr ctxt, xmlCharEncoding enc)
@@ -1250,12 +1224,11 @@ xmlSwitchEncoding(xmlParserCtxtPtr ctxt, xmlCharEncoding enc)
}
/**
- * xmlSwitchInputEncodingName:
- * @ctxt: the parser context
- * @input: the input strea,
- * @encoding: the encoding name
+ * @param ctxt the parser context
+ * @param input the input strea,
+ * @param encoding the encoding name
*
- * Returns 0 in case of success, -1 otherwise
+ * @returns 0 in case of success, -1 otherwise
*/
static int
xmlSwitchInputEncodingName(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
@@ -1287,9 +1260,8 @@ xmlSwitchInputEncodingName(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
}
/**
- * xmlSwitchEncodingName:
- * @ctxt: the parser context
- * @encoding: the encoding name
+ * @param ctxt the parser context
+ * @param encoding the encoding name
*
* Use specified encoding to decode input data. This overrides the
* encoding found in the XML declaration.
@@ -1299,7 +1271,7 @@ xmlSwitchInputEncodingName(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
*
* Available since 2.13.0.
*
- * Returns 0 in case of success, -1 otherwise
+ * @returns 0 in case of success, -1 otherwise
*/
int
xmlSwitchEncodingName(xmlParserCtxtPtr ctxt, const char *encoding) {
@@ -1310,15 +1282,14 @@ xmlSwitchEncodingName(xmlParserCtxtPtr ctxt, const char *encoding) {
}
/**
- * xmlInputSetEncodingHandler:
- * @input: the input stream
- * @handler: the encoding handler
+ * @param input the input stream
+ * @param handler the encoding handler
*
* Use encoding handler to decode input data.
*
* Closes the handler on error.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
xmlParserErrors
xmlInputSetEncodingHandler(xmlParserInputPtr input,
@@ -1410,16 +1381,15 @@ xmlInputSetEncodingHandler(xmlParserInputPtr input,
}
/**
- * xmlSwitchInputEncoding:
- * @ctxt: the parser context, only for error reporting
- * @input: the input stream
- * @handler: the encoding handler
+ * @param ctxt the parser context, only for error reporting
+ * @param input the input stream
+ * @param handler the encoding handler
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Use encoding handler to decode input data.
*
- * Returns 0 in case of success, -1 otherwise
+ * @returns 0 in case of success, -1 otherwise
*/
int
xmlSwitchInputEncoding(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
@@ -1435,16 +1405,15 @@ xmlSwitchInputEncoding(xmlParserCtxtPtr ctxt, xmlParserInputPtr input,
}
/**
- * xmlSwitchToEncoding:
- * @ctxt: the parser context
- * @handler: the encoding handler
+ * @param ctxt the parser context
+ * @param handler the encoding handler
*
* Use encoding handler to decode input data.
*
* This function can be used to enforce the encoding of chunks passed
* to xmlParseChunk.
*
- * Returns 0 in case of success, -1 otherwise
+ * @returns 0 in case of success, -1 otherwise
*/
int
xmlSwitchToEncoding(xmlParserCtxtPtr ctxt, xmlCharEncodingHandlerPtr handler)
@@ -1464,8 +1433,7 @@ xmlSwitchToEncoding(xmlParserCtxtPtr ctxt, xmlCharEncodingHandlerPtr handler)
}
/**
- * xmlDetectEncoding:
- * @ctxt: the parser context
+ * @param ctxt the parser context
*
* Handle optional BOM, detect and switch to encoding.
*
@@ -1595,9 +1563,8 @@ xmlDetectEncoding(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlSetDeclaredEncoding:
- * @ctxt: the parser context
- * @encoding: declared encoding
+ * @param ctxt the parser context
+ * @param encoding declared encoding
*
* Set the encoding from a declaration in the document.
*
@@ -1692,12 +1659,11 @@ xmlSetDeclaredEncoding(xmlParserCtxtPtr ctxt, xmlChar *encoding) {
}
/**
- * xmlCtxtGetDeclaredEncoding:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the encoding from the encoding declaration. This can differ
+ * @returns the encoding from the encoding declaration. This can differ
* from the actual encoding.
*/
const xmlChar *
@@ -1709,10 +1675,9 @@ xmlCtxtGetDeclaredEncoding(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlGetActualEncoding:
- * @ctxt: the parser context
+ * @param ctxt the parser context
*
- * Returns the actual used to parse the document. This can differ from
+ * @returns the actual used to parse the document. This can differ from
* the declared encoding.
*/
const xmlChar *
@@ -1739,8 +1704,7 @@ xmlGetActualEncoding(xmlParserCtxtPtr ctxt) {
************************************************************************/
/**
- * xmlFreeInputStream:
- * @input: an xmlParserInputPtr
+ * @param input an xmlParserInputPtr
*
* Free up an input stream.
*/
@@ -1758,14 +1722,13 @@ xmlFreeInputStream(xmlParserInputPtr input) {
}
/**
- * xmlNewInputStream:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Use xmlNewInputFromUrl or similar functions.
+ * @deprecated Use xmlNewInputFromUrl or similar functions.
*
* Create a new input stream structure.
*
- * Returns the new input stream or NULL
+ * @returns the new input stream or NULL
*/
xmlParserInputPtr
xmlNewInputStream(xmlParserCtxtPtr ctxt) {
@@ -1784,17 +1747,16 @@ xmlNewInputStream(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtNewInputFromUrl:
- * @ctxt: parser context
- * @url: filename or URL
- * @publicId: publid ID from doctype (optional)
- * @encoding: character encoding (optional)
- * @flags: unused, pass 0
+ * @param ctxt parser context
+ * @param url filename or URL
+ * @param publicId publid ID from doctype (optional)
+ * @param encoding character encoding (optional)
+ * @param flags unused, pass 0
*
* Creates a new parser input from the filesystem, the network or
* a user-defined resource loader.
*
- * Returns a new parser input.
+ * @returns a new parser input.
*/
xmlParserInputPtr
xmlCtxtNewInputFromUrl(xmlParserCtxtPtr ctxt, const char *url,
@@ -1816,13 +1778,12 @@ xmlCtxtNewInputFromUrl(xmlParserCtxtPtr ctxt, const char *url,
}
/**
- * xmlNewInputInternal:
- * @buf: parser input buffer
- * @filename: filename or URL
+ * @param buf parser input buffer
+ * @param filename filename or URL
*
* Internal helper function.
*
- * Returns a new parser input.
+ * @returns a new parser input.
*/
static xmlParserInputPtr
xmlNewInputInternal(xmlParserInputBufferPtr buf, const char *filename) {
@@ -1852,15 +1813,14 @@ xmlNewInputInternal(xmlParserInputBufferPtr buf, const char *filename) {
}
/**
- * xmlNewInputFromMemory:
- * @url: base URL (optional)
- * @mem: pointer to char array
- * @size: size of array
- * @flags: optimization hints
+ * @param url base URL (optional)
+ * @param mem pointer to char array
+ * @param size size of array
+ * @param flags optimization hints
*
* Creates a new parser input to read from a memory area.
*
- * @url is used as base to resolve external entities and for
+ * `url` is used as base to resolve external entities and for
* error reporting.
*
* If the XML_INPUT_BUF_STATIC flag is set, the memory area must
@@ -1868,12 +1828,12 @@ xmlNewInputInternal(xmlParserInputBufferPtr buf, const char *filename) {
* temporary copies.
*
* If the XML_INPUT_BUF_ZERO_TERMINATED flag is set, the memory
- * area must contain a zero byte after the buffer at position @size.
+ * area must contain a zero byte after the buffer at position `size`.
* This can avoid temporary copies.
*
* Available since 2.14.0.
*
- * Returns a new parser input or NULL if a memory allocation failed.
+ * @returns a new parser input or NULL if a memory allocation failed.
*/
xmlParserInputPtr
xmlNewInputFromMemory(const char *url, const void *mem, size_t size,
@@ -1891,15 +1851,14 @@ xmlNewInputFromMemory(const char *url, const void *mem, size_t size,
}
/**
- * xmlCtxtNewInputFromMemory:
- * @ctxt: parser context
- * @url: base URL (optional)
- * @mem: pointer to char array
- * @size: size of array
- * @encoding: character encoding (optional)
- * @flags: optimization hints
+ * @param ctxt parser context
+ * @param url base URL (optional)
+ * @param mem pointer to char array
+ * @param size size of array
+ * @param encoding character encoding (optional)
+ * @param flags optimization hints
*
- * Returns a new parser input or NULL in case of error.
+ * @returns a new parser input or NULL in case of error.
*/
xmlParserInputPtr
xmlCtxtNewInputFromMemory(xmlParserCtxtPtr ctxt, const char *url,
@@ -1923,14 +1882,13 @@ xmlCtxtNewInputFromMemory(xmlParserCtxtPtr ctxt, const char *url,
}
/**
- * xmlNewInputFromString:
- * @url: base URL (optional)
- * @str: zero-terminated string
- * @flags: optimization hints
+ * @param url base URL (optional)
+ * @param str zero-terminated string
+ * @param flags optimization hints
*
* Creates a new parser input to read from a zero-terminated string.
*
- * @url is used as base to resolve external entities and for
+ * `url` is used as base to resolve external entities and for
* error reporting.
*
* If the XML_INPUT_BUF_STATIC flag is set, the string must
@@ -1939,7 +1897,7 @@ xmlCtxtNewInputFromMemory(xmlParserCtxtPtr ctxt, const char *url,
*
* Available since 2.14.0.
*
- * Returns a new parser input or NULL if a memory allocation failed.
+ * @returns a new parser input or NULL if a memory allocation failed.
*/
xmlParserInputPtr
xmlNewInputFromString(const char *url, const char *str,
@@ -1957,14 +1915,13 @@ xmlNewInputFromString(const char *url, const char *str,
}
/**
- * xmlCtxtNewInputFromString:
- * @ctxt: parser context
- * @url: base URL (optional)
- * @str: zero-terminated string
- * @encoding: character encoding (optional)
- * @flags: optimization hints
+ * @param ctxt parser context
+ * @param url base URL (optional)
+ * @param str zero-terminated string
+ * @param encoding character encoding (optional)
+ * @param flags optimization hints
*
- * Returns a new parser input.
+ * @returns a new parser input.
*/
xmlParserInputPtr
xmlCtxtNewInputFromString(xmlParserCtxtPtr ctxt, const char *url,
@@ -1988,25 +1945,24 @@ xmlCtxtNewInputFromString(xmlParserCtxtPtr ctxt, const char *url,
}
/**
- * xmlNewInputFromFd:
- * @url: base URL (optional)
- * @fd: file descriptor
- * @flags: input flags
+ * @param url base URL (optional)
+ * @param fd file descriptor
+ * @param flags input flags
*
* Creates a new parser input to read from a zero-terminated string.
*
- * @url is used as base to resolve external entities and for
+ * `url` is used as base to resolve external entities and for
* error reporting.
*
- * @fd is closed after parsing has finished.
+ * `fd` is closed after parsing has finished.
*
- * Supported @flags are XML_INPUT_UNZIP to decompress data
+ * Supported `flags` are XML_INPUT_UNZIP to decompress data
* automatically. This feature is deprecated and will be removed
* in a future release.
*
* Available since 2.14.0.
*
- * Returns a new parser input or NULL if a memory allocation failed.
+ * @returns a new parser input or NULL if a memory allocation failed.
*/
xmlParserInputPtr
xmlNewInputFromFd(const char *url, int fd, xmlParserInputFlags flags) {
@@ -2028,14 +1984,13 @@ xmlNewInputFromFd(const char *url, int fd, xmlParserInputFlags flags) {
}
/**
- * xmlCtxtNewInputFromFd:
- * @ctxt: parser context
- * @url: base URL (optional)
- * @fd: file descriptor
- * @encoding: character encoding (optional)
- * @flags: unused, pass 0
+ * @param ctxt parser context
+ * @param url base URL (optional)
+ * @param fd file descriptor
+ * @param encoding character encoding (optional)
+ * @param flags unused, pass 0
*
- * Returns a new parser input.
+ * @returns a new parser input.
*/
xmlParserInputPtr
xmlCtxtNewInputFromFd(xmlParserCtxtPtr ctxt, const char *url,
@@ -2062,30 +2017,29 @@ xmlCtxtNewInputFromFd(xmlParserCtxtPtr ctxt, const char *url,
}
/**
- * xmlNewInputFromIO:
- * @url: base URL (optional)
- * @ioRead: read callback
- * @ioClose: close callback (optional)
- * @ioCtxt: IO context
- * @flags: unused, pass 0
+ * @param url base URL (optional)
+ * @param ioRead read callback
+ * @param ioClose close callback (optional)
+ * @param ioCtxt IO context
+ * @param flags unused, pass 0
*
* Creates a new parser input to read from input callbacks and
* cintext.
*
- * @url is used as base to resolve external entities and for
+ * `url` is used as base to resolve external entities and for
* error reporting.
*
- * @ioRead is called to read new data into a provided buffer.
+ * `ioRead` is called to read new data into a provided buffer.
* It must return the number of bytes written into the buffer
* ot a negative xmlParserErrors code on failure.
*
- * @ioClose is called after parsing has finished.
+ * `ioClose` is called after parsing has finished.
*
- * @ioCtxt is an opaque pointer passed to the callbacks.
+ * `ioCtxt` is an opaque pointer passed to the callbacks.
*
* Available since 2.14.0.
*
- * Returns a new parser input or NULL if a memory allocation failed.
+ * @returns a new parser input or NULL if a memory allocation failed.
*/
xmlParserInputPtr
xmlNewInputFromIO(const char *url, xmlInputReadCallback ioRead,
@@ -2111,16 +2065,15 @@ xmlNewInputFromIO(const char *url, xmlInputReadCallback ioRead,
}
/**
- * xmlCtxtNewInputFromIO:
- * @ctxt: parser context
- * @url: base URL (optional)
- * @ioRead: read callback
- * @ioClose: close callback (optional)
- * @ioCtxt: IO context
- * @encoding: character encoding (optional)
- * @flags: unused, pass 0
+ * @param ctxt parser context
+ * @param url base URL (optional)
+ * @param ioRead read callback
+ * @param ioClose close callback (optional)
+ * @param ioCtxt IO context
+ * @param encoding character encoding (optional)
+ * @param flags unused, pass 0
*
- * Returns a new parser input.
+ * @returns a new parser input.
*/
xmlParserInputPtr
xmlCtxtNewInputFromIO(xmlParserCtxtPtr ctxt, const char *url,
@@ -2146,14 +2099,13 @@ xmlCtxtNewInputFromIO(xmlParserCtxtPtr ctxt, const char *url,
}
/**
- * xmlNewPushInput:
- * @url: base URL (optional)
- * @chunk: pointer to char array
- * @size: size of array
+ * @param url base URL (optional)
+ * @param chunk pointer to char array
+ * @param size size of array
*
* Creates a new parser input for a push parser.
*
- * Returns a new parser input or NULL if a memory allocation failed.
+ * @returns a new parser input or NULL if a memory allocation failed.
*/
xmlParserInputPtr
xmlNewPushInput(const char *url, const char *chunk, int size) {
@@ -2185,15 +2137,14 @@ xmlNewPushInput(const char *url, const char *chunk, int size) {
}
/**
- * xmlNewIOInputStream:
- * @ctxt: an XML parser context
- * @buf: an input buffer
- * @enc: the charset encoding if known
+ * @param ctxt an XML parser context
+ * @param buf an input buffer
+ * @param enc the charset encoding if known
*
- * Create a new input stream structure encapsulating the @input into
+ * Create a new input stream structure encapsulating the `input` into
* a stream suitable for the parser.
*
- * Returns the new input stream or NULL
+ * @returns the new input stream or NULL
*/
xmlParserInputPtr
xmlNewIOInputStream(xmlParserCtxtPtr ctxt, xmlParserInputBufferPtr buf,
@@ -2218,15 +2169,14 @@ xmlNewIOInputStream(xmlParserCtxtPtr ctxt, xmlParserInputBufferPtr buf,
}
/**
- * xmlNewEntityInputStream:
- * @ctxt: an XML parser context
- * @ent: an Entity pointer
+ * @param ctxt an XML parser context
+ * @param ent an Entity pointer
*
- * DEPRECATED: Internal function, do not use.
+ * @deprecated Internal function, do not use.
*
* Create a new input stream based on an xmlEntityPtr
*
- * Returns the new input stream or NULL
+ * @returns the new input stream or NULL
*/
xmlParserInputPtr
xmlNewEntityInputStream(xmlParserCtxtPtr ctxt, xmlEntityPtr ent) {
@@ -2261,15 +2211,14 @@ xmlNewEntityInputStream(xmlParserCtxtPtr ctxt, xmlEntityPtr ent) {
}
/**
- * xmlNewStringInputStream:
- * @ctxt: an XML parser context
- * @buffer: an memory buffer
+ * @param ctxt an XML parser context
+ * @param buffer an memory buffer
*
- * DEPRECATED: Use xmlNewInputFromString.
+ * @deprecated Use xmlNewInputFromString.
*
* Create a new input stream based on a memory buffer.
*
- * Returns the new input stream
+ * @returns the new input stream
*/
xmlParserInputPtr
xmlNewStringInputStream(xmlParserCtxtPtr ctxt, const xmlChar *buffer) {
@@ -2287,16 +2236,15 @@ xmlNewStringInputStream(xmlParserCtxtPtr ctxt, const xmlChar *buffer) {
#ifdef LIBXML_CATALOG_ENABLED
/**
- * xmlResolveResourceFromCatalog:
- * @URL: the URL for the entity to load
- * @ID: the System ID for the entity to load
- * @ctxt: the context in which the entity is called or NULL
+ * @param URL the URL for the entity to load
+ * @param ID the System ID for the entity to load
+ * @param ctxt the context in which the entity is called or NULL
*
* Resolves the URL and ID against the appropriate catalog.
* This function is used by xmlDefaultExternalEntityLoader and
* xmlNoNetExternalEntityLoader.
*
- * Returns a new allocated URL, or NULL.
+ * @returns a new allocated URL, or NULL.
*/
static xmlChar *
xmlResolveResourceFromCatalog(const char *URL, const char *ID,
@@ -2374,13 +2322,12 @@ xmlResolveResourceFromCatalog(const char *URL, const char *ID,
#endif
/**
- * xmlCheckHTTPInput:
- * @ctxt: an XML parser context
- * @ret: an XML parser input
+ * @param ctxt an XML parser context
+ * @param ret an XML parser input
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns NULL.
+ * @returns NULL.
*/
xmlParserInputPtr
xmlCheckHTTPInput(xmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -2389,10 +2336,9 @@ xmlCheckHTTPInput(xmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlNewInputFromUrl:
- * @filename: the filename to use as entity
- * @flags: XML_INPUT flags
- * @out: pointer to new parser input
+ * @param filename the filename to use as entity
+ * @param flags XML_INPUT flags
+ * @param out pointer to new parser input
*
* Create a new input stream based on a file or a URL.
*
@@ -2413,7 +2359,7 @@ xmlCheckHTTPInput(xmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
*
* Available since 2.14.0.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
xmlParserErrors
xmlNewInputFromUrl(const char *filename, xmlParserInputFlags flags,
@@ -2449,15 +2395,14 @@ xmlNewInputFromUrl(const char *filename, xmlParserInputFlags flags,
}
/**
- * xmlNewInputFromFile:
- * @ctxt: an XML parser context
- * @filename: the filename to use as entity
+ * @param ctxt an XML parser context
+ * @param filename the filename to use as entity
*
- * DEPRECATED: Use xmlNewInputFromUrl.
+ * @deprecated Use xmlNewInputFromUrl.
*
* Create a new input stream based on a file or an URL.
*
- * Returns the new input stream or NULL in case of error
+ * @returns the new input stream or NULL in case of error
*/
xmlParserInputPtr
xmlNewInputFromFile(xmlParserCtxtPtr ctxt, const char *filename) {
@@ -2483,14 +2428,13 @@ xmlNewInputFromFile(xmlParserCtxtPtr ctxt, const char *filename) {
}
/**
- * xmlDefaultExternalEntityLoader:
- * @url: the URL for the entity to load
- * @ID: the System ID for the entity to load
- * @ctxt: the context in which the entity is called or NULL
+ * @param url the URL for the entity to load
+ * @param ID the System ID for the entity to load
+ * @param ctxt the context in which the entity is called or NULL
*
* By default we don't load external entities, yet.
*
- * Returns a new allocated xmlParserInputPtr, or NULL.
+ * @returns a new allocated xmlParserInputPtr, or NULL.
*/
static xmlParserInputPtr
xmlDefaultExternalEntityLoader(const char *url, const char *ID,
@@ -2528,17 +2472,16 @@ xmlDefaultExternalEntityLoader(const char *url, const char *ID,
}
/**
- * xmlNoNetExternalEntityLoader:
- * @URL: the URL for the entity to load
- * @ID: the System ID for the entity to load
- * @ctxt: the context in which the entity is called or NULL
+ * @param URL the URL for the entity to load
+ * @param ID the System ID for the entity to load
+ * @param ctxt the context in which the entity is called or NULL
*
- * DEPRECATED: Use XML_PARSE_NONET.
+ * @deprecated Use XML_PARSE_NONET.
*
* A specific entity loader disabling network accesses, though still
* allowing local catalog accesses for resolution.
*
- * Returns a new allocated xmlParserInputPtr, or NULL.
+ * @returns a new allocated xmlParserInputPtr, or NULL.
*/
xmlParserInputPtr
xmlNoNetExternalEntityLoader(const char *URL, const char *ID,
@@ -2566,10 +2509,9 @@ static xmlExternalEntityLoader
xmlCurrentExternalEntityLoader = xmlDefaultExternalEntityLoader;
/**
- * xmlSetExternalEntityLoader:
- * @f: the new entity resolver function
+ * @param f the new entity resolver function
*
- * DEPRECATED: This is a global setting and not thread-safe. Use
+ * @deprecated This is a global setting and not thread-safe. Use
* xmlCtxtSetResourceLoader or similar functions.
*
* Changes the default external entity resolver function for the
@@ -2581,13 +2523,12 @@ xmlSetExternalEntityLoader(xmlExternalEntityLoader f) {
}
/**
- * xmlGetExternalEntityLoader:
*
- * DEPRECATED: See xmlSetExternalEntityLoader.
+ * @deprecated See xmlSetExternalEntityLoader.
*
* Get the default external entity resolver function for the application
*
- * Returns the xmlExternalEntityLoader function pointer
+ * @returns the xmlExternalEntityLoader function pointer
*/
xmlExternalEntityLoader
xmlGetExternalEntityLoader(void) {
@@ -2595,10 +2536,9 @@ xmlGetExternalEntityLoader(void) {
}
/**
- * xmlCtxtSetResourceLoader:
- * @ctxt: parser context
- * @loader: callback
- * @vctxt: user data
+ * @param ctxt parser context
+ * @param loader callback
+ * @param vctxt user data
*
* Installs a custom callback to load documents, DTDs or external
* entities.
@@ -2616,13 +2556,12 @@ xmlCtxtSetResourceLoader(xmlParserCtxtPtr ctxt, xmlResourceLoader loader,
}
/**
- * xmlLoadResource:
- * @ctxt: parser context
- * @url: the URL for the entity to load
- * @publicId: the Public ID for the entity to load
- * @type: resource type
+ * @param ctxt parser context
+ * @param url the URL for the entity to load
+ * @param publicId the Public ID for the entity to load
+ * @param type resource type
*
- * Returns the xmlParserInputPtr or NULL in case of error.
+ * @returns the xmlParserInputPtr or NULL in case of error.
*/
xmlParserInputPtr
xmlLoadResource(xmlParserCtxtPtr ctxt, const char *url, const char *publicId,
@@ -2672,16 +2611,15 @@ xmlLoadResource(xmlParserCtxtPtr ctxt, const char *url, const char *publicId,
}
/**
- * xmlLoadExternalEntity:
- * @URL: the URL for the entity to load
- * @ID: the Public ID for the entity to load
- * @ctxt: the context in which the entity is called or NULL
+ * @param URL the URL for the entity to load
+ * @param ID the Public ID for the entity to load
+ * @param ctxt the context in which the entity is called or NULL
*
- * @URL is a filename or URL. If if contains the substring "://",
+ * `URL` is a filename or URL. If if contains the substring "://",
* it is assumed to be a Legacy Extended IRI. Otherwise, it is
* treated as a filesystem path.
*
- * @ID is an optional XML public ID, typically from a doctype
+ * `ID` is an optional XML public ID, typically from a doctype
* declaration. It is used for catalog lookups.
*
* If catalog lookup is enabled (default is yes) and URL or ID are
@@ -2701,7 +2639,7 @@ xmlLoadResource(xmlParserCtxtPtr ctxt, const char *url, const char *publicId,
* - a file opened from the filesystem, with automatic detection
* of compressed files if support is compiled in.
*
- * Returns the xmlParserInputPtr or NULL
+ * @returns the xmlParserInputPtr or NULL
*/
xmlParserInputPtr
xmlLoadExternalEntity(const char *URL, const char *ID,
@@ -2716,14 +2654,13 @@ xmlLoadExternalEntity(const char *URL, const char *ID,
************************************************************************/
/**
- * xmlInitSAXParserCtxt:
- * @ctxt: XML parser context
- * @sax: SAX handlert
- * @userData: user data
+ * @param ctxt XML parser context
+ * @param sax SAX handlert
+ * @param userData user data
*
* Initialize a SAX parser context
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
static int
@@ -2887,15 +2824,14 @@ xmlInitSAXParserCtxt(xmlParserCtxtPtr ctxt, const xmlSAXHandler *sax,
}
/**
- * xmlInitParserCtxt:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
- * DEPRECATED: Internal function which will be made private in a future
+ * @deprecated Internal function which will be made private in a future
* version.
*
* Initialize a parser context
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
@@ -2905,8 +2841,7 @@ xmlInitParserCtxt(xmlParserCtxtPtr ctxt)
}
/**
- * xmlFreeParserCtxt:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Free all the memory used by a parser context. However the parsed
* document in ctxt->myDoc is not freed.
@@ -2993,11 +2928,10 @@ xmlFreeParserCtxt(xmlParserCtxtPtr ctxt)
}
/**
- * xmlNewParserCtxt:
*
* Allocate and initialize a new parser context.
*
- * Returns the xmlParserCtxtPtr or NULL
+ * @returns the xmlParserCtxtPtr or NULL
*/
xmlParserCtxtPtr
@@ -3007,9 +2941,8 @@ xmlNewParserCtxt(void)
}
/**
- * xmlNewSAXParserCtxt:
- * @sax: SAX handler
- * @userData: user data
+ * @param sax SAX handler
+ * @param userData user data
*
* Allocate and initialize a new SAX parser context. If userData is NULL,
* the parser context will be passed as user data.
@@ -3018,7 +2951,7 @@ xmlNewParserCtxt(void)
* it's best to invoke xmlNewParserCtxt and set ctxt->sax with
* struct assignment.
*
- * Returns the xmlParserCtxtPtr or NULL if memory allocation failed.
+ * @returns the xmlParserCtxtPtr or NULL if memory allocation failed.
*/
xmlParserCtxtPtr
@@ -3040,12 +2973,11 @@ xmlNewSAXParserCtxt(const xmlSAXHandler *sax, void *userData)
}
/**
- * xmlCtxtGetPrivate:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the private application data.
+ * @returns the private application data.
*/
void *
xmlCtxtGetPrivate(xmlParserCtxtPtr ctxt) {
@@ -3056,9 +2988,8 @@ xmlCtxtGetPrivate(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtSetPrivate:
- * @ctxt: parser context
- * @priv: private application data
+ * @param ctxt parser context
+ * @param priv private application data
*
* Available since 2.14.0.
*
@@ -3073,12 +3004,11 @@ xmlCtxtSetPrivate(xmlParserCtxtPtr ctxt, void *priv) {
}
/**
- * xmlCtxtGetCatalogs:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the local catalogs.
+ * @returns the local catalogs.
*/
void *
xmlCtxtGetCatalogs(xmlParserCtxtPtr ctxt) {
@@ -3089,9 +3019,8 @@ xmlCtxtGetCatalogs(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtSetCatalogs:
- * @ctxt: parser context
- * @catalogs: catalogs pointer
+ * @param ctxt parser context
+ * @param catalogs catalogs pointer
*
* Available since 2.14.0.
*
@@ -3106,12 +3035,11 @@ xmlCtxtSetCatalogs(xmlParserCtxtPtr ctxt, void *catalogs) {
}
/**
- * xmlCtxtGetDict:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the dictionary.
+ * @returns the dictionary.
*/
xmlDictPtr
xmlCtxtGetDict(xmlParserCtxtPtr ctxt) {
@@ -3122,9 +3050,8 @@ xmlCtxtGetDict(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtSetDict:
- * @ctxt: parser context
- * @dict: dictionary
+ * @param ctxt parser context
+ * @param dict dictionary
*
* Available since 2.14.0.
*
@@ -3144,12 +3071,11 @@ xmlCtxtSetDict(xmlParserCtxtPtr ctxt, xmlDictPtr dict) {
}
/**
- * xmlCtxtGetSaxHandler:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the SAX handler struct. This is not a copy and must not
+ * @returns the SAX handler struct. This is not a copy and must not
* be freed. Handlers can be updated.
*/
xmlSAXHandler *
@@ -3161,15 +3087,14 @@ xmlCtxtGetSaxHandler(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtSetSaxHandler:
- * @ctxt: parser context
- * @sax: SAX handler
+ * @param ctxt parser context
+ * @param sax SAX handler
*
* Available since 2.14.0.
*
- * Set the SAX handler struct to a copy of @sax.
+ * Set the SAX handler struct to a copy of `sax`.
*
- * Returns 0 on success or -1 if arguments are invalid or a memory
+ * @returns 0 on success or -1 if arguments are invalid or a memory
* allocation failed.
*/
int
@@ -3190,12 +3115,11 @@ xmlCtxtSetSaxHandler(xmlParserCtxtPtr ctxt, const xmlSAXHandler *sax) {
}
/**
- * xmlCtxtGetDocument:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the parsed document or NULL if a fatal error occurred when
+ * @returns the parsed document or NULL if a fatal error occurred when
* parsing. The document must be freed by the caller. Resets the
* context's document to NULL.
*/
@@ -3222,12 +3146,11 @@ xmlCtxtGetDocument(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtIsHtml:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns 1 if this is a HTML parser context, 0 otherwise.
+ * @returns 1 if this is a HTML parser context, 0 otherwise.
*/
int
xmlCtxtIsHtml(xmlParserCtxtPtr ctxt) {
@@ -3238,12 +3161,11 @@ xmlCtxtIsHtml(xmlParserCtxtPtr ctxt) {
}
/**
- * xmlCtxtIsStopped:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns 1 if the parser is stopped, 0 otherwise.
+ * @returns 1 if the parser is stopped, 0 otherwise.
*/
int
xmlCtxtIsStopped(xmlParserCtxtPtr ctxt) {
@@ -3255,12 +3177,11 @@ xmlCtxtIsStopped(xmlParserCtxtPtr ctxt) {
#ifdef LIBXML_VALID_ENABLED
/**
- * xmlCtxtGetValidCtxt:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Available since 2.14.0.
*
- * Returns the validation context.
+ * @returns the validation context.
*/
xmlValidCtxtPtr
xmlCtxtGetValidCtxt(xmlParserCtxtPtr ctxt) {
@@ -3278,8 +3199,7 @@ xmlCtxtGetValidCtxt(xmlParserCtxtPtr ctxt) {
************************************************************************/
/**
- * xmlClearParserCtxt:
- * @ctxt: an XML parser context
+ * @param ctxt an XML parser context
*
* Clear (release owned resources) and reinitialize a parser context
*/
@@ -3295,15 +3215,14 @@ xmlClearParserCtxt(xmlParserCtxtPtr ctxt)
/**
- * xmlParserFindNodeInfo:
- * @ctx: an XML parser context
- * @node: an XML node within the tree
+ * @param ctx an XML parser context
+ * @param node an XML node within the tree
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Find the parser node info struct for a given node
*
- * Returns an xmlParserNodeInfo block pointer or NULL
+ * @returns an xmlParserNodeInfo block pointer or NULL
*/
const xmlParserNodeInfo *
xmlParserFindNodeInfo(xmlParserCtxtPtr ctx, xmlNodePtr node)
@@ -3323,10 +3242,9 @@ xmlParserFindNodeInfo(xmlParserCtxtPtr ctx, xmlNodePtr node)
/**
- * xmlInitNodeInfoSeq:
- * @seq: a node info sequence pointer
+ * @param seq a node info sequence pointer
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* -- Initialize (set to initial state) node info sequence
*/
@@ -3341,10 +3259,9 @@ xmlInitNodeInfoSeq(xmlParserNodeInfoSeqPtr seq)
}
/**
- * xmlClearNodeInfoSeq:
- * @seq: a node info sequence pointer
+ * @param seq a node info sequence pointer
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* -- Clear (release memory and reinitialize) node
* info sequence
@@ -3360,16 +3277,15 @@ xmlClearNodeInfoSeq(xmlParserNodeInfoSeqPtr seq)
}
/**
- * xmlParserFindNodeInfoIndex:
- * @seq: a node info sequence pointer
- * @node: an XML node pointer
+ * @param seq a node info sequence pointer
+ * @param node an XML node pointer
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* xmlParserFindNodeInfoIndex : Find the index that the info record for
* the given node is or should be at in a sorted sequence
*
- * Returns a long indicating the position of the record
+ * @returns a long indicating the position of the record
*/
unsigned long
xmlParserFindNodeInfoIndex(xmlParserNodeInfoSeqPtr seq,
@@ -3404,11 +3320,10 @@ xmlParserFindNodeInfoIndex(xmlParserNodeInfoSeqPtr seq,
/**
- * xmlParserAddNodeInfo:
- * @ctxt: an XML parser context
- * @info: a node info sequence pointer
+ * @param ctxt an XML parser context
+ * @param info a node info sequence pointer
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Insert node info record into the sorted sequence
*/
@@ -3471,14 +3386,13 @@ xmlParserAddNodeInfo(xmlParserCtxtPtr ctxt,
* *
************************************************************************/
/**
- * xmlPedanticParserDefault:
- * @val: int 0 or 1
+ * @param val int 0 or 1
*
- * DEPRECATED: Use the modern options API with XML_PARSE_PEDANTIC.
+ * @deprecated Use the modern options API with XML_PARSE_PEDANTIC.
*
* Set and return the previous value for enabling pedantic warnings.
*
- * Returns the last value for 0 for no substitution, 1 for substitution.
+ * @returns the last value for 0 for no substitution, 1 for substitution.
*/
int
@@ -3490,15 +3404,14 @@ xmlPedanticParserDefault(int val) {
}
/**
- * xmlLineNumbersDefault:
- * @val: int 0 or 1
+ * @param val int 0 or 1
*
- * DEPRECATED: The modern options API always enables line numbers.
+ * @deprecated The modern options API always enables line numbers.
*
* Set and return the previous value for enabling line numbers in elements
* contents. This may break on old application and is turned off by default.
*
- * Returns the last value for 0 for no substitution, 1 for substitution.
+ * @returns the last value for 0 for no substitution, 1 for substitution.
*/
int
@@ -3510,10 +3423,9 @@ xmlLineNumbersDefault(int val) {
}
/**
- * xmlSubstituteEntitiesDefault:
- * @val: int 0 or 1
+ * @param val int 0 or 1
*
- * DEPRECATED: Use the modern options API with XML_PARSE_NOENT.
+ * @deprecated Use the modern options API with XML_PARSE_NOENT.
*
* Set and return the previous value for default entity support.
* Initially the parser always keep entity references instead of substituting
@@ -3522,7 +3434,7 @@ xmlLineNumbersDefault(int val) {
* SAX::substituteEntities() has to be used for changing that on a file by
* file basis.
*
- * Returns the last value for 0 for no substitution, 1 for substitution.
+ * @returns the last value for 0 for no substitution, 1 for substitution.
*/
int
@@ -3534,10 +3446,9 @@ xmlSubstituteEntitiesDefault(int val) {
}
/**
- * xmlKeepBlanksDefault:
- * @val: int 0 or 1
+ * @param val int 0 or 1
*
- * DEPRECATED: Use the modern options API with XML_PARSE_NOBLANKS.
+ * @deprecated Use the modern options API with XML_PARSE_NOBLANKS.
*
* Set and return the previous value for default blanks text nodes support.
* The 1.x version of the parser used an heuristic to try to detect
@@ -3556,7 +3467,7 @@ xmlSubstituteEntitiesDefault(int val) {
* This value also affect autogeneration of indentation when saving code
* if blanks sections are kept, indentation is not generated.
*
- * Returns the last value for 0 for no substitution, 1 for substitution.
+ * @returns the last value for 0 for no substitution, 1 for substitution.
*/
int
diff --git a/pattern.c b/pattern.c
index d480c156..880e1cf6 100644
--- a/pattern.c
+++ b/pattern.c
@@ -192,11 +192,10 @@ struct _xmlPatParserContext {
************************************************************************/
/**
- * xmlNewPattern:
*
* Create a new XSLT Pattern
*
- * Returns the newly allocated xmlPatternPtr or NULL in case of error
+ * @returns the newly allocated xmlPatternPtr or NULL in case of error
*/
static xmlPatternPtr
xmlNewPattern(void) {
@@ -215,10 +214,9 @@ xmlNewPattern(void) {
}
/**
- * xmlFreePattern:
- * @comp: an XSLT comp
+ * @param comp an XSLT comp
*
- * Free up the memory allocated by @comp
+ * Free up the memory allocated by `comp`
*/
void
xmlFreePattern(xmlPatternPtr comp) {
@@ -256,10 +254,9 @@ xmlFreePatternInternal(xmlPatternPtr comp) {
}
/**
- * xmlFreePatternList:
- * @comp: an XSLT comp list
+ * @param comp an XSLT comp list
*
- * Free up the memory allocated by all the elements of @comp
+ * Free up the memory allocated by all the elements of `comp`
*/
void
xmlFreePatternList(xmlPatternPtr comp) {
@@ -274,15 +271,14 @@ xmlFreePatternList(xmlPatternPtr comp) {
}
/**
- * xmlNewPatParserContext:
- * @pattern: the pattern context
- * @dict: the inherited dictionary or NULL
- * @namespaces: the prefix definitions, array of [URI, prefix] terminated
+ * @param pattern the pattern context
+ * @param dict the inherited dictionary or NULL
+ * @param namespaces the prefix definitions, array of [URI, prefix] terminated
* with [NULL, NULL] or NULL if no namespace is used
*
* Create a new XML pattern parser context
*
- * Returns the newly allocated xmlPatParserContextPtr or NULL in case of error
+ * @returns the newly allocated xmlPatParserContextPtr or NULL in case of error
*/
static xmlPatParserContextPtr
xmlNewPatParserContext(const xmlChar *pattern, xmlDictPtr dict,
@@ -315,10 +311,9 @@ xmlNewPatParserContext(const xmlChar *pattern, xmlDictPtr dict,
}
/**
- * xmlFreePatParserContext:
- * @ctxt: an XSLT parser context
+ * @param ctxt an XSLT parser context
*
- * Free up the memory allocated by @ctxt
+ * Free up the memory allocated by `ctxt`
*/
static void
xmlFreePatParserContext(xmlPatParserContextPtr ctxt) {
@@ -347,16 +342,15 @@ xmlPatternGrow(xmlPatternPtr comp) {
}
/**
- * xmlPatternAdd:
- * @ctxt: the pattern parser context
- * @comp: the compiled match expression
- * @op: an op
- * @value: the first value
- * @value2: the second value
+ * @param ctxt the pattern parser context
+ * @param comp the compiled match expression
+ * @param op an op
+ * @param value the first value
+ * @param value2 the second value
*
* Add a step to an XSLT Compiled Match
*
- * Returns -1 in case of failure, 0 otherwise.
+ * @returns -1 in case of failure, 0 otherwise.
*/
static int
xmlPatternAdd(xmlPatParserContextPtr ctxt, xmlPatternPtr comp,
@@ -376,12 +370,11 @@ xmlPatternAdd(xmlPatParserContextPtr ctxt, xmlPatternPtr comp,
}
/**
- * xmlReversePattern:
- * @comp: the compiled match expression
+ * @param comp the compiled match expression
*
* reverse all the stack of expressions
*
- * returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
static int
xmlReversePattern(xmlPatternPtr comp) {
@@ -459,13 +452,12 @@ xmlPatPushState(xmlStepStates *states, int step, xmlNodePtr node) {
}
/**
- * xmlPatMatch:
- * @comp: the precompiled pattern
- * @node: a node
+ * @param comp the precompiled pattern
+ * @param node a node
*
* Test whether the node matches the pattern
*
- * Returns 1 if it matches, 0 if it doesn't and -1 in case of failure
+ * @returns 1 if it matches, 0 if it doesn't and -1 in case of failure
*/
static int
xmlPatMatch(xmlPatternPtr comp, xmlNodePtr node) {
@@ -684,8 +676,7 @@ rollback:
if (xmlPatternAdd(ctxt, ctxt->comp, (op), (val), (val2))) goto error;
/**
- * xmlPatScanName:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [4] NameChar ::= Letter | Digit | '.' | '-' | '_' |
* CombiningChar | Extender
@@ -694,7 +685,7 @@ rollback:
*
* [6] Names ::= Name (S Name)*
*
- * Returns the Name parsed or NULL
+ * @returns the Name parsed or NULL
*/
static xmlChar *
@@ -727,12 +718,11 @@ xmlPatScanName(xmlPatParserContextPtr ctxt) {
}
/**
- * xmlPatScanNCName:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Parses a non qualified name
*
- * Returns the Name parsed or NULL
+ * @returns the Name parsed or NULL
*/
static xmlChar *
@@ -767,8 +757,7 @@ xmlPatScanNCName(xmlPatParserContextPtr ctxt) {
}
/**
- * xmlCompileAttributeTest:
- * @ctxt: the compilation context
+ * @param ctxt the compilation context
*
* Compile an attribute test.
*/
@@ -858,8 +847,7 @@ error:
}
/**
- * xmlCompileStepPattern:
- * @ctxt: the compilation context
+ * @param ctxt the compilation context
*
* Compile the Step Pattern and generates a precompiled
* form suitable for fast matching.
@@ -1081,8 +1069,7 @@ error:
}
/**
- * xmlCompilePathPattern:
- * @ctxt: the compilation context
+ * @param ctxt the compilation context
*
* Compile the Path Pattern and generates a precompiled
* form suitable for fast matching.
@@ -1180,8 +1167,7 @@ error:
}
/**
- * xmlCompileIDCXPathPath:
- * @ctxt: the compilation context
+ * @param ctxt the compilation context
*
* Compile the Path Pattern and generates a precompiled
* form suitable for fast matching.
@@ -1286,12 +1272,11 @@ error_unfinished:
************************************************************************/
/**
- * xmlNewStreamComp:
- * @size: the number of expected steps
+ * @param size the number of expected steps
*
* build a new compiled pattern for streaming
*
- * Returns the new structure or NULL in case of error.
+ * @returns the new structure or NULL in case of error.
*/
static xmlStreamCompPtr
xmlNewStreamComp(int size) {
@@ -1320,8 +1305,7 @@ xmlNewStreamComp(int size) {
}
/**
- * xmlFreeStreamComp:
- * @comp: the compiled pattern for streaming
+ * @param comp the compiled pattern for streaming
*
* Free the compiled pattern for streaming
*/
@@ -1337,16 +1321,15 @@ xmlFreeStreamComp(xmlStreamCompPtr comp) {
}
/**
- * xmlStreamCompAddStep:
- * @comp: the compiled pattern for streaming
- * @name: the first string, the name, or NULL for *
- * @ns: the second step, the namespace name
- * @nodeType: the node type
- * @flags: the flags for that step
+ * @param comp the compiled pattern for streaming
+ * @param name the first string, the name, or NULL for *
+ * @param ns the second step, the namespace name
+ * @param nodeType the node type
+ * @param flags the flags for that step
*
* Add a new step to the compiled pattern
*
- * Returns -1 in case of error or the step index if successful
+ * @returns -1 in case of error or the step index if successful
*/
static int
xmlStreamCompAddStep(xmlStreamCompPtr comp, const xmlChar *name,
@@ -1382,12 +1365,11 @@ xmlStreamCompAddStep(xmlStreamCompPtr comp, const xmlChar *name,
}
/**
- * xmlStreamCompile:
- * @comp: the precompiled pattern
+ * @param comp the precompiled pattern
*
* Tries to stream compile a pattern
*
- * Returns -1 in case of failure and 0 in case of success.
+ * @returns -1 in case of failure and 0 in case of success.
*/
static int
xmlStreamCompile(xmlPatternPtr comp) {
@@ -1561,12 +1543,11 @@ error:
}
/**
- * xmlNewStreamCtxt:
- * @stream: the copmiled stream
+ * @param stream the copmiled stream
*
* build a new stream context
*
- * Returns the new structure or NULL in case of error.
+ * @returns the new structure or NULL in case of error.
*/
static xmlStreamCtxtPtr
xmlNewStreamCtxt(xmlStreamCompPtr stream) {
@@ -1589,8 +1570,7 @@ xmlNewStreamCtxt(xmlStreamCompPtr stream) {
}
/**
- * xmlFreeStreamCtxt:
- * @stream: the stream context
+ * @param stream the stream context
*
* Free the stream context
*/
@@ -1608,14 +1588,13 @@ xmlFreeStreamCtxt(xmlStreamCtxtPtr stream) {
}
/**
- * xmlStreamCtxtAddState:
- * @comp: the stream context
- * @idx: the step index for that streaming state
- * @level: the level
+ * @param comp the stream context
+ * @param idx the step index for that streaming state
+ * @param level the level
*
* Add a new state to the stream context
*
- * Returns -1 in case of error or the state index if successful
+ * @returns -1 in case of error or the state index if successful
*/
static int
xmlStreamCtxtAddState(xmlStreamCtxtPtr comp, int idx, int level) {
@@ -1653,19 +1632,18 @@ xmlStreamCtxtAddState(xmlStreamCtxtPtr comp, int idx, int level) {
}
/**
- * xmlStreamPushInternal:
- * @stream: the stream context
- * @name: the current name
- * @ns: the namespace name
- * @nodeType: the type of the node
+ * @param stream the stream context
+ * @param name the current name
+ * @param ns the namespace name
+ * @param nodeType the type of the node
*
* Push new data onto the stream. NOTE: if the call xmlPatterncompile()
* indicated a dictionary, then strings for name and ns will be expected
* to come from the dictionary.
- * Both @name and @ns being NULL means the / i.e. the root of the document.
+ * Both `name` and `ns` being NULL means the / i.e. the root of the document.
* This can also act as a reset.
*
- * Returns: -1 in case of error, 1 if the current state in the stream is a
+ * @returns -1 in case of error, 1 if the current state in the stream is a
* match and 0 otherwise.
*/
static int
@@ -1977,19 +1955,18 @@ stream_next:
}
/**
- * xmlStreamPush:
- * @stream: the stream context
- * @name: the current name
- * @ns: the namespace name
+ * @param stream the stream context
+ * @param name the current name
+ * @param ns the namespace name
*
* Push new data onto the stream. NOTE: if the call xmlPatterncompile()
* indicated a dictionary, then strings for name and ns will be expected
* to come from the dictionary.
- * Both @name and @ns being NULL means the / i.e. the root of the document.
+ * Both `name` and `ns` being NULL means the / i.e. the root of the document.
* This can also act as a reset.
* Otherwise the function will act as if it has been given an element-node.
*
- * Returns: -1 in case of error, 1 if the current state in the stream is a
+ * @returns -1 in case of error, 1 if the current state in the stream is a
* match and 0 otherwise.
*/
int
@@ -1999,22 +1976,21 @@ xmlStreamPush(xmlStreamCtxtPtr stream,
}
/**
- * xmlStreamPushNode:
- * @stream: the stream context
- * @name: the current name
- * @ns: the namespace name
- * @nodeType: the type of the node being pushed
+ * @param stream the stream context
+ * @param name the current name
+ * @param ns the namespace name
+ * @param nodeType the type of the node being pushed
*
* Push new data onto the stream. NOTE: if the call xmlPatterncompile()
* indicated a dictionary, then strings for name and ns will be expected
* to come from the dictionary.
- * Both @name and @ns being NULL means the / i.e. the root of the document.
+ * Both `name` and `ns` being NULL means the / i.e. the root of the document.
* This can also act as a reset.
* Different from xmlStreamPush() this function can be fed with nodes of type:
* element-, attribute-, text-, cdata-section-, comment- and
* processing-instruction-node.
*
- * Returns: -1 in case of error, 1 if the current state in the stream is a
+ * @returns -1 in case of error, 1 if the current state in the stream is a
* match and 0 otherwise.
*/
int
@@ -2049,12 +2025,11 @@ xmlStreamPushAttr(xmlStreamCtxtPtr stream,
}
/**
- * xmlStreamPop:
- * @stream: the stream context
+ * @param stream the stream context
*
* push one level from the stream.
*
- * Returns: -1 in case of error, 0 otherwise.
+ * @returns -1 in case of error, 0 otherwise.
*/
int
xmlStreamPop(xmlStreamCtxtPtr stream) {
@@ -2093,15 +2068,14 @@ xmlStreamPop(xmlStreamCtxtPtr stream) {
}
/**
- * xmlStreamWantsAnyNode:
- * @streamCtxt: the stream context
+ * @param streamCtxt the stream context
*
* Query if the streaming pattern additionally needs to be fed with
* text-, cdata-section-, comment- and processing-instruction-nodes.
* If the result is 0 then only element-nodes and attribute-nodes
* need to be pushed.
*
- * Returns: 1 in case of need of nodes of the above described types,
+ * @returns 1 in case of need of nodes of the above described types,
* 0 otherwise. -1 on API errors.
*/
int
@@ -2124,18 +2098,17 @@ xmlStreamWantsAnyNode(xmlStreamCtxtPtr streamCtxt)
************************************************************************/
/**
- * xmlPatternCompileSafe:
- * @pattern: the pattern to compile
- * @dict: an optional dictionary for interned strings
- * @flags: compilation flags, see xmlPatternFlags
- * @namespaces: the prefix definitions, array of [URI, prefix] or NULL
- * @patternOut: output pattern
+ * @param pattern the pattern to compile
+ * @param dict an optional dictionary for interned strings
+ * @param flags compilation flags, see xmlPatternFlags
+ * @param namespaces the prefix definitions, array of [URI, prefix] or NULL
+ * @param patternOut output pattern
*
* Compile a pattern.
*
* Available since 2.13.0.
*
- * Returns 0 on success, 1 on error, -1 if a memory allocation failed.
+ * @returns 0 on success, 1 on error, -1 if a memory allocation failed.
*/
int
xmlPatternCompileSafe(const xmlChar *pattern, xmlDict *dict, int flags,
@@ -2254,15 +2227,14 @@ error:
}
/**
- * xmlPatterncompile:
- * @pattern: the pattern to compile
- * @dict: an optional dictionary for interned strings
- * @flags: compilation flags, see xmlPatternFlags
- * @namespaces: the prefix definitions, array of [URI, prefix] or NULL
+ * @param pattern the pattern to compile
+ * @param dict an optional dictionary for interned strings
+ * @param flags compilation flags, see xmlPatternFlags
+ * @param namespaces the prefix definitions, array of [URI, prefix] or NULL
*
* Compile a pattern.
*
- * Returns the compiled form of the pattern or NULL in case of error
+ * @returns the compiled form of the pattern or NULL in case of error
*/
xmlPatternPtr
xmlPatterncompile(const xmlChar *pattern, xmlDict *dict, int flags,
@@ -2273,13 +2245,12 @@ xmlPatterncompile(const xmlChar *pattern, xmlDict *dict, int flags,
}
/**
- * xmlPatternMatch:
- * @comp: the precompiled pattern
- * @node: a node
+ * @param comp the precompiled pattern
+ * @param node a node
*
* Test whether the node matches the pattern
*
- * Returns 1 if it matches, 0 if it doesn't and -1 in case of failure
+ * @returns 1 if it matches, 0 if it doesn't and -1 in case of failure
*/
int
xmlPatternMatch(xmlPatternPtr comp, xmlNodePtr node)
@@ -2299,13 +2270,12 @@ xmlPatternMatch(xmlPatternPtr comp, xmlNodePtr node)
}
/**
- * xmlPatternGetStreamCtxt:
- * @comp: the precompiled pattern
+ * @param comp the precompiled pattern
*
* Get a streaming context for that pattern
* Use xmlFreeStreamCtxt to free the context.
*
- * Returns a pointer to the context or NULL in case of failure
+ * @returns a pointer to the context or NULL in case of failure
*/
xmlStreamCtxtPtr
xmlPatternGetStreamCtxt(xmlPatternPtr comp)
@@ -2337,13 +2307,12 @@ failed:
}
/**
- * xmlPatternStreamable:
- * @comp: the precompiled pattern
+ * @param comp the precompiled pattern
*
* Check if the pattern is streamable i.e. xmlPatternGetStreamCtxt()
* should work.
*
- * Returns 1 if streamable, 0 if not and -1 in case of error.
+ * @returns 1 if streamable, 0 if not and -1 in case of error.
*/
int
xmlPatternStreamable(xmlPatternPtr comp) {
@@ -2358,12 +2327,11 @@ xmlPatternStreamable(xmlPatternPtr comp) {
}
/**
- * xmlPatternMaxDepth:
- * @comp: the precompiled pattern
+ * @param comp the precompiled pattern
*
* Check the maximum depth reachable by a pattern
*
- * Returns -2 if no limit (using //), otherwise the depth,
+ * @returns -2 if no limit (using //), otherwise the depth,
* and -1 in case of error
*/
int
@@ -2385,13 +2353,12 @@ xmlPatternMaxDepth(xmlPatternPtr comp) {
}
/**
- * xmlPatternMinDepth:
- * @comp: the precompiled pattern
+ * @param comp the precompiled pattern
*
* Check the minimum depth reachable by a pattern, 0 mean the / or . are
* part of the set.
*
- * Returns -1 in case of error otherwise the depth,
+ * @returns -1 in case of error otherwise the depth,
*
*/
int
@@ -2412,12 +2379,11 @@ xmlPatternMinDepth(xmlPatternPtr comp) {
}
/**
- * xmlPatternFromRoot:
- * @comp: the precompiled pattern
+ * @param comp the precompiled pattern
*
* Check if the pattern must be looked at from the root.
*
- * Returns 1 if true, 0 if false and -1 in case of error
+ * @returns 1 if true, 0 if false and -1 in case of error
*/
int
xmlPatternFromRoot(xmlPatternPtr comp) {
diff --git a/relaxng.c b/relaxng.c
index de1617fd..f5d3e537 100644
--- a/relaxng.c
+++ b/relaxng.c
@@ -239,7 +239,6 @@ struct _xmlRelaxNGParserCtxt {
#define FLAGS_NOERROR 8
/**
- * xmlRelaxNGInterleaveGroup:
*
* A RelaxNGs partition set associated to lists of definitions
*/
@@ -255,7 +254,6 @@ struct _xmlRelaxNGInterleaveGroup {
#define IS_NEEDCHECK 2
/**
- * xmlRelaxNGPartitions:
*
* A RelaxNGs partition associated to an interleave group
*/
@@ -270,7 +268,6 @@ struct _xmlRelaxNGPartition {
};
/**
- * xmlRelaxNGValidState:
*
* A RelaxNGs validation state
*/
@@ -289,7 +286,6 @@ struct _xmlRelaxNGValidState {
};
/**
- * xmlRelaxNGStates:
*
* A RelaxNGs container for validation state
*/
@@ -304,7 +300,6 @@ struct _xmlRelaxNGStates {
#define ERROR_IS_DUP 1
/**
- * xmlRelaxNGValidError:
*
* A RelaxNGs validation error
*/
@@ -320,7 +315,6 @@ struct _xmlRelaxNGValidError {
};
/**
- * xmlRelaxNGValidCtxt:
*
* A RelaxNGs validation context
*/
@@ -371,7 +365,6 @@ struct _xmlRelaxNGValidCtxt {
};
/**
- * xmlRelaxNGInclude:
*
* Structure associated to a RelaxNGs document element
*/
@@ -384,7 +377,6 @@ struct _xmlRelaxNGInclude {
};
/**
- * xmlRelaxNGDocument:
*
* Structure associated to a RelaxNGs document element
*/
@@ -405,8 +397,7 @@ struct _xmlRelaxNGDocument {
************************************************************************/
/**
- * xmlRngPErrMemory:
- * @ctxt: an Relax-NG parser context
+ * @param ctxt an Relax-NG parser context
*
* Handle a redefinition of attribute error
*/
@@ -430,8 +421,7 @@ xmlRngPErrMemory(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRngVErrMemory:
- * @ctxt: a Relax-NG validation context
+ * @param ctxt a Relax-NG validation context
*
* Handle a redefinition of attribute error
*/
@@ -455,13 +445,12 @@ xmlRngVErrMemory(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRngPErr:
- * @ctxt: a Relax-NG parser context
- * @node: the node raising the error
- * @error: the error code
- * @msg: message
- * @str1: extra info
- * @str2: extra info
+ * @param ctxt a Relax-NG parser context
+ * @param node the node raising the error
+ * @param error the error code
+ * @param msg message
+ * @param str1 extra info
+ * @param str2 extra info
*
* Handle a Relax NG Parsing error
*/
@@ -497,13 +486,12 @@ xmlRngPErr(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node, int error,
}
/**
- * xmlRngVErr:
- * @ctxt: a Relax-NG validation context
- * @node: the node raising the error
- * @error: the error code
- * @msg: message
- * @str1: extra info
- * @str2: extra info
+ * @param ctxt a Relax-NG validation context
+ * @param node the node raising the error
+ * @param error the error code
+ * @param msg message
+ * @param str1 extra info
+ * @param str2 extra info
*
* Handle a Relax NG Validation error
*/
@@ -545,43 +533,40 @@ xmlRngVErr(xmlRelaxNGValidCtxtPtr ctxt, xmlNodePtr node, int error,
************************************************************************/
/**
- * xmlRelaxNGTypeHave:
- * @data: data needed for the library
- * @type: the type name
+ * @param data data needed for the library
+ * @param type the type name
*
* Function provided by a type library to check if a type is exported
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
typedef int (*xmlRelaxNGTypeHave) (void *data, const xmlChar * type);
/**
- * xmlRelaxNGTypeCheck:
- * @data: data needed for the library
- * @type: the type name
- * @value: the value to check
- * @result: place to store the result if needed
+ * @param data data needed for the library
+ * @param type the type name
+ * @param value the value to check
+ * @param result place to store the result if needed
*
* Function provided by a type library to check if a value match a type
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
typedef int (*xmlRelaxNGTypeCheck) (void *data, const xmlChar * type,
const xmlChar * value, void **result,
xmlNodePtr node);
/**
- * xmlRelaxNGFacetCheck:
- * @data: data needed for the library
- * @type: the type name
- * @facet: the facet name
- * @val: the facet value
- * @strval: the string value
- * @value: the value to check
+ * @param data data needed for the library
+ * @param type the type name
+ * @param facet the facet name
+ * @param val the facet value
+ * @param strval the string value
+ * @param value the value to check
*
* Function provided by a type library to check a value facet
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
typedef int (*xmlRelaxNGFacetCheck) (void *data, const xmlChar * type,
const xmlChar * facet,
@@ -589,25 +574,23 @@ typedef int (*xmlRelaxNGFacetCheck) (void *data, const xmlChar * type,
const xmlChar * strval, void *value);
/**
- * xmlRelaxNGTypeFree:
- * @data: data needed for the library
- * @result: the value to free
+ * @param data data needed for the library
+ * @param result the value to free
*
* Function provided by a type library to free a returned result
*/
typedef void (*xmlRelaxNGTypeFree) (void *data, void *result);
/**
- * xmlRelaxNGTypeCompare:
- * @data: data needed for the library
- * @type: the type name
- * @value1: the first value
- * @value2: the second value
+ * @param data data needed for the library
+ * @param type the type name
+ * @param value1 the first value
+ * @param value2 the second value
*
* Function provided by a type library to compare two values accordingly
* to a type.
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
typedef int (*xmlRelaxNGTypeCompare) (void *data, const xmlChar * type,
const xmlChar * value1,
@@ -644,8 +627,7 @@ static void xmlRelaxNGFreeValidState(xmlRelaxNGValidCtxtPtr ctxt,
xmlRelaxNGValidStatePtr state);
/**
- * xmlRelaxNGFreeDocument:
- * @docu: a document structure
+ * @param docu a document structure
*
* Deallocate a RelaxNG document structure.
*/
@@ -665,8 +647,7 @@ xmlRelaxNGFreeDocument(xmlRelaxNGDocumentPtr docu)
}
/**
- * xmlRelaxNGFreeDocumentList:
- * @docu: a list of document structure
+ * @param docu a list of document structure
*
* Deallocate a RelaxNG document structures.
*/
@@ -683,8 +664,7 @@ xmlRelaxNGFreeDocumentList(xmlRelaxNGDocumentPtr docu)
}
/**
- * xmlRelaxNGFreeInclude:
- * @incl: a include structure
+ * @param incl a include structure
*
* Deallocate a RelaxNG include structure.
*/
@@ -704,8 +684,7 @@ xmlRelaxNGFreeInclude(xmlRelaxNGIncludePtr incl)
}
/**
- * xmlRelaxNGFreeIncludeList:
- * @incl: a include structure list
+ * @param incl a include structure list
*
* Deallocate a RelaxNG include structure.
*/
@@ -722,12 +701,11 @@ xmlRelaxNGFreeIncludeList(xmlRelaxNGIncludePtr incl)
}
/**
- * xmlRelaxNGNewRelaxNG:
- * @ctxt: a Relax-NG validation context (optional)
+ * @param ctxt a Relax-NG validation context (optional)
*
* Allocate a new RelaxNG structure.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlRelaxNGPtr
xmlRelaxNGNewRelaxNG(xmlRelaxNGParserCtxtPtr ctxt)
@@ -745,8 +723,7 @@ xmlRelaxNGNewRelaxNG(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRelaxNGFreeInnerSchema:
- * @schema: a schema structure
+ * @param schema a schema structure
*
* Deallocate a RelaxNG schema structure.
*/
@@ -770,8 +747,7 @@ xmlRelaxNGFreeInnerSchema(xmlRelaxNGPtr schema)
}
/**
- * xmlRelaxNGFree:
- * @schema: a schema structure
+ * @param schema a schema structure
*
* Deallocate a RelaxNG structure.
*/
@@ -801,12 +777,11 @@ xmlRelaxNGFree(xmlRelaxNGPtr schema)
}
/**
- * xmlRelaxNGNewGrammar:
- * @ctxt: a Relax-NG validation context (optional)
+ * @param ctxt a Relax-NG validation context (optional)
*
* Allocate a new RelaxNG grammar.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlRelaxNGGrammarPtr
xmlRelaxNGNewGrammar(xmlRelaxNGParserCtxtPtr ctxt)
@@ -824,8 +799,7 @@ xmlRelaxNGNewGrammar(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRelaxNGFreeGrammar:
- * @grammar: a grammar structure
+ * @param grammar a grammar structure
*
* Deallocate a RelaxNG grammar structure.
*/
@@ -852,13 +826,12 @@ xmlRelaxNGFreeGrammar(xmlRelaxNGGrammarPtr grammar)
}
/**
- * xmlRelaxNGNewDefine:
- * @ctxt: a Relax-NG validation context
- * @node: the node in the input document.
+ * @param ctxt a Relax-NG validation context
+ * @param node the node in the input document.
*
* Allocate a new RelaxNG define.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGNewDefine(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -901,8 +874,7 @@ xmlRelaxNGNewDefine(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGFreePartition:
- * @partitions: a partition set structure
+ * @param partitions a partition set structure
*
* Deallocate RelaxNG partition set structures.
*/
@@ -934,8 +906,7 @@ xmlRelaxNGFreePartition(xmlRelaxNGPartitionPtr partitions)
}
/**
- * xmlRelaxNGFreeDefine:
- * @define: a define structure
+ * @param define a define structure
*
* Deallocate a RelaxNG define structure.
*/
@@ -968,13 +939,12 @@ xmlRelaxNGFreeDefine(xmlRelaxNGDefinePtr define)
}
/**
- * xmlRelaxNGNewStates:
- * @ctxt: a Relax-NG validation context
- * @size: the default size for the container
+ * @param ctxt a Relax-NG validation context
+ * @param size the default size for the container
*
* Allocate a new RelaxNG validation state container
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlRelaxNGStatesPtr
xmlRelaxNGNewStates(xmlRelaxNGValidCtxtPtr ctxt, int size)
@@ -1013,15 +983,14 @@ xmlRelaxNGNewStates(xmlRelaxNGValidCtxtPtr ctxt, int size)
}
/**
- * xmlRelaxNGAddStateUniq:
- * @ctxt: a Relax-NG validation context
- * @states: the states container
- * @state: the validation state
+ * @param ctxt a Relax-NG validation context
+ * @param states the states container
+ * @param state the validation state
*
* Add a RelaxNG validation state to the container without checking
* for unicity.
*
- * Return 1 in case of success and 0 if this is a duplicate and -1 on error
+ * @returns 1 in case of success and 0 if this is a duplicate and -1 on error
*/
static int
xmlRelaxNGAddStatesUniq(xmlRelaxNGValidCtxtPtr ctxt,
@@ -1052,14 +1021,13 @@ xmlRelaxNGAddStatesUniq(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGAddState:
- * @ctxt: a Relax-NG validation context
- * @states: the states container
- * @state: the validation state
+ * @param ctxt a Relax-NG validation context
+ * @param states the states container
+ * @param state the validation state
*
* Add a RelaxNG validation state to the container
*
- * Return 1 in case of success and 0 if this is a duplicate and -1 on error
+ * @returns 1 in case of success and 0 if this is a duplicate and -1 on error
*/
static int
xmlRelaxNGAddStates(xmlRelaxNGValidCtxtPtr ctxt,
@@ -1098,9 +1066,8 @@ xmlRelaxNGAddStates(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGFreeStates:
- * @ctxt: a Relax-NG validation context
- * @states: the container
+ * @param ctxt a Relax-NG validation context
+ * @param states the container
*
* Free a RelaxNG validation state container
*/
@@ -1144,13 +1111,12 @@ xmlRelaxNGFreeStates(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGNewValidState:
- * @ctxt: a Relax-NG validation context
- * @node: the current node or NULL for the document
+ * @param ctxt a Relax-NG validation context
+ * @param node the current node or NULL for the document
*
* Allocate a new RelaxNG validation state
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlRelaxNGValidStatePtr
xmlRelaxNGNewValidState(xmlRelaxNGValidCtxtPtr ctxt, xmlNodePtr node)
@@ -1239,13 +1205,12 @@ xmlRelaxNGNewValidState(xmlRelaxNGValidCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGCopyValidState:
- * @ctxt: a Relax-NG validation context
- * @state: a validation state
+ * @param ctxt a Relax-NG validation context
+ * @param state a validation state
*
* Copy the validation state
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlRelaxNGValidStatePtr
xmlRelaxNGCopyValidState(xmlRelaxNGValidCtxtPtr ctxt,
@@ -1305,14 +1270,13 @@ xmlRelaxNGCopyValidState(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGEqualValidState:
- * @ctxt: a Relax-NG validation context
- * @state1: a validation state
- * @state2: a validation state
+ * @param ctxt a Relax-NG validation context
+ * @param state1 a validation state
+ * @param state2 a validation state
*
* Compare the validation states for equality
*
- * Returns 1 if equal, 0 otherwise
+ * @returns 1 if equal, 0 otherwise
*/
static int
xmlRelaxNGEqualValidState(xmlRelaxNGValidCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -1346,9 +1310,8 @@ xmlRelaxNGEqualValidState(xmlRelaxNGValidCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGFreeValidState:
- * @ctxt: validation context
- * @state: a validation state structure
+ * @param ctxt validation context
+ * @param state a validation state structure
*
* Deallocate a RelaxNG validation state structure.
*/
@@ -1378,14 +1341,13 @@ xmlRelaxNGFreeValidState(xmlRelaxNGValidCtxtPtr ctxt,
************************************************************************/
/**
- * xmlRelaxParserSetFlag:
- * @ctxt: a RelaxNG parser context
- * @flags: a set of flags values
+ * @param ctxt a RelaxNG parser context
+ * @param flags a set of flags values
*
* Semi private function used to pass information to a parser context
* which are a combination of xmlRelaxNGParserFlag .
*
- * Returns 0 if success and -1 in case of error
+ * @returns 0 if success and -1 in case of error
*/
int
xmlRelaxParserSetFlag(xmlRelaxNGParserCtxtPtr ctxt, int flags)
@@ -1454,13 +1416,12 @@ xmlRelaxReadMemory(xmlRelaxNGParserCtxtPtr ctxt, const char *buf, int size) {
}
/**
- * xmlRelaxNGIncludePush:
- * @ctxt: the parser context
- * @value: the element doc
+ * @param ctxt the parser context
+ * @param value the element doc
*
* Pushes a new include on top of the include stack
*
- * Returns 0 in case of error, the index in the stack otherwise
+ * @returns 0 in case of error, the index in the stack otherwise
*/
static int
xmlRelaxNGIncludePush(xmlRelaxNGParserCtxtPtr ctxt,
@@ -1494,12 +1455,11 @@ xmlRelaxNGIncludePush(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGIncludePop:
- * @ctxt: the parser context
+ * @param ctxt the parser context
*
* Pops the top include from the include stack
*
- * Returns the include just removed
+ * @returns the include just removed
*/
static xmlRelaxNGIncludePtr
xmlRelaxNGIncludePop(xmlRelaxNGParserCtxtPtr ctxt)
@@ -1519,15 +1479,14 @@ xmlRelaxNGIncludePop(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRelaxNGRemoveRedefine:
- * @ctxt: the parser context
- * @URL: the normalized URL
- * @target: the included target
- * @name: the define name to eliminate
+ * @param ctxt the parser context
+ * @param URL the normalized URL
+ * @param target the included target
+ * @param name the define name to eliminate
*
* Applies the elimination algorithm of 4.7
*
- * Returns 0 in case of error, 1 in case of success.
+ * @returns 0 in case of error, 1 in case of success.
*/
static int
xmlRelaxNGRemoveRedefine(xmlRelaxNGParserCtxtPtr ctxt,
@@ -1582,17 +1541,16 @@ xmlRelaxNGRemoveRedefine(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGLoadInclude:
- * @ctxt: the parser context
- * @URL: the normalized URL
- * @node: the include node.
- * @ns: the namespace passed from the context.
+ * @param ctxt the parser context
+ * @param URL the normalized URL
+ * @param node the include node.
+ * @param ns the namespace passed from the context.
*
* First lookup if the document is already loaded into the parser context,
* check against recursion. If not found the resource is loaded and
* the content is preprocessed before being returned back to the caller.
*
- * Returns the xmlRelaxNGIncludePtr or NULL in case of error
+ * @returns the xmlRelaxNGIncludePtr or NULL in case of error
*/
static xmlRelaxNGIncludePtr
xmlRelaxNGLoadInclude(xmlRelaxNGParserCtxtPtr ctxt, const xmlChar * URL,
@@ -1746,16 +1704,15 @@ xmlRelaxNGLoadInclude(xmlRelaxNGParserCtxtPtr ctxt, const xmlChar * URL,
}
/**
- * xmlRelaxNGValidErrorPush:
- * @ctxt: the validation context
- * @err: the error code
- * @arg1: the first string argument
- * @arg2: the second string argument
- * @dup: arg need to be duplicated
+ * @param ctxt the validation context
+ * @param err the error code
+ * @param arg1 the first string argument
+ * @param arg2 the second string argument
+ * @param dup arg need to be duplicated
*
* Pushes a new error on top of the error stack
*
- * Returns 0 in case of error, the index in the stack otherwise
+ * @returns 0 in case of error, the index in the stack otherwise
*/
static int
xmlRelaxNGValidErrorPush(xmlRelaxNGValidCtxtPtr ctxt,
@@ -1816,8 +1773,7 @@ xmlRelaxNGValidErrorPush(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidErrorPop:
- * @ctxt: the validation context
+ * @param ctxt the validation context
*
* Pops the top error from the error stack
*/
@@ -1848,13 +1804,12 @@ xmlRelaxNGValidErrorPop(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGDocumentPush:
- * @ctxt: the parser context
- * @value: the element doc
+ * @param ctxt the parser context
+ * @param value the element doc
*
* Pushes a new doc on top of the doc stack
*
- * Returns 0 in case of error, the index in the stack otherwise
+ * @returns 0 in case of error, the index in the stack otherwise
*/
static int
xmlRelaxNGDocumentPush(xmlRelaxNGParserCtxtPtr ctxt,
@@ -1888,12 +1843,11 @@ xmlRelaxNGDocumentPush(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGDocumentPop:
- * @ctxt: the parser context
+ * @param ctxt the parser context
*
* Pops the top doc from the doc stack
*
- * Returns the doc just removed
+ * @returns the doc just removed
*/
static xmlRelaxNGDocumentPtr
xmlRelaxNGDocumentPop(xmlRelaxNGParserCtxtPtr ctxt)
@@ -1913,16 +1867,15 @@ xmlRelaxNGDocumentPop(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRelaxNGLoadExternalRef:
- * @ctxt: the parser context
- * @URL: the normalized URL
- * @ns: the inherited ns if any
+ * @param ctxt the parser context
+ * @param URL the normalized URL
+ * @param ns the inherited ns if any
*
* First lookup if the document is already loaded into the parser context,
* check against recursion. If not found the resource is loaded and
* the content is preprocessed before being returned back to the caller.
*
- * Returns the xmlRelaxNGDocumentPtr or NULL in case of error
+ * @returns the xmlRelaxNGDocumentPtr or NULL in case of error
*/
static xmlRelaxNGDocumentPtr
xmlRelaxNGLoadExternalRef(xmlRelaxNGParserCtxtPtr ctxt,
@@ -2069,14 +2022,13 @@ xmlRelaxNGDefName(xmlRelaxNGDefinePtr def)
}
/**
- * xmlRelaxNGGetErrorString:
- * @err: the error code
- * @arg1: the first string argument
- * @arg2: the second string argument
+ * @param err the error code
+ * @param arg1 the first string argument
+ * @param arg2 the second string argument
*
* computes a formatted error string for the given error code and args
*
- * Returns the error string, it must be deallocated by the caller
+ * @returns the error string, it must be deallocated by the caller
*/
static xmlChar *
xmlRelaxNGGetErrorString(xmlRelaxNGValidErr err, const xmlChar * arg1,
@@ -2216,13 +2168,12 @@ xmlRelaxNGGetErrorString(xmlRelaxNGValidErr err, const xmlChar * arg1,
}
/**
- * xmlRelaxNGShowValidError:
- * @ctxt: the validation context
- * @err: the error number
- * @node: the node
- * @child: the node child generating the problem.
- * @arg1: the first argument
- * @arg2: the second argument
+ * @param ctxt the validation context
+ * @param err the error number
+ * @param node the node
+ * @param child the node child generating the problem.
+ * @param arg1 the first argument
+ * @param arg2 the second argument
*
* Show a validation error.
*/
@@ -2249,9 +2200,8 @@ xmlRelaxNGShowValidError(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGPopErrors:
- * @ctxt: the validation context
- * @level: the error level in the stack
+ * @param ctxt the validation context
+ * @param level the error level in the stack
*
* pop and discard all errors until the given level is reached
*/
@@ -2279,8 +2229,7 @@ xmlRelaxNGPopErrors(xmlRelaxNGValidCtxtPtr ctxt, int level)
}
/**
- * xmlRelaxNGDumpValidError:
- * @ctxt: the validation context
+ * @param ctxt the validation context
*
* Show all validation error over a given index.
*/
@@ -2320,12 +2269,11 @@ xmlRelaxNGDumpValidError(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGAddValidError:
- * @ctxt: the validation context
- * @err: the error number
- * @arg1: the first argument
- * @arg2: the second argument
- * @dup: need to dup the args
+ * @param ctxt the validation context
+ * @param err the error number
+ * @param arg1 the first argument
+ * @param arg2 the second argument
+ * @param dup need to dup the args
*
* Register a validation error, either generating it if it's sure
* or stacking it for later handling if unsure.
@@ -2382,14 +2330,13 @@ static xmlChar *xmlRelaxNGNormalize(xmlRelaxNGValidCtxtPtr ctxt,
const xmlChar * str);
/**
- * xmlRelaxNGSchemaTypeHave:
- * @data: data needed for the library
- * @type: the type name
+ * @param data data needed for the library
+ * @param type the type name
*
* Check if the given type is provided by
* the W3C XMLSchema Datatype library.
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGSchemaTypeHave(void *data ATTRIBUTE_UNUSED, const xmlChar * type)
@@ -2407,17 +2354,16 @@ xmlRelaxNGSchemaTypeHave(void *data ATTRIBUTE_UNUSED, const xmlChar * type)
}
/**
- * xmlRelaxNGSchemaTypeCheck:
- * @data: data needed for the library
- * @type: the type name
- * @value: the value to check
- * @result: pointer to result
- * @node: the node
+ * @param data data needed for the library
+ * @param type the type name
+ * @param value the value to check
+ * @param result pointer to result
+ * @param node the node
*
* Check if the given type and value are validated by
* the W3C XMLSchema Datatype library.
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGSchemaTypeCheck(void *data ATTRIBUTE_UNUSED,
@@ -2447,17 +2393,16 @@ xmlRelaxNGSchemaTypeCheck(void *data ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGSchemaFacetCheck:
- * @data: data needed for the library
- * @type: the type name
- * @facetname: the facet name
- * @val: the facet value
- * @strval: the string value
- * @value: the value to check
+ * @param data data needed for the library
+ * @param type the type name
+ * @param facetname the facet name
+ * @param val the facet value
+ * @param strval the string value
+ * @param value the value to check
*
* Function provided by a type library to check a value facet
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGSchemaFacetCheck(void *data ATTRIBUTE_UNUSED,
@@ -2523,13 +2468,12 @@ xmlRelaxNGSchemaFacetCheck(void *data ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGSchemaFreeValue:
- * @data: data needed for the library
- * @value: the value to free
+ * @param data data needed for the library
+ * @param value the value to free
*
* Function provided by a type library to free a Schemas value
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static void
xmlRelaxNGSchemaFreeValue(void *data ATTRIBUTE_UNUSED, void *value)
@@ -2538,19 +2482,18 @@ xmlRelaxNGSchemaFreeValue(void *data ATTRIBUTE_UNUSED, void *value)
}
/**
- * xmlRelaxNGSchemaTypeCompare:
- * @data: data needed for the library
- * @type: the type name
- * @value1: the first value
- * @ctxt1: the first context node
- * @comp1: value to compare with
- * @value2: the second value
- * @ctxt2: the second context node
+ * @param data data needed for the library
+ * @param type the type name
+ * @param value1 the first value
+ * @param ctxt1 the first context node
+ * @param comp1 value to compare with
+ * @param value2 the second value
+ * @param ctxt2 the second context node
*
* Compare two values for equality accordingly a type from the W3C XMLSchema
* Datatype library.
*
- * Returns 1 if equal, 0 if no and -1 in case of error.
+ * @returns 1 if equal, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGSchemaTypeCompare(void *data ATTRIBUTE_UNUSED,
@@ -2598,14 +2541,13 @@ xmlRelaxNGSchemaTypeCompare(void *data ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGDefaultTypeHave:
- * @data: data needed for the library
- * @type: the type name
+ * @param data data needed for the library
+ * @param type the type name
*
* Check if the given type is provided by
* the default datatype library.
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGDefaultTypeHave(void *data ATTRIBUTE_UNUSED,
@@ -2621,17 +2563,16 @@ xmlRelaxNGDefaultTypeHave(void *data ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGDefaultTypeCheck:
- * @data: data needed for the library
- * @type: the type name
- * @value: the value to check
- * @result: pointer to result
- * @node: the node
+ * @param data data needed for the library
+ * @param type the type name
+ * @param value the value to check
+ * @param result pointer to result
+ * @param node the node
*
* Check if the given type and value are validated by
* the default datatype library.
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGDefaultTypeCheck(void *data ATTRIBUTE_UNUSED,
@@ -2652,19 +2593,18 @@ xmlRelaxNGDefaultTypeCheck(void *data ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGDefaultTypeCompare:
- * @data: data needed for the library
- * @type: the type name
- * @value1: the first value
- * @ctxt1: the first context node
- * @comp1: value to compare with
- * @value2: the second value
- * @ctxt2: the second context node
+ * @param data data needed for the library
+ * @param type the type name
+ * @param value1 the first value
+ * @param ctxt1 the first context node
+ * @param comp1 value to compare with
+ * @param value2 the second value
+ * @param ctxt2 the second context node
*
* Compare two values accordingly a type from the default
* datatype library.
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGDefaultTypeCompare(void *data ATTRIBUTE_UNUSED,
@@ -2710,9 +2650,8 @@ static int xmlRelaxNGTypeInitialized = 0;
static xmlHashTablePtr xmlRelaxNGRegisteredTypes = NULL;
/**
- * xmlRelaxNGFreeTypeLibrary:
- * @payload: the type library structure
- * @namespace: the URI bound to the library
+ * @param payload the type library structure
+ * @param namespace the URI bound to the library
*
* Free the structure associated to the type library
*/
@@ -2729,18 +2668,17 @@ xmlRelaxNGFreeTypeLibrary(void *payload,
}
/**
- * xmlRelaxNGRegisterTypeLibrary:
- * @namespace: the URI bound to the library
- * @data: data associated to the library
- * @have: the provide function
- * @check: the checking function
- * @comp: the comparison function
- * @facet: facet check function
- * @freef: free function
+ * @param namespace the URI bound to the library
+ * @param data data associated to the library
+ * @param have the provide function
+ * @param check the checking function
+ * @param comp the comparison function
+ * @param facet facet check function
+ * @param freef free function
*
* Register a new type library
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
static int
xmlRelaxNGRegisterTypeLibrary(const xmlChar * namespace, void *data,
@@ -2782,11 +2720,10 @@ xmlRelaxNGRegisterTypeLibrary(const xmlChar * namespace, void *data,
}
/**
- * xmlRelaxNGInitTypes:
*
* Initialize the default type libraries.
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlRelaxNGInitTypes(void)
@@ -2813,9 +2750,8 @@ xmlRelaxNGInitTypes(void)
}
/**
- * xmlRelaxNGCleanupTypes:
*
- * DEPRECATED: This function will be made private. Call xmlCleanupParser
+ * @deprecated This function will be made private. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have call cleanup functions at all.
@@ -2845,12 +2781,11 @@ static int xmlRelaxNGTryCompile(xmlRelaxNGParserCtxtPtr ctxt,
xmlRelaxNGDefinePtr def);
/**
- * xmlRelaxNGIsCompilable:
- * @def: the definition to check
+ * @param def the definition to check
*
* Check if a definition is nullable.
*
- * Returns 1 if yes, 0 if no and -1 in case of error
+ * @returns 1 if yes, 0 if no and -1 in case of error
*/
static int
xmlRelaxNGIsCompilable(xmlRelaxNGDefinePtr def)
@@ -2964,14 +2899,13 @@ xmlRelaxNGIsCompilable(xmlRelaxNGDefinePtr def)
}
/**
- * xmlRelaxNGCompile:
- * @ctxt: the RelaxNG parser context
- * @def: the definition tree to compile
+ * @param ctxt the RelaxNG parser context
+ * @param def the definition tree to compile
*
* Compile the set of definitions, it works recursively, till the
* element boundaries, where it tries to compile the content if possible
*
- * Returns 0 if success and -1 in case of error
+ * @returns 0 if success and -1 in case of error
*/
static int
xmlRelaxNGCompile(xmlRelaxNGParserCtxtPtr ctxt, xmlRelaxNGDefinePtr def)
@@ -3185,14 +3119,13 @@ xmlRelaxNGCompile(xmlRelaxNGParserCtxtPtr ctxt, xmlRelaxNGDefinePtr def)
}
/**
- * xmlRelaxNGTryCompile:
- * @ctxt: the RelaxNG parser context
- * @def: the definition tree to compile
+ * @param ctxt the RelaxNG parser context
+ * @param def the definition tree to compile
*
* Try to compile the set of definitions, it works recursively,
* possibly ignoring parts which cannot be compiled.
*
- * Returns 0 if success and -1 in case of error
+ * @returns 0 if success and -1 in case of error
*/
static int
xmlRelaxNGTryCompile(xmlRelaxNGParserCtxtPtr ctxt, xmlRelaxNGDefinePtr def)
@@ -3286,12 +3219,11 @@ static int xmlRelaxNGElementMatch(xmlRelaxNGValidCtxtPtr ctxt,
#define IS_BLANK_NODE(n) (xmlRelaxNGIsBlank((n)->content))
/**
- * xmlRelaxNGIsNullable:
- * @define: the definition to verify
+ * @param define the definition to verify
*
* Check if a definition is nullable.
*
- * Returns 1 if yes, 0 if no and -1 in case of error
+ * @returns 1 if yes, 0 if no and -1 in case of error
*/
static int
xmlRelaxNGIsNullable(xmlRelaxNGDefinePtr define)
@@ -3365,12 +3297,11 @@ xmlRelaxNGIsNullable(xmlRelaxNGDefinePtr define)
}
/**
- * xmlRelaxNGIsBlank:
- * @str: a string
+ * @param str a string
*
* Check if a string is ignorable c.f. 4.2. Whitespace
*
- * Returns 1 if the string is NULL or made of blanks chars, 0 otherwise
+ * @returns 1 if the string is NULL or made of blanks chars, 0 otherwise
*/
static int
xmlRelaxNGIsBlank(xmlChar * str)
@@ -3386,13 +3317,12 @@ xmlRelaxNGIsBlank(xmlChar * str)
}
/**
- * xmlRelaxNGGetDataTypeLibrary:
- * @ctxt: a Relax-NG parser context
- * @node: the current data or value element
+ * @param ctxt a Relax-NG parser context
+ * @param node the current data or value element
*
* Applies algorithm from 4.3. datatypeLibrary attribute
*
- * Returns the datatypeLibrary value or NULL if not found
+ * @returns the datatypeLibrary value or NULL if not found
*/
static xmlChar *
xmlRelaxNGGetDataTypeLibrary(xmlRelaxNGParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -3439,13 +3369,12 @@ xmlRelaxNGGetDataTypeLibrary(xmlRelaxNGParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGParseValue:
- * @ctxt: a Relax-NG parser context
- * @node: the data node.
+ * @param ctxt a Relax-NG parser context
+ * @param node the data node.
*
* parse the content of a RelaxNG value node.
*
- * Returns the definition pointer or NULL in case of error
+ * @returns the definition pointer or NULL in case of error
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseValue(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -3531,13 +3460,12 @@ xmlRelaxNGParseValue(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParseData:
- * @ctxt: a Relax-NG parser context
- * @node: the data node.
+ * @param ctxt a Relax-NG parser context
+ * @param node the data node.
*
* parse the content of a RelaxNG data node.
*
- * Returns the definition pointer or NULL in case of error
+ * @returns the definition pointer or NULL in case of error
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseData(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -3693,15 +3621,14 @@ xmlRelaxNGParseData(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
static const xmlChar *invalidName = BAD_CAST "\1";
/**
- * xmlRelaxNGCompareNameClasses:
- * @def1: the first element/attribute defs
- * @def2: the second element/attribute defs
+ * @param def1 the first element/attribute defs
+ * @param def2 the second element/attribute defs
*
* Compare the 2 lists of element definitions. The comparison is
* that if both lists do not accept the same QNames, it returns 1
* If the 2 lists can accept the same QName the comparison returns 0
*
- * Returns 1 distinct, 0 if equal
+ * @returns 1 distinct, 0 if equal
*/
static int
xmlRelaxNGCompareNameClasses(xmlRelaxNGDefinePtr def1,
@@ -3795,16 +3722,15 @@ xmlRelaxNGCompareNameClasses(xmlRelaxNGDefinePtr def1,
}
/**
- * xmlRelaxNGCompareElemDefLists:
- * @ctxt: a Relax-NG parser context
- * @def1: the first list of element/attribute defs
- * @def2: the second list of element/attribute defs
+ * @param ctxt a Relax-NG parser context
+ * @param def1 the first list of element/attribute defs
+ * @param def2 the second list of element/attribute defs
*
* Compare the 2 lists of element or attribute definitions. The comparison
* is that if both lists do not accept the same QNames, it returns 1
* If the 2 lists can accept the same QName the comparison returns 0
*
- * Returns 1 distinct, 0 if equal
+ * @returns 1 distinct, 0 if equal
*/
static int
xmlRelaxNGCompareElemDefLists(xmlRelaxNGParserCtxtPtr ctxt
@@ -3830,13 +3756,12 @@ xmlRelaxNGCompareElemDefLists(xmlRelaxNGParserCtxtPtr ctxt
}
/**
- * xmlRelaxNGGenerateAttributes:
- * @ctxt: a Relax-NG parser context
- * @def: the definition definition
+ * @param ctxt a Relax-NG parser context
+ * @param def the definition definition
*
* Check if the definition can only generate attributes
*
- * Returns 1 if yes, 0 if no and -1 in case of error.
+ * @returns 1 if yes, 0 if no and -1 in case of error.
*/
static int
xmlRelaxNGGenerateAttributes(xmlRelaxNGParserCtxtPtr ctxt,
@@ -3905,14 +3830,13 @@ xmlRelaxNGGenerateAttributes(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGGetElements:
- * @ctxt: a Relax-NG parser context
- * @def: the definition definition
- * @eora: gather elements (0), attributes (1) or elements and text (2)
+ * @param ctxt a Relax-NG parser context
+ * @param def the definition definition
+ * @param eora gather elements (0), attributes (1) or elements and text (2)
*
* Compute the list of top elements a definition can generate
*
- * Returns a list of elements or NULL if none was found.
+ * @returns a list of elements or NULL if none was found.
*/
static xmlRelaxNGDefinePtr *
xmlRelaxNGGetElements(xmlRelaxNGParserCtxtPtr ctxt,
@@ -4010,9 +3934,8 @@ xmlRelaxNGGetElements(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGCheckChoiceDeterminism:
- * @ctxt: a Relax-NG parser context
- * @def: the choice definition
+ * @param ctxt a Relax-NG parser context
+ * @param def the choice definition
*
* Also used to find indeterministic pattern in choice
*/
@@ -4146,9 +4069,8 @@ xmlRelaxNGCheckChoiceDeterminism(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGCheckGroupAttrs:
- * @ctxt: a Relax-NG parser context
- * @def: the group definition
+ * @param ctxt a Relax-NG parser context
+ * @param def the group definition
*
* Detects violations of rule 7.3
*/
@@ -4230,10 +4152,9 @@ xmlRelaxNGCheckGroupAttrs(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGComputeInterleaves:
- * @payload: the interleave definition
- * @data: a Relax-NG parser context
- * @name: the definition name
+ * @param payload the interleave definition
+ * @param data a Relax-NG parser context
+ * @param name the definition name
*
* A lot of work for preprocessing interleave definitions
* is potentially needed to get a decent execution speed at runtime
@@ -4396,13 +4317,12 @@ xmlRelaxNGComputeInterleaves(void *payload, void *data,
}
/**
- * xmlRelaxNGParseInterleave:
- * @ctxt: a Relax-NG parser context
- * @node: the data node.
+ * @param ctxt a Relax-NG parser context
+ * @param node the data node.
*
* parse the content of a RelaxNG interleave node.
*
- * Returns the definition pointer or NULL in case of error
+ * @returns the definition pointer or NULL in case of error
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseInterleave(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -4458,13 +4378,12 @@ xmlRelaxNGParseInterleave(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParseInclude:
- * @ctxt: a Relax-NG parser context
- * @node: the include node
+ * @param ctxt a Relax-NG parser context
+ * @param node the include node
*
* Integrate the content of an include node in the current grammar
*
- * Returns 0 in case of success or -1 in case of error
+ * @returns 0 in case of success or -1 in case of error
*/
static int
xmlRelaxNGParseInclude(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -4508,13 +4427,12 @@ xmlRelaxNGParseInclude(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParseDefine:
- * @ctxt: a Relax-NG parser context
- * @node: the define node
+ * @param ctxt a Relax-NG parser context
+ * @param node the define node
*
* parse the content of a RelaxNG define element node.
*
- * Returns 0 in case of success or -1 in case of error
+ * @returns 0 in case of success or -1 in case of error
*/
static int
xmlRelaxNGParseDefine(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -4580,10 +4498,9 @@ xmlRelaxNGParseDefine(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParseImportRef:
- * @payload: the parser context
- * @data: the current grammar
- * @name: the reference name
+ * @param payload the parser context
+ * @param data the current grammar
+ * @param name the reference name
*
* Import import one references into the current grammar
*/
@@ -4619,13 +4536,12 @@ xmlRelaxNGParseImportRef(void *payload, void *data, const xmlChar *name) {
}
/**
- * xmlRelaxNGParseImportRefs:
- * @ctxt: the parser context
- * @grammar: the sub grammar
+ * @param ctxt the parser context
+ * @param grammar the sub grammar
*
* Import references from the subgrammar into the current grammar
*
- * Returns 0 in case of success, -1 in case of failure
+ * @returns 0 in case of success, -1 in case of failure
*/
static int
xmlRelaxNGParseImportRefs(xmlRelaxNGParserCtxtPtr ctxt,
@@ -4646,13 +4562,12 @@ xmlRelaxNGParseImportRefs(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGProcessExternalRef:
- * @ctxt: the parser context
- * @node: the externalRef node
+ * @param ctxt the parser context
+ * @param node the externalRef node
*
* Process and compile an externalRef node
*
- * Returns the xmlRelaxNGDefinePtr or NULL in case of error
+ * @returns the xmlRelaxNGDefinePtr or NULL in case of error
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGProcessExternalRef(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -4732,13 +4647,12 @@ xmlRelaxNGProcessExternalRef(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParsePattern:
- * @ctxt: a Relax-NG parser context
- * @node: the pattern node.
+ * @param ctxt a Relax-NG parser context
+ * @param node the pattern node.
*
* parse the content of a RelaxNG pattern node.
*
- * Returns the definition pointer or NULL in case of error or if no
+ * @returns the definition pointer or NULL in case of error or if no
* pattern is generated.
*/
static xmlRelaxNGDefinePtr
@@ -5027,13 +4941,12 @@ xmlRelaxNGParsePattern(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParseAttribute:
- * @ctxt: a Relax-NG parser context
- * @node: the element node
+ * @param ctxt a Relax-NG parser context
+ * @param node the element node
*
* parse the content of a RelaxNG attribute node.
*
- * Returns the definition pointer or NULL in case of error.
+ * @returns the definition pointer or NULL in case of error.
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseAttribute(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -5110,14 +5023,13 @@ xmlRelaxNGParseAttribute(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParseExceptNameClass:
- * @ctxt: a Relax-NG parser context
- * @node: the except node
- * @attr: 1 if within an attribute, 0 if within an element
+ * @param ctxt a Relax-NG parser context
+ * @param node the except node
+ * @param attr 1 if within an attribute, 0 if within an element
*
* parse the content of a RelaxNG nameClass node.
*
- * Returns the definition pointer or NULL in case of error.
+ * @returns the definition pointer or NULL in case of error.
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseExceptNameClass(xmlRelaxNGParserCtxtPtr ctxt,
@@ -5171,14 +5083,13 @@ xmlRelaxNGParseExceptNameClass(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGParseNameClass:
- * @ctxt: a Relax-NG parser context
- * @node: the nameClass node
- * @def: the current definition
+ * @param ctxt a Relax-NG parser context
+ * @param node the nameClass node
+ * @param def the current definition
*
* parse the content of a RelaxNG nameClass node.
*
- * Returns the definition pointer or NULL in case of error.
+ * @returns the definition pointer or NULL in case of error.
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseNameClass(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node,
@@ -5317,13 +5228,12 @@ xmlRelaxNGParseNameClass(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node,
}
/**
- * xmlRelaxNGParseElement:
- * @ctxt: a Relax-NG parser context
- * @node: the element node
+ * @param ctxt a Relax-NG parser context
+ * @param node the element node
*
* parse the content of a RelaxNG element node.
*
- * Returns the definition pointer or NULL in case of error.
+ * @returns the definition pointer or NULL in case of error.
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParseElement(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
@@ -5429,14 +5339,13 @@ xmlRelaxNGParseElement(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGParsePatterns:
- * @ctxt: a Relax-NG parser context
- * @nodes: list of nodes
- * @group: use an implicit `` for elements
+ * @param ctxt a Relax-NG parser context
+ * @param nodes list of nodes
+ * @param group use an implicit `` for elements
*
* parse the content of a RelaxNG start node.
*
- * Returns the definition pointer or NULL in case of error.
+ * @returns the definition pointer or NULL in case of error.
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGParsePatterns(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr nodes,
@@ -5482,13 +5391,12 @@ xmlRelaxNGParsePatterns(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr nodes,
}
/**
- * xmlRelaxNGParseStart:
- * @ctxt: a Relax-NG parser context
- * @nodes: start children nodes
+ * @param ctxt a Relax-NG parser context
+ * @param nodes start children nodes
*
* parse the content of a RelaxNG start node.
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
static int
xmlRelaxNGParseStart(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr nodes)
@@ -5540,13 +5448,12 @@ xmlRelaxNGParseStart(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr nodes)
}
/**
- * xmlRelaxNGParseGrammarContent:
- * @ctxt: a Relax-NG parser context
- * @nodes: grammar children nodes
+ * @param ctxt a Relax-NG parser context
+ * @param nodes grammar children nodes
*
* parse the content of a RelaxNG grammar node.
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
static int
xmlRelaxNGParseGrammarContent(xmlRelaxNGParserCtxtPtr ctxt,
@@ -5589,10 +5496,9 @@ xmlRelaxNGParseGrammarContent(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGCheckReference:
- * @payload: the ref
- * @data: a Relax-NG parser context
- * @name: the name associated to the defines
+ * @param payload the ref
+ * @param data a Relax-NG parser context
+ * @param name the name associated to the defines
*
* Applies the 4.17. combine attribute rule for all the define
* element of a given grammar using the same name.
@@ -5645,10 +5551,9 @@ xmlRelaxNGCheckReference(void *payload, void *data, const xmlChar * name)
}
/**
- * xmlRelaxNGCheckCombine:
- * @payload: the define(s) list
- * @data: a Relax-NG parser context
- * @name: the name associated to the defines
+ * @param payload the define(s) list
+ * @param data a Relax-NG parser context
+ * @param name the name associated to the defines
*
* Applies the 4.17. combine attribute rule for all the define
* element of a given grammar using the same name.
@@ -5761,9 +5666,8 @@ xmlRelaxNGCheckCombine(void *payload, void *data, const xmlChar * name)
}
/**
- * xmlRelaxNGCombineStart:
- * @ctxt: a Relax-NG parser context
- * @grammar: the grammar
+ * @param ctxt a Relax-NG parser context
+ * @param grammar the grammar
*
* Applies the 4.17. combine rule for all the start
* element of a given grammar.
@@ -5861,14 +5765,13 @@ xmlRelaxNGCombineStart(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGCheckCycles:
- * @ctxt: a Relax-NG parser context
- * @cur: grammar children nodes
- * @depth: the counter
+ * @param ctxt a Relax-NG parser context
+ * @param cur grammar children nodes
+ * @param depth the counter
*
* Check for cycles.
*
- * Returns 0 if check passed, and -1 in case of error
+ * @returns 0 if check passed, and -1 in case of error
*/
static int
xmlRelaxNGCheckCycles(xmlRelaxNGParserCtxtPtr ctxt,
@@ -5900,15 +5803,14 @@ xmlRelaxNGCheckCycles(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGTryUnlink:
- * @ctxt: a Relax-NG parser context
- * @cur: the definition to unlink
- * @parent: the parent definition
- * @prev: the previous sibling definition
+ * @param ctxt a Relax-NG parser context
+ * @param cur the definition to unlink
+ * @param parent the parent definition
+ * @param prev the previous sibling definition
*
* Try to unlink a definition. If not possible make it a NOOP
*
- * Returns the new prev definition
+ * @returns the new prev definition
*/
static xmlRelaxNGDefinePtr
xmlRelaxNGTryUnlink(xmlRelaxNGParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -5934,10 +5836,9 @@ xmlRelaxNGTryUnlink(xmlRelaxNGParserCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGSimplify:
- * @ctxt: a Relax-NG parser context
- * @cur: grammar children nodes
- * @parent: parent
+ * @param ctxt a Relax-NG parser context
+ * @param cur grammar children nodes
+ * @param parent parent
*
* Check for simplification of empty and notAllowed
*/
@@ -6101,13 +6002,12 @@ xmlRelaxNGSimplify(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGGroupContentType:
- * @ct1: the first content type
- * @ct2: the second content type
+ * @param ct1 the first content type
+ * @param ct2 the second content type
*
* Try to group 2 content types
*
- * Returns the content type
+ * @returns the content type
*/
static xmlRelaxNGContentType
xmlRelaxNGGroupContentType(xmlRelaxNGContentType ct1,
@@ -6127,13 +6027,12 @@ xmlRelaxNGGroupContentType(xmlRelaxNGContentType ct1,
}
/**
- * xmlRelaxNGMaxContentType:
- * @ct1: the first content type
- * @ct2: the second content type
+ * @param ct1 the first content type
+ * @param ct2 the second content type
*
* Compute the max content-type
*
- * Returns the content type
+ * @returns the content type
*/
static xmlRelaxNGContentType
xmlRelaxNGMaxContentType(xmlRelaxNGContentType ct1,
@@ -6152,15 +6051,14 @@ xmlRelaxNGMaxContentType(xmlRelaxNGContentType ct1,
}
/**
- * xmlRelaxNGCheckRules:
- * @ctxt: a Relax-NG parser context
- * @cur: the current definition
- * @flags: some accumulated flags
- * @ptype: the parent type
+ * @param ctxt a Relax-NG parser context
+ * @param cur the current definition
+ * @param flags some accumulated flags
+ * @param ptype the parent type
*
* Check for rules in section 7.1 and 7.2
*
- * Returns the content type of @cur
+ * @returns the content type of `cur`
*/
static xmlRelaxNGContentType
xmlRelaxNGCheckRules(xmlRelaxNGParserCtxtPtr ctxt,
@@ -6480,13 +6378,12 @@ xmlRelaxNGCheckRules(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGParseGrammar:
- * @ctxt: a Relax-NG parser context
- * @nodes: grammar children nodes
+ * @param ctxt a Relax-NG parser context
+ * @param nodes grammar children nodes
*
* parse a Relax-NG `` node
*
- * Returns the internal xmlRelaxNGGrammarPtr built or
+ * @returns the internal xmlRelaxNGGrammarPtr built or
* NULL in case of error
*/
static xmlRelaxNGGrammarPtr
@@ -6548,14 +6445,13 @@ xmlRelaxNGParseGrammar(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr nodes)
}
/**
- * xmlRelaxNGParseDocument:
- * @ctxt: a Relax-NG parser context
- * @node: the root node of the RelaxNG schema
+ * @param ctxt a Relax-NG parser context
+ * @param node the root node of the RelaxNG schema
*
* parse a Relax-NG definition resource and build an internal
* xmlRelaxNG structure which can be used to validate instances.
*
- * Returns the internal XML RelaxNG structure built or
+ * @returns the internal XML RelaxNG structure built or
* NULL in case of error
*/
static xmlRelaxNGPtr
@@ -6633,13 +6529,12 @@ xmlRelaxNGParseDocument(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
************************************************************************/
/**
- * xmlRelaxNGNewParserCtxt:
- * @URL: the location of the schema
+ * @param URL the location of the schema
*
* Create an XML RelaxNGs parse context for that file/resource expected
* to contain an XML RelaxNGs file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlRelaxNGParserCtxtPtr
xmlRelaxNGNewParserCtxt(const char *URL)
@@ -6661,14 +6556,13 @@ xmlRelaxNGNewParserCtxt(const char *URL)
}
/**
- * xmlRelaxNGNewMemParserCtxt:
- * @buffer: a pointer to a char array containing the schemas
- * @size: the size of the array
+ * @param buffer a pointer to a char array containing the schemas
+ * @param size the size of the array
*
* Create an XML RelaxNGs parse context for that memory buffer expected
* to contain an XML RelaxNGs file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlRelaxNGParserCtxtPtr
xmlRelaxNGNewMemParserCtxt(const char *buffer, int size)
@@ -6691,14 +6585,13 @@ xmlRelaxNGNewMemParserCtxt(const char *buffer, int size)
}
/**
- * xmlRelaxNGNewDocParserCtxt:
- * @doc: a preparsed document tree
+ * @param doc a preparsed document tree
*
* Create an XML RelaxNGs parser context for that document.
* Note: since the process of compiling a RelaxNG schemas modifies the
- * document, the @doc parameter is duplicated internally.
+ * document, the `doc` parameter is duplicated internally.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlRelaxNGParserCtxtPtr
xmlRelaxNGNewDocParserCtxt(xmlDocPtr doc)
@@ -6727,8 +6620,7 @@ xmlRelaxNGNewDocParserCtxt(xmlDocPtr doc)
}
/**
- * xmlRelaxNGFreeParserCtxt:
- * @ctxt: the schema parser context
+ * @param ctxt the schema parser context
*
* Free the resources associated to the schema parser context
*/
@@ -6764,8 +6656,7 @@ xmlRelaxNGFreeParserCtxt(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRelaxNGNormExtSpace:
- * @value: a value
+ * @param value a value
*
* Removes the leading and ending spaces of the value
* The string is modified "in situ"
@@ -6816,9 +6707,8 @@ xmlRelaxNGNormExtSpace(xmlChar * value)
}
/**
- * xmlRelaxNGCleanupAttributes:
- * @ctxt: a Relax-NG parser context
- * @node: a Relax-NG node
+ * @param ctxt a Relax-NG parser context
+ * @param node a Relax-NG node
*
* Check all the attributes on the given node
*/
@@ -6903,9 +6793,8 @@ xmlRelaxNGCleanupAttributes(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr node)
}
/**
- * xmlRelaxNGCleanupTree:
- * @ctxt: a Relax-NG parser context
- * @root: an xmlNodePtr subtree
+ * @param ctxt a Relax-NG parser context
+ * @param root an xmlNodePtr subtree
*
* Cleanup the subtree from unwanted nodes for parsing, resolve
* Include and externalRef lookups.
@@ -7344,14 +7233,13 @@ xmlRelaxNGCleanupTree(xmlRelaxNGParserCtxtPtr ctxt, xmlNodePtr root)
}
/**
- * xmlRelaxNGCleanupDoc:
- * @ctxt: a Relax-NG parser context
- * @doc: an xmldocPtr document pointer
+ * @param ctxt a Relax-NG parser context
+ * @param doc an xmldocPtr document pointer
*
* Cleanup the document from unwanted nodes for parsing, resolve
* Include and externalRef lookups.
*
- * Returns the cleaned up document or NULL in case of error
+ * @returns the cleaned up document or NULL in case of error
*/
static xmlDocPtr
xmlRelaxNGCleanupDoc(xmlRelaxNGParserCtxtPtr ctxt, xmlDocPtr doc)
@@ -7372,13 +7260,12 @@ xmlRelaxNGCleanupDoc(xmlRelaxNGParserCtxtPtr ctxt, xmlDocPtr doc)
}
/**
- * xmlRelaxNGParse:
- * @ctxt: a Relax-NG parser context
+ * @param ctxt a Relax-NG parser context
*
* parse a schema definition resource and build an internal
* XML Schema structure which can be used to validate instances.
*
- * Returns the internal XML RelaxNG structure built from the resource or
+ * @returns the internal XML RelaxNG structure built from the resource or
* NULL in case of error
*/
xmlRelaxNGPtr
@@ -7510,13 +7397,12 @@ xmlRelaxNGParse(xmlRelaxNGParserCtxtPtr ctxt)
}
/**
- * xmlRelaxNGSetParserErrors:
- * @ctxt: a Relax-NG validation context
- * @err: the error callback
- * @warn: the warning callback
- * @ctx: contextual data for the callbacks
+ * @param ctxt a Relax-NG validation context
+ * @param err the error callback
+ * @param warn the warning callback
+ * @param ctx contextual data for the callbacks
*
- * DEPRECATED: Use xmlRelaxNGSetParserStructuredErrors.
+ * @deprecated Use xmlRelaxNGSetParserStructuredErrors.
*
* Set the callback functions used to handle errors for a validation context
*/
@@ -7534,15 +7420,14 @@ xmlRelaxNGSetParserErrors(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGGetParserErrors:
- * @ctxt: a Relax-NG validation context
- * @err: the error callback result
- * @warn: the warning callback result
- * @ctx: contextual data for the callbacks result
+ * @param ctxt a Relax-NG validation context
+ * @param err the error callback result
+ * @param warn the warning callback result
+ * @param ctx contextual data for the callbacks result
*
* Get the callback information used to handle errors for a validation context
*
- * Returns -1 in case of failure, 0 otherwise.
+ * @returns -1 in case of failure, 0 otherwise.
*/
int
xmlRelaxNGGetParserErrors(xmlRelaxNGParserCtxtPtr ctxt,
@@ -7561,10 +7446,9 @@ xmlRelaxNGGetParserErrors(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGSetParserStructuredErrors:
- * @ctxt: a Relax-NG parser context
- * @serror: the error callback
- * @ctx: contextual data for the callbacks
+ * @param ctxt a Relax-NG parser context
+ * @param serror the error callback
+ * @param ctx contextual data for the callbacks
*
* Set the callback functions used to handle errors for a parsing context
*/
@@ -7582,10 +7466,9 @@ xmlRelaxNGSetParserStructuredErrors(xmlRelaxNGParserCtxtPtr ctxt,
}
/**
- * xmlRelaxNGSetResourceLoader:
- * @ctxt: a Relax-NG parser context
- * @loader: the callback
- * @vctxt: contextual data for the callbacks
+ * @param ctxt a Relax-NG parser context
+ * @param loader the callback
+ * @param vctxt contextual data for the callbacks
*
* Set the callback function used to load external resources.
*/
@@ -7609,9 +7492,8 @@ static void xmlRelaxNGDumpDefine(FILE * output,
xmlRelaxNGDefinePtr define);
/**
- * xmlRelaxNGDumpDefines:
- * @output: the file output
- * @defines: a list of define structures
+ * @param output the file output
+ * @param defines a list of define structures
*
* Dump a RelaxNG structure back
*/
@@ -7625,9 +7507,8 @@ xmlRelaxNGDumpDefines(FILE * output, xmlRelaxNGDefinePtr defines)
}
/**
- * xmlRelaxNGDumpDefine:
- * @output: the file output
- * @define: a define structure
+ * @param output the file output
+ * @param define a define structure
*
* Dump a RelaxNG structure back
*/
@@ -7743,10 +7624,9 @@ xmlRelaxNGDumpDefine(FILE * output, xmlRelaxNGDefinePtr define)
}
/**
- * xmlRelaxNGDumpGrammar:
- * @output: the file output
- * @grammar: a grammar structure
- * @top: is this a top grammar
+ * @param output the file output
+ * @param grammar a grammar structure
+ * @param top is this a top grammar
*
* Dump a RelaxNG structure back
*/
@@ -7784,9 +7664,8 @@ xmlRelaxNGDumpGrammar(FILE * output, xmlRelaxNGGrammarPtr grammar, int top)
}
/**
- * xmlRelaxNGDump:
- * @output: the file output
- * @schema: a schema structure
+ * @param output the file output
+ * @param schema a schema structure
*
* Dump a RelaxNG structure back
*/
@@ -7815,9 +7694,8 @@ xmlRelaxNGDump(FILE * output, xmlRelaxNGPtr schema)
}
/**
- * xmlRelaxNGDumpTree:
- * @output: the file output
- * @schema: a schema structure
+ * @param output the file output
+ * @param schema a schema structure
*
* Dump the transformed RelaxNG tree.
*/
@@ -7847,11 +7725,10 @@ static int xmlRelaxNGValidateDefinition(xmlRelaxNGValidCtxtPtr ctxt,
xmlRelaxNGDefinePtr define);
/**
- * xmlRelaxNGValidateCompiledCallback:
- * @exec: the regular expression instance
- * @token: the token which matched
- * @transdata: callback data, the define for the subelement if available
- * @inputdata: callback data, the Relax NG validation context
+ * @param exec the regular expression instance
+ * @param token the token which matched
+ * @param transdata callback data, the define for the subelement if available
+ * @param inputdata callback data, the Relax NG validation context
*
* Handle the callback and if needed validate the element children.
*/
@@ -7891,14 +7768,13 @@ xmlRelaxNGValidateCompiledCallback(xmlRegExecCtxtPtr exec ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGValidateCompiledContent:
- * @ctxt: the RelaxNG validation context
- * @regexp: the regular expression as compiled
- * @content: list of children to test against the regexp
+ * @param ctxt the RelaxNG validation context
+ * @param regexp the regular expression as compiled
+ * @param content list of children to test against the regexp
*
* Validate the content model of an element or start using the regexp
*
- * Returns 0 in case of success, -1 in case of error.
+ * @returns 0 in case of success, -1 in case of error.
*/
static int
xmlRelaxNGValidateCompiledContent(xmlRelaxNGValidCtxtPtr ctxt,
@@ -7989,13 +7865,12 @@ static int xmlRelaxNGValidateElementEnd(xmlRelaxNGValidCtxtPtr ctxt,
static void xmlRelaxNGLogBestError(xmlRelaxNGValidCtxtPtr ctxt);
/**
- * xmlRelaxNGElemPush:
- * @ctxt: the validation context
- * @exec: the regexp runtime for the new content model
+ * @param ctxt the validation context
+ * @param exec the regexp runtime for the new content model
*
* Push a new regexp for the current node content model on the stack
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
static int
xmlRelaxNGElemPush(xmlRelaxNGValidCtxtPtr ctxt, xmlRegExecCtxtPtr exec)
@@ -8027,12 +7902,11 @@ xmlRelaxNGElemPush(xmlRelaxNGValidCtxtPtr ctxt, xmlRegExecCtxtPtr exec)
}
/**
- * xmlRelaxNGElemPop:
- * @ctxt: the validation context
+ * @param ctxt the validation context
*
* Pop the regexp of the current node content model from the stack
*
- * Returns the exec or NULL if empty
+ * @returns the exec or NULL if empty
*/
static xmlRegExecCtxtPtr
xmlRelaxNGElemPop(xmlRelaxNGValidCtxtPtr ctxt)
@@ -8052,14 +7926,13 @@ xmlRelaxNGElemPop(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGValidateProgressiveCallback:
- * @exec: the regular expression instance
- * @token: the token which matched
- * @transdata: callback data, the define for the subelement if available
- * @inputdata: callback data, the Relax NG validation context
+ * @param exec the regular expression instance
+ * @param token the token which matched
+ * @param transdata callback data, the define for the subelement if available
+ * @param inputdata callback data, the Relax NG validation context
*
* Handle the callback and if needed validate the element children.
- * some of the in/out information are passed via the context in @inputdata.
+ * some of the in/out information are passed via the context in `inputdata`.
*/
static void
xmlRelaxNGValidateProgressiveCallback(xmlRegExecCtxtPtr exec
@@ -8185,14 +8058,13 @@ xmlRelaxNGValidateProgressiveCallback(xmlRegExecCtxtPtr exec
}
/**
- * xmlRelaxNGValidatePushElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
*
* Push a new element start on the RelaxNG validation stack.
*
- * returns 1 if no validation problem was found or 0 if validating the
+ * @returns 1 if no validation problem was found or 0 if validating the
* element requires a full node, and -1 in case of error.
*/
int
@@ -8257,14 +8129,13 @@ xmlRelaxNGValidatePushElement(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidatePushCData:
- * @ctxt: the RelaxNG validation context
- * @data: some character data read
- * @len: the length of the data
+ * @param ctxt the RelaxNG validation context
+ * @param data some character data read
+ * @param len the length of the data
*
* check the CData parsed for validation in the current stack
*
- * returns 1 if no validation problem was found or -1 otherwise
+ * @returns 1 if no validation problem was found or -1 otherwise
*/
int
xmlRelaxNGValidatePushCData(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8293,14 +8164,13 @@ xmlRelaxNGValidatePushCData(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidatePopElement:
- * @ctxt: the RelaxNG validation context
- * @doc: a document instance
- * @elem: an element instance
+ * @param ctxt the RelaxNG validation context
+ * @param doc a document instance
+ * @param elem an element instance
*
* Pop the element end from the RelaxNG validation stack.
*
- * returns 1 if no validation problem was found or 0 otherwise
+ * @returns 1 if no validation problem was found or 0 otherwise
*/
int
xmlRelaxNGValidatePopElement(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8333,15 +8203,14 @@ xmlRelaxNGValidatePopElement(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateFullElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
*
* Validate a full subtree when xmlRelaxNGValidatePushElement() returned
* 0 and the content of the node has been expanded.
*
- * returns 1 if no validation problem was found or -1 in case of error.
+ * @returns 1 if no validation problem was found or -1 in case of error.
*/
int
xmlRelaxNGValidateFullElement(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8379,13 +8248,12 @@ static int xmlRelaxNGValidateValue(xmlRelaxNGValidCtxtPtr ctxt,
xmlRelaxNGDefinePtr define);
/**
- * xmlRelaxNGSkipIgnored:
- * @ctxt: a schema validation context
- * @node: the top node.
+ * @param ctxt a schema validation context
+ * @param node the top node.
*
* Skip ignorable nodes in that context
*
- * Returns the new sibling or NULL in case of error.
+ * @returns the new sibling or NULL in case of error.
*/
static xmlNodePtr
xmlRelaxNGSkipIgnored(xmlRelaxNGValidCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -8409,14 +8277,13 @@ xmlRelaxNGSkipIgnored(xmlRelaxNGValidCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlRelaxNGNormalize:
- * @ctxt: a schema validation context
- * @str: the string to normalize
+ * @param ctxt a schema validation context
+ * @param str the string to normalize
*
* Implements the normalizeWhiteSpace( s ) function from
* section 6.2.9 of the spec
*
- * Returns the new string or NULL in case of error.
+ * @returns the new string or NULL in case of error.
*/
static xmlChar *
xmlRelaxNGNormalize(xmlRelaxNGValidCtxtPtr ctxt, const xmlChar * str)
@@ -8455,15 +8322,14 @@ xmlRelaxNGNormalize(xmlRelaxNGValidCtxtPtr ctxt, const xmlChar * str)
}
/**
- * xmlRelaxNGValidateDatatype:
- * @ctxt: a Relax-NG validation context
- * @value: the string value
- * @define: the datatype definition
- * @node: the node
+ * @param ctxt a Relax-NG validation context
+ * @param value the string value
+ * @param define the datatype definition
+ * @param node the node
*
* Validate the given value against the datatype
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateDatatype(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8529,12 +8395,11 @@ xmlRelaxNGValidateDatatype(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGNextValue:
- * @ctxt: a Relax-NG validation context
+ * @param ctxt a Relax-NG validation context
*
* Skip to the next value when validating within a list
*
- * Returns 0 if the operation succeeded or an error code.
+ * @returns 0 if the operation succeeded or an error code.
*/
static int
xmlRelaxNGNextValue(xmlRelaxNGValidCtxtPtr ctxt)
@@ -8559,13 +8424,12 @@ xmlRelaxNGNextValue(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGValidateValueList:
- * @ctxt: a Relax-NG validation context
- * @defines: the list of definitions to verify
+ * @param ctxt a Relax-NG validation context
+ * @param defines the list of definitions to verify
*
* Validate the given set of definitions for the current value
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateValueList(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8583,13 +8447,12 @@ xmlRelaxNGValidateValueList(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateValue:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to verify
*
* Validate the given definition for the current value
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateValue(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8852,13 +8715,12 @@ xmlRelaxNGValidateValue(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateValueContent:
- * @ctxt: a Relax-NG validation context
- * @defines: the list of definitions to verify
+ * @param ctxt a Relax-NG validation context
+ * @param defines the list of definitions to verify
*
* Validate the given definitions for the current value
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateValueContent(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8876,14 +8738,13 @@ xmlRelaxNGValidateValueContent(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGAttributeMatch:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to check
- * @prop: the attribute
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to check
+ * @param prop the attribute
*
* Check if the attribute matches the definition nameClass
*
- * Returns 1 if the attribute matches, 0 if no, or -1 in case of error
+ * @returns 1 if the attribute matches, 0 if no, or -1 in case of error
*/
static int
xmlRelaxNGAttributeMatch(xmlRelaxNGValidCtxtPtr ctxt,
@@ -8941,13 +8802,12 @@ xmlRelaxNGAttributeMatch(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateAttribute:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to verify
*
* Validate the given attribute definition for that node
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateAttribute(xmlRelaxNGValidCtxtPtr ctxt,
@@ -9035,13 +8895,12 @@ xmlRelaxNGValidateAttribute(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateAttributeList:
- * @ctxt: a Relax-NG validation context
- * @defines: the list of definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param defines the list of definition to verify
*
* Validate the given node against the list of attribute definitions
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateAttributeList(xmlRelaxNGValidCtxtPtr ctxt,
@@ -9083,13 +8942,12 @@ xmlRelaxNGValidateAttributeList(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGNodeMatchesList:
- * @node: the node
- * @list: a NULL terminated array of definitions
+ * @param node the node
+ * @param list a NULL terminated array of definitions
*
* Check if a node can be matched by one of the definitions
*
- * Returns 1 if matches 0 otherwise
+ * @returns 1 if matches 0 otherwise
*/
static int
xmlRelaxNGNodeMatchesList(xmlNodePtr node, xmlRelaxNGDefinePtr * list)
@@ -9121,13 +8979,12 @@ xmlRelaxNGNodeMatchesList(xmlNodePtr node, xmlRelaxNGDefinePtr * list)
}
/**
- * xmlRelaxNGValidateInterleave:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to verify
*
* Validate an interleave definition for a node.
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateInterleave(xmlRelaxNGValidCtxtPtr ctxt,
@@ -9426,13 +9283,12 @@ xmlRelaxNGValidateInterleave(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateDefinitionList:
- * @ctxt: a Relax-NG validation context
- * @defines: the list of definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param defines the list of definition to verify
*
* Validate the given node content against the (list) of definitions
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateDefinitionList(xmlRelaxNGValidCtxtPtr ctxt,
@@ -9464,14 +9320,13 @@ xmlRelaxNGValidateDefinitionList(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGElementMatch:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to check
- * @elem: the element
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to check
+ * @param elem the element
*
* Check if the element matches the definition nameClass
*
- * Returns 1 if the element matches, 0 if no, or -1 in case of error
+ * @returns 1 if the element matches, 0 if no, or -1 in case of error
*/
static int
xmlRelaxNGElementMatch(xmlRelaxNGValidCtxtPtr ctxt,
@@ -9578,15 +9433,14 @@ xmlRelaxNGElementMatch(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGBestState:
- * @ctxt: a Relax-NG validation context
+ * @param ctxt a Relax-NG validation context
*
* Find the "best" state in the ctxt->states list of states to report
* errors about. I.e. a state with no element left in the child list
* or the one with the less attributes left.
* This is called only if a validation error was detected
*
- * Returns the index of the "best" state or -1 in case of error
+ * @returns the index of the "best" state or -1 in case of error
*/
static int
xmlRelaxNGBestState(xmlRelaxNGValidCtxtPtr ctxt)
@@ -9621,8 +9475,7 @@ xmlRelaxNGBestState(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGLogBestError:
- * @ctxt: a Relax-NG validation context
+ * @param ctxt a Relax-NG validation context
*
* Find the "best" state in the ctxt->states list of states to report
* errors about and log it.
@@ -9645,15 +9498,14 @@ xmlRelaxNGLogBestError(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGValidateElementEnd:
- * @ctxt: a Relax-NG validation context
- * @dolog: indicate that error logging should be done
+ * @param ctxt a Relax-NG validation context
+ * @param dolog indicate that error logging should be done
*
* Validate the end of the element, implements check that
* there is nothing left not consumed in the element content
* or in the attribute list.
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateElementEnd(xmlRelaxNGValidCtxtPtr ctxt, int dolog)
@@ -9685,13 +9537,12 @@ xmlRelaxNGValidateElementEnd(xmlRelaxNGValidCtxtPtr ctxt, int dolog)
}
/**
- * xmlRelaxNGValidateState:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to verify
*
* Validate the current state against the definition
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateState(xmlRelaxNGValidCtxtPtr ctxt,
@@ -10409,13 +10260,12 @@ xmlRelaxNGValidateState(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateDefinition:
- * @ctxt: a Relax-NG validation context
- * @define: the definition to verify
+ * @param ctxt a Relax-NG validation context
+ * @param define the definition to verify
*
* Validate the current node lists against the definition
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateDefinition(xmlRelaxNGValidCtxtPtr ctxt,
@@ -10542,13 +10392,12 @@ xmlRelaxNGValidateDefinition(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateDocument:
- * @ctxt: a Relax-NG validation context
- * @doc: the document
+ * @param ctxt a Relax-NG validation context
+ * @param doc the document
*
* Validate the given document
*
- * Returns 0 if the validation succeeded or an error code.
+ * @returns 0 if the validation succeeded or an error code.
*/
static int
xmlRelaxNGValidateDocument(xmlRelaxNGValidCtxtPtr ctxt, xmlDocPtr doc)
@@ -10635,8 +10484,7 @@ xmlRelaxNGValidateDocument(xmlRelaxNGValidCtxtPtr ctxt, xmlDocPtr doc)
}
/**
- * xmlRelaxNGCleanPSVI:
- * @node: an input element or document
+ * @param node an input element or document
*
* Call this routine to speed up XPath computation on static documents.
* This stamps all the element nodes with the document order
@@ -10644,7 +10492,7 @@ xmlRelaxNGValidateDocument(xmlRelaxNGValidCtxtPtr ctxt, xmlDocPtr doc)
* field, the value stored is actually - the node number (starting at -1)
* to be able to differentiate from line numbers.
*
- * Returns the number of elements found in the document or -1 in case
+ * @returns the number of elements found in the document or -1 in case
* of error.
*/
static void
@@ -10694,12 +10542,11 @@ xmlRelaxNGCleanPSVI(xmlNodePtr node) {
************************************************************************/
/**
- * xmlRelaxNGNewValidCtxt:
- * @schema: a precompiled XML RelaxNGs
+ * @param schema a precompiled XML RelaxNGs
*
* Create an XML RelaxNGs validation context based on the given schema
*
- * Returns the validation context or NULL in case of error
+ * @returns the validation context or NULL in case of error
*/
xmlRelaxNGValidCtxtPtr
xmlRelaxNGNewValidCtxt(xmlRelaxNGPtr schema)
@@ -10727,8 +10574,7 @@ xmlRelaxNGNewValidCtxt(xmlRelaxNGPtr schema)
}
/**
- * xmlRelaxNGFreeValidCtxt:
- * @ctxt: the schema validation context
+ * @param ctxt the schema validation context
*
* Free the resources associated to the schema validation context
*/
@@ -10769,13 +10615,12 @@ xmlRelaxNGFreeValidCtxt(xmlRelaxNGValidCtxtPtr ctxt)
}
/**
- * xmlRelaxNGSetValidErrors:
- * @ctxt: a Relax-NG validation context
- * @err: the error function
- * @warn: the warning function
- * @ctx: the functions context
+ * @param ctxt a Relax-NG validation context
+ * @param err the error function
+ * @param warn the warning function
+ * @param ctx the functions context
*
- * DEPRECATED: Use xmlRelaxNGSetValidStructuredErrors.
+ * @deprecated Use xmlRelaxNGSetValidStructuredErrors.
*
* Set the error and warning callback information
*/
@@ -10793,10 +10638,9 @@ xmlRelaxNGSetValidErrors(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGSetValidStructuredErrors:
- * @ctxt: a Relax-NG validation context
- * @serror: the structured error function
- * @ctx: the functions context
+ * @param ctxt a Relax-NG validation context
+ * @param serror the structured error function
+ * @param ctx the functions context
*
* Set the structured error callback
*/
@@ -10813,15 +10657,14 @@ xmlRelaxNGSetValidStructuredErrors(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGGetValidErrors:
- * @ctxt: a Relax-NG validation context
- * @err: the error function result
- * @warn: the warning function result
- * @ctx: the functions context result
+ * @param ctxt a Relax-NG validation context
+ * @param err the error function result
+ * @param warn the warning function result
+ * @param ctx the functions context result
*
* Get the error and warning callback information
*
- * Returns -1 in case of error and 0 otherwise
+ * @returns -1 in case of error and 0 otherwise
*/
int
xmlRelaxNGGetValidErrors(xmlRelaxNGValidCtxtPtr ctxt,
@@ -10840,13 +10683,12 @@ xmlRelaxNGGetValidErrors(xmlRelaxNGValidCtxtPtr ctxt,
}
/**
- * xmlRelaxNGValidateDoc:
- * @ctxt: a Relax-NG validation context
- * @doc: a parsed document tree
+ * @param ctxt a Relax-NG validation context
+ * @param doc a parsed document tree
*
* Validate a document tree in memory.
*
- * Returns 0 if the document is valid, a positive error code
+ * @returns 0 if the document is valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
int
diff --git a/runtest.c b/runtest.c
index b20f9b4e..fd78f992 100644
--- a/runtest.c
+++ b/runtest.c
@@ -608,11 +608,11 @@ static int quiet = 0;
/**
* isStandaloneDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Is this document tagged standalone ?
*
- * Returns 1 if true
+ * @returns 1 if true
*/
static int
isStandaloneDebug(void *ctx ATTRIBUTE_UNUSED)
@@ -626,11 +626,11 @@ isStandaloneDebug(void *ctx ATTRIBUTE_UNUSED)
/**
* hasInternalSubsetDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an internal subset
*
- * Returns 1 if true
+ * @returns 1 if true
*/
static int
hasInternalSubsetDebug(void *ctx ATTRIBUTE_UNUSED)
@@ -644,11 +644,11 @@ hasInternalSubsetDebug(void *ctx ATTRIBUTE_UNUSED)
/**
* hasExternalSubsetDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an external subset
*
- * Returns 1 if true
+ * @returns 1 if true
*/
static int
hasExternalSubsetDebug(void *ctx ATTRIBUTE_UNUSED)
@@ -662,7 +662,7 @@ hasExternalSubsetDebug(void *ctx ATTRIBUTE_UNUSED)
/**
* internalSubsetDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an internal subset
*/
@@ -688,7 +688,7 @@ internalSubsetDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name,
/**
* externalSubsetDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an external subset
*/
@@ -712,9 +712,9 @@ externalSubsetDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name,
/**
* resolveEntityDebug:
- * @ctxt: An XML parser context
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctxt An XML parser context
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* Special entity resolver, better left to the parser, it has
* more context than the application layer.
@@ -722,7 +722,7 @@ externalSubsetDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name,
* the ENTITY_REF nodes are built in the structure (and the parameter
* values).
*
- * Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
+ * @returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
*/
static xmlParserInputPtr
resolveEntityDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *publicId, const xmlChar *systemId)
@@ -752,12 +752,12 @@ resolveEntityDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *publicId, const xm
/**
* getEntityDebug:
- * @ctxt: An XML parser context
- * @name: The entity name
+ * @param ctxt An XML parser context
+ * @param name The entity name
*
* Get an entity by name
*
- * Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
+ * @returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
*/
static xmlEntityPtr
getEntityDebug(void *ctx, const xmlChar *name)
@@ -774,12 +774,12 @@ getEntityDebug(void *ctx, const xmlChar *name)
/**
* getParameterEntityDebug:
- * @ctxt: An XML parser context
- * @name: The entity name
+ * @param ctxt An XML parser context
+ * @param name The entity name
*
* Get a parameter entity by name
*
- * Returns the xmlParserInputPtr
+ * @returns the xmlParserInputPtr
*/
static xmlEntityPtr
getParameterEntityDebug(void *ctx, const xmlChar *name)
@@ -797,12 +797,12 @@ getParameterEntityDebug(void *ctx, const xmlChar *name)
/**
* entityDeclDebug:
- * @ctxt: An XML parser context
- * @name: the entity name
- * @type: the entity type
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @content: the entity value (without processing).
+ * @param ctxt An XML parser context
+ * @param name the entity name
+ * @param type the entity type
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param content the entity value (without processing).
*
* An entity definition has been parsed
*/
@@ -840,9 +840,9 @@ entityDeclDebug(void *ctx, const xmlChar *name, int type,
/**
* attributeDeclDebug:
- * @ctxt: An XML parser context
- * @name: the attribute name
- * @type: the attribute type
+ * @param ctxt An XML parser context
+ * @param name the attribute name
+ * @param type the attribute type
*
* An attribute definition has been parsed
*/
@@ -865,10 +865,10 @@ attributeDeclDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar * elem,
/**
* elementDeclDebug:
- * @ctxt: An XML parser context
- * @name: the element name
- * @type: the element type
- * @content: the element value (without processing).
+ * @param ctxt An XML parser context
+ * @param name the element name
+ * @param type the element type
+ * @param content the element value (without processing).
*
* An element definition has been parsed
*/
@@ -885,10 +885,10 @@ elementDeclDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name, int type,
/**
* notationDeclDebug:
- * @ctxt: An XML parser context
- * @name: The name of the notation
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctxt An XML parser context
+ * @param name The name of the notation
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* What to do when a notation declaration has been parsed.
*/
@@ -905,11 +905,11 @@ notationDeclDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name,
/**
* unparsedEntityDeclDebug:
- * @ctxt: An XML parser context
- * @name: The name of the entity
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @notationName: the name of the notation
+ * @param ctxt An XML parser context
+ * @param name The name of the entity
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param notationName the name of the notation
*
* What to do when an unparsed entity declaration is parsed
*/
@@ -936,8 +936,8 @@ const xmlChar *nullstr = BAD_CAST "(null)";
/**
* setDocumentLocatorDebug:
- * @ctxt: An XML parser context
- * @loc: A SAX Locator
+ * @param ctxt An XML parser context
+ * @param loc A SAX Locator
*
* Receive the document locator at startup, actually xmlDefaultSAXLocator
* Everything is available on the context, so this is useless in our case.
@@ -953,7 +953,7 @@ setDocumentLocatorDebug(void *ctx ATTRIBUTE_UNUSED, xmlSAXLocatorPtr loc ATTRIBU
/**
* startDocumentDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* called when the document start being processed.
*/
@@ -968,7 +968,7 @@ startDocumentDebug(void *ctx ATTRIBUTE_UNUSED)
/**
* endDocumentDebug:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* called when the document end has been detected.
*/
@@ -983,8 +983,8 @@ endDocumentDebug(void *ctx ATTRIBUTE_UNUSED)
/**
* startElementDebug:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when an opening tag has been processed.
*/
@@ -1009,8 +1009,8 @@ startElementDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name, const xmlChar
/**
* endElementDebug:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when the end of an element has been detected.
*/
@@ -1025,9 +1025,9 @@ endElementDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name)
/**
* charactersDebug:
- * @ctxt: An XML parser context
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some chars from the parser.
* Question: how much at a time ???
@@ -1050,8 +1050,8 @@ charactersDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *ch, int len)
/**
* referenceDebug:
- * @ctxt: An XML parser context
- * @name: The entity name
+ * @param ctxt An XML parser context
+ * @param name The entity name
*
* called when an entity reference is detected.
*/
@@ -1066,10 +1066,10 @@ referenceDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name)
/**
* ignorableWhitespaceDebug:
- * @ctxt: An XML parser context
- * @ch: a xmlChar string
- * @start: the first char in the string
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param ch a xmlChar string
+ * @param start the first char in the string
+ * @param len the number of xmlChar
*
* receiving some ignorable whitespaces from the parser.
* Question: how much at a time ???
@@ -1091,10 +1091,10 @@ ignorableWhitespaceDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *ch, int len)
/**
* processingInstructionDebug:
- * @ctxt: An XML parser context
- * @target: the target name
- * @data: the PI data's
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param target the target name
+ * @param data the PI data's
+ * @param len the number of xmlChar
*
* A processing instruction has been parsed.
*/
@@ -1115,9 +1115,9 @@ processingInstructionDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *target,
/**
* cdataBlockDebug:
- * @ctx: the user data (XML parser context)
- * @value: The pcdata content
- * @len: the block length
+ * @param ctx the user data (XML parser context)
+ * @param value The pcdata content
+ * @param len the block length
*
* called when a pcdata block has been parsed
*/
@@ -1133,8 +1133,8 @@ cdataBlockDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *value, int len)
/**
* commentDebug:
- * @ctxt: An XML parser context
- * @value: the comment content
+ * @param ctxt An XML parser context
+ * @param value the comment content
*
* A comment has been parsed.
*/
@@ -1149,8 +1149,8 @@ commentDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *value)
/**
* warningDebug:
- * @ctxt: An XML parser context
- * @msg: the message to display/transmit
+ * @param ctxt An XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a warning messages, gives file, line, position and
@@ -1172,8 +1172,8 @@ warningDebug(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...)
/**
* errorDebug:
- * @ctxt: An XML parser context
- * @msg: the message to display/transmit
+ * @param ctxt An XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a error messages, gives file, line, position and
@@ -1195,8 +1195,8 @@ errorDebug(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...)
/**
* fatalErrorDebug:
- * @ctxt: An XML parser context
- * @msg: the message to display/transmit
+ * @param ctxt An XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a fatalError messages, gives file, line, position and
@@ -1258,8 +1258,8 @@ static xmlSAXHandlerPtr debugSAXHandler = &debugSAXHandlerStruct;
*/
/**
* startElementNsDebug:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when an opening tag has been processed.
*/
@@ -1315,8 +1315,8 @@ startElementNsDebug(void *ctx ATTRIBUTE_UNUSED,
/**
* endElementDebug:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when the end of an element has been detected.
*/
@@ -1379,9 +1379,8 @@ static xmlSAXHandlerPtr debugSAX2Handler = &debugSAX2HandlerStruct;
#ifdef LIBXML_HTML_ENABLED
/**
- * htmlstartElementDebug:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when an opening tag has been processed.
*/
@@ -1414,10 +1413,9 @@ htmlstartElementDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *name, const xml
}
/**
- * htmlcharactersDebug:
- * @ctxt: An XML parser context
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some chars from the parser.
* Question: how much at a time ???
@@ -1435,10 +1433,9 @@ htmlcharactersDebug(void *ctx ATTRIBUTE_UNUSED, const xmlChar *ch, int len)
}
/**
- * htmlcdataDebug:
- * @ctxt: An XML parser context
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some cdata chars from the parser.
* Question: how much at a time ???
@@ -1502,13 +1499,13 @@ hashFreeEntity(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
/**
* saxParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the SAX API and check for errors.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
saxParseTest(const char *filename, const char *result,
@@ -1743,14 +1740,13 @@ static xmlSAXHandler tokenizeHtmlSAXHandler = {
};
/**
- * htmlTokenizerTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the SAX API and check for errors.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
htmlTokenizerTest(const char *filename, const char *result,
@@ -1839,15 +1835,15 @@ htmlTokenizerTest(const char *filename, const char *result,
************************************************************************/
/**
* oldParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a file using the old xmlParseFile API, then serialize back
* reparse the result and serialize again, then check for deviation
* in serialization.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
oldParseTest(const char *filename, const char *result,
@@ -1910,14 +1906,14 @@ oldParseTest(const char *filename, const char *result,
#ifdef LIBXML_PUSH_ENABLED
/**
* pushParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a file using the Push API, then serialize back
* to check for content.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
pushParseTest(const char *filename, const char *result,
@@ -2097,14 +2093,14 @@ endElementNsBnd(void *ctx, const xmlChar *localname, const xmlChar *prefix,
/**
* pushBoundaryTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Test whether the push parser detects boundaries between syntactical
* elements correctly.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
pushBoundaryTest(const char *filename, const char *result,
@@ -2412,15 +2408,15 @@ testParseContent(xmlParserCtxtPtr ctxt, xmlDocPtr doc, const char *filename) {
/**
* memParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a file using the old xmlReadMemory API, then serialize back
* reparse the result and serialize again, then check for deviation
* in serialization.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
memParseTest(const char *filename, const char *result,
@@ -2467,15 +2463,15 @@ memParseTest(const char *filename, const char *result,
/**
* noentParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a file with entity resolution, then serialize back
* reparse the result and serialize again, then check for deviation
* in serialization.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
noentParseTest(const char *filename, const char *result,
@@ -2526,13 +2522,13 @@ noentParseTest(const char *filename, const char *result,
/**
* errParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the xmlReadFile API and check for errors.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
errParseTest(const char *filename, const char *result, const char *err,
@@ -2615,13 +2611,13 @@ errParseTest(const char *filename, const char *result, const char *err,
#if defined(LIBXML_VALID_ENABLED) || defined(LIBXML_HTML_ENABLED)
/**
* fdParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the xmlReadFd API and check for errors.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
fdParseTest(const char *filename, const char *result, const char *err,
@@ -2802,13 +2798,13 @@ streamProcessTest(const char *filename, const char *result, const char *err,
/**
* streamParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the reader API and check for errors.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
streamParseTest(const char *filename, const char *result, const char *err,
@@ -2826,13 +2822,13 @@ streamParseTest(const char *filename, const char *result, const char *err,
/**
* walkerParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the walker, i.e. a reader built from a atree.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
walkerParseTest(const char *filename, const char *result, const char *err,
@@ -2855,13 +2851,13 @@ walkerParseTest(const char *filename, const char *result, const char *err,
/**
* streamMemParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file using the reader API from memory and check for errors.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
streamMemParseTest(const char *filename, const char *result, const char *err,
@@ -2938,13 +2934,13 @@ testXPath(const char *str, int xptr, int expr) {
/**
* xpathExprTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing XPath standalone expressions and evaluate them
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
xpathCommonTest(const char *filename, const char *result,
@@ -3006,13 +3002,13 @@ xpathCommonTest(const char *filename, const char *result,
/**
* xpathExprTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing XPath standalone expressions and evaluate them
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
xpathExprTest(const char *filename, const char *result,
@@ -3023,14 +3019,14 @@ xpathExprTest(const char *filename, const char *result,
/**
* xpathDocTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing XPath expressions and evaluate them against
* a set of corresponding documents.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
xpathDocTest(const char *filename,
@@ -3075,14 +3071,14 @@ xpathDocTest(const char *filename,
#ifdef LIBXML_XPTR_ENABLED
/**
* xptrDocTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing XPath expressions and evaluate them against
* a set of corresponding documents.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
xptrDocTest(const char *filename,
@@ -3127,15 +3123,14 @@ xptrDocTest(const char *filename,
#ifdef LIBXML_VALID_ENABLED
/**
- * xmlidDocTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing xml:id and check for errors and verify
* that XPath queries will work on them as expected.
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
xmlidDocTest(const char *filename,
@@ -3238,13 +3233,13 @@ handleURI(const char *str, const char *base, FILE *o) {
/**
* uriCommonTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing URI and check for errors
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
uriCommonTest(const char *filename,
@@ -3326,13 +3321,13 @@ uriCommonTest(const char *filename,
/**
* uriParseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing URI and check for errors
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
uriParseTest(const char *filename,
@@ -3344,14 +3339,14 @@ uriParseTest(const char *filename,
/**
* uriBaseTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing URI, compose them against a fixed base and
* check for errors
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
uriBaseTest(const char *filename,
@@ -3400,11 +3395,11 @@ static int urip_rlen;
/**
* uripMatch:
- * @URI: an URI to test
+ * @param URI an URI to test
*
* Check for an urip: query
*
- * Returns 1 if yes and 0 if another Input module should be used
+ * @returns 1 if yes and 0 if another Input module should be used
*/
static int
uripMatch(const char * URI) {
@@ -3421,12 +3416,12 @@ uripMatch(const char * URI) {
/**
* uripOpen:
- * @URI: an URI to test
+ * @param URI an URI to test
*
- * Return a pointer to the urip: query handler, in this example simply
+ * @returns a pointer to the urip: query handler, in this example simply
* the urip_current pointer...
*
- * Returns an Input context or NULL in case or error
+ * @returns an Input context or NULL in case or error
*/
static void *
uripOpen(const char * URI) {
@@ -3445,11 +3440,11 @@ uripOpen(const char * URI) {
/**
* uripClose:
- * @context: the read context
+ * @param context the read context
*
* Close the urip: query handler
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
uripClose(void * context) {
@@ -3461,13 +3456,13 @@ uripClose(void * context) {
/**
* uripRead:
- * @context: the read context
- * @buffer: where to store data
- * @len: number of bytes to read
+ * @param context the read context
+ * @param buffer where to store data
+ * @param len number of bytes to read
*
* Implement an urip: query read.
*
- * Returns the number of bytes read or -1 in case of error
+ * @returns the number of bytes read or -1 in case of error
*/
static int
uripRead(void * context, char * buffer, int len) {
@@ -3495,14 +3490,14 @@ urip_checkURL(const char *URL) {
/**
* uriPathTest:
- * @filename: ignored
- * @result: ignored
- * @err: ignored
+ * @param filename ignored
+ * @param result ignored
+ * @param err ignored
*
* Run a set of tests to check how Path and URI are handled before
* being passed to the I/O layer
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
uriPathTest(const char *filename ATTRIBUTE_UNUSED,
@@ -3610,14 +3605,14 @@ done:
}
/**
* schemasTest:
- * @filename: the schemas file
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the schemas file
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a file containing URI, compose them against a fixed base and
* check for errors
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
schemasTest(const char *filename,
@@ -3743,13 +3738,13 @@ rngOneTest(const char *sch,
}
/**
* rngTest:
- * @filename: the schemas file
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the schemas file
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse an RNG schemas and then apply it to the related .xml
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
rngTest(const char *filename,
@@ -3835,13 +3830,13 @@ rngTest(const char *filename,
#ifdef LIBXML_READER_ENABLED
/**
* rngStreamTest:
- * @filename: the schemas file
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the schemas file
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a set of files with streaming, applying an RNG schemas
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
rngStreamTest(const char *filename,
@@ -3974,11 +3969,11 @@ schematronOneTest(const char *sch, const char *filename, int options,
/**
* schematronTest:
- * @filename: the schemas file
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the schemas file
+ * @param result the file with expected result
+ * @param err the file with error messages
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
schematronTest(const char *filename,
@@ -4126,13 +4121,13 @@ static void patternNode(FILE *out, xmlTextReaderPtr reader,
/**
* patternTest:
- * @filename: the schemas file
- * @result: the file with expected result
- * @err: the file with error messages
+ * @param filename the schemas file
+ * @param result the file with expected result
+ * @param err the file with error messages
*
* Parse a set of files with streaming, applying an RNG schemas
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
patternTest(const char *filename,
diff --git a/schematron.c b/schematron.c
index 2a8c15ee..9f899219 100644
--- a/schematron.c
+++ b/schematron.c
@@ -155,7 +155,6 @@ struct _xmlSchematron {
};
/**
- * xmlSchematronValidCtxt:
*
* A Schematrons validation context
*/
@@ -225,8 +224,7 @@ struct _xmlSchematronParserCtxt {
************************************************************************/
/**
- * xmlSchematronPErrMemory:
- * @ctxt: parser context
+ * @param ctxt parser context
*
* Handle an out of memory condition
*/
@@ -239,13 +237,12 @@ xmlSchematronPErrMemory(xmlSchematronParserCtxtPtr ctxt)
}
/**
- * xmlSchematronPErr:
- * @ctxt: the parsing context
- * @node: the context node
- * @error: the error code
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt the parsing context
+ * @param node the context node
+ * @param error the error code
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Handle a parser error
*/
@@ -279,8 +276,7 @@ xmlSchematronPErr(xmlSchematronParserCtxtPtr ctxt, xmlNodePtr node, int error,
}
/**
- * xmlSchematronVTypeErrMemory:
- * @ctxt: validation context
+ * @param ctxt validation context
*
* Handle an out of memory condition
*/
@@ -295,11 +291,10 @@ xmlSchematronVErrMemory(xmlSchematronValidCtxtPtr ctxt)
}
/**
- * xmlSchematronVErr:
- * @ctxt: validation context
- * @error: the error code
- * @msg: the error message
- * @str1: extra data
+ * @param ctxt validation context
+ * @param error the error code
+ * @param msg the error message
+ * @param str1 extra data
*
* Handle a validation error
*/
@@ -339,17 +334,16 @@ xmlSchematronVErr(xmlSchematronValidCtxtPtr ctxt, int error,
************************************************************************/
/**
- * xmlSchematronAddTest:
- * @ctxt: the schema parsing context
- * @type: the type of test
- * @rule: the parent rule
- * @node: the node hosting the test
- * @test: the associated test
- * @report: the associated report string
+ * @param ctxt the schema parsing context
+ * @param type the type of test
+ * @param rule the parent rule
+ * @param node the node hosting the test
+ * @param test the associated test
+ * @param report the associated report string
*
* Add a test to a schematron
*
- * Returns the new pointer or NULL in case of error
+ * @returns the new pointer or NULL in case of error
*/
static xmlSchematronTestPtr
xmlSchematronAddTest(xmlSchematronParserCtxtPtr ctxt,
@@ -401,8 +395,7 @@ xmlSchematronAddTest(xmlSchematronParserCtxtPtr ctxt,
}
/**
- * xmlSchematronFreeTests:
- * @tests: a list of tests
+ * @param tests a list of tests
*
* Free a list of tests.
*/
@@ -424,8 +417,7 @@ xmlSchematronFreeTests(xmlSchematronTestPtr tests) {
}
/**
- * xmlSchematronFreeLets:
- * @lets: a list of let variables
+ * @param lets a list of let variables
*
* Free a list of let variables.
*/
@@ -445,17 +437,16 @@ xmlSchematronFreeLets(xmlSchematronLetPtr lets) {
}
/**
- * xmlSchematronAddRule:
- * @ctxt: the schema parsing context
- * @schema: a schema structure
- * @pat: a pattern
- * @node: the node hosting the rule
- * @context: the associated context string
- * @report: the associated report string
+ * @param ctxt the schema parsing context
+ * @param schema a schema structure
+ * @param pat a pattern
+ * @param node the node hosting the rule
+ * @param context the associated context string
+ * @param report the associated report string
*
* Add a rule to a schematron
*
- * Returns the new pointer or NULL in case of error
+ * @returns the new pointer or NULL in case of error
*/
static xmlSchematronRulePtr
xmlSchematronAddRule(xmlSchematronParserCtxtPtr ctxt, xmlSchematronPtr schema,
@@ -516,8 +507,7 @@ xmlSchematronAddRule(xmlSchematronParserCtxtPtr ctxt, xmlSchematronPtr schema,
}
/**
- * xmlSchematronFreeRules:
- * @rules: a list of rules
+ * @param rules a list of rules
*
* Free a list of rules.
*/
@@ -543,15 +533,14 @@ xmlSchematronFreeRules(xmlSchematronRulePtr rules) {
}
/**
- * xmlSchematronAddPattern:
- * @ctxt: the schema parsing context
- * @schema: a schema structure
- * @node: the node hosting the pattern
- * @name: the name of the pattern
+ * @param ctxt the schema parsing context
+ * @param schema a schema structure
+ * @param node the node hosting the pattern
+ * @param name the name of the pattern
*
* Add a pattern to a schematron
*
- * Returns the new pointer or NULL in case of error
+ * @returns the new pointer or NULL in case of error
*/
static xmlSchematronPatternPtr
xmlSchematronAddPattern(xmlSchematronParserCtxtPtr ctxt,
@@ -583,8 +572,7 @@ xmlSchematronAddPattern(xmlSchematronParserCtxtPtr ctxt,
}
/**
- * xmlSchematronFreePatterns:
- * @patterns: a list of patterns
+ * @param patterns a list of patterns
*
* Free a list of patterns.
*/
@@ -602,12 +590,11 @@ xmlSchematronFreePatterns(xmlSchematronPatternPtr patterns) {
}
/**
- * xmlSchematronNewSchematron:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* Allocate a new Schematron structure.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlSchematronPtr
xmlSchematronNewSchematron(xmlSchematronParserCtxtPtr ctxt)
@@ -627,8 +614,7 @@ xmlSchematronNewSchematron(xmlSchematronParserCtxtPtr ctxt)
}
/**
- * xmlSchematronFree:
- * @schema: a schema structure
+ * @param schema a schema structure
*
* Deallocate a Schematron structure.
*/
@@ -651,13 +637,12 @@ xmlSchematronFree(xmlSchematronPtr schema)
}
/**
- * xmlSchematronNewParserCtxt:
- * @URL: the location of the schema
+ * @param URL the location of the schema
*
* Create an XML Schematrons parse context for that file/resource expected
* to contain an XML Schematrons file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlSchematronParserCtxtPtr
xmlSchematronNewParserCtxt(const char *URL)
@@ -690,14 +675,13 @@ xmlSchematronNewParserCtxt(const char *URL)
}
/**
- * xmlSchematronNewMemParserCtxt:
- * @buffer: a pointer to a char array containing the schemas
- * @size: the size of the array
+ * @param buffer a pointer to a char array containing the schemas
+ * @param size the size of the array
*
* Create an XML Schematrons parse context for that memory buffer expected
* to contain an XML Schematrons file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlSchematronParserCtxtPtr
xmlSchematronNewMemParserCtxt(const char *buffer, int size)
@@ -728,13 +712,12 @@ xmlSchematronNewMemParserCtxt(const char *buffer, int size)
}
/**
- * xmlSchematronNewDocParserCtxt:
- * @doc: a preparsed document tree
+ * @param doc a preparsed document tree
*
* Create an XML Schematrons parse context for that document.
* NB. The document may be modified during the parsing process.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlSchematronParserCtxtPtr
xmlSchematronNewDocParserCtxt(xmlDocPtr doc)
@@ -767,8 +750,7 @@ xmlSchematronNewDocParserCtxt(xmlDocPtr doc)
}
/**
- * xmlSchematronFreeParserCtxt:
- * @ctxt: the schema parser context
+ * @param ctxt the schema parser context
*
* Free the resources associated to the schema parser context
*/
@@ -790,10 +772,9 @@ xmlSchematronFreeParserCtxt(xmlSchematronParserCtxtPtr ctxt)
#if 0
/**
- * xmlSchematronPushInclude:
- * @ctxt: the schema parser context
- * @doc: the included document
- * @cur: the current include node
+ * @param ctxt the schema parser context
+ * @param doc the included document
+ * @param cur the current include node
*
* Add an included document
*/
@@ -829,12 +810,11 @@ xmlSchematronPushInclude(xmlSchematronParserCtxtPtr ctxt,
}
/**
- * xmlSchematronPopInclude:
- * @ctxt: the schema parser context
+ * @param ctxt the schema parser context
*
* Pop an include level. The included document is being freed
*
- * Returns the node immediately following the include or NULL if the
+ * @returns the node immediately following the include or NULL if the
* include list was empty.
*/
static xmlNodePtr
@@ -858,10 +838,9 @@ xmlSchematronPopInclude(xmlSchematronParserCtxtPtr ctxt)
#endif
/**
- * xmlSchematronAddNamespace:
- * @ctxt: the schema parser context
- * @prefix: the namespace prefix
- * @ns: the namespace name
+ * @param ctxt the schema parser context
+ * @param prefix the namespace prefix
+ * @param ns the namespace name
*
* Add a namespace definition in the context
*/
@@ -902,9 +881,8 @@ xmlSchematronAddNamespace(xmlSchematronParserCtxtPtr ctxt,
}
/**
- * xmlSchematronParseTestReportMsg:
- * @ctxt: the schema parser context
- * @con: the assert or report node
+ * @param ctxt the schema parser context
+ * @param con the assert or report node
*
* Format the message content of the assert or report test
*/
@@ -952,10 +930,9 @@ xmlSchematronParseTestReportMsg(xmlSchematronParserCtxtPtr ctxt, xmlNodePtr con)
}
/**
- * xmlSchematronParseRule:
- * @ctxt: a schema validation context
- * @pattern: a pattern
- * @rule: the rule node
+ * @param ctxt a schema validation context
+ * @param pattern a pattern
+ * @param rule the rule node
*
* parse a rule element
*/
@@ -1121,9 +1098,8 @@ xmlSchematronParseRule(xmlSchematronParserCtxtPtr ctxt,
}
/**
- * xmlSchematronParsePattern:
- * @ctxt: a schema validation context
- * @pat: the pattern node
+ * @param ctxt a schema validation context
+ * @param pat the pattern node
*
* parse a pattern element
*/
@@ -1170,13 +1146,12 @@ xmlSchematronParsePattern(xmlSchematronParserCtxtPtr ctxt, xmlNodePtr pat)
#if 0
/**
- * xmlSchematronLoadInclude:
- * @ctxt: a schema validation context
- * @cur: the include element
+ * @param ctxt a schema validation context
+ * @param cur the include element
*
* Load the include document, Push the current pointer
*
- * Returns the updated node pointer
+ * @returns the updated node pointer
*/
static xmlNodePtr
xmlSchematronLoadInclude(xmlSchematronParserCtxtPtr ctxt, xmlNodePtr cur)
@@ -1236,13 +1211,12 @@ done:
#endif
/**
- * xmlSchematronParse:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* parse a schema definition resource and build an internal
* XML Schema structure which can be used to validate instances.
*
- * Returns the internal XML Schematron structure built from the resource or
+ * @returns the internal XML Schematron structure built from the resource or
* NULL in case of error
*/
xmlSchematronPtr
@@ -1435,10 +1409,9 @@ xmlSchematronGetNode(xmlSchematronValidCtxtPtr ctxt,
}
/**
- * xmlSchematronReportOutput:
- * @ctxt: the validation context
- * @cur: the current node tested
- * @msg: the message output
+ * @param ctxt the validation context
+ * @param cur the current node tested
+ * @param msg the message output
*
* Output part of the report to whatever channel the user selected
*/
@@ -1451,14 +1424,13 @@ xmlSchematronReportOutput(xmlSchematronValidCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmlSchematronFormatReport:
- * @ctxt: the validation context
- * @test: the test node
- * @cur: the current node tested
+ * @param ctxt the validation context
+ * @param test the test node
+ * @param cur the current node tested
*
* Build the string being reported to the user.
*
- * Returns a report string or NULL in case of error. The string needs
+ * @returns a report string or NULL in case of error. The string needs
* to be deallocated by the caller
*/
static xmlChar *
@@ -1580,12 +1552,11 @@ xmlSchematronFormatReport(xmlSchematronValidCtxtPtr ctxt,
}
/**
- * xmlSchematronReportSuccess:
- * @ctxt: the validation context
- * @test: the compiled test
- * @cur: the current node tested
- * @pattern: a pattern
- * @success: boolean value for the result
+ * @param ctxt the validation context
+ * @param test the compiled test
+ * @param cur the current node tested
+ * @param pattern a pattern
+ * @param success boolean value for the result
*
* called from the validation engine when an assert or report test have
* been done.
@@ -1671,9 +1642,8 @@ xmlSchematronReportSuccess(xmlSchematronValidCtxtPtr ctxt,
}
/**
- * xmlSchematronReportPattern:
- * @ctxt: the validation context
- * @pattern: the current pattern
+ * @param ctxt the validation context
+ * @param pattern the current pattern
*
* called from the validation engine when starting to check a pattern
*/
@@ -1704,10 +1674,9 @@ xmlSchematronReportPattern(xmlSchematronValidCtxtPtr ctxt,
************************************************************************/
/**
- * xmlSchematronSetValidStructuredErrors:
- * @ctxt: a Schematron validation context
- * @serror: the structured error function
- * @ctx: the functions context
+ * @param ctxt a Schematron validation context
+ * @param serror the structured error function
+ * @param ctx the functions context
*
* Set the structured error callback
*/
@@ -1724,13 +1693,12 @@ xmlSchematronSetValidStructuredErrors(xmlSchematronValidCtxtPtr ctxt,
}
/**
- * xmlSchematronNewValidCtxt:
- * @schema: a precompiled XML Schematrons
- * @options: a set of xmlSchematronValidOptions
+ * @param schema a precompiled XML Schematrons
+ * @param options a set of xmlSchematronValidOptions
*
* Create an XML Schematrons validation context based on the given schema.
*
- * Returns the validation context or NULL in case of error
+ * @returns the validation context or NULL in case of error
*/
xmlSchematronValidCtxtPtr
xmlSchematronNewValidCtxt(xmlSchematronPtr schema, int options)
@@ -1767,8 +1735,7 @@ xmlSchematronNewValidCtxt(xmlSchematronPtr schema, int options)
}
/**
- * xmlSchematronFreeValidCtxt:
- * @ctxt: the schema validation context
+ * @param ctxt the schema validation context
*
* Free the resources associated to the schema validation context
*/
@@ -1820,16 +1787,15 @@ xmlSchematronNextNode(xmlNodePtr cur) {
}
/**
- * xmlSchematronRunTest:
- * @ctxt: the schema validation context
- * @test: the current test
- * @instance: the document instance tree
- * @cur: the current node in the instance
- * @pattern: a pattern
+ * @param ctxt the schema validation context
+ * @param test the current test
+ * @param instance the document instance tree
+ * @param cur the current node in the instance
+ * @param pattern a pattern
*
* Validate a rule against a tree instance at a given position
*
- * Returns 1 in case of success, 0 if error and -1 in case of internal error
+ * @returns 1 in case of success, 0 if error and -1 in case of internal error
*/
static int
xmlSchematronRunTest(xmlSchematronValidCtxtPtr ctxt,
@@ -1883,16 +1849,15 @@ xmlSchematronRunTest(xmlSchematronValidCtxtPtr ctxt,
}
/**
- * xmlSchematronRegisterVariables:
- * @vctxt: the schema validation context
- * @ctxt: an XPath context
- * @let: the list of let variables
- * @instance: the document instance tree
- * @cur: the current node
+ * @param vctxt the schema validation context
+ * @param ctxt an XPath context
+ * @param let the list of let variables
+ * @param instance the document instance tree
+ * @param cur the current node
*
- * Registers a list of let variables to the current context of @cur
+ * Registers a list of let variables to the current context of `cur`
*
- * Returns -1 in case of errors, otherwise 0
+ * @returns -1 in case of errors, otherwise 0
*/
static int
xmlSchematronRegisterVariables(xmlSchematronValidCtxtPtr vctxt,
@@ -1923,14 +1888,13 @@ xmlSchematronRegisterVariables(xmlSchematronValidCtxtPtr vctxt,
}
/**
- * xmlSchematronUnregisterVariables:
- * @vctxt: the schema validation context
- * @ctxt: an XPath context
- * @let: the list of let variables
+ * @param vctxt the schema validation context
+ * @param ctxt an XPath context
+ * @param let the list of let variables
*
* Unregisters a list of let variables from the context
*
- * Returns -1 in case of errors, otherwise 0
+ * @returns -1 in case of errors, otherwise 0
*/
static int
xmlSchematronUnregisterVariables(xmlSchematronValidCtxtPtr vctxt,
@@ -1949,13 +1913,12 @@ xmlSchematronUnregisterVariables(xmlSchematronValidCtxtPtr vctxt,
}
/**
- * xmlSchematronValidateDoc:
- * @ctxt: the schema validation context
- * @instance: the document instance tree
+ * @param ctxt the schema validation context
+ * @param instance the document instance tree
*
* Validate a tree instance against the schematron
*
- * Returns 0 in case of success, -1 in case of internal error
+ * @returns 0 in case of success, -1 in case of internal error
* and an error count otherwise.
*/
int
diff --git a/shell.c b/shell.c
index 3ca6f73a..9156feef 100644
--- a/shell.c
+++ b/shell.c
@@ -62,12 +62,11 @@ struct _xmllintShellCtxt {
};
/**
- * xmllintLsCountNode:
- * @node: the node to count
+ * @param node the node to count
*
- * Count the children of @node.
+ * Count the children of `node`.
*
- * Returns the number of children of @node.
+ * @returns the number of children of `node`.
*/
static int
xmllintLsCountNode(xmlNodePtr node) {
@@ -117,11 +116,10 @@ xmllintLsCountNode(xmlNodePtr node) {
}
/**
- * xmllintLsOneNode:
- * @output: the FILE * for the output
- * @node: the node to dump
+ * @param output the FILE * for the output
+ * @param node the node to dump
*
- * Dump to @output the type and name of @node.
+ * Dump to `output` the type and name of `node`.
*/
static void
xmllintLsOneNode(FILE *output, xmlNodePtr node) {
@@ -252,16 +250,15 @@ xmllintLsOneNode(FILE *output, xmlNodePtr node) {
}
/**
- * xmllintShellList:
- * @ctxt: the shell context
- * @arg: unused
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg unused
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "ls"
* Does an Unix like listing of the given node (like a directory)
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellList(xmllintShellCtxtPtr ctxt,
@@ -295,16 +292,15 @@ xmllintShellList(xmllintShellCtxtPtr ctxt,
}
/**
- * xmllintShellBase:
- * @ctxt: the shell context
- * @arg: unused
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg unused
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "base"
* dumps the current XML base of the node
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellBase(xmllintShellCtxtPtr ctxt,
@@ -331,16 +327,15 @@ xmllintShellBase(xmllintShellCtxtPtr ctxt,
}
/**
- * xmllintShellSetBase:
- * @ctxt: the shell context
- * @arg: the new base
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg the new base
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "setbase"
* change the current XML base of the node
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellSetBase(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -353,17 +348,16 @@ xmllintShellSetBase(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
#ifdef LIBXML_XPATH_ENABLED
/**
- * xmllintShellRegisterNamespace:
- * @ctxt: the shell context
- * @arg: a string in prefix=nsuri format
- * @node: unused
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg a string in prefix=nsuri format
+ * @param node unused
+ * @param node2 unused
*
* Implements the XML shell function "setns"
* register/unregister a prefix=namespace pair
* on the XPath context
*
- * Returns 0 on success and a negative value otherwise.
+ * @returns 0 on success and a negative value otherwise.
*/
static int
xmllintShellRegisterNamespace(xmllintShellCtxtPtr ctxt, char *arg,
@@ -410,16 +404,15 @@ xmllintShellRegisterNamespace(xmllintShellCtxtPtr ctxt, char *arg,
return(0);
}
/**
- * xmllintShellRegisterRootNamespaces:
- * @ctxt: the shell context
- * @arg: unused
- * @root: the root element
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg unused
+ * @param root the root element
+ * @param node2 unused
*
* Implements the XML shell function "setrootns"
* which registers all namespaces declarations found on the root element.
*
- * Returns 0 on success and a negative value otherwise.
+ * @returns 0 on success and a negative value otherwise.
*/
static int
xmllintShellRegisterRootNamespaces(xmllintShellCtxtPtr ctxt, char *arg ATTRIBUTE_UNUSED,
@@ -443,16 +436,15 @@ xmllintShellRegisterRootNamespaces(xmllintShellCtxtPtr ctxt, char *arg ATTRIBUTE
#endif
/**
- * xmllintShellGrep:
- * @ctxt: the shell context
- * @arg: the string or regular expression to find
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg the string or regular expression to find
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "grep"
* dumps information about the node (namespace, attributes, content).
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellGrep(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -519,16 +511,15 @@ xmllintShellGrep(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmllintShellDir:
- * @ctxt: the shell context
- * @arg: unused
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg unused
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "dir"
* dumps information about the node (namespace, attributes, content).
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellDir(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -555,16 +546,15 @@ xmllintShellDir(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
}
/**
- * xmllintShellSetContent:
- * @ctxt: the shell context
- * @value: the content as a string
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param value the content as a string
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "dir"
* dumps information about the node (namespace, attributes, content).
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellSetContent(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED,
@@ -613,16 +603,15 @@ xmllintShellPrintf(void *ctx, const char *msg, ...) {
#ifdef LIBXML_RELAXNG_ENABLED
/**
- * xmllintShellRNGValidate:
- * @sctxt: the shell context
- * @schemas: the path to the Relax-NG schemas
- * @node: a node
- * @node2: unused
+ * @param sctxt the shell context
+ * @param schemas the path to the Relax-NG schemas
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "relaxng"
* validating the instance against a Relax-NG schemas
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellRNGValidate(xmllintShellCtxtPtr sctxt, char *schemas,
@@ -663,16 +652,15 @@ xmllintShellRNGValidate(xmllintShellCtxtPtr sctxt, char *schemas,
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmllintShellCat:
- * @ctxt: the shell context
- * @arg: unused
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg unused
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "cat"
* dumps the serialization node content (XML or HTML).
*
- * Returns 0
+ * @returns 0
*/
static int
xmllintShellCat(xmllintShellCtxtPtr ctxt, char *arg ATTRIBUTE_UNUSED,
@@ -708,16 +696,15 @@ xmllintShellCat(xmllintShellCtxtPtr ctxt, char *arg ATTRIBUTE_UNUSED,
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmllintShellLoad:
- * @ctxt: the shell context
- * @filename: the file name
- * @node: unused
- * @node2: unused
+ * @param ctxt the shell context
+ * @param filename the file name
+ * @param node unused
+ * @param node2 unused
*
* Implements the XML shell function "load"
* loads a new document specified by the filename
*
- * Returns 0 or -1 if loading failed
+ * @returns 0 or -1 if loading failed
*/
static int
xmllintShellLoad(xmllintShellCtxtPtr ctxt, char *filename,
@@ -763,17 +750,16 @@ xmllintShellLoad(xmllintShellCtxtPtr ctxt, char *filename,
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmllintShellWrite:
- * @ctxt: the shell context
- * @filename: the file name
- * @node: a node in the tree
- * @node2: unused
+ * @param ctxt the shell context
+ * @param filename the file name
+ * @param node a node in the tree
+ * @param node2 unused
*
* Implements the XML shell function "write"
* Write the current node to the filename, it saves the serialization
- * of the subtree under the @node specified
+ * of the subtree under the `node` specified
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
xmllintShellWrite(xmllintShellCtxtPtr ctxt, char *filename, xmlNodePtr node,
@@ -824,16 +810,15 @@ xmllintShellWrite(xmllintShellCtxtPtr ctxt, char *filename, xmlNodePtr node,
}
/**
- * xmllintShellSave:
- * @ctxt: the shell context
- * @filename: the file name (optional)
- * @node: unused
- * @node2: unused
+ * @param ctxt the shell context
+ * @param filename the file name (optional)
+ * @param node unused
+ * @param node2 unused
*
* Implements the XML shell function "save"
* Write the current document to the filename, or it's original name
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
xmllintShellSave(xmllintShellCtxtPtr ctxt, char *filename,
@@ -878,17 +863,16 @@ xmllintShellSave(xmllintShellCtxtPtr ctxt, char *filename,
#ifdef LIBXML_VALID_ENABLED
/**
- * xmllintShellValidate:
- * @ctxt: the shell context
- * @dtd: the DTD URI (optional)
- * @node: unused
- * @node2: unused
+ * @param ctxt the shell context
+ * @param dtd the DTD URI (optional)
+ * @param node unused
+ * @param node2 unused
*
* Implements the XML shell function "validate"
* Validate the document, if a DTD path is provided, then the validation
* is done against the given DTD.
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
xmllintShellValidate(xmllintShellCtxtPtr ctxt, char *dtd,
@@ -921,17 +905,16 @@ xmllintShellValidate(xmllintShellCtxtPtr ctxt, char *dtd,
#endif /* LIBXML_VALID_ENABLED */
/**
- * xmllintShellDu:
- * @ctxt: the shell context
- * @arg: unused
- * @tree: a node defining a subtree
- * @node2: unused
+ * @param ctxt the shell context
+ * @param arg unused
+ * @param tree a node defining a subtree
+ * @param node2 unused
*
* Implements the XML shell function "du"
- * show the structure of the subtree under node @tree
- * If @tree is null, the command works on the current node.
+ * show the structure of the subtree under node `tree`
+ * If `tree` is null, the command works on the current node.
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
xmllintShellDu(xmllintShellCtxtPtr ctxt,
@@ -1005,18 +988,17 @@ xmllintShellDu(xmllintShellCtxtPtr ctxt,
}
/**
- * xmllintShellPwd:
- * @ctxt: the shell context
- * @buffer: the output buffer
- * @node: a node
- * @node2: unused
+ * @param ctxt the shell context
+ * @param buffer the output buffer
+ * @param node a node
+ * @param node2 unused
*
* Implements the XML shell function "pwd"
* Show the full path from the root to the node, if needed building
* thumblers when similar elements exists at a given ancestor level.
* The output is compatible with XPath commands.
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
xmllintShellPwd(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED, char *buffer,
@@ -1047,12 +1029,11 @@ xmllintShellPwd(xmllintShellCtxtPtr ctxt ATTRIBUTE_UNUSED, char *buffer,
}
/**
- * xmllintShellReadline:
- * @prompt: the prompt value
+ * @param prompt the prompt value
*
* Read a string
*
- * Returns a pointer to it or NULL on EOF the caller is expected to
+ * @returns a pointer to it or NULL on EOF the caller is expected to
* free the returned string.
*/
static char *
@@ -1093,10 +1074,9 @@ xmllintShellReadline(char *prompt) {
}
/**
- * xmllintShell:
- * @doc: the initial document
- * @filename: the output buffer
- * @output: the output FILE*, defaults to stdout if NULL
+ * @param doc the initial document
+ * @param filename the output buffer
+ * @param output the output FILE*, defaults to stdout if NULL
*
* Implements the XML shell
* This allow to load, validate, view, modify and save a document
diff --git a/testlimits.c b/testlimits.c
index 3f572ea6..14c2a5ad 100644
--- a/testlimits.c
+++ b/testlimits.c
@@ -90,11 +90,11 @@ static int instate = 0;
/**
* hugeMatch:
- * @URI: an URI to test
+ * @param URI an URI to test
*
* Check for an huge: query
*
- * Returns 1 if yes and 0 if another Input module should be used
+ * @returns 1 if yes and 0 if another Input module should be used
*/
static int
hugeMatch(const char * URI) {
@@ -105,12 +105,12 @@ hugeMatch(const char * URI) {
/**
* hugeOpen:
- * @URI: an URI to test
+ * @param URI an URI to test
*
- * Return a pointer to the huge: query handler, in this example simply
+ * @returns a pointer to the huge: query handler, in this example simply
* the current pointer...
*
- * Returns an Input context or NULL in case or error
+ * @returns an Input context or NULL in case or error
*/
static void *
hugeOpen(const char * URI) {
@@ -133,11 +133,11 @@ found:
/**
* hugeClose:
- * @context: the read context
+ * @param context the read context
*
* Close the huge: query handler
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
hugeClose(void * context) {
@@ -165,13 +165,13 @@ size_t dotlen;
/**
* hugeRead:
- * @context: the read context
- * @buffer: where to store data
- * @len: number of bytes to read
+ * @param context the read context
+ * @param buffer where to store data
+ * @param len number of bytes to read
*
* Implement an huge: query read.
*
- * Returns the number of bytes read or -1 in case of error
+ * @returns the number of bytes read or -1 in case of error
*/
static int
hugeRead(void *context, char *buffer, int len)
@@ -253,11 +253,11 @@ foo\
/**
* crazyMatch:
- * @URI: an URI to test
+ * @param URI an URI to test
*
* Check for a crazy: query
*
- * Returns 1 if yes and 0 if another Input module should be used
+ * @returns 1 if yes and 0 if another Input module should be used
*/
static int
crazyMatch(const char * URI) {
@@ -268,12 +268,12 @@ crazyMatch(const char * URI) {
/**
* crazyOpen:
- * @URI: an URI to test
+ * @param URI an URI to test
*
- * Return a pointer to the crazy: query handler, in this example simply
+ * @returns a pointer to the crazy: query handler, in this example simply
* the current pointer...
*
- * Returns an Input context or NULL in case or error
+ * @returns an Input context or NULL in case or error
*/
static void *
crazyOpen(const char * URI) {
@@ -291,11 +291,11 @@ crazyOpen(const char * URI) {
/**
* crazyClose:
- * @context: the read context
+ * @param context the read context
*
* Close the crazy: query handler
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
crazyClose(void * context) {
@@ -306,13 +306,13 @@ crazyClose(void * context) {
/**
* crazyRead:
- * @context: the read context
- * @buffer: where to store data
- * @len: number of bytes to read
+ * @param context the read context
+ * @param buffer where to store data
+ * @param len number of bytes to read
*
* Implement an crazy: query read.
*
- * Returns the number of bytes read or -1 in case of error
+ * @returns the number of bytes read or -1 in case of error
*/
static int
crazyRead(void *context, char *buffer, int len)
@@ -406,11 +406,11 @@ unsigned long callbacks = 0;
/**
* isStandaloneCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Is this document tagged standalone ?
*
- * Returns 1 if true
+ * @returns 1 if true
*/
static int
isStandaloneCallback(void *ctx ATTRIBUTE_UNUSED)
@@ -421,11 +421,11 @@ isStandaloneCallback(void *ctx ATTRIBUTE_UNUSED)
/**
* hasInternalSubsetCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an internal subset
*
- * Returns 1 if true
+ * @returns 1 if true
*/
static int
hasInternalSubsetCallback(void *ctx ATTRIBUTE_UNUSED)
@@ -436,11 +436,11 @@ hasInternalSubsetCallback(void *ctx ATTRIBUTE_UNUSED)
/**
* hasExternalSubsetCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an external subset
*
- * Returns 1 if true
+ * @returns 1 if true
*/
static int
hasExternalSubsetCallback(void *ctx ATTRIBUTE_UNUSED)
@@ -451,7 +451,7 @@ hasExternalSubsetCallback(void *ctx ATTRIBUTE_UNUSED)
/**
* internalSubsetCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an internal subset
*/
@@ -466,7 +466,7 @@ internalSubsetCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* externalSubsetCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* Does this document has an external subset
*/
@@ -481,9 +481,9 @@ externalSubsetCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* resolveEntityCallback:
- * @ctxt: An XML parser context
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctxt An XML parser context
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* Special entity resolver, better left to the parser, it has
* more context than the application layer.
@@ -491,7 +491,7 @@ externalSubsetCallback(void *ctx ATTRIBUTE_UNUSED,
* the ENTITY_REF nodes are built in the structure (and the parameter
* values).
*
- * Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
+ * @returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
*/
static xmlParserInputPtr
resolveEntityCallback(void *ctx ATTRIBUTE_UNUSED,
@@ -504,12 +504,12 @@ resolveEntityCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* getEntityCallback:
- * @ctxt: An XML parser context
- * @name: The entity name
+ * @param ctxt An XML parser context
+ * @param name The entity name
*
* Get an entity by name
*
- * Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
+ * @returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.
*/
static xmlEntityPtr
getEntityCallback(void *ctx ATTRIBUTE_UNUSED,
@@ -521,12 +521,12 @@ getEntityCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* getParameterEntityCallback:
- * @ctxt: An XML parser context
- * @name: The entity name
+ * @param ctxt An XML parser context
+ * @param name The entity name
*
* Get a parameter entity by name
*
- * Returns the xmlParserInputPtr
+ * @returns the xmlParserInputPtr
*/
static xmlEntityPtr
getParameterEntityCallback(void *ctx ATTRIBUTE_UNUSED,
@@ -539,12 +539,12 @@ getParameterEntityCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* entityDeclCallback:
- * @ctxt: An XML parser context
- * @name: the entity name
- * @type: the entity type
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @content: the entity value (without processing).
+ * @param ctxt An XML parser context
+ * @param name the entity name
+ * @param type the entity type
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param content the entity value (without processing).
*
* An entity definition has been parsed
*/
@@ -561,9 +561,9 @@ entityDeclCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* attributeDeclCallback:
- * @ctxt: An XML parser context
- * @name: the attribute name
- * @type: the attribute type
+ * @param ctxt An XML parser context
+ * @param name the attribute name
+ * @param type the attribute type
*
* An attribute definition has been parsed
*/
@@ -580,10 +580,10 @@ attributeDeclCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* elementDeclCallback:
- * @ctxt: An XML parser context
- * @name: the element name
- * @type: the element type
- * @content: the element value (without processing).
+ * @param ctxt An XML parser context
+ * @param name the element name
+ * @param type the element type
+ * @param content the element value (without processing).
*
* An element definition has been parsed
*/
@@ -598,10 +598,10 @@ elementDeclCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* notationDeclCallback:
- * @ctxt: An XML parser context
- * @name: The name of the notation
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
+ * @param ctxt An XML parser context
+ * @param name The name of the notation
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
*
* What to do when a notation declaration has been parsed.
*/
@@ -616,11 +616,11 @@ notationDeclCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* unparsedEntityDeclCallback:
- * @ctxt: An XML parser context
- * @name: The name of the entity
- * @publicId: The public ID of the entity
- * @systemId: The system ID of the entity
- * @notationName: the name of the notation
+ * @param ctxt An XML parser context
+ * @param name The name of the entity
+ * @param publicId The public ID of the entity
+ * @param systemId The system ID of the entity
+ * @param notationName the name of the notation
*
* What to do when an unparsed entity declaration is parsed
*/
@@ -636,8 +636,8 @@ unparsedEntityDeclCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* setDocumentLocatorCallback:
- * @ctxt: An XML parser context
- * @loc: A SAX Locator
+ * @param ctxt An XML parser context
+ * @param loc A SAX Locator
*
* Receive the document locator at startup, actually xmlDefaultSAXLocator
* Everything is available on the context, so this is useless in our case.
@@ -651,7 +651,7 @@ setDocumentLocatorCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* startDocumentCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* called when the document start being processed.
*/
@@ -663,7 +663,7 @@ startDocumentCallback(void *ctx ATTRIBUTE_UNUSED)
/**
* endDocumentCallback:
- * @ctxt: An XML parser context
+ * @param ctxt An XML parser context
*
* called when the document end has been detected.
*/
@@ -676,8 +676,8 @@ endDocumentCallback(void *ctx ATTRIBUTE_UNUSED)
#if 0
/**
* startElementCallback:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when an opening tag has been processed.
*/
@@ -692,8 +692,8 @@ startElementCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* endElementCallback:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when the end of an element has been detected.
*/
@@ -708,9 +708,9 @@ endElementCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* charactersCallback:
- * @ctxt: An XML parser context
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some chars from the parser.
* Question: how much at a time ???
@@ -725,8 +725,8 @@ charactersCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* referenceCallback:
- * @ctxt: An XML parser context
- * @name: The entity name
+ * @param ctxt An XML parser context
+ * @param name The entity name
*
* called when an entity reference is detected.
*/
@@ -739,10 +739,10 @@ referenceCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* ignorableWhitespaceCallback:
- * @ctxt: An XML parser context
- * @ch: a xmlChar string
- * @start: the first char in the string
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param ch a xmlChar string
+ * @param start the first char in the string
+ * @param len the number of xmlChar
*
* receiving some ignorable whitespaces from the parser.
* Question: how much at a time ???
@@ -757,10 +757,10 @@ ignorableWhitespaceCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* processingInstructionCallback:
- * @ctxt: An XML parser context
- * @target: the target name
- * @data: the PI data's
- * @len: the number of xmlChar
+ * @param ctxt An XML parser context
+ * @param target the target name
+ * @param data the PI data's
+ * @param len the number of xmlChar
*
* A processing instruction has been parsed.
*/
@@ -774,9 +774,9 @@ processingInstructionCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* cdataBlockCallback:
- * @ctx: the user data (XML parser context)
- * @value: The pcdata content
- * @len: the block length
+ * @param ctx the user data (XML parser context)
+ * @param value The pcdata content
+ * @param len the block length
*
* called when a pcdata block has been parsed
*/
@@ -790,8 +790,8 @@ cdataBlockCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* commentCallback:
- * @ctxt: An XML parser context
- * @value: the comment content
+ * @param ctxt An XML parser context
+ * @param value the comment content
*
* A comment has been parsed.
*/
@@ -804,8 +804,8 @@ commentCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* warningCallback:
- * @ctxt: An XML parser context
- * @msg: the message to display/transmit
+ * @param ctxt An XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a warning messages, gives file, line, position and
@@ -820,8 +820,8 @@ warningCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* errorCallback:
- * @ctxt: An XML parser context
- * @msg: the message to display/transmit
+ * @param ctxt An XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a error messages, gives file, line, position and
@@ -836,8 +836,8 @@ errorCallback(void *ctx ATTRIBUTE_UNUSED, const char *msg ATTRIBUTE_UNUSED,
/**
* fatalErrorCallback:
- * @ctxt: An XML parser context
- * @msg: the message to display/transmit
+ * @param ctxt An XML parser context
+ * @param msg the message to display/transmit
* @...: extra parameters for the message display
*
* Display and format a fatalError messages, gives file, line, position and
@@ -856,8 +856,8 @@ fatalErrorCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* startElementNsCallback:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when an opening tag has been processed.
*/
@@ -877,8 +877,8 @@ startElementNsCallback(void *ctx ATTRIBUTE_UNUSED,
/**
* endElementCallback:
- * @ctxt: An XML parser context
- * @name: The element name
+ * @param ctxt An XML parser context
+ * @param name The element name
*
* called when the end of an element has been detected.
*/
@@ -936,14 +936,14 @@ static xmlSAXHandlerPtr callbackSAX2Handler = &callbackSAX2HandlerStruct;
/**
* readerTest:
- * @filename: the file to parse
- * @max_size: size of the limit to test
- * @options: parsing options
- * @fail: should a failure be reported
+ * @param filename the file to parse
+ * @param max_size size of the limit to test
+ * @param options parsing options
+ * @param fail should a failure be reported
*
* Parse a memory generated file using SAX
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
saxTest(const char *filename, size_t limit, int options, int fail) {
@@ -988,14 +988,14 @@ saxTest(const char *filename, size_t limit, int options, int fail) {
#ifdef LIBXML_READER_ENABLED
/**
* readerTest:
- * @filename: the file to parse
- * @max_size: size of the limit to test
- * @options: parsing options
- * @fail: should a failure be reported
+ * @param filename the file to parse
+ * @param max_size size of the limit to test
+ * @param options parsing options
+ * @param fail should a failure be reported
*
* Parse a memory generated file using the xmlReader
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
readerTest(const char *filename, size_t limit, int options, int fail) {
diff --git a/testrecurse.c b/testrecurse.c
index 10bc84b6..b1c6fb1a 100644
--- a/testrecurse.c
+++ b/testrecurse.c
@@ -245,11 +245,11 @@ static int rlen;
/**
* hugeMatch:
- * @URI: an URI to test
+ * @param URI an URI to test
*
* Check for a huge query
*
- * Returns 1 if yes and 0 if another Input module should be used
+ * @returns 1 if yes and 0 if another Input module should be used
*/
static int
hugeMatch(const char * URI) {
@@ -268,12 +268,12 @@ hugeMatch(const char * URI) {
/**
* hugeOpen:
- * @URI: an URI to test
+ * @param URI an URI to test
*
- * Return a pointer to the huge query handler, in this example simply
+ * @returns a pointer to the huge query handler, in this example simply
* the current pointer...
*
- * Returns an Input context or NULL in case or error
+ * @returns an Input context or NULL in case or error
*/
static void *
hugeOpen(const char * URI) {
@@ -297,11 +297,11 @@ hugeOpen(const char * URI) {
/**
* hugeClose:
- * @context: the read context
+ * @param context the read context
*
* Close the huge query handler
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
static int
hugeClose(void * context) {
@@ -313,13 +313,13 @@ hugeClose(void * context) {
/**
* hugeRead:
- * @context: the read context
- * @buffer: where to store data
- * @len: number of bytes to read
+ * @param context the read context
+ * @param buffer where to store data
+ * @param len number of bytes to read
*
* Implement an huge query read.
*
- * Returns the number of bytes read or -1 in case of error
+ * @returns the number of bytes read or -1 in case of error
*/
static int
hugeRead(void *context, char *buffer, int len)
@@ -467,14 +467,14 @@ static int checkTestFile(const char *filename) {
************************************************************************/
/**
* recursiveDetectTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a file loading DTD and replacing entities check it fails for
* lol cases
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
recursiveDetectTest(const char *filename,
@@ -515,14 +515,14 @@ recursiveDetectTest(const char *filename,
/**
* notRecursiveDetectTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a file loading DTD and replacing entities check it works for
* good cases
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
notRecursiveDetectTest(const char *filename,
@@ -558,14 +558,14 @@ notRecursiveDetectTest(const char *filename,
/**
* notRecursiveHugeTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a memory generated file
* good cases
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
notRecursiveHugeTest(const char *filename ATTRIBUTE_UNUSED,
@@ -660,14 +660,14 @@ notRecursiveHugeTest(const char *filename ATTRIBUTE_UNUSED,
/**
* notRecursiveHugeTest:
- * @filename: the file to parse
- * @result: the file with expected result
- * @err: the file with error messages: unused
+ * @param filename the file to parse
+ * @param result the file with expected result
+ * @param err the file with error messages: unused
*
* Parse a memory generated file
* good cases
*
- * Returns 0 in case of success, an error code otherwise
+ * @returns 0 in case of success, an error code otherwise
*/
static int
hugeDtdTest(const char *filename ATTRIBUTE_UNUSED,
diff --git a/threads.c b/threads.c
index 261c07bb..6e240c39 100644
--- a/threads.c
+++ b/threads.c
@@ -48,8 +48,7 @@
static xmlRMutex xmlLibraryLock;
/**
- * xmlInitMutex:
- * @mutex: the mutex
+ * @param mutex the mutex
*
* Initialize a mutex.
*/
@@ -66,12 +65,11 @@ xmlInitMutex(xmlMutexPtr mutex)
}
/**
- * xmlNewMutex:
*
* xmlNewMutex() is used to allocate a libxml2 token struct for use in
* synchronizing access to data.
*
- * Returns a new simple mutex pointer or NULL in case of error
+ * @returns a new simple mutex pointer or NULL in case of error
*/
xmlMutexPtr
xmlNewMutex(void)
@@ -86,8 +84,7 @@ xmlNewMutex(void)
}
/**
- * xmlCleanupMutex:
- * @mutex: the simple mutex
+ * @param mutex the simple mutex
*
* Reclaim resources associated with a mutex.
*/
@@ -104,8 +101,7 @@ xmlCleanupMutex(xmlMutexPtr mutex)
}
/**
- * xmlFreeMutex:
- * @tok: the simple mutex
+ * @param tok the simple mutex
*
* Free a mutex.
*/
@@ -120,8 +116,7 @@ xmlFreeMutex(xmlMutexPtr tok)
}
/**
- * xmlMutexLock:
- * @tok: the simple mutex
+ * @param tok the simple mutex
*
* xmlMutexLock() is used to lock a libxml2 token.
*/
@@ -143,8 +138,7 @@ xmlMutexLock(xmlMutexPtr tok)
}
/**
- * xmlMutexUnlock:
- * @tok: the simple mutex
+ * @param tok the simple mutex
*
* xmlMutexUnlock() is used to unlock a libxml2 token.
*/
@@ -161,8 +155,7 @@ xmlMutexUnlock(xmlMutexPtr tok)
}
/**
- * xmlInitRMutex:
- * @tok: mutex
+ * @param tok mutex
*
* Initialize the mutex.
*/
@@ -181,14 +174,13 @@ xmlInitRMutex(xmlRMutexPtr tok) {
}
/**
- * xmlNewRMutex:
*
* xmlRNewMutex() is used to allocate a reentrant mutex for use in
* synchronizing access to data. token_r is a re-entrant lock and thus useful
* for synchronizing access to data structures that may be manipulated in a
* recursive fashion.
*
- * Returns the new reentrant mutex pointer or NULL in case of error
+ * @returns the new reentrant mutex pointer or NULL in case of error
*/
xmlRMutexPtr
xmlNewRMutex(void)
@@ -203,8 +195,7 @@ xmlNewRMutex(void)
}
/**
- * xmlCleanupRMutex:
- * @tok: mutex
+ * @param tok mutex
*
* Cleanup the mutex.
*/
@@ -221,8 +212,7 @@ xmlCleanupRMutex(xmlRMutexPtr tok) {
}
/**
- * xmlFreeRMutex:
- * @tok: the reentrant mutex
+ * @param tok the reentrant mutex
*
* xmlRFreeMutex() is used to reclaim resources associated with a
* reentrant mutex.
@@ -237,8 +227,7 @@ xmlFreeRMutex(xmlRMutexPtr tok)
}
/**
- * xmlRMutexLock:
- * @tok: the reentrant mutex
+ * @param tok the reentrant mutex
*
* xmlRMutexLock() is used to lock a libxml2 token_r.
*/
@@ -270,8 +259,7 @@ xmlRMutexLock(xmlRMutexPtr tok)
}
/**
- * xmlRMutexUnlock:
- * @tok: the reentrant mutex
+ * @param tok the reentrant mutex
*
* xmlRMutexUnlock() is used to unlock a libxml2 token_r.
*/
@@ -301,7 +289,6 @@ xmlRMutexUnlock(xmlRMutexPtr tok ATTRIBUTE_UNUSED)
************************************************************************/
/**
- * xmlLockLibrary:
*
* xmlLockLibrary() is used to take out a re-entrant lock on the libxml2
* library.
@@ -313,7 +300,6 @@ xmlLockLibrary(void)
}
/**
- * xmlUnlockLibrary:
*
* xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2
* library.
@@ -325,9 +311,8 @@ xmlUnlockLibrary(void)
}
/**
- * xmlInitThreads:
*
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
*/
void
xmlInitThreads(void)
@@ -336,9 +321,8 @@ xmlInitThreads(void)
}
/**
- * xmlCleanupThreads:
*
- * DEPRECATED: This function is a no-op. Call xmlCleanupParser
+ * @deprecated This function is a no-op. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have call cleanup functions at all.
@@ -407,7 +391,6 @@ xmlInitParserWinWrapper(INIT_ONCE *initOnce ATTRIBUTE_UNUSED,
#endif
/**
- * xmlInitParser:
*
* Initialization function for the XML parser.
*
@@ -433,7 +416,6 @@ xmlInitParser(void) {
}
/**
- * xmlCleanupParser:
*
* This function is named somewhat misleadingly. It does not clean up
* parser state but global memory allocated by the library itself.
diff --git a/tree.c b/tree.c
index 4a4f18b1..c050ff79 100644
--- a/tree.c
+++ b/tree.c
@@ -103,14 +103,13 @@ static int xmlCompressMode = 0;
#include
/**
- * xmlGetEntityFromDtd:
- * @dtd: A pointer to the DTD to search
- * @name: The entity name
+ * @param dtd A pointer to the DTD to search
+ * @param name The entity name
*
* Do an entity lookup in the DTD entity hash table and
- * return the corresponding entity, if found.
+ * @returns the corresponding entity, if found.
*
- * Returns A pointer to the entity structure or NULL if not found.
+ * @returns A pointer to the entity structure or NULL if not found.
*/
static xmlEntityPtr
xmlGetEntityFromDtd(const xmlDtd *dtd, const xmlChar *name) {
@@ -124,14 +123,13 @@ xmlGetEntityFromDtd(const xmlDtd *dtd, const xmlChar *name) {
return(NULL);
}
/**
- * xmlGetParameterEntityFromDtd:
- * @dtd: A pointer to the DTD to search
- * @name: The entity name
+ * @param dtd A pointer to the DTD to search
+ * @param name The entity name
*
* Do an entity lookup in the DTD parameter entity hash table and
- * return the corresponding entity, if found.
+ * @returns the corresponding entity, if found.
*
- * Returns A pointer to the entity structure or NULL if not found.
+ * @returns A pointer to the entity structure or NULL if not found.
*/
static xmlEntityPtr
xmlGetParameterEntityFromDtd(const xmlDtd *dtd, const xmlChar *name) {
@@ -152,18 +150,17 @@ xmlGetParameterEntityFromDtd(const xmlDtd *dtd, const xmlChar *name) {
************************************************************************/
/**
- * xmlBuildQName:
- * @ncname: the Name
- * @prefix: the prefix
- * @memory: preallocated memory
- * @len: preallocated memory length
+ * @param ncname the Name
+ * @param prefix the prefix
+ * @param memory preallocated memory
+ * @param len preallocated memory length
*
- * Builds the QName `prefix:ncname` in @memory if there is enough space
+ * Builds the QName `prefix:ncname` in `memory` if there is enough space
* and prefix is not NULL nor empty, otherwise allocate a new string.
* If prefix is NULL or empty it returns ncname.
*
- * Returns the new string which must be freed by the caller if different from
- * @memory and @ncname or NULL in case of error
+ * @returns the new string which must be freed by the caller if different from
+ * `memory` and `ncname` or NULL in case of error
*/
xmlChar *
xmlBuildQName(const xmlChar *ncname, const xmlChar *prefix,
@@ -198,11 +195,10 @@ xmlBuildQName(const xmlChar *ncname, const xmlChar *prefix,
}
/**
- * xmlSplitQName2:
- * @name: the full QName
- * @prefix: a xmlChar **
+ * @param name the full QName
+ * @param prefix a xmlChar **
*
- * DEPRECATED: This function doesn't report malloc failures.
+ * @deprecated This function doesn't report malloc failures.
*
* parse an XML qualified name string
*
@@ -212,7 +208,7 @@ xmlBuildQName(const xmlChar *ncname, const xmlChar *prefix,
*
* [NS 7] LocalPart ::= NCName
*
- * Returns NULL if the name doesn't have a prefix. Otherwise, returns the
+ * @returns NULL if the name doesn't have a prefix. Otherwise, returns the
* local part, and prefix is updated to get the Prefix. Both the return value
* and the prefix must be freed by the caller.
*/
@@ -255,13 +251,12 @@ xmlSplitQName2(const xmlChar *name, xmlChar **prefix) {
}
/**
- * xmlSplitQName3:
- * @name: the full QName
- * @len: an int *
+ * @param name the full QName
+ * @param len an int *
*
* parse an XML qualified name string,i
*
- * returns NULL if it is not a Qualified Name, otherwise, update len
+ * @returns NULL if it is not a Qualified Name, otherwise, update len
* with the length in byte of the prefix and return a pointer
* to the start of the name without the prefix
*/
@@ -293,16 +288,15 @@ xmlSplitQName3(const xmlChar *name, int *len) {
}
/**
- * xmlSplitQName4:
- * @name: the full QName
- * @prefixPtr: pointer to resulting prefix
+ * @param name the full QName
+ * @param prefixPtr pointer to resulting prefix
*
* Parse a QName. The return value points to the start of the local
* name in the input string. If the QName has a prefix, it will be
- * allocated and stored in @prefixPtr. This string must be freed by
- * the caller. If there's no prefix, @prefixPtr is set to NULL.
+ * allocated and stored in `prefixPtr`. This string must be freed by
+ * the caller. If there's no prefix, `prefixPtr` is set to NULL.
*
- * Returns the local name or NULL if a memory allocation failed.
+ * @returns the local name or NULL if a memory allocation failed.
*/
const xmlChar *
xmlSplitQName4(const xmlChar *name, xmlChar **prefixPtr) {
@@ -348,13 +342,12 @@ xmlSplitQName4(const xmlChar *name, xmlChar **prefixPtr) {
#define CUR_SCHAR(s, l) xmlStringCurrentChar(NULL, s, &l)
/**
- * xmlValidateNCName:
- * @value: the value to check
- * @space: allow spaces in front and end of the string
+ * @param value the value to check
+ * @param space allow spaces in front and end of the string
*
* Check that a value conforms to the lexical space of NCName
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -420,13 +413,12 @@ try_complex:
}
/**
- * xmlValidateQName:
- * @value: the value to check
- * @space: allow spaces in front and end of the string
+ * @param value the value to check
+ * @param space allow spaces in front and end of the string
*
* Check that a value conforms to the lexical space of QName
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -518,13 +510,12 @@ try_complex:
}
/**
- * xmlValidateName:
- * @value: the value to check
- * @space: allow spaces in front and end of the string
+ * @param value the value to check
+ * @param space allow spaces in front and end of the string
*
* Check that a value conforms to the lexical space of Name
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -587,13 +578,12 @@ try_complex:
}
/**
- * xmlValidateNMToken:
- * @value: the value to check
- * @space: allow spaces in front and end of the string
+ * @param value the value to check
+ * @param space allow spaces in front and end of the string
*
* Check that a value conforms to the lexical space of NMToken
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -665,21 +655,20 @@ try_complex:
************************************************************************/
/**
- * xmlNewNs:
- * @node: the element carrying the namespace (optional)
- * @href: the URI associated
- * @prefix: the prefix for the namespace (optional)
+ * @param node the element carrying the namespace (optional)
+ * @param href the URI associated
+ * @param prefix the prefix for the namespace (optional)
*
- * Create a new namespace. For a default namespace, @prefix should be
- * NULL. The namespace URI in @href is not checked. You should make sure
+ * Create a new namespace. For a default namespace, `prefix` should be
+ * NULL. The namespace URI in `href` is not checked. You should make sure
* to pass a valid URI.
*
- * If @node is provided, it must be an element node. The namespace will
+ * If `node` is provided, it must be an element node. The namespace will
* be appended to the node's namespace declarations. It is an error if
* the node already has a definition for the prefix or default
* namespace.
*
- * Returns a new namespace pointer or NULL if arguments are invalid,
+ * @returns a new namespace pointer or NULL if arguments are invalid,
* the prefix is already in use or a memory allocation failed.
*/
xmlNsPtr
@@ -739,9 +728,8 @@ error:
}
/**
- * xmlSetNs:
- * @node: a node in the document
- * @ns: a namespace pointer (optional)
+ * @param node a node in the document
+ * @param ns a namespace pointer (optional)
*
* Set the namespace of an element or attribute node. Passing a NULL
* namespace unsets the namespace.
@@ -757,8 +745,7 @@ xmlSetNs(xmlNodePtr node, xmlNsPtr ns) {
}
/**
- * xmlFreeNs:
- * @cur: the namespace pointer
+ * @param cur the namespace pointer
*
* Free an xmlNs object.
*/
@@ -773,8 +760,7 @@ xmlFreeNs(xmlNsPtr cur) {
}
/**
- * xmlFreeNsList:
- * @cur: the first namespace pointer
+ * @param cur the first namespace pointer
*
* Free a list of xmlNs objects.
*/
@@ -792,11 +778,10 @@ xmlFreeNsList(xmlNsPtr cur) {
}
/**
- * xmlNewDtd:
- * @doc: the document pointer (optional)
- * @name: the DTD name (optional)
- * @ExternalID: the external ID (optional)
- * @SystemID: the system ID (optional)
+ * @param doc the document pointer (optional)
+ * @param name the DTD name (optional)
+ * @param ExternalID the external ID (optional)
+ * @param SystemID the system ID (optional)
*
* Create a DTD node.
*
@@ -806,7 +791,7 @@ xmlFreeNsList(xmlNsPtr cur) {
*
* To create an internal subset, use xmlCreateIntSubset().
*
- * Returns a pointer to the new DTD object or NULL if arguments are
+ * @returns a pointer to the new DTD object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlDtdPtr
@@ -856,12 +841,11 @@ error:
}
/**
- * xmlGetIntSubset:
- * @doc: the document pointer
+ * @param doc the document pointer
*
* Get the internal subset of a document.
*
- * Returns a pointer to the DTD object or NULL if not found.
+ * @returns a pointer to the DTD object or NULL if not found.
*/
xmlDtdPtr
xmlGetIntSubset(const xmlDoc *doc) {
@@ -879,11 +863,10 @@ xmlGetIntSubset(const xmlDoc *doc) {
}
/**
- * xmlCreateIntSubset:
- * @doc: the document pointer (optional)
- * @name: the DTD name (optional)
- * @ExternalID: the external (PUBLIC) ID (optional)
- * @SystemID: the system ID (optional)
+ * @param doc the document pointer (optional)
+ * @param name the DTD name (optional)
+ * @param ExternalID the external (PUBLIC) ID (optional)
+ * @param SystemID the system ID (optional)
*
* Create a DTD node.
*
@@ -892,7 +875,7 @@ xmlGetIntSubset(const xmlDoc *doc) {
* If the document has no internal subset, it will be set to the
* created DTD.
*
- * Returns a pointer to the new or existing DTD object or NULL if
+ * @returns a pointer to the new or existing DTD object or NULL if
* arguments are invalid or a memory allocation failed.
*/
xmlDtdPtr
@@ -980,7 +963,7 @@ error:
/**
* DICT_FREE:
- * @str: a string
+ * @param str a string
*
* Free a string if it is not owned by the "dict" dictionary in the
* current scope
@@ -991,8 +974,7 @@ error:
xmlFree((char *)(str));
/**
- * xmlFreeDtd:
- * @cur: the DTD structure to free up
+ * @param cur the DTD structure to free up
*
* Free a DTD structure.
*/
@@ -1046,12 +1028,11 @@ xmlFreeDtd(xmlDtdPtr cur) {
}
/**
- * xmlNewDoc:
- * @version: XML version string like "1.0" (optional)
+ * @param version XML version string like "1.0" (optional)
*
* Creates a new XML document. If version is NULL, "1.0" is used.
*
- * Returns a new document or NULL if a memory allocation failed.
+ * @returns a new document or NULL if a memory allocation failed.
*/
xmlDocPtr
xmlNewDoc(const xmlChar *version) {
@@ -1092,8 +1073,7 @@ xmlNewDoc(const xmlChar *version) {
}
/**
- * xmlFreeDoc:
- * @cur: pointer to the document
+ * @param cur pointer to the document
*
* Free a document including all children and associated DTDs.
*/
@@ -1145,16 +1125,15 @@ xmlFreeDoc(xmlDocPtr cur) {
}
/**
- * xmlNodeParseContentInternal:
- * @doc: a document (optional)
- * @parent: an element or attribute (optional)
- * @value: an attribute value
- * @len: maximum length of the attribute value
- * @listPtr: pointer to the resulting node list (optional)
+ * @param doc a document (optional)
+ * @param parent an element or attribute (optional)
+ * @param value an attribute value
+ * @param len maximum length of the attribute value
+ * @param listPtr pointer to the resulting node list (optional)
*
* See xmlNodeParseContent.
*
- * Returns 0 on success, -1 if a memory allocation failed.
+ * @returns 0 on success, -1 if a memory allocation failed.
*/
static int
xmlNodeParseContentInternal(const xmlDoc *doc, xmlNodePtr parent,
@@ -1411,21 +1390,20 @@ out:
}
/**
- * xmlNodeParseContent:
- * @node: an element or attribute
- * @content: text content with XML references
- * @len: maximum length of content
+ * @param node an element or attribute
+ * @param content text content with XML references
+ * @param len maximum length of content
*
* Parse content and replace the node's children with the resulting
* node list.
*
- * @content is expected to be a valid XML attribute value possibly
+ * `content` is expected to be a valid XML attribute value possibly
* containing character and entity references. Syntax errors
* and references to undeclared entities are ignored silently.
* Only references are handled, nested elements, comments or PIs are
* not.
*
- * Returns 0 on success, -1 if a memory allocation failed.
+ * @returns 0 on success, -1 if a memory allocation failed.
*/
int
xmlNodeParseContent(xmlNodePtr node, const xmlChar *content, int len) {
@@ -1433,16 +1411,15 @@ xmlNodeParseContent(xmlNodePtr node, const xmlChar *content, int len) {
}
/**
- * xmlStringLenGetNodeList:
- * @doc: a document (optional)
- * @value: an attribute value
- * @len: maximum length of the attribute value
+ * @param doc a document (optional)
+ * @param value an attribute value
+ * @param len maximum length of the attribute value
*
- * DEPRECATED: Use xmlNodeSetContentLen.
+ * @deprecated Use xmlNodeSetContentLen.
*
* See xmlStringGetNodeList.
*
- * Returns a pointer to the first child or NULL if the value if empty
+ * @returns a pointer to the first child or NULL if the value if empty
* or a memory allocation failed.
*/
xmlNodePtr
@@ -1454,11 +1431,10 @@ xmlStringLenGetNodeList(const xmlDoc *doc, const xmlChar *value, int len) {
}
/**
- * xmlStringGetNodeList:
- * @doc: a document (optional)
- * @value: an attribute value
+ * @param doc a document (optional)
+ * @param value an attribute value
*
- * DEPRECATED: Use xmlNodeSetContent.
+ * @deprecated Use xmlNodeSetContent.
*
* Parse an attribute value and build a node list containing only
* text and entity reference nodes. The resulting nodes will be
@@ -1469,7 +1445,7 @@ xmlStringLenGetNodeList(const xmlDoc *doc, const xmlChar *value, int len) {
* undeclared entities will be ignored silently with unspecified
* results.
*
- * Returns a pointer to the first child or NULL if the value if empty
+ * @returns a pointer to the first child or NULL if the value if empty
* or a memory allocation failed.
*/
xmlNodePtr
@@ -1481,12 +1457,11 @@ xmlStringGetNodeList(const xmlDoc *doc, const xmlChar *value) {
}
/**
- * xmlNodeListGetStringInternal:
- * @doc: a document (optional)
- * @node: a node list
- * @escMode: escape mode (0 = no, 1 = elem, 2 = attr, 3 = raw)
+ * @param doc a document (optional)
+ * @param node a node list
+ * @param escMode escape mode (0 = no, 1 = elem, 2 = attr, 3 = raw)
*
- * Returns a pointer to the string.
+ * @returns a pointer to the string.
*/
static xmlChar *
xmlNodeListGetStringInternal(xmlDocPtr doc, const xmlNode *node, int escMode) {
@@ -1555,20 +1530,19 @@ error:
}
/**
- * xmlNodeListGetString:
- * @doc: a document (optional)
- * @list: a node list of attribute children
- * @inLine: whether entity references are substituted
+ * @param doc a document (optional)
+ * @param list a node list of attribute children
+ * @param inLine whether entity references are substituted
*
* Serializes attribute children (text and entity reference nodes)
* into a string.
*
- * If @inLine is true, entity references will be substituted.
+ * If `inLine` is true, entity references will be substituted.
* Otherwise, entity references will be kept and special characters
* like '&' as well as non-ASCII chars will be escaped. See
* xmlNodeListGetRawString for an alternative option.
*
- * Returns a string or NULL if a memory allocation failed.
+ * @returns a string or NULL if a memory allocation failed.
*/
xmlChar *
xmlNodeListGetString(xmlDocPtr doc, const xmlNode *list, int inLine)
@@ -1593,19 +1567,18 @@ xmlNodeListGetString(xmlDocPtr doc, const xmlNode *list, int inLine)
}
/**
- * xmlNodeListGetRawString:
- * @doc: a document (optional)
- * @list: a node list of attribute children
- * @inLine: whether entity references are substituted
+ * @param doc a document (optional)
+ * @param list a node list of attribute children
+ * @param inLine whether entity references are substituted
*
* Serializes attribute children (text and entity reference nodes)
* into a string.
*
- * If @inLine is true, entity references will be substituted.
+ * If `inLine` is true, entity references will be substituted.
* Otherwise, entity references will be kept and special characters
* like '&' will be escaped.
*
- * Returns a string or NULL if a memory allocation failed.
+ * @returns a string or NULL if a memory allocation failed.
*/
xmlChar *
xmlNodeListGetRawString(const xmlDoc *doc, const xmlNode *list, int inLine)
@@ -1718,20 +1691,19 @@ error:
}
/**
- * xmlNewProp:
- * @node: the parent node (optional)
- * @name: the name of the attribute
- * @value: the value of the attribute (optional)
+ * @param node the parent node (optional)
+ * @param name the name of the attribute
+ * @param value the value of the attribute (optional)
*
* Create an attribute node.
*
- * If provided, @value should be a raw, unescaped string.
+ * If provided, `value` should be a raw, unescaped string.
*
- * If @node is provided, the created attribute will be appended without
- * checking for duplicate names. It is an error if @node is not an
+ * If `node` is provided, the created attribute will be appended without
+ * checking for duplicate names. It is an error if `node` is not an
* element.
*
- * Returns a pointer to the attribute or NULL if arguments are invalid
+ * @returns a pointer to the attribute or NULL if arguments are invalid
* or a memory allocation failed.
*/
xmlAttrPtr
@@ -1745,21 +1717,20 @@ xmlNewProp(xmlNodePtr node, const xmlChar *name, const xmlChar *value) {
}
/**
- * xmlNewNsProp:
- * @node: the parent node (optional)
- * @ns: the namespace (optional)
- * @name: the local name of the attribute
- * @value: the value of the attribute (optional)
+ * @param node the parent node (optional)
+ * @param ns the namespace (optional)
+ * @param name the local name of the attribute
+ * @param value the value of the attribute (optional)
*
* Create an attribute object.
*
- * If provided, @value should be a raw, unescaped string.
+ * If provided, `value` should be a raw, unescaped string.
*
- * If @node is provided, the created attribute will be appended without
- * checking for duplicate names. It is an error if @node is not an
+ * If `node` is provided, the created attribute will be appended without
+ * checking for duplicate names. It is an error if `node` is not an
* element.
*
- * Returns a pointer to the attribute or NULL if arguments are invalid
+ * @returns a pointer to the attribute or NULL if arguments are invalid
* or a memory allocation failed.
*/
xmlAttrPtr
@@ -1774,17 +1745,16 @@ xmlNewNsProp(xmlNodePtr node, xmlNsPtr ns, const xmlChar *name,
}
/**
- * xmlNewNsPropEatName:
- * @node: the parent node (optional)
- * @ns: the namespace (optional)
- * @name: the local name of the attribute
- * @value: the value of the attribute (optional)
+ * @param node the parent node (optional)
+ * @param ns the namespace (optional)
+ * @param name the local name of the attribute
+ * @param value the value of the attribute (optional)
*
- * Like xmlNewNsProp, but the @name string will be used directly
- * without making a copy. Takes ownership of @name which will also
+ * Like xmlNewNsProp, but the `name` string will be used directly
+ * without making a copy. Takes ownership of `name` which will also
* be freed on error.
*
- * Returns a pointer to the attribute or NULL if arguments are invalid
+ * @returns a pointer to the attribute or NULL if arguments are invalid
* or a memory allocation failed.
*/
xmlAttrPtr
@@ -1799,19 +1769,18 @@ xmlNewNsPropEatName(xmlNodePtr node, xmlNsPtr ns, xmlChar *name,
}
/**
- * xmlNewDocProp:
- * @doc: the target document (optional)
- * @name: the name of the attribute
- * @value: attribute value with XML references (optional)
+ * @param doc the target document (optional)
+ * @param name the name of the attribute
+ * @param value attribute value with XML references (optional)
*
* Create an attribute object.
*
- * If provided, @value is expected to be a valid XML attribute value
+ * If provided, `value` is expected to be a valid XML attribute value
* possibly containing character and entity references. Syntax errors
* and references to undeclared entities are ignored silently.
* If you want to pass a raw string, see xmlNewProp.
*
- * Returns a pointer to the attribute or NULL if arguments are invalid
+ * @returns a pointer to the attribute or NULL if arguments are invalid
* or a memory allocation failed.
*/
xmlAttrPtr
@@ -1853,8 +1822,7 @@ error:
}
/**
- * xmlFreePropList:
- * @cur: the first attribute in the list
+ * @param cur the first attribute in the list
*
* Free an attribute list including all children.
*/
@@ -1870,8 +1838,7 @@ xmlFreePropList(xmlAttrPtr cur) {
}
/**
- * xmlFreeProp:
- * @cur: an attribute
+ * @param cur an attribute
*
* Free an attribute including all children.
*/
@@ -1895,8 +1862,7 @@ xmlFreeProp(xmlAttrPtr cur) {
}
/**
- * xmlRemoveProp:
- * @cur: an attribute
+ * @param cur an attribute
*
* Unlink and free an attribute including all children.
*
@@ -1904,7 +1870,7 @@ xmlFreeProp(xmlAttrPtr cur) {
*
* The attribute must have a non-NULL parent pointer.
*
- * Returns 0 on success or -1 if the attribute was not found or
+ * @returns 0 on success or -1 if the attribute was not found or
* arguments are invalid.
*/
int
@@ -1938,14 +1904,13 @@ xmlRemoveProp(xmlAttrPtr cur) {
}
/**
- * xmlNewDocPI:
- * @doc: the target document (optional)
- * @name: the processing instruction target
- * @content: the PI content (optional)
+ * @param doc the target document (optional)
+ * @param name the processing instruction target
+ * @param content the PI content (optional)
*
* Create a processing instruction object.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -1988,15 +1953,14 @@ error:
}
/**
- * xmlNewPI:
- * @name: the processing instruction target
- * @content: the PI content (optional)
+ * @param name the processing instruction target
+ * @param content the PI content (optional)
*
* Create a processing instruction node.
*
* Use of this function is DISCOURAGED in favor of xmlNewDocPI.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2005,15 +1969,14 @@ xmlNewPI(const xmlChar *name, const xmlChar *content) {
}
/**
- * xmlNewNode:
- * @ns: namespace (optional)
- * @name: the node name
+ * @param ns namespace (optional)
+ * @param name the node name
*
* Create an element node.
*
* Use of this function is DISCOURAGED in favor of xmlNewDocNode.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2022,19 +1985,18 @@ xmlNewNode(xmlNsPtr ns, const xmlChar *name) {
}
/**
- * xmlNewNodeEatName:
- * @ns: namespace (optional)
- * @name: the node name
+ * @param ns namespace (optional)
+ * @param name the node name
*
* Create an element node.
*
* Use of this function is DISCOURAGED in favor of xmlNewDocNodeEatName.
*
- * Like xmlNewNode, but the @name string will be used directly
- * without making a copy. Takes ownership of @name which will also
+ * Like xmlNewNode, but the `name` string will be used directly
+ * without making a copy. Takes ownership of `name` which will also
* be freed on error.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2072,15 +2034,14 @@ xmlNewElem(xmlDocPtr doc, xmlNsPtr ns, const xmlChar *name,
}
/**
- * xmlNewDocNode:
- * @doc: the target document
- * @ns: namespace (optional)
- * @name: the node name
- * @content: text content with XML references (optional)
+ * @param doc the target document
+ * @param ns namespace (optional)
+ * @param name the node name
+ * @param content text content with XML references (optional)
*
* Create an element node.
*
- * If provided, @content is expected to be a valid XML attribute value
+ * If provided, `content` is expected to be a valid XML attribute value
* possibly containing character and entity references. Syntax errors
* and references to undeclared entities are ignored silently.
* Only references are handled, nested elements, comments or PIs are
@@ -2094,7 +2055,7 @@ xmlNewElem(xmlDocPtr doc, xmlNsPtr ns, const xmlChar *name,
* tree. Note that a document only owns nodes reachable from the root
* node. Unlinked subtrees must be freed manually.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2128,19 +2089,18 @@ xmlNewDocNode(xmlDocPtr doc, xmlNsPtr ns,
}
/**
- * xmlNewDocNodeEatName:
- * @doc: the target document
- * @ns: namespace (optional)
- * @name: the node name
- * @content: text content with XML references (optional)
+ * @param doc the target document
+ * @param ns namespace (optional)
+ * @param name the node name
+ * @param content text content with XML references (optional)
*
* Create an element node.
*
- * Like xmlNewDocNode, but the @name string will be used directly
- * without making a copy. Takes ownership of @name which will also
+ * Like xmlNewDocNode, but the `name` string will be used directly
+ * without making a copy. Takes ownership of `name` which will also
* be freed on error.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2165,17 +2125,16 @@ xmlNewDocNodeEatName(xmlDocPtr doc, xmlNsPtr ns,
}
/**
- * xmlNewDocRawNode:
- * @doc: the target document
- * @ns: namespace (optional)
- * @name: the node name
- * @content: raw text content (optional)
+ * @param doc the target document
+ * @param ns namespace (optional)
+ * @param name the node name
+ * @param content raw text content (optional)
*
* Create an element node.
*
- * If provided, @value should be a raw, unescaped string.
+ * If provided, `value` should be a raw, unescaped string.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2204,12 +2163,11 @@ xmlNewDocRawNode(xmlDocPtr doc, xmlNsPtr ns,
}
/**
- * xmlNewDocFragment:
- * @doc: the target document (optional)
+ * @param doc the target document (optional)
*
* Create a document fragment node.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2233,14 +2191,13 @@ xmlNewDocFragment(xmlDocPtr doc) {
}
/**
- * xmlNewText:
- * @content: raw text content (optional)
+ * @param content raw text content (optional)
*
* Create a text node.
*
* Use of this function is DISCOURAGED in favor of xmlNewDocText.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2273,21 +2230,20 @@ error:
}
/**
- * xmlNewTextChild:
- * @parent: the parent node
- * @ns: a namespace (optional)
- * @name: the name of the child
- * @content: raw text content of the child (optional)
+ * @param parent the parent node
+ * @param ns a namespace (optional)
+ * @param name the name of the child
+ * @param content raw text content of the child (optional)
*
* Create a new child element and append it to a parent element.
*
- * If @ns is NULL, the newly created element inherits the namespace
+ * If `ns` is NULL, the newly created element inherits the namespace
* of the parent.
*
- * If @content is provided, a text node will be added to the child
+ * If `content` is provided, a text node will be added to the child
* element, see xmlNewDocRawNode.
*
- * Returns a pointer to the new node object or NULL if arguments
+ * @returns a pointer to the new node object or NULL if arguments
* are invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2335,16 +2291,15 @@ xmlNewTextChild(xmlNodePtr parent, xmlNsPtr ns,
}
/**
- * xmlNewEntityRef:
- * @doc: the target document (optional)
- * @name: the entity name
+ * @param doc the target document (optional)
+ * @param name the entity name
*
* Create an empty entity reference node. This function doesn't attempt
- * to look up the entity in @doc.
+ * to look up the entity in `doc`.
*
- * @name is consumed.
+ * `name` is consumed.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
static xmlNodePtr
@@ -2371,19 +2326,18 @@ xmlNewEntityRef(xmlDocPtr doc, xmlChar *name) {
}
/**
- * xmlNewCharRef:
- * @doc: the target document (optional)
- * @name: the entity name
+ * @param doc the target document (optional)
+ * @param name the entity name
*
* This function is MISNAMED. It doesn't create a character reference
* but an entity reference.
*
* Create an empty entity reference node. This function doesn't attempt
- * to look up the entity in @doc.
+ * to look up the entity in `doc`.
*
* Entity names like `&entity;` are handled as well.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2410,16 +2364,15 @@ xmlNewCharRef(xmlDocPtr doc, const xmlChar *name) {
}
/**
- * xmlNewReference:
- * @doc: the target document (optional)
- * @name: the entity name
+ * @param doc the target document (optional)
+ * @param name the entity name
*
* Create a new entity reference node, linking the result with the
- * entity in @doc if found.
+ * entity in `doc` if found.
*
* Entity names like `&entity;` are handled as well.
*
- * Returns a pointer to the new node object or NULL if arguments are
+ * @returns a pointer to the new node object or NULL if arguments are
* invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -2475,13 +2428,12 @@ error:
}
/**
- * xmlNewDocText:
- * @doc: the target document
- * @content: raw text content (optional)
+ * @param doc the target document
+ * @param content raw text content (optional)
*
* Create a new text node.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2494,13 +2446,12 @@ xmlNewDocText(const xmlDoc *doc, const xmlChar *content) {
}
/**
- * xmlNewTextLen:
- * @content: raw text content (optional)
- * @len: size of text content
+ * @param content raw text content (optional)
+ * @param len size of text content
*
* Use of this function is DISCOURAGED in favor of xmlNewDocTextLen.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2531,14 +2482,13 @@ xmlNewTextLen(const xmlChar *content, int len) {
}
/**
- * xmlNewDocTextLen:
- * @doc: the target document
- * @content: raw text content (optional)
- * @len: size of text content
+ * @param doc the target document
+ * @param content raw text content (optional)
+ * @param len size of text content
*
* Create a new text node.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2551,14 +2501,13 @@ xmlNewDocTextLen(xmlDocPtr doc, const xmlChar *content, int len) {
}
/**
- * xmlNewComment:
- * @content: the comment content (optional)
+ * @param content the comment content (optional)
*
* Use of this function is DISCOURAGED in favor of xmlNewDocComment.
*
* Create a comment node.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2591,14 +2540,13 @@ error:
}
/**
- * xmlNewCDataBlock:
- * @doc: the target document (optional)
- * @content: raw text content (optional)
- * @len: size of text content
+ * @param doc the target document (optional)
+ * @param content raw text content (optional)
+ * @param len size of text content
*
* Create a CDATA section node.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2629,13 +2577,12 @@ xmlNewCDataBlock(xmlDocPtr doc, const xmlChar *content, int len) {
}
/**
- * xmlNewDocComment:
- * @doc: the document
- * @content: the comment content
+ * @param doc the document
+ * @param content the comment content
*
* Create a comment node.
*
- * Returns a pointer to the new node object or NULL if a memory
+ * @returns a pointer to the new node object or NULL if a memory
* allocation failed.
*/
xmlNodePtr
@@ -2794,13 +2741,12 @@ xmlNodeSetDoc(xmlNodePtr node, xmlDocPtr doc) {
}
/**
- * xmlSetTreeDoc:
- * @tree: root of a subtree
- * @doc: new document
+ * @param tree root of a subtree
+ * @param doc new document
*
* This is an internal function which shouldn't be used. It is
* invoked by functions like xmlAddChild, xmlAddSibling or
- * xmlReplaceNode. @tree must be the root node of an unlinked
+ * xmlReplaceNode. `tree` must be the root node of an unlinked
* subtree.
*
* Associate all nodes in a tree with a new document.
@@ -2808,7 +2754,7 @@ xmlNodeSetDoc(xmlNodePtr node, xmlDocPtr doc) {
* Also copy strings from the old document's dictionary and
* remove ID attributes from the old ID table.
*
- * Returns 0 on success. If a memory allocation fails, returns -1.
+ * @returns 0 on success. If a memory allocation fails, returns -1.
* The whole tree will be updated on failure but some strings
* may be lost.
*/
@@ -2850,15 +2796,14 @@ xmlSetTreeDoc(xmlNodePtr tree, xmlDocPtr doc) {
}
/**
- * xmlSetListDoc:
- * @list: a node list
- * @doc: new document
+ * @param list a node list
+ * @param doc new document
*
- * Associate all subtrees in @list with a new document.
+ * Associate all subtrees in `list` with a new document.
*
* Internal function, see xmlSetTreeDoc.
*
- * Returns 0 on success. If a memory allocation fails, returns -1.
+ * @returns 0 on success. If a memory allocation fails, returns -1.
* All subtrees will be updated on failure but some strings
* may be lost.
*/
@@ -2883,23 +2828,22 @@ xmlSetListDoc(xmlNodePtr list, xmlDocPtr doc) {
}
/**
- * xmlNewChild:
- * @parent: the parent node
- * @ns: a namespace (optional)
- * @name: the name of the child
- * @content: text content with XML references (optional)
+ * @param parent the parent node
+ * @param ns a namespace (optional)
+ * @param name the name of the child
+ * @param content text content with XML references (optional)
*
* Create a new child element and append it to a parent element.
*
- * If @ns is NULL, the newly created element inherits the namespace
+ * If `ns` is NULL, the newly created element inherits the namespace
* of the parent.
*
- * If provided, @content is expected to be a valid XML attribute
+ * If provided, `content` is expected to be a valid XML attribute
* value possibly containing character and entity references. Text
* and entity reference node will be added to the child element,
* see xmlNewDocNode.
*
- * Returns a pointer to the new node object or NULL if arguments
+ * @returns a pointer to the new node object or NULL if arguments
* are invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -3107,21 +3051,20 @@ xmlInsertNode(xmlDocPtr doc, xmlNodePtr cur, xmlNodePtr parent,
}
/**
- * xmlAddNextSibling:
- * @prev: the target node
- * @cur: the new node
+ * @param prev the target node
+ * @param cur the new node
*
- * Unlinks @cur and inserts it as next sibling after @prev.
+ * Unlinks `cur` and inserts it as next sibling after `prev`.
*
* Unlike xmlAddChild this function does not merge text nodes.
*
- * If @cur is an attribute node, it is inserted after attribute
- * @prev. If the attribute list contains an attribute with a name
- * matching @cur, the old attribute is destroyed.
+ * If `cur` is an attribute node, it is inserted after attribute
+ * `prev`. If the attribute list contains an attribute with a name
+ * matching `cur`, the old attribute is destroyed.
*
* See the notes in xmlAddChild.
*
- * Returns @cur or a sibling if @cur was merged. Returns NULL
+ * @returns `cur` or a sibling if `cur` was merged. Returns NULL
* if arguments are invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -3138,21 +3081,20 @@ xmlAddNextSibling(xmlNodePtr prev, xmlNodePtr cur) {
}
/**
- * xmlAddPrevSibling:
- * @next: the target node
- * @cur: the new node
+ * @param next the target node
+ * @param cur the new node
*
- * Unlinks @cur and inserts it as previous sibling before @next.
+ * Unlinks `cur` and inserts it as previous sibling before `next`.
*
* Unlike xmlAddChild this function does not merge text nodes.
*
- * If @cur is an attribute node, it is inserted before attribute
- * @next. If the attribute list contains an attribute with a name
- * matching @cur, the old attribute is destroyed.
+ * If `cur` is an attribute node, it is inserted before attribute
+ * `next`. If the attribute list contains an attribute with a name
+ * matching `cur`, the old attribute is destroyed.
*
* See the notes in xmlAddChild.
*
- * Returns @cur or a sibling if @cur was merged. Returns NULL
+ * @returns `cur` or a sibling if `cur` was merged. Returns NULL
* if arguments are invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -3169,23 +3111,22 @@ xmlAddPrevSibling(xmlNodePtr next, xmlNodePtr cur) {
}
/**
- * xmlAddSibling:
- * @node: the target node
- * @cur: the new node
+ * @param node the target node
+ * @param cur the new node
*
- * Unlinks @cur and inserts it as last sibling of @node.
+ * Unlinks `cur` and inserts it as last sibling of `node`.
*
- * If @cur is a text node, it may be merged with an adjacent text
+ * If `cur` is a text node, it may be merged with an adjacent text
* node and freed. In this case the text node containing the merged
* content is returned.
*
- * If @cur is an attribute node, it is appended to the attribute
- * list containing @node. If the attribute list contains an attribute
- * with a name matching @cur, the old attribute is destroyed.
+ * If `cur` is an attribute node, it is appended to the attribute
+ * list containing `node`. If the attribute list contains an attribute
+ * with a name matching `cur`, the old attribute is destroyed.
*
* See the notes in xmlAddChild.
*
- * Returns @cur or a sibling if @cur was merged. Returns NULL
+ * @returns `cur` or a sibling if `cur` was merged. Returns NULL
* if arguments are invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -3214,15 +3155,14 @@ xmlAddSibling(xmlNodePtr node, xmlNodePtr cur) {
}
/**
- * xmlAddChildList:
- * @parent: the parent node
- * @cur: the first node in the list
+ * @param parent the parent node
+ * @param cur the first node in the list
*
* Append a node list to another node.
*
* See xmlAddChild.
*
- * Returns the last child or NULL in case of error.
+ * @returns the last child or NULL in case of error.
*/
xmlNodePtr
xmlAddChildList(xmlNodePtr parent, xmlNodePtr cur) {
@@ -3291,19 +3231,18 @@ xmlAddChildList(xmlNodePtr parent, xmlNodePtr cur) {
}
/**
- * xmlAddChild:
- * @parent: the parent node
- * @cur: the child node
+ * @param parent the parent node
+ * @param cur the child node
*
- * Unlink @cur and append it to the children of @parent.
+ * Unlink `cur` and append it to the children of `parent`.
*
- * If @cur is a text node, it may be merged with an adjacent text
+ * If `cur` is a text node, it may be merged with an adjacent text
* node and freed. In this case the text node containing the merged
* content is returned.
*
- * If @cur is an attribute node, it is appended to the attributes of
- * @parent. If the attribute list contains an attribute with a name
- * matching @cur, the old attribute is destroyed.
+ * If `cur` is an attribute node, it is appended to the attributes of
+ * `parent`. If the attribute list contains an attribute with a name
+ * matching `cur`, the old attribute is destroyed.
*
* General notes:
*
@@ -3330,7 +3269,7 @@ xmlAddChildList(xmlNodePtr parent, xmlNodePtr cur) {
*
* Moving DTDs between documents isn't supported.
*
- * Returns @cur or a sibling if @cur was merged. Returns NULL
+ * @returns `cur` or a sibling if `cur` was merged. Returns NULL
* if arguments are invalid or a memory allocation failed.
*/
xmlNodePtr
@@ -3370,12 +3309,11 @@ xmlAddChild(xmlNodePtr parent, xmlNodePtr cur) {
}
/**
- * xmlGetLastChild:
- * @parent: the parent node
+ * @param parent the parent node
*
* Find the last child of a node.
*
- * Returns the last child or NULL if parent has no children.
+ * @returns the last child or NULL if parent has no children.
*/
xmlNodePtr
xmlGetLastChild(const xmlNode *parent) {
@@ -3390,14 +3328,13 @@ xmlGetLastChild(const xmlNode *parent) {
*/
/**
- * xmlChildElementCount:
- * @parent: the parent node
+ * @param parent the parent node
*
* Count the number of child nodes which are elements.
*
* Note that entity references are not expanded.
*
- * Returns the number of element children or 0 if arguments are
+ * @returns the number of element children or 0 if arguments are
* invalid.
*/
unsigned long
@@ -3427,14 +3364,13 @@ xmlChildElementCount(xmlNodePtr parent) {
}
/**
- * xmlFirstElementChild:
- * @parent: the parent node
+ * @param parent the parent node
*
* Find the first child node which is an element.
*
* Note that entity references are not expanded.
*
- * Returns the first element or NULL if parent has no children.
+ * @returns the first element or NULL if parent has no children.
*/
xmlNodePtr
xmlFirstElementChild(xmlNodePtr parent) {
@@ -3462,14 +3398,13 @@ xmlFirstElementChild(xmlNodePtr parent) {
}
/**
- * xmlLastElementChild:
- * @parent: the parent node
+ * @param parent the parent node
*
* Find the last child node which is an element.
*
* Note that entity references are not expanded.
*
- * Returns the last element or NULL if parent has no children.
+ * @returns the last element or NULL if parent has no children.
*/
xmlNodePtr
xmlLastElementChild(xmlNodePtr parent) {
@@ -3497,14 +3432,13 @@ xmlLastElementChild(xmlNodePtr parent) {
}
/**
- * xmlPreviousElementSibling:
- * @node: the current node
+ * @param node the current node
*
* Find the closest preceding sibling which is a element.
*
* Note that entity references are not expanded.
*
- * Returns the sibling or NULL if no sibling was found.
+ * @returns the sibling or NULL if no sibling was found.
*/
xmlNodePtr
xmlPreviousElementSibling(xmlNodePtr node) {
@@ -3533,14 +3467,13 @@ xmlPreviousElementSibling(xmlNodePtr node) {
}
/**
- * xmlNextElementSibling:
- * @node: the current node
+ * @param node the current node
*
* Find the closest following sibling which is a element.
*
* Note that entity references are not expanded.
*
- * Returns the sibling or NULL if no sibling was found.
+ * @returns the sibling or NULL if no sibling was found.
*/
xmlNodePtr
xmlNextElementSibling(xmlNodePtr node) {
@@ -3570,8 +3503,7 @@ xmlNextElementSibling(xmlNodePtr node) {
}
/**
- * xmlFreeNodeList:
- * @cur: the first node in the list
+ * @param cur the first node in the list
*
* Free a node list including all children.
*/
@@ -3658,13 +3590,12 @@ xmlFreeNodeList(xmlNodePtr cur) {
}
/**
- * xmlFreeNode:
- * @cur: the node
+ * @param cur the node
*
* Free a node including all the children.
*
* This doesn't unlink the node from the tree. Call xmlUnlinkNode first
- * unless @cur is a root node.
+ * unless `cur` is a root node.
*/
void
xmlFreeNode(xmlNodePtr cur) {
@@ -3726,8 +3657,7 @@ xmlFreeNode(xmlNodePtr cur) {
}
/**
- * xmlUnlinkNodeInternal:
- * @cur: the node
+ * @param cur the node
*
* Unlink a node from its tree.
*
@@ -3760,8 +3690,7 @@ xmlUnlinkNodeInternal(xmlNodePtr cur) {
}
/**
- * xmlUnlinkNode:
- * @cur: the node
+ * @param cur the node
*
* Unlink a node from its tree.
*
@@ -3794,21 +3723,20 @@ xmlUnlinkNode(xmlNodePtr cur) {
}
/**
- * xmlReplaceNode:
- * @old: the old node
- * @cur: the node (optional)
+ * @param old the old node
+ * @param cur the node (optional)
*
- * Unlink the old node. If @cur is provided, it is unlinked and
- * inserted in place of @old.
+ * Unlink the old node. If `cur` is provided, it is unlinked and
+ * inserted in place of `old`.
*
- * It is an error if @old has no parent.
+ * It is an error if `old` has no parent.
*
* Unlike xmlAddChild, this function doesn't merge text nodes or
* delete duplicate attributes.
*
* See the notes in xmlAddChild.
*
- * Returns @old or NULL if arguments are invalid or a memory
+ * @returns `old` or NULL if arguments are invalid or a memory
* allocation failed.
*/
xmlNodePtr
@@ -3862,12 +3790,11 @@ xmlReplaceNode(xmlNodePtr old, xmlNodePtr cur) {
************************************************************************/
/**
- * xmlCopyNamespace:
- * @cur: the namespace
+ * @param cur the namespace
*
* Copy a namespace.
*
- * Returns the copied namespace or NULL if a memory allocation
+ * @returns the copied namespace or NULL if a memory allocation
* failed.
*/
xmlNsPtr
@@ -3886,12 +3813,11 @@ xmlCopyNamespace(xmlNsPtr cur) {
}
/**
- * xmlCopyNamespaceList:
- * @cur: the first namespace
+ * @param cur the first namespace
*
* Copy a namespace list.
*
- * Returns the head of the copied list or NULL if a memory
+ * @returns the head of the copied list or NULL if a memory
* allocation failed.
*/
xmlNsPtr
@@ -4037,17 +3963,16 @@ error:
}
/**
- * xmlCopyProp:
- * @target: the element where the attribute will be grafted
- * @cur: the attribute
+ * @param target the element where the attribute will be grafted
+ * @param cur the attribute
*
* Create a copy of the attribute. This function sets the parent
- * pointer of the copy to @target but doesn't set the attribute on
+ * pointer of the copy to `target` but doesn't set the attribute on
* the target element. Users should consider to set the attribute
* by calling xmlAddChild afterwards or reset the parent pointer to
* NULL.
*
- * Returns the copied attribute or NULL if a memory allocation
+ * @returns the copied attribute or NULL if a memory allocation
* failed.
*/
xmlAttrPtr
@@ -4056,15 +3981,14 @@ xmlCopyProp(xmlNodePtr target, xmlAttrPtr cur) {
}
/**
- * xmlCopyPropList:
- * @target: the element where the attributes will be grafted
- * @cur: the first attribute
+ * @param target the element where the attributes will be grafted
+ * @param cur the first attribute
*
* Create a copy of an attribute list. This function sets the
- * parent pointers of the copied attributes to @target but doesn't
+ * parent pointers of the copied attributes to `target` but doesn't
* set the attributes on the target element.
*
- * Returns the head of the copied list or NULL if a memory
+ * @returns the head of the copied list or NULL if a memory
* allocation failed.
*/
xmlAttrPtr
@@ -4112,15 +4036,14 @@ xmlCopyPropList(xmlNodePtr target, xmlAttrPtr cur) {
*/
/**
- * xmlStaticCopyNode:
- * @node: source node
- * @doc: target document
- * @parent: target parent
- * @extended: flags
+ * @param node source node
+ * @param doc target document
+ * @param parent target parent
+ * @param extended flags
*
* Copy a node.
*
- * Returns the copy or NULL if a memory allocation failed.
+ * @returns the copy or NULL if a memory allocation failed.
*/
xmlNodePtr
xmlStaticCopyNode(xmlNodePtr node, xmlDocPtr doc, xmlNodePtr parent,
@@ -4307,16 +4230,15 @@ error:
}
/**
- * xmlStaticCopyNodeList:
- * @node: node to copy
- * @doc: target document
- * @parent: target node (optional)
+ * @param node node to copy
+ * @param doc target document
+ * @param parent target node (optional)
*
- * Copy a node list. If @parent is provided, sets the parent pointer
+ * Copy a node list. If `parent` is provided, sets the parent pointer
* of the copied nodes, but doesn't update the children and last
- * pointer of @parent.
+ * pointer of `parent`.
*
- * Returns a the copy or NULL in case of error.
+ * @returns a the copy or NULL in case of error.
*/
xmlNodePtr
xmlStaticCopyNodeList(xmlNodePtr node, xmlDocPtr doc, xmlNodePtr parent) {
@@ -4393,9 +4315,8 @@ error:
}
/**
- * xmlCopyNode:
- * @node: the node
- * @extended: if 1 do a recursive copy (properties, namespaces and children
+ * @param node the node
+ * @param extended if 1 do a recursive copy (properties, namespaces and children
* when applicable)
* if 2 copy properties and namespaces (when applicable)
*
@@ -4403,7 +4324,7 @@ error:
*
* Use of this function is DISCOURAGED in favor of xmlDocCopyNode.
*
- * Returns the copied node or NULL if a memory allocation failed.
+ * @returns the copied node or NULL if a memory allocation failed.
*/
xmlNodePtr
xmlCopyNode(xmlNodePtr node, int extended) {
@@ -4414,16 +4335,15 @@ xmlCopyNode(xmlNodePtr node, int extended) {
}
/**
- * xmlDocCopyNode:
- * @node: the node
- * @doc: the document
- * @extended: if 1 do a recursive copy (properties, namespaces and children
+ * @param node the node
+ * @param doc the document
+ * @param extended if 1 do a recursive copy (properties, namespaces and children
* when applicable)
* if 2 copy properties and namespaces (when applicable)
*
* Copy a node into another document.
*
- * Returns the copied node or NULL if a memory allocation failed.
+ * @returns the copied node or NULL if a memory allocation failed.
*/
xmlNodePtr
xmlDocCopyNode(xmlNodePtr node, xmlDocPtr doc, int extended) {
@@ -4434,13 +4354,12 @@ xmlDocCopyNode(xmlNodePtr node, xmlDocPtr doc, int extended) {
}
/**
- * xmlDocCopyNodeList:
- * @doc: the target document
- * @node: the first node in the list.
+ * @param doc the target document
+ * @param node the first node in the list.
*
* Copy a node list and all children into a new document.
*
- * Returns the head of the copied list or NULL if a memory
+ * @returns the head of the copied list or NULL if a memory
* allocation failed.
*/
xmlNodePtr xmlDocCopyNodeList(xmlDocPtr doc, xmlNodePtr node) {
@@ -4449,14 +4368,13 @@ xmlNodePtr xmlDocCopyNodeList(xmlDocPtr doc, xmlNodePtr node) {
}
/**
- * xmlCopyNodeList:
- * @node: the first node in the list.
+ * @param node the first node in the list.
*
* Copy a node list and all children.
*
* Use of this function is DISCOURAGED in favor of xmlDocCopyNodeList.
*
- * Returns the head of the copied list or NULL if a memory
+ * @returns the head of the copied list or NULL if a memory
* allocation failed.
*/
xmlNodePtr xmlCopyNodeList(xmlNodePtr node) {
@@ -4465,12 +4383,11 @@ xmlNodePtr xmlCopyNodeList(xmlNodePtr node) {
}
/**
- * xmlCopyDtd:
- * @dtd: the DTD
+ * @param dtd the DTD
*
* Copy a DTD.
*
- * Returns the copied DTD or NULL if a memory allocation failed.
+ * @returns the copied DTD or NULL if a memory allocation failed.
*/
xmlDtdPtr
xmlCopyDtd(xmlDtdPtr dtd) {
@@ -4571,14 +4488,13 @@ error:
}
/**
- * xmlCopyDoc:
- * @doc: the document
- * @recursive: if not zero do a recursive copy.
+ * @param doc the document
+ * @param recursive if not zero do a recursive copy.
*
* Copy a document. If recursive, the content tree will
* be copied too as well as DTD, namespaces and entities.
*
- * Returns the copied document or NULL if a memory allocation
+ * @returns the copied document or NULL if a memory allocation
* failed.
*/
xmlDocPtr
@@ -4652,14 +4568,13 @@ error:
************************************************************************/
/**
- * xmlGetLineNoInternal:
- * @node: valid node
- * @depth: used to limit any risk of recursion
+ * @param node valid node
+ * @param depth used to limit any risk of recursion
*
- * Get line number of @node.
+ * Get line number of `node`.
* Try to override the limitation of lines being store in 16 bits ints
*
- * Returns the line number if successful, -1 otherwise
+ * @returns the line number if successful, -1 otherwise
*/
static long
xmlGetLineNoInternal(const xmlNode *node, int depth)
@@ -4702,14 +4617,13 @@ xmlGetLineNoInternal(const xmlNode *node, int depth)
}
/**
- * xmlGetLineNo:
- * @node: valid node
+ * @param node valid node
*
- * Get line number of @node.
+ * Get line number of `node`.
* Try to override the limitation of lines being store in 16 bits ints
* if XML_PARSE_BIG_LINES parser option was used
*
- * Returns the line number if successful, -1 otherwise
+ * @returns the line number if successful, -1 otherwise
*/
long
xmlGetLineNo(const xmlNode *node)
@@ -4718,12 +4632,11 @@ xmlGetLineNo(const xmlNode *node)
}
/**
- * xmlGetNodePath:
- * @node: a node
+ * @param node a node
*
* Build a structure based Path for the given node
*
- * Returns the new path or NULL in case of error. The caller must free
+ * @returns the new path or NULL in case of error. The caller must free
* the returned string
*/
xmlChar *
@@ -4973,13 +4886,12 @@ xmlGetNodePath(const xmlNode *node)
}
/**
- * xmlDocGetRootElement:
- * @doc: the document
+ * @param doc the document
*
* Get the root element of the document (doc->children is a list
* containing possibly comments, PIs, etc ...).
*
- * Returns the root element or NULL if no element was found.
+ * @returns the root element or NULL if no element was found.
*/
xmlNodePtr
xmlDocGetRootElement(const xmlDoc *doc) {
@@ -4996,17 +4908,16 @@ xmlDocGetRootElement(const xmlDoc *doc) {
}
/**
- * xmlDocSetRootElement:
- * @doc: the document
- * @root: the new document root element, if root is NULL no action is taken,
+ * @param doc the document
+ * @param root the new document root element, if root is NULL no action is taken,
* to remove a node from a document use xmlUnlinkNode(root) instead.
*
* Set the root element of the document (doc->children is a list
* containing possibly comments, PIs, etc ...).
*
- * @root must be an element node. It is unlinked before insertion.
+ * `root` must be an element node. It is unlinked before insertion.
*
- * Returns the unlinked old root element or NULL if the document
+ * @returns the unlinked old root element or NULL if the document
* didn't have a root element or a memory allocation failed.
*/
xmlNodePtr
@@ -5042,14 +4953,13 @@ xmlDocSetRootElement(xmlDocPtr doc, xmlNodePtr root) {
}
/**
- * xmlNodeSetLang:
- * @cur: the node being changed
- * @lang: the language description
+ * @param cur the node being changed
+ * @param lang the language description
*
* Set the language of a node, i.e. the values of the xml:lang
* attribute.
*
- * Return 0 on success, 1 if arguments are invalid, -1 if a
+ * @returns 0 on success, 1 if arguments are invalid, -1 if a
* memory allocation failed.
*/
int
@@ -5072,13 +4982,12 @@ xmlNodeSetLang(xmlNodePtr cur, const xmlChar *lang) {
}
/**
- * xmlNodeGetLang:
- * @cur: the node being checked
+ * @param cur the node being checked
*
* Searches the language of a node, i.e. the values of the xml:lang
* attribute or the one carried by the nearest ancestor.
*
- * Returns a pointer to the lang value, or NULL if not found
+ * @returns a pointer to the lang value, or NULL if not found
* It's up to the caller to free the memory with xmlFree().
*/
xmlChar *
@@ -5105,14 +5014,13 @@ xmlNodeGetLang(const xmlNode *cur) {
/**
- * xmlNodeSetSpacePreserve:
- * @cur: the node being changed
- * @val: the xml:space value ("0": default, 1: "preserve")
+ * @param cur the node being changed
+ * @param val the xml:space value ("0": default, 1: "preserve")
*
* Set (or reset) the space preserving behaviour of a node, i.e. the
* value of the xml:space attribute.
*
- * Return 0 on success, 1 if arguments are invalid, -1 if a
+ * @returns 0 on success, 1 if arguments are invalid, -1 if a
* memory allocation failed.
*/
int
@@ -5142,14 +5050,13 @@ xmlNodeSetSpacePreserve(xmlNodePtr cur, int val) {
}
/**
- * xmlNodeGetSpacePreserve:
- * @cur: the node being checked
+ * @param cur the node being checked
*
* Searches the space preserving behaviour of a node, i.e. the values
* of the xml:space attribute or the one carried by the nearest
* ancestor.
*
- * Returns -1 if xml:space is not inherited, 0 if "default", 1 if "preserve"
+ * @returns -1 if xml:space is not inherited, 0 if "default", 1 if "preserve"
*/
int
xmlNodeGetSpacePreserve(const xmlNode *cur) {
@@ -5183,9 +5090,8 @@ xmlNodeGetSpacePreserve(const xmlNode *cur) {
}
/**
- * xmlNodeSetName:
- * @cur: the node being changed
- * @name: the new tag name
+ * @param cur the node being changed
+ * @param name the new tag name
*
* Set (or reset) the name of a node.
*/
@@ -5229,14 +5135,13 @@ xmlNodeSetName(xmlNodePtr cur, const xmlChar *name) {
}
/**
- * xmlNodeSetBase:
- * @cur: the node being changed
- * @uri: the new base URI
+ * @param cur the node being changed
+ * @param uri the new base URI
*
* Set (or reset) the base URI of a node, i.e. the value of the
* xml:base attribute.
*
- * Returns 0 on success, -1 on error.
+ * @returns 0 on success, -1 on error.
*/
int
xmlNodeSetBase(xmlNodePtr cur, const xmlChar* uri) {
@@ -5284,10 +5189,9 @@ xmlNodeSetBase(xmlNodePtr cur, const xmlChar* uri) {
}
/**
- * xmlNodeGetBaseSafe:
- * @doc: the document the node pertains to
- * @cur: the node being checked
- * @baseOut: pointer to base
+ * @param doc the document the node pertains to
+ * @param cur the node being checked
+ * @param baseOut pointer to base
*
* Searches for the BASE URL. The code should work on both XML
* and HTML document even if base mechanisms are completely different.
@@ -5300,7 +5204,7 @@ xmlNodeSetBase(xmlNodePtr cur, const xmlChar* uri) {
*
* Available since 2.13.0.
*
- * Return 0 in case of success, 1 if a URI or argument is invalid, -1 if a
+ * @returns 0 in case of success, 1 if a URI or argument is invalid, -1 if a
* memory allocation failed.
*/
int
@@ -5404,14 +5308,13 @@ found:
}
/**
- * xmlNodeGetBase:
- * @doc: the document the node pertains to
- * @cur: the node being checked
+ * @param doc the document the node pertains to
+ * @param cur the node being checked
*
* See xmlNodeGetBaseSafe. This function doesn't allow to distinguish
* memory allocation failures from a non-existing base.
*
- * Returns a pointer to the base URL, or NULL if not found
+ * @returns a pointer to the base URL, or NULL if not found
* It's up to the caller to free the memory with xmlFree().
*/
xmlChar *
@@ -5423,17 +5326,16 @@ xmlNodeGetBase(const xmlDoc *doc, const xmlNode *cur) {
}
/**
- * xmlNodeBufGetContent:
- * @buffer: a buffer
- * @cur: the node being read
+ * @param buffer a buffer
+ * @param cur the node being read
*
- * Read the value of a node @cur, this can be either the text carried
+ * Read the value of a node `cur`, this can be either the text carried
* directly by this node if it's a TEXT node or the aggregate string
* of the values carried by this node child's (TEXT and ENTITY_REF).
* Entity references are substituted.
- * Fills up the buffer @buffer with this value
+ * Fills up the buffer `buffer` with this value
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlNodeBufGetContent(xmlBufferPtr buffer, const xmlNode *cur)
@@ -5514,17 +5416,16 @@ xmlBufGetChildContent(xmlBufPtr buf, const xmlNode *tree) {
}
/**
- * xmlBufGetNodeContent:
- * @buf: a buffer xmlBufPtr
- * @cur: the node being read
+ * @param buf a buffer xmlBufPtr
+ * @param cur the node being read
*
- * Read the value of a node @cur, this can be either the text carried
+ * Read the value of a node `cur`, this can be either the text carried
* directly by this node if it's a TEXT node or the aggregate string
* of the values carried by this node child's (TEXT and ENTITY_REF).
* Entity references are substituted.
- * Fills up the buffer @buf with this value
+ * Fills up the buffer `buf` with this value
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlBufGetNodeContent(xmlBufPtr buf, const xmlNode *cur)
@@ -5565,14 +5466,13 @@ xmlBufGetNodeContent(xmlBufPtr buf, const xmlNode *cur)
}
/**
- * xmlNodeGetContent:
- * @cur: the node being read
+ * @param cur the node being read
*
* Read the value of a node, this can be either the text carried
* directly by this node if it's a TEXT node or the aggregate string
* of the values carried by this node child's (TEXT and ENTITY_REF).
* Entity references are substituted.
- * Returns a new #xmlChar * or NULL if no content is available.
+ * @returns a new \#xmlChar * or NULL if no content is available.
* It's up to the caller to free the memory with xmlFree().
*/
xmlChar *
@@ -5677,16 +5577,15 @@ xmlNodeSetContentInternal(xmlNodePtr cur, const xmlChar *content, int len) {
}
/**
- * xmlNodeSetContent:
- * @cur: the node being modified
- * @content: the new value of the content
+ * @param cur the node being modified
+ * @param content the new value of the content
*
* Replace the text content of a node.
*
* Sets the raw text content of text, CDATA, comment or PI nodes.
*
* For element and attribute nodes, removes all children and
- * replaces them by parsing @content which is expected to be a
+ * replaces them by parsing `content` which is expected to be a
* valid XML attribute value possibly containing character and
* entity references. Syntax errors and references to undeclared
* entities are ignored silently. Unfortunately, there isn't an
@@ -5697,7 +5596,7 @@ xmlNodeSetContentInternal(xmlNodePtr cur, const xmlChar *content, int len) {
* xmlNodeAddContent(node, content). Unlike this function,
* xmlNodeAddContent accepts raw text.
*
- * Returns 0 on success, 1 on error, -1 if a memory allocation failed.
+ * @returns 0 on success, 1 on error, -1 if a memory allocation failed.
*/
int
xmlNodeSetContent(xmlNodePtr cur, const xmlChar *content) {
@@ -5705,14 +5604,13 @@ xmlNodeSetContent(xmlNodePtr cur, const xmlChar *content) {
}
/**
- * xmlNodeSetContentLen:
- * @cur: the node being modified
- * @content: the new value of the content
- * @len: the size of @content
+ * @param cur the node being modified
+ * @param content the new value of the content
+ * @param len the size of `content`
*
* See xmlNodeSetContent.
*
- * Returns 0 on success, 1 on error, -1 if a memory allocation failed.
+ * @returns 0 on success, 1 on error, -1 if a memory allocation failed.
*/
int
xmlNodeSetContentLen(xmlNodePtr cur, const xmlChar *content, int len) {
@@ -5720,17 +5618,16 @@ xmlNodeSetContentLen(xmlNodePtr cur, const xmlChar *content, int len) {
}
/**
- * xmlNodeAddContentLen:
- * @cur: the node being modified
- * @content: extra content
- * @len: the size of @content
+ * @param cur the node being modified
+ * @param content extra content
+ * @param len the size of `content`
*
* Append the extra substring to the node content.
- * NOTE: In contrast to xmlNodeSetContentLen(), @content is supposed to be
+ * NOTE: In contrast to xmlNodeSetContentLen(), `content` is supposed to be
* raw text, so unescaped XML special chars are allowed, entity
* references are not supported.
*
- * Returns 0 on success, 1 on error, -1 if a memory allocation failed.
+ * @returns 0 on success, 1 on error, -1 if a memory allocation failed.
*/
int
xmlNodeAddContentLen(xmlNodePtr cur, const xmlChar *content, int len) {
@@ -5769,16 +5666,15 @@ xmlNodeAddContentLen(xmlNodePtr cur, const xmlChar *content, int len) {
}
/**
- * xmlNodeAddContent:
- * @cur: the node being modified
- * @content: extra content
+ * @param cur the node being modified
+ * @param content extra content
*
* Append the extra substring to the node content.
- * NOTE: In contrast to xmlNodeSetContent(), @content is supposed to be
+ * NOTE: In contrast to xmlNodeSetContent(), `content` is supposed to be
* raw text, so unescaped XML special chars are allowed, entity
* references are not supported.
*
- * Returns 0 on success, 1 on error, -1 if a memory allocation failed.
+ * @returns 0 on success, 1 on error, -1 if a memory allocation failed.
*/
int
xmlNodeAddContent(xmlNodePtr cur, const xmlChar *content) {
@@ -5786,15 +5682,14 @@ xmlNodeAddContent(xmlNodePtr cur, const xmlChar *content) {
}
/**
- * xmlTextMerge:
- * @first: the first text node
- * @second: the second text node being merged
+ * @param first the first text node
+ * @param second the second text node being merged
*
- * Merge the second text node into the first. If @first is NULL,
- * @second is returned. Otherwise, the second node is unlinked and
+ * Merge the second text node into the first. If `first` is NULL,
+ * `second` is returned. Otherwise, the second node is unlinked and
* freed.
*
- * Returns the first text node augmented or NULL in case of error.
+ * @returns the first text node augmented or NULL in case of error.
*/
xmlNodePtr
xmlTextMerge(xmlNodePtr first, xmlNodePtr second) {
@@ -5818,18 +5713,17 @@ xmlTextMerge(xmlNodePtr first, xmlNodePtr second) {
}
/**
- * xmlGetNsListSafe:
- * @doc: the document
- * @node: the current node
- * @out: the returned namespace array
+ * @param doc the document
+ * @param node the current node
+ * @param out the returned namespace array
*
- * Find all in-scope namespaces of a node. @out returns a NULL
+ * Find all in-scope namespaces of a node. `out` returns a NULL
* terminated array of namespace pointers that must be freed by
* the caller.
*
* Available since 2.13.0.
*
- * Returns 0 on success, 1 if no namespaces were found, -1 if a
+ * @returns 0 on success, 1 if no namespaces were found, -1 if a
* memory allocation failed.
*/
int
@@ -5896,15 +5790,14 @@ xmlGetNsListSafe(const xmlDoc *doc ATTRIBUTE_UNUSED, const xmlNode *node,
}
/**
- * xmlGetNsList:
- * @doc: the document
- * @node: the current node
+ * @param doc the document
+ * @param node the current node
*
* Find all in-scope namespaces of a node.
*
* Use xmlGetNsListSafe for better error reporting.
*
- * Returns a NULL terminated array of namespace pointers that must
+ * @returns a NULL terminated array of namespace pointers that must
* be freed by the caller or NULL if no namespaces were found or
* a memory allocation failed.
*/
@@ -5964,14 +5857,13 @@ xmlTreeEnsureXMLDecl(xmlDocPtr doc)
}
/**
- * xmlSearchNsSafe:
- * @node: a node
- * @prefix: a namespace prefix
- * @out: pointer to resulting namespace
+ * @param node a node
+ * @param prefix a namespace prefix
+ * @param out pointer to resulting namespace
*
- * Search a namespace with @prefix in scope of @node.
+ * Search a namespace with `prefix` in scope of `node`.
*
- * Returns 0 on success, -1 if a memory allocation failed, 1 on
+ * @returns 0 on success, -1 if a memory allocation failed, 1 on
* other errors.
*/
int
@@ -6047,20 +5939,19 @@ xmlSearchNsSafe(xmlNodePtr node, const xmlChar *prefix,
}
/**
- * xmlSearchNs:
- * @doc: the document
- * @node: the current node
- * @nameSpace: the namespace prefix
+ * @param doc the document
+ * @param node the current node
+ * @param nameSpace the namespace prefix
*
* Search a Ns registered under a given name space for a document.
* recurse on the parents until it finds the defined namespace
* or return NULL otherwise.
- * @nameSpace can be NULL, this is a search for the default namespace.
+ * `nameSpace` can be NULL, this is a search for the default namespace.
* We don't allow to cross entities boundaries. If you don't declare
* the namespace within those you will be in troubles !!! A warning
* is generated to cover this case.
*
- * Returns the namespace pointer or NULL if no namespace was found or
+ * @returns the namespace pointer or NULL if no namespace was found or
* a memory allocation failed. Allocations can only fail if the "xml"
* namespace is queried.
*/
@@ -6074,16 +5965,15 @@ xmlSearchNs(xmlDocPtr doc ATTRIBUTE_UNUSED, xmlNodePtr node,
}
/**
- * xmlNsInScope:
- * @doc: the document
- * @node: the current node
- * @ancestor: the ancestor carrying the namespace
- * @prefix: the namespace prefix
+ * @param doc the document
+ * @param node the current node
+ * @param ancestor the ancestor carrying the namespace
+ * @param prefix the namespace prefix
*
- * Verify that the given namespace held on @ancestor is still in scope
+ * Verify that the given namespace held on `ancestor` is still in scope
* on node.
*
- * Returns 1 if true, 0 if false and -1 in case of error.
+ * @returns 1 if true, 0 if false and -1 in case of error.
*/
static int
xmlNsInScope(xmlDocPtr doc ATTRIBUTE_UNUSED, xmlNodePtr node,
@@ -6116,14 +6006,13 @@ xmlNsInScope(xmlDocPtr doc ATTRIBUTE_UNUSED, xmlNodePtr node,
}
/**
- * xmlSearchNsByHrefSafe:
- * @node: a node
- * @href: a namespace URI
- * @out: pointer to resulting namespace
+ * @param node a node
+ * @param href a namespace URI
+ * @param out pointer to resulting namespace
*
- * Search a namespace matching @URI in scope of @node.
+ * Search a namespace matching `URI` in scope of `node`.
*
- * Returns 0 on success, -1 if a memory allocation failed, 1 on
+ * @returns 0 on success, -1 if a memory allocation failed, 1 on
* other errors.
*/
int
@@ -6208,15 +6097,14 @@ xmlSearchNsByHrefSafe(xmlNodePtr node, const xmlChar *href,
}
/**
- * xmlSearchNsByHref:
- * @doc: the document
- * @node: the current node
- * @href: the namespace value
+ * @param doc the document
+ * @param node the current node
+ * @param href the namespace value
*
* Search a Ns aliasing a given URI. Recurse on the parents until it finds
* the defined namespace or return NULL otherwise.
*
- * Returns the namespace pointer or NULL if no namespace was found or
+ * @returns the namespace pointer or NULL if no namespace was found or
* a memory allocation failed. Allocations can only fail if the "xml"
* namespace is queried.
*/
@@ -6230,16 +6118,15 @@ xmlSearchNsByHref(xmlDocPtr doc ATTRIBUTE_UNUSED, xmlNodePtr node,
}
/**
- * xmlNewReconciledNs:
- * @tree: a node expected to hold the new namespace
- * @ns: the original namespace
+ * @param tree a node expected to hold the new namespace
+ * @param ns the original namespace
*
* This function tries to locate a namespace definition in a tree
* ancestors, or create a new namespace definition node similar to
- * @ns trying to reuse the same prefix. However if the given prefix is
+ * `ns` trying to reuse the same prefix. However if the given prefix is
* null (default namespace) or reused within the subtree defined by
- * @tree or on one of its ancestors then a new prefix is generated.
- * Returns the (new) namespace definition or NULL in case of error
+ * `tree` or on one of its ancestors then a new prefix is generated.
+ * @returns the (new) namespace definition or NULL in case of error
*/
static xmlNsPtr
xmlNewReconciledNs(xmlNodePtr tree, xmlNsPtr ns) {
@@ -6318,9 +6205,8 @@ xmlGrowNsCache(xmlNsCache **cache, int *capacity) {
}
/**
- * xmlReconciliateNs:
- * @doc: the document
- * @tree: a node defining the subtree to reconciliate
+ * @param doc the document
+ * @param tree a node defining the subtree to reconciliate
*
* This function checks that all the namespaces declared within the given
* tree are properly declared. This is needed for example after Copy or Cut
@@ -6328,9 +6214,9 @@ xmlGrowNsCache(xmlNsCache **cache, int *capacity) {
* namespace declarations outside the subtree or invalid/masked. As much
* as possible the function try to reuse the existing namespaces found in
* the new environment. If not possible the new namespaces are redeclared
- * on @tree at the top of the given subtree.
+ * on `tree` at the top of the given subtree.
*
- * Returns 0 on success or -1 in case of error.
+ * @returns 0 on success or -1 in case of error.
*/
int
xmlReconciliateNs(xmlDocPtr doc, xmlNodePtr tree) {
@@ -6595,15 +6481,14 @@ xmlGetPropNodeValueInternal(const xmlAttr *prop)
}
/**
- * xmlHasProp:
- * @node: the node
- * @name: the attribute name
+ * @param node the node
+ * @param name the attribute name
*
* Search an attribute associated to a node
- * This function also looks in DTD attribute declaration for #FIXED or
+ * This function also looks in DTD attribute declaration for \#FIXED or
* default declaration values.
*
- * Returns the attribute or the attribute declaration or NULL if
+ * @returns the attribute or the attribute declaration or NULL if
* neither was found. Also returns NULL if a memory allocation failed
* making this function unreliable.
*/
@@ -6646,19 +6531,18 @@ xmlHasProp(const xmlNode *node, const xmlChar *name) {
}
/**
- * xmlHasNsProp:
- * @node: the node
- * @name: the attribute name
- * @nameSpace: the URI of the namespace
+ * @param node the node
+ * @param name the attribute name
+ * @param nameSpace the URI of the namespace
*
* Search for an attribute associated to a node
* This attribute has to be anchored in the namespace specified.
* This does the entity substitution.
- * This function looks in DTD attribute declaration for #FIXED or
+ * This function looks in DTD attribute declaration for \#FIXED or
* default declaration values.
* Note that a namespace of NULL indicates to use the default namespace.
*
- * Returns the attribute or the attribute declaration or NULL if
+ * @returns the attribute or the attribute declaration or NULL if
* neither was found. Also returns NULL if a memory allocation failed
* making this function unreliable.
*/
@@ -6669,11 +6553,10 @@ xmlHasNsProp(const xmlNode *node, const xmlChar *name, const xmlChar *nameSpace)
}
/**
- * xmlNodeGetAttrValue:
- * @node: the node
- * @name: the attribute name
- * @nsUri: the URI of the namespace
- * @out: the returned string
+ * @param node the node
+ * @param name the attribute name
+ * @param nsUri the URI of the namespace
+ * @param out the returned string
*
* Search and get the value of an attribute associated to a node
* This attribute has to be anchored in the namespace specified.
@@ -6682,7 +6565,7 @@ xmlHasNsProp(const xmlNode *node, const xmlChar *name, const xmlChar *nameSpace)
*
* Available since 2.13.0.
*
- * Returns 0 on success, 1 if no attribute was found, -1 if a
+ * @returns 0 on success, 1 if no attribute was found, -1 if a
* memory allocation failed.
*/
int
@@ -6705,13 +6588,12 @@ xmlNodeGetAttrValue(const xmlNode *node, const xmlChar *name,
}
/**
- * xmlGetProp:
- * @node: the node
- * @name: the attribute name
+ * @param node the node
+ * @param name the attribute name
*
* Search and get the value of an attribute associated to a node
* This does the entity substitution.
- * This function looks in DTD attribute declaration for #FIXED or
+ * This function looks in DTD attribute declaration for \#FIXED or
* default declaration values.
*
* NOTE: This function acts independently of namespaces associated
@@ -6721,7 +6603,7 @@ xmlNodeGetAttrValue(const xmlNode *node, const xmlChar *name,
* NOTE: This function doesn't allow to distinguish malloc failures from
* missing attributes. It's more robust to use xmlNodeGetAttrValue.
*
- * Returns the attribute value or NULL if not found or a memory allocation
+ * @returns the attribute value or NULL if not found or a memory allocation
* failed. It's up to the caller to free the memory with xmlFree().
*/
xmlChar *
@@ -6735,13 +6617,12 @@ xmlGetProp(const xmlNode *node, const xmlChar *name) {
}
/**
- * xmlGetNoNsProp:
- * @node: the node
- * @name: the attribute name
+ * @param node the node
+ * @param name the attribute name
*
* Search and get the value of an attribute associated to a node
* This does the entity substitution.
- * This function looks in DTD attribute declaration for #FIXED or
+ * This function looks in DTD attribute declaration for \#FIXED or
* default declaration values.
* This function is similar to xmlGetProp except it will accept only
* an attribute in no namespace.
@@ -6749,7 +6630,7 @@ xmlGetProp(const xmlNode *node, const xmlChar *name) {
* NOTE: This function doesn't allow to distinguish malloc failures from
* missing attributes. It's more robust to use xmlNodeGetAttrValue.
*
- * Returns the attribute value or NULL if not found or a memory allocation
+ * @returns the attribute value or NULL if not found or a memory allocation
* failed. It's up to the caller to free the memory with xmlFree().
*/
xmlChar *
@@ -6763,21 +6644,20 @@ xmlGetNoNsProp(const xmlNode *node, const xmlChar *name) {
}
/**
- * xmlGetNsProp:
- * @node: the node
- * @name: the attribute name
- * @nameSpace: the URI of the namespace
+ * @param node the node
+ * @param name the attribute name
+ * @param nameSpace the URI of the namespace
*
* Search and get the value of an attribute associated to a node
* This attribute has to be anchored in the namespace specified.
* This does the entity substitution.
- * This function looks in DTD attribute declaration for #FIXED or
+ * This function looks in DTD attribute declaration for \#FIXED or
* default declaration values.
*
* NOTE: This function doesn't allow to distinguish malloc failures from
* missing attributes. It's more robust to use xmlNodeGetAttrValue.
*
- * Returns the attribute value or NULL if not found or a memory allocation
+ * @returns the attribute value or NULL if not found or a memory allocation
* failed. It's up to the caller to free the memory with xmlFree().
*/
xmlChar *
@@ -6791,13 +6671,12 @@ xmlGetNsProp(const xmlNode *node, const xmlChar *name, const xmlChar *nameSpace)
}
/**
- * xmlUnsetProp:
- * @node: the node
- * @name: the attribute name
+ * @param node the node
+ * @param name the attribute name
*
* Remove an attribute carried by a node.
* This handles only attributes in no namespace.
- * Returns 0 if successful, -1 if not found
+ * @returns 0 if successful, -1 if not found
*/
int
xmlUnsetProp(xmlNodePtr node, const xmlChar *name) {
@@ -6812,13 +6691,12 @@ xmlUnsetProp(xmlNodePtr node, const xmlChar *name) {
}
/**
- * xmlUnsetNsProp:
- * @node: the node
- * @ns: the namespace definition
- * @name: the attribute name
+ * @param node the node
+ * @param ns the namespace definition
+ * @param name the attribute name
*
* Remove an attribute carried by a node.
- * Returns 0 if successful, -1 if not found
+ * @returns 0 if successful, -1 if not found
*/
int
xmlUnsetNsProp(xmlNodePtr node, xmlNsPtr ns, const xmlChar *name) {
@@ -6834,17 +6712,16 @@ xmlUnsetNsProp(xmlNodePtr node, xmlNsPtr ns, const xmlChar *name) {
}
/**
- * xmlSetProp:
- * @node: the node
- * @name: the attribute name (a QName)
- * @value: the attribute value
+ * @param node the node
+ * @param name the attribute name (a QName)
+ * @param value the attribute value
*
* Set (or reset) an attribute carried by a node.
- * If @name has a prefix, then the corresponding
+ * If `name` has a prefix, then the corresponding
* namespace-binding will be used, if in scope; it is an
* error it there's no such ns-binding for the prefix in
* scope.
- * Returns the attribute pointer.
+ * @returns the attribute pointer.
*
*/
xmlAttrPtr
@@ -6877,16 +6754,15 @@ xmlSetProp(xmlNodePtr node, const xmlChar *name, const xmlChar *value) {
}
/**
- * xmlSetNsProp:
- * @node: the node
- * @ns: the namespace definition
- * @name: the attribute name
- * @value: the attribute value
+ * @param node the node
+ * @param ns the namespace definition
+ * @param name the attribute name
+ * @param value the attribute value
*
* Set (or reset) an attribute carried by a node.
* The ns structure must be in scope, this is not checked
*
- * Returns the attribute pointer.
+ * @returns the attribute pointer.
*/
xmlAttrPtr
xmlSetNsProp(xmlNodePtr node, xmlNsPtr ns, const xmlChar *name,
@@ -6947,11 +6823,10 @@ xmlSetNsProp(xmlNodePtr node, xmlNsPtr ns, const xmlChar *name,
}
/**
- * xmlNodeIsText:
- * @node: the node
+ * @param node the node
*
* Is this node a Text node ?
- * Returns 1 yes, 0 no
+ * @returns 1 yes, 0 no
*/
int
xmlNodeIsText(const xmlNode *node) {
@@ -6962,13 +6837,12 @@ xmlNodeIsText(const xmlNode *node) {
}
/**
- * xmlIsBlankNode:
- * @node: the node
+ * @param node the node
*
* Checks whether this node is an empty or whitespace only
* (and possibly ignorable) text-node.
*
- * Returns 1 yes, 0 no
+ * @returns 1 yes, 0 no
*/
int
xmlIsBlankNode(const xmlNode *node) {
@@ -6989,16 +6863,15 @@ xmlIsBlankNode(const xmlNode *node) {
}
/**
- * xmlTextConcat:
- * @node: the node
- * @content: the content
- * @len: @content length
+ * @param node the node
+ * @param content the content
+ * @param len `content` length
*
* Concat the given string at the end of the existing node content.
*
- * If @len is -1, the string length will be calculated.
+ * If `len` is -1, the string length will be calculated.
*
- * Returns -1 in case of error, 0 otherwise
+ * @returns -1 in case of error, 0 otherwise
*/
int
@@ -7016,11 +6889,10 @@ xmlTextConcat(xmlNodePtr node, const xmlChar *content, int len) {
}
/**
- * xmlGetDocCompressMode:
- * @doc: the document
+ * @param doc the document
*
* get the compression ratio for a document, ZLIB based
- * Returns 0 (uncompressed) to 9 (max compression)
+ * @returns 0 (uncompressed) to 9 (max compression)
*/
int
xmlGetDocCompressMode (const xmlDoc *doc) {
@@ -7029,9 +6901,8 @@ xmlGetDocCompressMode (const xmlDoc *doc) {
}
/**
- * xmlSetDocCompressMode:
- * @doc: the document
- * @mode: the compression ratio
+ * @param doc the document
+ * @param mode the compression ratio
*
* set the compression ratio for a document, ZLIB based
* Correct values: 0 (uncompressed) to 9 (max compression)
@@ -7045,12 +6916,11 @@ xmlSetDocCompressMode (xmlDocPtr doc, int mode) {
}
/**
- * xmlGetCompressMode:
*
- * DEPRECATED: Use xmlGetDocCompressMode
+ * @deprecated Use xmlGetDocCompressMode
*
* get the default compression mode used, ZLIB based.
- * Returns 0 (uncompressed) to 9 (max compression)
+ * @returns 0 (uncompressed) to 9 (max compression)
*/
int
xmlGetCompressMode(void)
@@ -7059,10 +6929,9 @@ xmlGetCompressMode(void)
}
/**
- * xmlSetCompressMode:
- * @mode: the compression ratio
+ * @param mode the compression ratio
*
- * DEPRECATED: Use xmlSetDocCompressMode
+ * @deprecated Use xmlSetDocCompressMode
*
* set the default compression mode used, ZLIB based
* Correct values: 0 (uncompressed) to 9 (max compression)
@@ -9208,13 +9077,12 @@ xmlDOMWrapAdoptNode(xmlDOMWrapCtxtPtr ctxt,
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
/**
- * xmlIsXHTML:
- * @systemID: the system identifier
- * @publicID: the public identifier
+ * @param systemID the system identifier
+ * @param publicID the public identifier
*
* Try to find if the document correspond to an XHTML DTD
*
- * Returns 1 if true, 0 if not and -1 in case of error
+ * @returns 1 if true, 0 if not and -1 in case of error
*/
int
xmlIsXHTML(const xmlChar *systemID, const xmlChar *publicID) {
@@ -9240,14 +9108,13 @@ xmlIsXHTML(const xmlChar *systemID, const xmlChar *publicID) {
************************************************************************/
/**
- * xmlRegisterNodeDefault:
- * @func: function pointer to the new RegisterNodeFunc
+ * @param func function pointer to the new RegisterNodeFunc
*
- * DEPRECATED: don't use
+ * @deprecated don't use
*
* Registers a callback for node creation
*
- * Returns the old value of the registration function
+ * @returns the old value of the registration function
*/
xmlRegisterNodeFunc
xmlRegisterNodeDefault(xmlRegisterNodeFunc func)
@@ -9260,14 +9127,13 @@ xmlRegisterNodeDefault(xmlRegisterNodeFunc func)
}
/**
- * xmlDeregisterNodeDefault:
- * @func: function pointer to the new DeregisterNodeFunc
+ * @param func function pointer to the new DeregisterNodeFunc
*
- * DEPRECATED: don't use
+ * @deprecated don't use
*
* Registers a callback for node destruction
*
- * Returns the previous value of the deregistration function
+ * @returns the previous value of the deregistration function
*/
xmlDeregisterNodeFunc
xmlDeregisterNodeDefault(xmlDeregisterNodeFunc func)
diff --git a/uri.c b/uri.c
index 955d5c86..2f1a8850 100644
--- a/uri.c
+++ b/uri.c
@@ -144,7 +144,7 @@ static void xmlCleanURI(xmlURIPtr uri);
((*(p) == '=')) || ((*(p) == '\'')))
/*
- * gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
+ * gen-delims = ":" / "/" / "?" / "\#" / "[" / "]" / "@"
*/
#define ISA_GEN_DELIM(p) \
(((*(p) == ':')) || ((*(p) == '/')) || ((*(p) == '?')) || \
@@ -214,15 +214,14 @@ xmlIsUnreserved(xmlURIPtr uri, const char *cur) {
}
/**
- * xmlParse3986Scheme:
- * @uri: pointer to an URI structure
- * @str: pointer to the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str pointer to the string to analyze
*
* Parse an URI scheme
*
* ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Scheme(xmlURIPtr uri, const char **str) {
@@ -254,9 +253,8 @@ xmlParse3986Scheme(xmlURIPtr uri, const char **str) {
}
/**
- * xmlParse3986Fragment:
- * @uri: pointer to an URI structure
- * @str: pointer to the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str pointer to the string to analyze
*
* Parse the query part of an URI
*
@@ -266,7 +264,7 @@ xmlParse3986Scheme(xmlURIPtr uri, const char **str) {
* xpointer scheme selection, so we are allowing it here to not break
* for example all the DocBook processing chains.
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Fragment(xmlURIPtr uri, const char **str)
@@ -293,15 +291,14 @@ xmlParse3986Fragment(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986Query:
- * @uri: pointer to an URI structure
- * @str: pointer to the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str pointer to the string to analyze
*
* Parse the query part of an URI
*
* query = *uric
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Query(xmlURIPtr uri, const char **str)
@@ -336,16 +333,15 @@ xmlParse3986Query(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986Port:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse a port part and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* port = *DIGIT
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Port(xmlURIPtr uri, const char **str)
@@ -375,16 +371,15 @@ xmlParse3986Port(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986Userinfo:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an user information part and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Userinfo(xmlURIPtr uri, const char **str)
@@ -412,8 +407,7 @@ xmlParse3986Userinfo(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986DecOctet:
- * @str: the string to analyze
+ * @param str the string to analyze
*
* dec-octet = DIGIT ; 0-9
* / %x31-39 DIGIT ; 10-99
@@ -423,7 +417,7 @@ xmlParse3986Userinfo(xmlURIPtr uri, const char **str)
*
* Skip a dec-octet.
*
- * Returns 0 if found and skipped, 1 otherwise
+ * @returns 0 if found and skipped, 1 otherwise
*/
static int
xmlParse3986DecOctet(const char **str) {
@@ -449,19 +443,18 @@ xmlParse3986DecOctet(const char **str) {
return(0);
}
/**
- * xmlParse3986Host:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an host part and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* host = IP-literal / IPv4address / reg-name
* IP-literal = "[" ( IPv6address / IPvFuture ) "]"
* IPv4address = dec-octet "." dec-octet "." dec-octet "." dec-octet
* reg-name = *( unreserved / pct-encoded / sub-delims )
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Host(xmlURIPtr uri, const char **str)
@@ -531,16 +524,15 @@ found:
}
/**
- * xmlParse3986Authority:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an authority part and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* authority = [ userinfo "@" ] host [ ":" port ]
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Authority(xmlURIPtr uri, const char **str)
@@ -571,21 +563,20 @@ xmlParse3986Authority(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986Segment:
- * @uri: the URI
- * @str: the string to analyze
- * @forbid: an optional forbidden character
- * @empty: allow an empty segment
+ * @param uri the URI
+ * @param str the string to analyze
+ * @param forbid an optional forbidden character
+ * @param empty allow an empty segment
*
* Parse a segment and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* segment = *pchar
* segment-nz = 1*pchar
* segment-nz-nc = 1*( unreserved / pct-encoded / sub-delims / "@" )
* ; non-zero-length segment without any colon ":"
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986Segment(xmlURIPtr uri, const char **str, char forbid, int empty)
@@ -615,16 +606,15 @@ xmlParse3986Segment(xmlURIPtr uri, const char **str, char forbid, int empty)
}
/**
- * xmlParse3986PathAbEmpty:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an path absolute or empty and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* path-abempty = *( "/" segment )
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986PathAbEmpty(xmlURIPtr uri, const char **str)
@@ -657,16 +647,15 @@ xmlParse3986PathAbEmpty(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986PathAbsolute:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an path absolute and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* path-absolute = "/" [ segment-nz *( "/" segment ) ]
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986PathAbsolute(xmlURIPtr uri, const char **str)
@@ -705,16 +694,15 @@ xmlParse3986PathAbsolute(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986PathRootless:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an path without root and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* path-rootless = segment-nz *( "/" segment )
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986PathRootless(xmlURIPtr uri, const char **str)
@@ -749,16 +737,15 @@ xmlParse3986PathRootless(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986PathNoScheme:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an path which is not a scheme and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* path-noscheme = segment-nz-nc *( "/" segment )
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986PathNoScheme(xmlURIPtr uri, const char **str)
@@ -793,19 +780,18 @@ xmlParse3986PathNoScheme(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986HierPart:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an hierarchical part and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* hier-part = "//" authority path-abempty
* / path-absolute
* / path-rootless
* / path-empty
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986HierPart(xmlURIPtr uri, const char **str)
@@ -846,20 +832,19 @@ xmlParse3986HierPart(xmlURIPtr uri, const char **str)
}
/**
- * xmlParse3986RelativeRef:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an URI string and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
- * relative-ref = relative-part [ "?" query ] [ "#" fragment ]
+ * relative-ref = relative-part [ "?" query ] [ "\#" fragment ]
* relative-part = "//" authority path-abempty
* / path-absolute
* / path-noscheme
* / path-empty
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986RelativeRef(xmlURIPtr uri, const char *str) {
@@ -904,16 +889,15 @@ xmlParse3986RelativeRef(xmlURIPtr uri, const char *str) {
/**
- * xmlParse3986URI:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an URI string and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
- * scheme ":" hier-part [ "?" query ] [ "#" fragment ]
+ * scheme ":" hier-part [ "?" query ] [ "\#" fragment ]
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986URI(xmlURIPtr uri, const char *str) {
@@ -945,16 +929,15 @@ xmlParse3986URI(xmlURIPtr uri, const char *str) {
}
/**
- * xmlParse3986URIReference:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an URI reference string and fills in the appropriate fields
- * of the @uri structure
+ * of the `uri` structure
*
* URI-reference = URI / relative-ref
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
xmlParse3986URIReference(xmlURIPtr uri, const char *str) {
@@ -983,17 +966,16 @@ xmlParse3986URIReference(xmlURIPtr uri, const char *str) {
}
/**
- * xmlParseURISafe:
- * @str: the URI string to analyze
- * @uriOut: optional pointer to parsed URI
+ * @param str the URI string to analyze
+ * @param uriOut optional pointer to parsed URI
*
* Parse an URI based on RFC 3986
*
- * URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
+ * URI-reference = [ absoluteURI | relativeURI ] [ "\#" fragment ]
*
* Available since 2.13.0.
*
- * Returns 0 on success, an error code (typically 1) if the URI is invalid
+ * @returns 0 on success, an error code (typically 1) if the URI is invalid
* or -1 if a memory allocation failed.
*/
int
@@ -1022,14 +1004,13 @@ xmlParseURISafe(const char *str, xmlURIPtr *uriOut) {
}
/**
- * xmlParseURI:
- * @str: the URI string to analyze
+ * @param str the URI string to analyze
*
* Parse an URI based on RFC 3986
*
- * URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
+ * URI-reference = [ absoluteURI | relativeURI ] [ "\#" fragment ]
*
- * Returns a newly built xmlURIPtr or NULL in case of error
+ * @returns a newly built xmlURIPtr or NULL in case of error
*/
xmlURIPtr
xmlParseURI(const char *str) {
@@ -1039,16 +1020,15 @@ xmlParseURI(const char *str) {
}
/**
- * xmlParseURIReference:
- * @uri: pointer to an URI structure
- * @str: the string to analyze
+ * @param uri pointer to an URI structure
+ * @param str the string to analyze
*
* Parse an URI reference string based on RFC 3986 and fills in the
- * appropriate fields of the @uri structure
+ * appropriate fields of the `uri` structure
*
* URI-reference = URI / relative-ref
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
int
xmlParseURIReference(xmlURIPtr uri, const char *str) {
@@ -1056,15 +1036,14 @@ xmlParseURIReference(xmlURIPtr uri, const char *str) {
}
/**
- * xmlParseURIRaw:
- * @str: the URI string to analyze
- * @raw: if 1 unescaping of URI pieces are disabled
+ * @param str the URI string to analyze
+ * @param raw if 1 unescaping of URI pieces are disabled
*
* Parse an URI but allows to keep intact the original fragments.
*
* URI-reference = URI / relative-ref
*
- * Returns a newly built xmlURIPtr or NULL in case of error
+ * @returns a newly built xmlURIPtr or NULL in case of error
*/
xmlURIPtr
xmlParseURIRaw(const char *str, int raw) {
@@ -1094,11 +1073,10 @@ xmlParseURIRaw(const char *str, int raw) {
************************************************************************/
/**
- * xmlCreateURI:
*
* Simply creates an empty xmlURI
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
xmlURIPtr
xmlCreateURI(void) {
@@ -1113,7 +1091,6 @@ xmlCreateURI(void) {
}
/**
- * xmlSaveUriRealloc:
*
* Function to handle properly a reallocation when saving an URI
* Also imposes some limit on the length of an URI string output
@@ -1134,12 +1111,11 @@ xmlSaveUriRealloc(xmlChar *ret, int *max) {
}
/**
- * xmlSaveUri:
- * @uri: pointer to an xmlURI
+ * @param uri pointer to an xmlURI
*
* Save the URI as an escaped string
*
- * Returns a new string (to be deallocated by caller)
+ * @returns a new string (to be deallocated by caller)
*/
xmlChar *
xmlSaveUri(xmlURIPtr uri) {
@@ -1408,11 +1384,10 @@ mem_error:
}
/**
- * xmlPrintURI:
- * @stream: a FILE* for the output
- * @uri: pointer to an xmlURI
+ * @param stream a FILE* for the output
+ * @param uri pointer to an xmlURI
*
- * Prints the URI in the stream @stream.
+ * Prints the URI in the stream `stream`.
*/
void
xmlPrintURI(FILE *stream, xmlURIPtr uri) {
@@ -1426,8 +1401,7 @@ xmlPrintURI(FILE *stream, xmlURIPtr uri) {
}
/**
- * xmlCleanURI:
- * @uri: pointer to an xmlURI
+ * @param uri pointer to an xmlURI
*
* Make sure the xmlURI struct is free of content
*/
@@ -1456,8 +1430,7 @@ xmlCleanURI(xmlURIPtr uri) {
}
/**
- * xmlFreeURI:
- * @uri: pointer to an xmlURI
+ * @param uri pointer to an xmlURI
*
* Free up the xmlURI struct
*/
@@ -1499,13 +1472,12 @@ xmlIsPathSeparator(int c, int isFile) {
}
/**
- * xmlNormalizePath:
- * @path: pointer to the path string
- * @isFile: true for filesystem paths, false for URIs
+ * @param path pointer to the path string
+ * @param isFile true for filesystem paths, false for URIs
*
* Normalize a filesystem path or URI.
*
- * Returns 0 or an error code
+ * @returns 0 or an error code
*/
static int
xmlNormalizePath(char *path, int isFile) {
@@ -1598,15 +1570,14 @@ xmlNormalizePath(char *path, int isFile) {
}
/**
- * xmlNormalizeURIPath:
- * @path: pointer to the path string
+ * @param path pointer to the path string
*
* Applies the 5 normalization steps to a path string--that is, RFC 2396
* Section 5.2, steps 6.c through 6.g.
*
* Normalization occurs directly on the string, no new allocation is done
*
- * Returns 0 or an error code
+ * @returns 0 or an error code
*/
int
xmlNormalizeURIPath(char *path) {
@@ -1622,17 +1593,16 @@ static int is_hex(char c) {
}
/**
- * xmlURIUnescapeString:
- * @str: the string to unescape
- * @len: the length in bytes to unescape (or <= 0 to indicate full string)
- * @target: optional destination buffer
+ * @param str the string to unescape
+ * @param len the length in bytes to unescape (or <= 0 to indicate full string)
+ * @param target optional destination buffer
*
* Unescaping routine, but does not check that the string is an URI. The
* output is a direct unsigned char translation of %XX values (no encoding)
* Note that the length of the result can only be smaller or same size as
* the input string.
*
- * Returns a copy of the string, but unescaped, will return NULL only in case
+ * @returns a copy of the string, but unescaped, will return NULL only in case
* of error
*/
char *
@@ -1684,15 +1654,14 @@ xmlURIUnescapeString(const char *str, int len, char *target) {
}
/**
- * xmlURIEscapeStr:
- * @str: string to escape
- * @list: exception list string of chars not to escape
+ * @param str string to escape
+ * @param list exception list string of chars not to escape
*
* This routine escapes a string to hex, ignoring unreserved characters
* a-z, A-Z, 0-9, "-._~", a few sub-delims "!*'()", the gen-delim "@"
* (why?) and the characters in the exception list.
*
- * Returns a new escaped string or NULL in case of error.
+ * @returns a new escaped string or NULL in case of error.
*/
xmlChar *
xmlURIEscapeStr(const xmlChar *str, const xmlChar *list) {
@@ -1757,14 +1726,13 @@ xmlURIEscapeStr(const xmlChar *str, const xmlChar *list) {
}
/**
- * xmlURIEscape:
- * @str: the string of the URI to escape
+ * @param str the string of the URI to escape
*
* Escaping routine, does not do validity checks !
* It will try to escape the chars needing this, but this is heuristic
* based it's impossible to be sure.
*
- * Returns an copy of the string, but escaped
+ * @returns an copy of the string, but escaped
*
* 25 May 2001
* Uses xmlParseURI and xmlURIEscapeStr to try to escape correctly
@@ -1913,14 +1881,13 @@ xmlIsAbsolutePath(const xmlChar *path) {
}
/**
- * xmlResolvePath:
- * @escRef: the filesystem path
- * @base: the base value
- * @out: pointer to result URI
+ * @param escRef the filesystem path
+ * @param base the base value
+ * @param out pointer to result URI
*
* Resolves a filesystem path from a base path.
*
- * Returns 0 on success, -1 if a memory allocation failed or an error
+ * @returns 0 on success, -1 if a memory allocation failed or an error
* code if URI or base are invalid.
*/
static int
@@ -2017,10 +1984,9 @@ err_memory:
}
/**
- * xmlBuildURISafe:
- * @URI: the URI instance found in the document
- * @base: the base value
- * @valPtr: pointer to result URI
+ * @param URI the URI instance found in the document
+ * @param base the base value
+ * @param valPtr pointer to result URI
*
* Computes he final URI of the reference done by checking that
* the given URI is valid, and building the final URI using the
@@ -2031,7 +1997,7 @@ err_memory:
*
* Available since 2.13.0.
*
- * Returns 0 on success, -1 if a memory allocation failed or an error
+ * @returns 0 on success, -1 if a memory allocation failed or an error
* code if URI or base are invalid.
*/
int
@@ -2386,9 +2352,8 @@ done:
}
/**
- * xmlBuildURI:
- * @URI: the URI instance found in the document
- * @base: the base value
+ * @param URI the URI instance found in the document
+ * @param base the base value
*
* Computes he final URI of the reference done by checking that
* the given URI is valid, and building the final URI using the
@@ -2397,7 +2362,7 @@ done:
*
* 5.2. Resolving Relative References to Absolute Form
*
- * Returns a new URI string (to be freed by the caller) or NULL in case
+ * @returns a new URI string (to be freed by the caller) or NULL in case
* of error.
*/
xmlChar *
@@ -2532,10 +2497,9 @@ done:
}
/**
- * xmlBuildRelativeURISafe:
- * @URI: the URI reference under consideration
- * @base: the base value
- * @valPtr: pointer to result URI
+ * @param URI the URI reference under consideration
+ * @param base the base value
+ * @param valPtr pointer to result URI
*
* Expresses the URI of the reference in terms relative to the
* base. Some examples of this operation include:
@@ -2554,7 +2518,7 @@ done:
*
* Available since 2.13.0.
*
- * Returns 0 on success, -1 if a memory allocation failed or an error
+ * @returns 0 on success, -1 if a memory allocation failed or an error
* code if URI or base are invalid.
*/
int
@@ -2775,13 +2739,12 @@ done:
}
/*
- * xmlBuildRelativeURI:
- * @URI: the URI reference under consideration
- * @base: the base value
+ * @param URI the URI reference under consideration
+ * @param base the base value
*
* See xmlBuildRelativeURISafe.
*
- * Returns a new URI string (to be freed by the caller) or NULL in case
+ * @returns a new URI string (to be freed by the caller) or NULL in case
* error.
*/
xmlChar *
@@ -2794,8 +2757,7 @@ xmlBuildRelativeURI(const xmlChar * URI, const xmlChar * base)
}
/**
- * xmlCanonicPath:
- * @path: the resource locator in a filesystem notation
+ * @param path the resource locator in a filesystem notation
*
* Prepares a path.
*
@@ -2810,7 +2772,7 @@ xmlBuildRelativeURI(const xmlChar * URI, const xmlChar * base)
* by the returned string. If there is insufficient memory available, or the
* argument is NULL, the function returns NULL.
*
- * Returns the escaped path.
+ * @returns the escaped path.
*/
xmlChar *
xmlCanonicPath(const xmlChar *path)
@@ -2838,12 +2800,11 @@ xmlCanonicPath(const xmlChar *path)
}
/**
- * xmlPathToURI:
- * @path: the resource locator in a filesystem notation
+ * @param path the resource locator in a filesystem notation
*
* Constructs an URI expressing the existing path
*
- * Returns a new URI, or a duplicate of the path parameter if the
+ * @returns a new URI, or a duplicate of the path parameter if the
* construction fails. The caller is responsible for freeing the memory
* occupied by the returned string. If there is insufficient memory available,
* or the argument is NULL, the function returns NULL.
diff --git a/valid.c b/valid.c
index a6153b3f..4a6353f0 100644
--- a/valid.c
+++ b/valid.c
@@ -45,8 +45,7 @@ xmlValidateAttributeValueInternal(xmlDocPtr doc, xmlAttributeType type,
************************************************************************/
/**
- * xmlVErrMemory:
- * @ctxt: an XML validation parser context
+ * @param ctxt an XML validation parser context
*
* Handle an out of memory error
*/
@@ -104,11 +103,10 @@ xmlDoErrValid(xmlValidCtxtPtr ctxt, xmlNodePtr node,
}
/**
- * xmlErrValid:
- * @ctxt: an XML validation parser context
- * @error: the error number
- * @msg: the error message
- * @extra: extra information
+ * @param ctxt an XML validation parser context
+ * @param error the error number
+ * @param msg the error message
+ * @param extra extra information
*
* Handle a validation error
*/
@@ -122,14 +120,13 @@ xmlErrValid(xmlValidCtxtPtr ctxt, xmlParserErrors error,
#ifdef LIBXML_VALID_ENABLED
/**
- * xmlErrValidNode:
- * @ctxt: an XML validation parser context
- * @node: the node raising the error
- * @error: the error number
- * @msg: the error message
- * @str1: extra information
- * @str2: extra information
- * @str3: extra information
+ * @param ctxt an XML validation parser context
+ * @param node the node raising the error
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 extra information
+ * @param str2 extra information
+ * @param str3 extra information
*
* Handle a validation error, provide contextual information
*/
@@ -144,14 +141,13 @@ xmlErrValidNode(xmlValidCtxtPtr ctxt,
}
/**
- * xmlErrValidNodeNr:
- * @ctxt: an XML validation parser context
- * @node: the node raising the error
- * @error: the error number
- * @msg: the error message
- * @str1: extra information
- * @int2: extra information
- * @str3: extra information
+ * @param ctxt an XML validation parser context
+ * @param node the node raising the error
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 extra information
+ * @param int2 extra information
+ * @param str3 extra information
*
* Handle a validation error, provide contextual information
*/
@@ -166,14 +162,13 @@ xmlErrValidNodeNr(xmlValidCtxtPtr ctxt,
}
/**
- * xmlErrValidWarning:
- * @ctxt: an XML validation parser context
- * @node: the node raising the error
- * @error: the error number
- * @msg: the error message
- * @str1: extra information
- * @str2: extra information
- * @str3: extra information
+ * @param ctxt an XML validation parser context
+ * @param node the node raising the error
+ * @param error the error number
+ * @param msg the error message
+ * @param str1 extra information
+ * @param str2 extra information
+ * @param str3 extra information
*
* Handle a validation error, provide contextual information
*/
@@ -422,14 +417,13 @@ nodeVPop(xmlValidCtxtPtr ctxt)
************************************************************************/
/**
- * xmlValidBuildAContentModel:
- * @content: the content model
- * @ctxt: the schema parser context
- * @name: the element name whose content is being built
+ * @param content the content model
+ * @param ctxt the schema parser context
+ * @param name the element name whose content is being built
*
* Generate the automata sequence needed for that type
*
- * Returns 1 if successful or 0 in case of error.
+ * @returns 1 if successful or 0 in case of error.
*/
static int
xmlValidBuildAContentModel(xmlElementContentPtr content,
@@ -580,16 +574,15 @@ xmlValidBuildAContentModel(xmlElementContentPtr content,
return(1);
}
/**
- * xmlValidBuildContentModel:
- * @ctxt: a validation context
- * @elem: an element declaration node
+ * @param ctxt a validation context
+ * @param elem an element declaration node
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* (Re)Build the automata associated to the content model of this
* element
*
- * Returns 1 in case of success, 0 in case of error
+ * @returns 1 in case of success, 0 in case of error
*/
int
xmlValidBuildContentModel(xmlValidCtxtPtr ctxt, xmlElementPtr elem) {
@@ -654,11 +647,10 @@ done:
****************************************************************/
/**
- * xmlNewValidCtxt:
*
* Allocate a validation context structure.
*
- * Returns NULL if not, otherwise the new validation context structure
+ * @returns NULL if not, otherwise the new validation context structure
*/
xmlValidCtxtPtr xmlNewValidCtxt(void) {
xmlValidCtxtPtr ret;
@@ -673,8 +665,7 @@ xmlValidCtxtPtr xmlNewValidCtxt(void) {
}
/**
- * xmlFreeValidCtxt:
- * @cur: the validation context to free
+ * @param cur the validation context to free
*
* Free a validation context structure.
*/
@@ -692,16 +683,15 @@ xmlFreeValidCtxt(xmlValidCtxtPtr cur) {
#endif /* LIBXML_VALID_ENABLED */
/**
- * xmlNewDocElementContent:
- * @doc: the document
- * @name: the subelement name or NULL
- * @type: the type of element content decl
+ * @param doc the document
+ * @param name the subelement name or NULL
+ * @param type the type of element content decl
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Allocate an element content structure for the document.
*
- * Returns NULL if not, otherwise the new element content structure
+ * @returns NULL if not, otherwise the new element content structure
*/
xmlElementContentPtr
xmlNewDocElementContent(xmlDocPtr doc, const xmlChar *name,
@@ -773,16 +763,15 @@ error:
}
/**
- * xmlNewElementContent:
- * @name: the subelement name or NULL
- * @type: the type of element content decl
+ * @param name the subelement name or NULL
+ * @param type the type of element content decl
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Allocate an element content structure.
* Deprecated in favor of xmlNewDocElementContent
*
- * Returns NULL if not, otherwise the new element content structure
+ * @returns NULL if not, otherwise the new element content structure
*/
xmlElementContentPtr
xmlNewElementContent(const xmlChar *name, xmlElementContentType type) {
@@ -790,15 +779,14 @@ xmlNewElementContent(const xmlChar *name, xmlElementContentType type) {
}
/**
- * xmlCopyDocElementContent:
- * @doc: the document owning the element declaration
- * @cur: An element content pointer.
+ * @param doc the document owning the element declaration
+ * @param cur An element content pointer.
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Build a copy of an element content description.
*
- * Returns the new xmlElementContentPtr or NULL in case of error.
+ * @returns the new xmlElementContentPtr or NULL in case of error.
*/
xmlElementContentPtr
xmlCopyDocElementContent(xmlDocPtr doc, xmlElementContentPtr cur) {
@@ -886,15 +874,14 @@ error:
}
/**
- * xmlCopyElementContent:
- * @cur: An element content pointer.
+ * @param cur An element content pointer.
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Build a copy of an element content description.
* Deprecated, use xmlCopyDocElementContent instead
*
- * Returns the new xmlElementContentPtr or NULL in case of error.
+ * @returns the new xmlElementContentPtr or NULL in case of error.
*/
xmlElementContentPtr
xmlCopyElementContent(xmlElementContentPtr cur) {
@@ -902,11 +889,10 @@ xmlCopyElementContent(xmlElementContentPtr cur) {
}
/**
- * xmlFreeDocElementContent:
- * @doc: the document owning the element declaration
- * @cur: the element content tree to free
+ * @param doc the document owning the element declaration
+ * @param cur the element content tree to free
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Free an element content structure. The whole subtree is removed.
*/
@@ -970,10 +956,9 @@ xmlFreeDocElementContent(xmlDocPtr doc, xmlElementContentPtr cur) {
}
/**
- * xmlFreeElementContent:
- * @cur: the element content tree to free
+ * @param cur the element content tree to free
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Free an element content structure. The whole subtree is removed.
* Deprecated, use xmlFreeDocElementContent instead
@@ -985,12 +970,11 @@ xmlFreeElementContent(xmlElementContentPtr cur) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlSprintfElementContent:
- * @buf: an output buffer
- * @content: An element table
- * @englob: 1 if one must print the englobing parenthesis, 0 otherwise
+ * @param buf an output buffer
+ * @param content An element table
+ * @param englob 1 if one must print the englobing parenthesis, 0 otherwise
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Deprecated, unsafe, use xmlSnprintfElementContent
*/
@@ -1002,13 +986,12 @@ xmlSprintfElementContent(char *buf ATTRIBUTE_UNUSED,
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlSnprintfElementContent:
- * @buf: an output buffer
- * @size: the buffer size
- * @content: An element table
- * @englob: 1 if one must print the englobing parenthesis, 0 otherwise
+ * @param buf an output buffer
+ * @param size the buffer size
+ * @param content An element table
+ * @param englob 1 if one must print the englobing parenthesis, 0 otherwise
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* This will dump the content of the element content definition
* Intended just for the debug routine
@@ -1112,8 +1095,7 @@ xmlSnprintfElementContent(char *buf, int size, xmlElementContentPtr content, int
****************************************************************/
/**
- * xmlFreeElement:
- * @elem: An element
+ * @param elem An element
*
* Deallocate the memory used by an element definition
*/
@@ -1135,18 +1117,17 @@ xmlFreeElement(xmlElementPtr elem) {
/**
- * xmlAddElementDecl:
- * @ctxt: the validation context
- * @dtd: pointer to the DTD
- * @name: the entity name
- * @type: the element type
- * @content: the element content tree or NULL
+ * @param ctxt the validation context
+ * @param dtd pointer to the DTD
+ * @param name the entity name
+ * @param type the element type
+ * @param content the element content tree or NULL
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Register a new element declaration
*
- * Returns NULL if not, otherwise the entity
+ * @returns NULL if not, otherwise the entity
*/
xmlElementPtr
xmlAddElementDecl(xmlValidCtxtPtr ctxt,
@@ -1350,10 +1331,9 @@ xmlFreeElementTableEntry(void *elem, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlFreeElementTable:
- * @table: An element table
+ * @param table An element table
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Deallocate the memory used by an element hash table.
*/
@@ -1363,13 +1343,12 @@ xmlFreeElementTable(xmlElementTablePtr table) {
}
/**
- * xmlCopyElement:
- * @payload: an element
- * @name: unused
+ * @param payload an element
+ * @param name unused
*
* Build a copy of an element.
*
- * Returns the new xmlElementPtr or NULL in case of error.
+ * @returns the new xmlElementPtr or NULL in case of error.
*/
static void *
xmlCopyElement(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
@@ -1407,14 +1386,13 @@ error:
}
/**
- * xmlCopyElementTable:
- * @table: An element table
+ * @param table An element table
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Build a copy of an element table.
*
- * Returns the new xmlElementTablePtr or NULL in case of error.
+ * @returns the new xmlElementTablePtr or NULL in case of error.
*/
xmlElementTablePtr
xmlCopyElementTable(xmlElementTablePtr table) {
@@ -1423,11 +1401,10 @@ xmlCopyElementTable(xmlElementTablePtr table) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlDumpElementDecl:
- * @buf: the XML buffer output
- * @elem: An element table
+ * @param buf the XML buffer output
+ * @param elem An element table
*
- * DEPRECATED: Use xmlSaveTree.
+ * @deprecated Use xmlSaveTree.
*
* This will dump the content of the element declaration as an XML
* DTD definition
@@ -1446,10 +1423,9 @@ xmlDumpElementDecl(xmlBufferPtr buf, xmlElementPtr elem) {
}
/**
- * xmlDumpElementDeclScan:
- * @elem: an element declaration
- * @save: a save context
- * @name: unused
+ * @param elem an element declaration
+ * @param save a save context
+ * @param name unused
*
* This routine is used by the hash scan function. It just reverses
* the arguments.
@@ -1461,11 +1437,10 @@ xmlDumpElementDeclScan(void *elem, void *save,
}
/**
- * xmlDumpElementTable:
- * @buf: the XML buffer output
- * @table: An element table
+ * @param buf the XML buffer output
+ * @param table An element table
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This will dump the content of the element table as an XML DTD definition
*/
@@ -1484,14 +1459,13 @@ xmlDumpElementTable(xmlBufferPtr buf, xmlElementTablePtr table) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlCreateEnumeration:
- * @name: the enumeration name or NULL
+ * @param name the enumeration name or NULL
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* create and initialize an enumeration attribute node.
*
- * Returns the xmlEnumerationPtr just created or NULL in case
+ * @returns the xmlEnumerationPtr just created or NULL in case
* of error.
*/
xmlEnumerationPtr
@@ -1515,8 +1489,7 @@ xmlCreateEnumeration(const xmlChar *name) {
}
/**
- * xmlFreeEnumeration:
- * @cur: the tree to free.
+ * @param cur the tree to free.
*
* free an enumeration attribute node (recursive).
*/
@@ -1533,14 +1506,13 @@ xmlFreeEnumeration(xmlEnumerationPtr cur) {
}
/**
- * xmlCopyEnumeration:
- * @cur: the tree to copy.
+ * @param cur the tree to copy.
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Copy an enumeration attribute node (recursive).
*
- * Returns the xmlEnumerationPtr just created or NULL in case
+ * @returns the xmlEnumerationPtr just created or NULL in case
* of error.
*/
xmlEnumerationPtr
@@ -1571,15 +1543,14 @@ xmlCopyEnumeration(xmlEnumerationPtr cur) {
#ifdef LIBXML_VALID_ENABLED
/**
- * xmlScanIDAttributeDecl:
- * @ctxt: the validation context
- * @elem: the element name
- * @err: whether to raise errors here
+ * @param ctxt the validation context
+ * @param elem the element name
+ * @param err whether to raise errors here
*
* Verify that the element don't have too many ID attributes
* declared.
*
- * Returns the number of ID attributes found.
+ * @returns the number of ID attributes found.
*/
static int
xmlScanIDAttributeDecl(xmlValidCtxtPtr ctxt, xmlElementPtr elem, int err) {
@@ -1603,8 +1574,7 @@ xmlScanIDAttributeDecl(xmlValidCtxtPtr ctxt, xmlElementPtr elem, int err) {
#endif /* LIBXML_VALID_ENABLED */
/**
- * xmlFreeAttribute:
- * @attr: an attribute
+ * @param attr an attribute
*
* Deallocate the memory used by an attribute definition
*/
@@ -1645,23 +1615,22 @@ xmlFreeAttribute(xmlAttributePtr attr) {
/**
- * xmlAddAttributeDecl:
- * @ctxt: the validation context
- * @dtd: pointer to the DTD
- * @elem: the element name
- * @name: the attribute name
- * @ns: the attribute namespace prefix
- * @type: the attribute type
- * @def: the attribute default type
- * @defaultValue: the attribute default value
- * @tree: if it's an enumeration, the associated list
+ * @param ctxt the validation context
+ * @param dtd pointer to the DTD
+ * @param elem the element name
+ * @param name the attribute name
+ * @param ns the attribute namespace prefix
+ * @param type the attribute type
+ * @param def the attribute default type
+ * @param defaultValue the attribute default value
+ * @param tree if it's an enumeration, the associated list
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Register a new attribute declaration
- * Note that @tree becomes the ownership of the DTD
+ * Note that `tree` becomes the ownership of the DTD
*
- * Returns NULL if not new, otherwise the attribute decl
+ * @returns NULL if not new, otherwise the attribute decl
*/
xmlAttributePtr
xmlAddAttributeDecl(xmlValidCtxtPtr ctxt,
@@ -1897,10 +1866,9 @@ xmlFreeAttributeTableEntry(void *attr, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlFreeAttributeTable:
- * @table: An attribute table
+ * @param table An attribute table
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Deallocate the memory used by an entities hash table.
*/
@@ -1910,13 +1878,12 @@ xmlFreeAttributeTable(xmlAttributeTablePtr table) {
}
/**
- * xmlCopyAttribute:
- * @payload: an attribute declaration
- * @name: unused
+ * @param payload an attribute declaration
+ * @param name unused
*
* Build a copy of an attribute declaration.
*
- * Returns the new xmlAttributePtr or NULL in case of error.
+ * @returns the new xmlAttributePtr or NULL in case of error.
*/
static void *
xmlCopyAttribute(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
@@ -1963,14 +1930,13 @@ error:
}
/**
- * xmlCopyAttributeTable:
- * @table: An attribute table
+ * @param table An attribute table
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Build a copy of an attribute table.
*
- * Returns the new xmlAttributeTablePtr or NULL in case of error.
+ * @returns the new xmlAttributeTablePtr or NULL in case of error.
*/
xmlAttributeTablePtr
xmlCopyAttributeTable(xmlAttributeTablePtr table) {
@@ -1980,11 +1946,10 @@ xmlCopyAttributeTable(xmlAttributeTablePtr table) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlDumpAttributeDecl:
- * @buf: the XML buffer output
- * @attr: An attribute declaration
+ * @param buf the XML buffer output
+ * @param attr An attribute declaration
*
- * DEPRECATED: Use xmlSaveTree.
+ * @deprecated Use xmlSaveTree.
*
* This will dump the content of the attribute declaration as an XML
* DTD definition
@@ -2003,10 +1968,9 @@ xmlDumpAttributeDecl(xmlBufferPtr buf, xmlAttributePtr attr) {
}
/**
- * xmlDumpAttributeDeclScan:
- * @attr: an attribute declaration
- * @save: a save context
- * @name: unused
+ * @param attr an attribute declaration
+ * @param save a save context
+ * @param name unused
*
* This is used with the hash scan function - just reverses arguments
*/
@@ -2017,11 +1981,10 @@ xmlDumpAttributeDeclScan(void *attr, void *save,
}
/**
- * xmlDumpAttributeTable:
- * @buf: the XML buffer output
- * @table: An attribute table
+ * @param buf the XML buffer output
+ * @param table An attribute table
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This will dump the content of the attribute table as an XML DTD definition
*/
@@ -2045,8 +2008,7 @@ xmlDumpAttributeTable(xmlBufferPtr buf, xmlAttributeTablePtr table) {
* *
************************************************************************/
/**
- * xmlFreeNotation:
- * @nota: A notation
+ * @param nota A notation
*
* Deallocate the memory used by an notation definition
*/
@@ -2064,18 +2026,17 @@ xmlFreeNotation(xmlNotationPtr nota) {
/**
- * xmlAddNotationDecl:
- * @dtd: pointer to the DTD
- * @ctxt: the validation context
- * @name: the entity name
- * @PublicID: the public identifier or NULL
- * @SystemID: the system identifier or NULL
+ * @param dtd pointer to the DTD
+ * @param ctxt the validation context
+ * @param name the entity name
+ * @param PublicID the public identifier or NULL
+ * @param SystemID the system identifier or NULL
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Register a new notation declaration
*
- * Returns NULL if not, otherwise the entity
+ * @returns NULL if not, otherwise the entity
*/
xmlNotationPtr
xmlAddNotationDecl(xmlValidCtxtPtr ctxt, xmlDtdPtr dtd,
@@ -2161,10 +2122,9 @@ xmlFreeNotationTableEntry(void *nota, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlFreeNotationTable:
- * @table: An notation table
+ * @param table An notation table
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Deallocate the memory used by an entities hash table.
*/
@@ -2174,13 +2134,12 @@ xmlFreeNotationTable(xmlNotationTablePtr table) {
}
/**
- * xmlCopyNotation:
- * @payload: a notation
- * @name: unused
+ * @param payload a notation
+ * @param name unused
*
* Build a copy of a notation.
*
- * Returns the new xmlNotationPtr or NULL in case of error.
+ * @returns the new xmlNotationPtr or NULL in case of error.
*/
static void *
xmlCopyNotation(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
@@ -2214,14 +2173,13 @@ error:
}
/**
- * xmlCopyNotationTable:
- * @table: A notation table
+ * @param table A notation table
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Build a copy of a notation table.
*
- * Returns the new xmlNotationTablePtr or NULL in case of error.
+ * @returns the new xmlNotationTablePtr or NULL in case of error.
*/
xmlNotationTablePtr
xmlCopyNotationTable(xmlNotationTablePtr table) {
@@ -2230,11 +2188,10 @@ xmlCopyNotationTable(xmlNotationTablePtr table) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlDumpNotationDecl:
- * @buf: the XML buffer output
- * @nota: A notation declaration
+ * @param buf the XML buffer output
+ * @param nota A notation declaration
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This will dump the content the notation declaration as an XML DTD definition
*/
@@ -2252,11 +2209,10 @@ xmlDumpNotationDecl(xmlBufferPtr buf, xmlNotationPtr nota) {
}
/**
- * xmlDumpNotationTable:
- * @buf: the XML buffer output
- * @table: A notation table
+ * @param buf the XML buffer output
+ * @param table A notation table
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* This will dump the content of the notation table as an XML DTD definition
*/
@@ -2281,7 +2237,7 @@ xmlDumpNotationTable(xmlBufferPtr buf, xmlNotationTablePtr table) {
************************************************************************/
/**
* DICT_FREE:
- * @str: a string
+ * @param str a string
*
* Free a string if it is not owned by the "dict" dictionary in the
* current scope
@@ -2304,8 +2260,7 @@ xmlIsStreaming(xmlValidCtxtPtr ctxt) {
}
/**
- * xmlFreeID:
- * @id: an id
+ * @param id an id
*
* Deallocate the memory used by an id definition
*/
@@ -2332,14 +2287,13 @@ xmlFreeID(xmlIDPtr id) {
/**
- * xmlAddIDInternal:
- * @attr: the attribute holding the ID
- * @value: the attribute (ID) value
- * @idPtr: pointer to resulting ID
+ * @param attr the attribute holding the ID
+ * @param value the attribute (ID) value
+ * @param idPtr pointer to resulting ID
*
* Register a new id declaration
*
- * Returns 1 on success, 0 if the ID already exists, -1 if a memory
+ * @returns 1 on success, 0 if the ID already exists, -1 if a memory
* allocation fails.
*/
static int
@@ -2410,15 +2364,14 @@ xmlAddIDInternal(xmlAttrPtr attr, const xmlChar *value, xmlIDPtr *idPtr) {
}
/**
- * xmlAddIDSafe:
- * @attr: the attribute holding the ID
- * @value: the attribute (ID) value
+ * @param attr the attribute holding the ID
+ * @param value the attribute (ID) value
*
* Register a new id declaration
*
* Available since 2.13.0.
*
- * Returns 1 on success, 0 if the ID already exists, -1 if a memory
+ * @returns 1 on success, 0 if the ID already exists, -1 if a memory
* allocation fails.
*/
int
@@ -2427,15 +2380,14 @@ xmlAddIDSafe(xmlAttrPtr attr, const xmlChar *value) {
}
/**
- * xmlAddID:
- * @ctxt: the validation context
- * @doc: pointer to the document
- * @value: the value name
- * @attr: the attribute holding the ID
+ * @param ctxt the validation context
+ * @param doc pointer to the document
+ * @param value the value name
+ * @param attr the attribute holding the ID
*
* Register a new id declaration
*
- * Returns NULL if not, otherwise the new xmlIDPtr
+ * @returns NULL if not, otherwise the new xmlIDPtr
*/
xmlIDPtr
xmlAddID(xmlValidCtxtPtr ctxt, xmlDocPtr doc, const xmlChar *value,
@@ -2471,8 +2423,7 @@ xmlFreeIDTableEntry(void *id, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlFreeIDTable:
- * @table: An id table
+ * @param table An id table
*
* Deallocate the memory used by an ID hash table.
*/
@@ -2482,17 +2433,16 @@ xmlFreeIDTable(xmlIDTablePtr table) {
}
/**
- * xmlIsID:
- * @doc: the document
- * @elem: the element carrying the attribute
- * @attr: the attribute
+ * @param doc the document
+ * @param elem the element carrying the attribute
+ * @param attr the attribute
*
* Determine whether an attribute is of type ID. In case we have DTD(s)
* then this is done if DTD loading has been requested. In the case
* of HTML documents parsed with the HTML parser, then ID detection is
* done systematically.
*
- * Returns 0 or 1 depending on the lookup result or -1 if a memory allocation
+ * @returns 0 or 1 depending on the lookup result or -1 if a memory allocation
* failed.
*/
int
@@ -2557,13 +2507,12 @@ xmlIsID(xmlDocPtr doc, xmlNodePtr elem, xmlAttrPtr attr) {
}
/**
- * xmlRemoveID:
- * @doc: the document
- * @attr: the attribute
+ * @param doc the document
+ * @param attr the attribute
*
* Remove the given attribute from the ID table maintained internally.
*
- * Returns -1 if the lookup failed and 0 otherwise
+ * @returns -1 if the lookup failed and 0 otherwise
*/
int
xmlRemoveID(xmlDocPtr doc, xmlAttrPtr attr) {
@@ -2583,13 +2532,12 @@ xmlRemoveID(xmlDocPtr doc, xmlAttrPtr attr) {
}
/**
- * xmlGetID:
- * @doc: pointer to the document
- * @ID: the ID value
+ * @param doc pointer to the document
+ * @param ID the ID value
*
* Search the attribute declaring the given ID
*
- * Returns NULL if not found, otherwise the xmlAttrPtr defining the ID
+ * @returns NULL if not found, otherwise the xmlAttrPtr defining the ID
*/
xmlAttrPtr
xmlGetID(xmlDocPtr doc, const xmlChar *ID) {
@@ -2643,8 +2591,7 @@ typedef struct xmlValidateMemo_t
typedef xmlValidateMemo *xmlValidateMemoPtr;
/**
- * xmlFreeRef:
- * @lk: A list link
+ * @param lk A list link
*
* Deallocate the memory used by a ref definition
*/
@@ -2660,9 +2607,8 @@ xmlFreeRef(xmlLinkPtr lk) {
}
/**
- * xmlFreeRefTableEntry:
- * @payload: A list of references.
- * @name: unused
+ * @param payload A list of references.
+ * @param name unused
*
* Deallocate the memory used by a list of references
*/
@@ -2674,11 +2620,10 @@ xmlFreeRefTableEntry(void *payload, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlWalkRemoveRef:
- * @data: Contents of current link
- * @user: Value supplied by the user
+ * @param data Contents of current link
+ * @param user Value supplied by the user
*
- * Returns 0 to abort the walk or 1 to continue
+ * @returns 0 to abort the walk or 1 to continue
*/
static int
xmlWalkRemoveRef(const void *data, void *user)
@@ -2696,8 +2641,8 @@ xmlWalkRemoveRef(const void *data, void *user)
/**
* xmlDummyCompare
- * @data0: Value supplied by the user
- * @data1: Value supplied by the user
+ * @param data0 Value supplied by the user
+ * @param data1 Value supplied by the user
*
* Do nothing, return 0. Used to create unordered lists.
*/
@@ -2709,17 +2654,16 @@ xmlDummyCompare(const void *data0 ATTRIBUTE_UNUSED,
}
/**
- * xmlAddRef:
- * @ctxt: the validation context
- * @doc: pointer to the document
- * @value: the value name
- * @attr: the attribute holding the Ref
+ * @param ctxt the validation context
+ * @param doc pointer to the document
+ * @param value the value name
+ * @param attr the attribute holding the Ref
*
- * DEPRECATED, do not use. This function will be removed from the public API.
+ * @deprecated, do not use. This function will be removed from the public API.
*
* Register a new ref declaration
*
- * Returns NULL if not, otherwise the new xmlRefPtr
+ * @returns NULL if not, otherwise the new xmlRefPtr
*/
xmlRefPtr
xmlAddRef(xmlValidCtxtPtr ctxt, xmlDocPtr doc, const xmlChar *value,
@@ -2810,10 +2754,9 @@ failed:
}
/**
- * xmlFreeRefTable:
- * @table: An ref table
+ * @param table An ref table
*
- * DEPRECATED, do not use. This function will be removed from the public API.
+ * @deprecated, do not use. This function will be removed from the public API.
*
* Deallocate the memory used by an Ref hash table.
*/
@@ -2823,18 +2766,17 @@ xmlFreeRefTable(xmlRefTablePtr table) {
}
/**
- * xmlIsRef:
- * @doc: the document
- * @elem: the element carrying the attribute
- * @attr: the attribute
+ * @param doc the document
+ * @param elem the element carrying the attribute
+ * @param attr the attribute
*
- * DEPRECATED, do not use. This function will be removed from the public API.
+ * @deprecated, do not use. This function will be removed from the public API.
*
* Determine whether an attribute is of type Ref. In case we have DTD(s)
* then this is simple, otherwise we use an heuristic: name Ref (upper
* or lowercase).
*
- * Returns 0 or 1 depending on the lookup result
+ * @returns 0 or 1 depending on the lookup result
*/
int
xmlIsRef(xmlDocPtr doc, xmlNodePtr elem, xmlAttrPtr attr) {
@@ -2871,15 +2813,14 @@ xmlIsRef(xmlDocPtr doc, xmlNodePtr elem, xmlAttrPtr attr) {
}
/**
- * xmlRemoveRef:
- * @doc: the document
- * @attr: the attribute
+ * @param doc the document
+ * @param attr the attribute
*
- * DEPRECATED, do not use. This function will be removed from the public API.
+ * @deprecated, do not use. This function will be removed from the public API.
*
* Remove the given attribute from the Ref table maintained internally.
*
- * Returns -1 if the lookup failed and 0 otherwise
+ * @returns -1 if the lookup failed and 0 otherwise
*/
int
xmlRemoveRef(xmlDocPtr doc, xmlAttrPtr attr) {
@@ -2929,15 +2870,14 @@ xmlRemoveRef(xmlDocPtr doc, xmlAttrPtr attr) {
}
/**
- * xmlGetRefs:
- * @doc: pointer to the document
- * @ID: the ID value
+ * @param doc pointer to the document
+ * @param ID the ID value
*
- * DEPRECATED, do not use. This function will be removed from the public API.
+ * @deprecated, do not use. This function will be removed from the public API.
*
* Find the set of references for the supplied ID.
*
- * Returns NULL if not found, otherwise node set for the ID.
+ * @returns NULL if not found, otherwise node set for the ID.
*/
xmlListPtr
xmlGetRefs(xmlDocPtr doc, const xmlChar *ID) {
@@ -2965,15 +2905,14 @@ xmlGetRefs(xmlDocPtr doc, const xmlChar *ID) {
************************************************************************/
/**
- * xmlGetDtdElementDesc:
- * @dtd: a pointer to the DtD to search
- * @name: the element name
+ * @param dtd a pointer to the DtD to search
+ * @param name the element name
*
* Search the DTD for the description of this element
*
* NOTE: A NULL return value can also mean that a memory allocation failed.
*
- * returns the xmlElementPtr if found or NULL
+ * @returns the xmlElementPtr if found or NULL
*/
xmlElementPtr
@@ -3001,14 +2940,13 @@ xmlGetDtdElementDesc(xmlDtdPtr dtd, const xmlChar *name) {
}
/**
- * xmlGetDtdElementDesc2:
- * @ctxt: a validation context
- * @dtd: a pointer to the DtD to search
- * @name: the element name
+ * @param ctxt a validation context
+ * @param dtd a pointer to the DtD to search
+ * @param name the element name
*
* Search the DTD for the description of this element
*
- * returns the xmlElementPtr if found or NULL
+ * @returns the xmlElementPtr if found or NULL
*/
static xmlElementPtr
@@ -3073,14 +3011,13 @@ mem_error:
}
/**
- * xmlGetDtdQElementDesc:
- * @dtd: a pointer to the DtD to search
- * @name: the element name
- * @prefix: the element namespace prefix
+ * @param dtd a pointer to the DtD to search
+ * @param name the element name
+ * @param prefix the element namespace prefix
*
* Search the DTD for the description of this element
*
- * returns the xmlElementPtr if found or NULL
+ * @returns the xmlElementPtr if found or NULL
*/
xmlElementPtr
@@ -3096,15 +3033,14 @@ xmlGetDtdQElementDesc(xmlDtdPtr dtd, const xmlChar *name,
}
/**
- * xmlGetDtdAttrDesc:
- * @dtd: a pointer to the DtD to search
- * @elem: the element name
- * @name: the attribute name
+ * @param dtd a pointer to the DtD to search
+ * @param elem the element name
+ * @param name the attribute name
*
* Search the DTD for the description of this attribute on
* this element.
*
- * returns the xmlAttributePtr if found or NULL
+ * @returns the xmlAttributePtr if found or NULL
*/
xmlAttributePtr
@@ -3132,16 +3068,15 @@ xmlGetDtdAttrDesc(xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name) {
}
/**
- * xmlGetDtdQAttrDesc:
- * @dtd: a pointer to the DtD to search
- * @elem: the element name
- * @name: the attribute name
- * @prefix: the attribute namespace prefix
+ * @param dtd a pointer to the DtD to search
+ * @param elem the element name
+ * @param name the attribute name
+ * @param prefix the attribute namespace prefix
*
* Search the DTD for the description of this qualified attribute on
* this element.
*
- * returns the xmlAttributePtr if found or NULL
+ * @returns the xmlAttributePtr if found or NULL
*/
xmlAttributePtr
@@ -3157,13 +3092,12 @@ xmlGetDtdQAttrDesc(xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name,
}
/**
- * xmlGetDtdNotationDesc:
- * @dtd: a pointer to the DtD to search
- * @name: the notation name
+ * @param dtd a pointer to the DtD to search
+ * @param name the notation name
*
* Search the DTD for the description of this notation
*
- * returns the xmlNotationPtr if found or NULL
+ * @returns the xmlNotationPtr if found or NULL
*/
xmlNotationPtr
@@ -3179,17 +3113,16 @@ xmlGetDtdNotationDesc(xmlDtdPtr dtd, const xmlChar *name) {
#ifdef LIBXML_VALID_ENABLED
/**
- * xmlValidateNotationUse:
- * @ctxt: the validation context
- * @doc: the document
- * @notationName: the notation name to check
+ * @param ctxt the validation context
+ * @param doc the document
+ * @param notationName the notation name to check
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Validate that the given name match a notation declaration.
* - [ VC: Notation Declared ]
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -3214,14 +3147,13 @@ xmlValidateNotationUse(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
#endif /* LIBXML_VALID_ENABLED */
/**
- * xmlIsMixedElement:
- * @doc: the document
- * @name: the element name
+ * @param doc the document
+ * @param name the element name
*
* Search in the DtDs whether an element accept Mixed content (or ANY)
* basically if it is supposed to accept text childs
*
- * returns 0 if no, 1 if yes, and -1 if no element description is available
+ * @returns 0 if no, 1 if yes, and -1 if no element description is available
*/
int
@@ -3254,8 +3186,7 @@ xmlIsMixedElement(xmlDocPtr doc, const xmlChar *name) {
#ifdef LIBXML_VALID_ENABLED
/**
- * xmlValidNormalizeString:
- * @str: a string
+ * @param str a string
*
* Normalize a string in-place.
*/
@@ -3351,13 +3282,12 @@ xmlIsDocNameChar(xmlDocPtr doc, int c) {
}
/**
- * xmlValidateNameValue:
- * @doc: pointer to the document or NULL
- * @value: an Name value
+ * @param doc pointer to the document or NULL
+ * @param value an Name value
*
* Validate that the given value match Name production
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
@@ -3385,12 +3315,11 @@ xmlValidateNameValueInternal(xmlDocPtr doc, const xmlChar *value) {
}
/**
- * xmlValidateNameValue:
- * @value: an Name value
+ * @param value an Name value
*
* Validate that the given value match Name production
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -3399,13 +3328,12 @@ xmlValidateNameValue(const xmlChar *value) {
}
/**
- * xmlValidateNamesValueInternal:
- * @doc: pointer to the document or NULL
- * @value: an Names value
+ * @param doc pointer to the document or NULL
+ * @param value an Names value
*
* Validate that the given value match Names production
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
@@ -3453,12 +3381,11 @@ xmlValidateNamesValueInternal(xmlDocPtr doc, const xmlChar *value) {
}
/**
- * xmlValidateNamesValue:
- * @value: an Names value
+ * @param value an Names value
*
* Validate that the given value match Names production
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -3467,15 +3394,14 @@ xmlValidateNamesValue(const xmlChar *value) {
}
/**
- * xmlValidateNmtokenValueInternal:
- * @doc: pointer to the document or NULL
- * @value: an Nmtoken value
+ * @param doc pointer to the document or NULL
+ * @param value an Nmtoken value
*
* Validate that the given value match Nmtoken production
*
* [ VC: Name Token ]
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
@@ -3504,14 +3430,13 @@ xmlValidateNmtokenValueInternal(xmlDocPtr doc, const xmlChar *value) {
}
/**
- * xmlValidateNmtokenValue:
- * @value: an Nmtoken value
+ * @param value an Nmtoken value
*
* Validate that the given value match Nmtoken production
*
* [ VC: Name Token ]
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -3520,15 +3445,14 @@ xmlValidateNmtokenValue(const xmlChar *value) {
}
/**
- * xmlValidateNmtokensValueInternal:
- * @doc: pointer to the document or NULL
- * @value: an Nmtokens value
+ * @param doc pointer to the document or NULL
+ * @param value an Nmtokens value
*
* Validate that the given value match Nmtokens production
*
* [ VC: Name Token ]
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
@@ -3580,14 +3504,13 @@ xmlValidateNmtokensValueInternal(xmlDocPtr doc, const xmlChar *value) {
}
/**
- * xmlValidateNmtokensValue:
- * @value: an Nmtokens value
+ * @param value an Nmtokens value
*
* Validate that the given value match Nmtokens production
*
* [ VC: Name Token ]
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -3596,12 +3519,11 @@ xmlValidateNmtokensValue(const xmlChar *value) {
}
/**
- * xmlValidateNotationDecl:
- * @ctxt: the validation context
- * @doc: a document instance
- * @nota: a notation definition
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param nota a notation definition
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a single notation definition
* basically it does the following checks as described by the
@@ -3609,7 +3531,7 @@ xmlValidateNmtokensValue(const xmlChar *value) {
* - it seems that no validity constraint exists on notation declarations
* But this function get called anyway ...
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -3621,14 +3543,13 @@ xmlValidateNotationDecl(xmlValidCtxtPtr ctxt ATTRIBUTE_UNUSED, xmlDocPtr doc ATT
}
/**
- * xmlValidateAttributeValueInternal:
- * @doc: the document
- * @type: an attribute type
- * @value: an attribute value
+ * @param doc the document
+ * @param type an attribute type
+ * @param value an attribute value
*
* Validate that the given attribute value match the proper production
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
@@ -3655,11 +3576,10 @@ xmlValidateAttributeValueInternal(xmlDocPtr doc, xmlAttributeType type,
}
/**
- * xmlValidateAttributeValue:
- * @type: an attribute type
- * @value: an attribute value
+ * @param type an attribute type
+ * @param value an attribute value
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Validate that the given attribute value match the proper production
*
@@ -3678,7 +3598,7 @@ xmlValidateAttributeValueInternal(xmlDocPtr doc, xmlAttributeType type,
* Values of type NMTOKEN must match the Nmtoken production; values
* of type NMTOKENS must match Nmtokens.
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
xmlValidateAttributeValue(xmlAttributeType type, const xmlChar *value) {
@@ -3686,12 +3606,11 @@ xmlValidateAttributeValue(xmlAttributeType type, const xmlChar *value) {
}
/**
- * xmlValidateAttributeValue2:
- * @ctxt: the validation context
- * @doc: the document
- * @name: the attribute name (used for error reporting only)
- * @type: the attribute type
- * @value: the attribute value
+ * @param ctxt the validation context
+ * @param doc the document
+ * @param name the attribute name (used for error reporting only)
+ * @param type the attribute type
+ * @param value the attribute value
*
* Validate that the given attribute value match a given type.
* This typically cannot be done before having finished parsing
@@ -3711,7 +3630,7 @@ xmlValidateAttributeValue(xmlAttributeType type, const xmlChar *value) {
* [ VC: Notation Attributes ]
* all notation names in the declaration must be declared.
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
@@ -3809,27 +3728,26 @@ xmlValidateAttributeValue2(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
}
/**
- * xmlValidCtxtNormalizeAttributeValue:
- * @ctxt: the validation context
- * @doc: the document
- * @elem: the parent
- * @name: the attribute name
- * @value: the attribute value
+ * @param ctxt the validation context
+ * @param doc the document
+ * @param elem the parent
+ * @param name the attribute name
+ * @param value the attribute value
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Does the validation related extra step of the normalization of attribute
* values:
*
* If the declared value is not CDATA, then the XML processor must further
* process the normalized attribute value by discarding any leading and
- * trailing space (#x20) characters, and by replacing sequences of space
- * (#x20) characters by single space (#x20) character.
+ * trailing space (\#x20) characters, and by replacing sequences of space
+ * (\#x20) characters by single space (\#x20) character.
*
* Also check VC: Standalone Document Declaration in P32, and update
* ctxt->valid accordingly
*
- * returns a new normalized string if normalization is needed, NULL otherwise
+ * @returns a new normalized string if normalization is needed, NULL otherwise
* the caller must free the returned value.
*/
@@ -3908,23 +3826,22 @@ done:
}
/**
- * xmlValidNormalizeAttributeValue:
- * @doc: the document
- * @elem: the parent
- * @name: the attribute name
- * @value: the attribute value
+ * @param doc the document
+ * @param elem the parent
+ * @param name the attribute name
+ * @param value the attribute value
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Does the validation related extra step of the normalization of attribute
* values:
*
* If the declared value is not CDATA, then the XML processor must further
* process the normalized attribute value by discarding any leading and
- * trailing space (#x20) characters, and by replacing sequences of space
- * (#x20) characters by single space (#x20) character.
+ * trailing space (\#x20) characters, and by replacing sequences of space
+ * (\#x20) characters by single space (\#x20) character.
*
- * Returns a new normalized string if normalization is needed, NULL otherwise
+ * @returns a new normalized string if normalization is needed, NULL otherwise
* the caller must free the returned value.
*/
@@ -3974,12 +3891,11 @@ xmlValidateAttributeIdCallback(void *payload, void *data,
}
/**
- * xmlValidateAttributeDecl:
- * @ctxt: the validation context
- * @doc: a document instance
- * @attr: an attribute definition
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param attr an attribute definition
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a single attribute definition
* basically it does the following checks as described by the
@@ -3990,7 +3906,7 @@ xmlValidateAttributeIdCallback(void *payload, void *data,
*
* The ID/IDREF uniqueness and matching are done separately
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -4105,12 +4021,11 @@ xmlValidateAttributeDecl(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
}
/**
- * xmlValidateElementDecl:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element definition
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element definition
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a single element definition
* basically it does the following checks as described by the
@@ -4119,7 +4034,7 @@ xmlValidateAttributeDecl(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
* - [ VC: No Duplicate Types ]
* - [ VC: Unique Element Type Declaration ]
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -4230,14 +4145,13 @@ xmlValidateElementDecl(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
}
/**
- * xmlValidateOneAttribute:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
- * @attr: an attribute instance
- * @value: the attribute value (without entities processing)
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
+ * @param attr an attribute instance
+ * @param value the attribute value (without entities processing)
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a single attribute for an element
* basically it does the following checks as described by the
@@ -4253,7 +4167,7 @@ xmlValidateElementDecl(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
*
* The ID/IDREF uniqueness and matching are done separately
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -4400,15 +4314,14 @@ xmlValidateOneAttribute(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
}
/**
- * xmlValidateOneNamespace:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
- * @prefix: the namespace prefix
- * @ns: an namespace declaration instance
- * @value: the attribute value (without entities processing)
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
+ * @param prefix the namespace prefix
+ * @param ns an namespace declaration instance
+ * @param value the attribute value (without entities processing)
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a single namespace declaration for an element
* basically it does the following checks as described by the
@@ -4424,7 +4337,7 @@ xmlValidateOneAttribute(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
*
* The ID/IDREF uniqueness and matching are done separately
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -4617,13 +4530,12 @@ xmlNodePtr elem, const xmlChar *prefix, xmlNsPtr ns, const xmlChar *value) {
#ifndef LIBXML_REGEXP_ENABLED
/**
- * xmlValidateSkipIgnorable:
- * @ctxt: the validation context
- * @child: the child list
+ * @param ctxt the validation context
+ * @param child the child list
*
* Skip ignorable elements w.r.t. the validation process
*
- * returns the first element to consider for validation of the content model
+ * @returns the first element to consider for validation of the content model
*/
static xmlNodePtr
@@ -4652,12 +4564,11 @@ xmlValidateSkipIgnorable(xmlNodePtr child) {
}
/**
- * xmlValidateElementType:
- * @ctxt: the validation context
+ * @param ctxt the validation context
*
* Try to validate the content model of an element internal function
*
- * returns 1 if valid or 0 ,-1 in case of error, -2 if an entity
+ * @returns 1 if valid or 0 ,-1 in case of error, -2 if an entity
* reference is found and -3 if the validation succeeded but
* the content model is not determinist.
*/
@@ -4980,11 +4891,10 @@ analyze:
#endif
/**
- * xmlSnprintfElements:
- * @buf: an output buffer
- * @size: the size of the buffer
- * @node: an element
- * @glob: 1 if one must print the englobing parenthesis, 0 otherwise
+ * @param buf an output buffer
+ * @param size the size of the buffer
+ * @param node an element
+ * @param glob 1 if one must print the englobing parenthesis, 0 otherwise
*
* This will dump the list of elements to the buffer
* Intended just for the debug routine
@@ -5063,16 +4973,15 @@ xmlSnprintfElements(char *buf, int size, xmlNodePtr node, int glob) {
}
/**
- * xmlValidateElementContent:
- * @ctxt: the validation context
- * @child: the child list
- * @elemDecl: pointer to the element declaration
- * @warn: emit the error message
- * @parent: the parent element (for error reporting)
+ * @param ctxt the validation context
+ * @param child the child list
+ * @param elemDecl pointer to the element declaration
+ * @param warn emit the error message
+ * @param parent the parent element (for error reporting)
*
* Try to validate the content model of an element
*
- * returns 1 if valid or 0 if not and -1 in case of error
+ * @returns 1 if valid or 0 if not and -1 in case of error
*/
static int
@@ -5371,14 +5280,13 @@ done:
}
/**
- * xmlValidateCdataElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
*
- * Check that an element follows #CDATA
+ * Check that an element follows \#CDATA
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
xmlValidateOneCdataElement(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
@@ -5442,14 +5350,13 @@ done:
#ifdef LIBXML_REGEXP_ENABLED
/**
- * xmlValidateCheckMixed:
- * @ctxt: the validation context
- * @cont: the mixed content model
- * @qname: the qualified name as appearing in the serialization
+ * @param ctxt the validation context
+ * @param cont the mixed content model
+ * @param qname the qualified name as appearing in the serialization
*
* Check if the given node is part of the content model.
*
- * Returns 1 if yes, 0 if no, -1 in case of error
+ * @returns 1 if yes, 0 if no, -1 in case of error
*/
static int
xmlValidateCheckMixed(xmlValidCtxtPtr ctxt,
@@ -5509,16 +5416,15 @@ xmlValidateCheckMixed(xmlValidCtxtPtr ctxt,
#endif /* LIBXML_REGEXP_ENABLED */
/**
- * xmlValidGetElemDecl:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
- * @extsubset: pointer, (out) indicate if the declaration was found
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
+ * @param extsubset pointer, (out) indicate if the declaration was found
* in the external subset.
*
* Finds a declaration associated to an element in the document.
*
- * returns the pointer to the declaration or NULL if not found.
+ * @returns the pointer to the declaration or NULL if not found.
*/
static xmlElementPtr
xmlValidGetElemDecl(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
@@ -5573,17 +5479,16 @@ xmlValidGetElemDecl(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
#ifdef LIBXML_REGEXP_ENABLED
/**
- * xmlValidatePushElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
- * @qname: the qualified name as appearing in the serialization
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
+ * @param qname the qualified name as appearing in the serialization
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Push a new element start on the validation stack.
*
- * returns 1 if no validation problem was found or 0 otherwise
+ * @returns 1 if no validation problem was found or 0 otherwise
*/
int
xmlValidatePushElement(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
@@ -5673,16 +5578,15 @@ xmlValidatePushElement(xmlValidCtxtPtr ctxt, xmlDocPtr doc,
}
/**
- * xmlValidatePushCData:
- * @ctxt: the validation context
- * @data: some character data read
- * @len: the length of the data
+ * @param ctxt the validation context
+ * @param data some character data read
+ * @param len the length of the data
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* check the CData parsed for validation in the current stack
*
- * returns 1 if no validation problem was found or 0 otherwise
+ * @returns 1 if no validation problem was found or 0 otherwise
*/
int
xmlValidatePushCData(xmlValidCtxtPtr ctxt, const xmlChar *data, int len) {
@@ -5746,17 +5650,16 @@ done:
}
/**
- * xmlValidatePopElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
- * @qname: the qualified name as appearing in the serialization
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
+ * @param qname the qualified name as appearing in the serialization
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Pop the element end from the validation stack.
*
- * returns 1 if no validation problem was found or 0 otherwise
+ * @returns 1 if no validation problem was found or 0 otherwise
*/
int
xmlValidatePopElement(xmlValidCtxtPtr ctxt, xmlDocPtr doc ATTRIBUTE_UNUSED,
@@ -5806,12 +5709,11 @@ xmlValidatePopElement(xmlValidCtxtPtr ctxt, xmlDocPtr doc ATTRIBUTE_UNUSED,
#endif /* LIBXML_REGEXP_ENABLED */
/**
- * xmlValidateOneElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @elem: an element instance
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param elem an element instance
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a single element and it's attributes,
* basically it does the following checks as described by the
@@ -5822,7 +5724,7 @@ xmlValidatePopElement(xmlValidCtxtPtr ctxt, xmlDocPtr doc ATTRIBUTE_UNUSED,
*
* The ID/IDREF checkings are done separately
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -6137,11 +6039,10 @@ found:
}
/**
- * xmlValidateRoot:
- * @ctxt: the validation context
- * @doc: a document instance
+ * @param ctxt the validation context
+ * @param doc a document instance
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Try to validate a the root element
* basically it does the following check as described by the
@@ -6149,7 +6050,7 @@ found:
* - [ VC: Root Element Type ]
* it doesn't try to recurse or apply other check to the element
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -6206,14 +6107,13 @@ name_ok:
/**
- * xmlValidateElement:
- * @ctxt: the validation context
- * @doc: a document instance
- * @root: an element instance
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param root an element instance
*
* Try to validate the subtree under an element
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -6282,10 +6182,9 @@ done:
}
/**
- * xmlValidateRef:
- * @ref: A reference to be validated
- * @ctxt: Validation context
- * @name: Name of ID we are searching for
+ * @param ref A reference to be validated
+ * @param ctxt Validation context
+ * @param name Name of ID we are searching for
*
*/
static void
@@ -6366,11 +6265,10 @@ xmlValidateRef(xmlRefPtr ref, xmlValidCtxtPtr ctxt,
}
/**
- * xmlWalkValidateList:
- * @data: Contents of current link
- * @user: Value supplied by the user
+ * @param data Contents of current link
+ * @param user Value supplied by the user
*
- * Returns 0 to abort the walk or 1 to continue
+ * @returns 0 to abort the walk or 1 to continue
*/
static int
xmlWalkValidateList(const void *data, void *user)
@@ -6381,10 +6279,9 @@ xmlWalkValidateList(const void *data, void *user)
}
/**
- * xmlValidateCheckRefCallback:
- * @payload: list of references
- * @data: validation context
- * @name: name of ID we are searching for
+ * @param payload list of references
+ * @param data validation context
+ * @param name name of ID we are searching for
*/
static void
xmlValidateCheckRefCallback(void *payload, void *data, const xmlChar *name) {
@@ -6402,11 +6299,10 @@ xmlValidateCheckRefCallback(void *payload, void *data, const xmlChar *name) {
}
/**
- * xmlValidateDocumentFinal:
- * @ctxt: the validation context
- * @doc: a document instance
+ * @param ctxt the validation context
+ * @param doc a document instance
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Does the final step for the document validation once all the
* incremental validation steps have been completed
@@ -6415,7 +6311,7 @@ xmlValidateCheckRefCallback(void *payload, void *data, const xmlChar *name) {
*
* Check all the IDREF/IDREFS attributes definition for validity
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -6463,10 +6359,9 @@ xmlValidateDocumentFinal(xmlValidCtxtPtr ctxt, xmlDocPtr doc) {
}
/**
- * xmlValidateDtd:
- * @ctxt: the validation context
- * @doc: a document instance
- * @dtd: a dtd instance
+ * @param ctxt the validation context
+ * @param doc a document instance
+ * @param dtd a dtd instance
*
* Try to validate the document against the dtd instance
*
@@ -6475,7 +6370,7 @@ xmlValidateDocumentFinal(xmlValidCtxtPtr ctxt, xmlDocPtr doc) {
* (i.e. not used), which could give problems if ID or IDREF
* is present.
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
@@ -6524,10 +6419,9 @@ xmlValidateDtd(xmlValidCtxtPtr ctxt, xmlDocPtr doc, xmlDtdPtr dtd) {
}
/**
- * xmlCtxtValidateDtd:
- * @ctxt: a parser context
- * @doc: a document instance
- * @dtd: a dtd instance
+ * @param ctxt a parser context
+ * @param doc a document instance
+ * @param dtd a dtd instance
*
* Validate a document against a DTD.
*
@@ -6535,7 +6429,7 @@ xmlValidateDtd(xmlValidCtxtPtr ctxt, xmlDocPtr doc, xmlDtdPtr dtd) {
*
* Availabe since 2.14.0.
*
- * Returns 1 if valid or 0 otherwise.
+ * @returns 1 if valid or 0 otherwise.
*/
int
xmlCtxtValidateDtd(xmlParserCtxtPtr ctxt, xmlDocPtr doc, xmlDtdPtr dtd) {
@@ -6656,11 +6550,10 @@ xmlValidateAttributeCallback(void *payload, void *data,
}
/**
- * xmlValidateDtdFinal:
- * @ctxt: the validation context
- * @doc: a document instance
+ * @param ctxt the validation context
+ * @param doc a document instance
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Does the final step for the dtds validation once all the
* subsets have been parsed
@@ -6671,7 +6564,7 @@ xmlValidateAttributeCallback(void *payload, void *data,
* - check that NOTATION type attributes default or
* possible values matches one of the defined notations.
*
- * returns 1 if valid or 0 if invalid and -1 if not well-formed
+ * @returns 1 if valid or 0 if invalid and -1 if not well-formed
*/
int
@@ -6707,14 +6600,13 @@ xmlValidateDtdFinal(xmlValidCtxtPtr ctxt, xmlDocPtr doc) {
}
/**
- * xmlValidateDocumentInternal:
- * @ctxt: parser context (optional)
- * @vctxt: validation context (optional)
- * @doc: document
+ * @param ctxt parser context (optional)
+ * @param vctxt validation context (optional)
+ * @param doc document
*
* Validate a document.
*
- * Returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
static int
xmlValidateDocumentInternal(xmlParserCtxtPtr ctxt, xmlValidCtxtPtr vctxt,
@@ -6801,11 +6693,10 @@ xmlValidateDocumentInternal(xmlParserCtxtPtr ctxt, xmlValidCtxtPtr vctxt,
}
/**
- * xmlValidateDocument:
- * @vctxt: the validation context
- * @doc: a document instance
+ * @param vctxt the validation context
+ * @param doc a document instance
*
- * DEPRECATED: This function can't report malloc or other failures.
+ * @deprecated This function can't report malloc or other failures.
* Use xmlCtxtValidateDocument.
*
* Try to validate the document instance
@@ -6814,7 +6705,7 @@ xmlValidateDocumentInternal(xmlParserCtxtPtr ctxt, xmlValidCtxtPtr vctxt,
* i.e. validates the internal and external subset (if present)
* and validate the document tree.
*
- * returns 1 if valid or 0 otherwise
+ * @returns 1 if valid or 0 otherwise
*/
int
xmlValidateDocument(xmlValidCtxtPtr vctxt, xmlDocPtr doc) {
@@ -6822,9 +6713,8 @@ xmlValidateDocument(xmlValidCtxtPtr vctxt, xmlDocPtr doc) {
}
/**
- * xmlCtxtValidateDocument:
- * @ctxt: a parser context
- * @doc: a document instance
+ * @param ctxt a parser context
+ * @param doc a document instance
*
* Validate a document.
*
@@ -6835,7 +6725,7 @@ xmlValidateDocument(xmlValidCtxtPtr vctxt, xmlDocPtr doc) {
*
* Availabe since 2.14.0.
*
- * Returns 1 if valid or 0 otherwise.
+ * @returns 1 if valid or 0 otherwise.
*/
int
xmlCtxtValidateDocument(xmlParserCtxtPtr ctxt, xmlDocPtr doc) {
@@ -6854,15 +6744,14 @@ xmlCtxtValidateDocument(xmlParserCtxtPtr ctxt, xmlDocPtr doc) {
************************************************************************/
/**
- * xmlValidGetPotentialChildren:
- * @ctree: an element content tree
- * @names: an array to store the list of child names
- * @len: a pointer to the number of element in the list
- * @max: the size of the array
+ * @param ctree an element content tree
+ * @param names an array to store the list of child names
+ * @param len a pointer to the number of element in the list
+ * @param max the size of the array
*
* Build/extend a list of potential children allowed by the content tree
*
- * returns the number of element in the list, or -1 in case of error.
+ * @returns the number of element in the list, or -1 in case of error.
*/
int
@@ -6907,16 +6796,15 @@ static void xmlNoValidityErr(void *ctx ATTRIBUTE_UNUSED,
}
/**
- * xmlValidGetValidElements:
- * @prev: an element to insert after
- * @next: an element to insert next
- * @names: an array to store the list of child names
- * @max: the size of the array
+ * @param prev an element to insert after
+ * @param next an element to insert next
+ * @param names an array to store the list of child names
+ * @param max the size of the array
*
* This function returns the list of authorized children to insert
* within an existing tree while respecting the validity constraints
- * forced by the Dtd. The insertion point is defined using @prev and
- * @next in the following ways:
+ * forced by the Dtd. The insertion point is defined using `prev` and
+ * `next` in the following ways:
* to insert before 'node': xmlValidGetValidElements(node->prev, node, ...
* to insert next 'node': xmlValidGetValidElements(node, node->next, ...
* to replace 'node': xmlValidGetValidElements(node->prev, node->next, ...
@@ -6926,8 +6814,8 @@ static void xmlNoValidityErr(void *ctx ATTRIBUTE_UNUSED,
* pointers to the element names are inserted at the beginning of the array
* and do not need to be freed.
*
- * returns the number of element in the list, or -1 in case of error. If
- * the function returns the value @max the caller is invited to grow the
+ * @returns the number of element in the list, or -1 in case of error. If
+ * the function returns the value `max` the caller is invited to grow the
* receiving array and retry.
*/
diff --git a/xinclude.c b/xinclude.c
index 73b94916..b7782ada 100644
--- a/xinclude.c
+++ b/xinclude.c
@@ -131,8 +131,7 @@ xmlXIncludeDoProcess(xmlXIncludeCtxtPtr ctxt, xmlNodePtr tree);
************************************************************************/
/**
- * xmlXIncludeErrMemory:
- * @ctxt: an XInclude context
+ * @param ctxt an XInclude context
*
* Handle an out of memory condition
*/
@@ -148,12 +147,11 @@ xmlXIncludeErrMemory(xmlXIncludeCtxtPtr ctxt)
}
/**
- * xmlXIncludeErr:
- * @ctxt: the XInclude context
- * @node: the context node
- * @error: the error code
- * @msg: the error message
- * @extra: extra information
+ * @param ctxt the XInclude context
+ * @param node the context node
+ * @param error the error code
+ * @param msg the error message
+ * @param extra extra information
*
* Handle an XInclude error
*/
@@ -204,14 +202,13 @@ xmlXIncludeErr(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node, int error,
}
/**
- * xmlXIncludeGetProp:
- * @ctxt: the XInclude context
- * @cur: the node
- * @name: the attribute name
+ * @param ctxt the XInclude context
+ * @param cur the node
+ * @param name the attribute name
*
* Get an XInclude attribute
*
- * Returns the value (to be freed) or NULL if not found
+ * @returns the value (to be freed) or NULL if not found
*/
static xmlChar *
xmlXIncludeGetProp(xmlXIncludeCtxtPtr ctxt, xmlNodePtr cur,
@@ -235,8 +232,7 @@ xmlXIncludeGetProp(xmlXIncludeCtxtPtr ctxt, xmlNodePtr cur,
return(ret);
}
/**
- * xmlXIncludeFreeRef:
- * @ref: the XInclude reference
+ * @param ref the XInclude reference
*
* Free an XInclude reference
*/
@@ -254,12 +250,11 @@ xmlXIncludeFreeRef(xmlXIncludeRefPtr ref) {
}
/**
- * xmlXIncludeNewContext:
- * @doc: an XML Document
+ * @param doc an XML Document
*
* Creates a new XInclude context
*
- * Returns the new set
+ * @returns the new set
*/
xmlXIncludeCtxtPtr
xmlXIncludeNewContext(xmlDocPtr doc) {
@@ -280,8 +275,7 @@ xmlXIncludeNewContext(xmlDocPtr doc) {
}
/**
- * xmlXIncludeFreeContext:
- * @ctxt: the XInclude context
+ * @param ctxt the XInclude context
*
* Free an XInclude context
*/
@@ -319,9 +313,8 @@ xmlXIncludeFreeContext(xmlXIncludeCtxtPtr ctxt) {
}
/**
- * xmlXIncludeParseFile:
- * @ctxt: the XInclude context
- * @URL: the URL or file path
+ * @param ctxt the XInclude context
+ * @param URL the URL or file path
*
* parse a document for XInclude
*/
@@ -396,9 +389,8 @@ error:
}
/**
- * xmlXIncludeAddNode:
- * @ctxt: the XInclude context
- * @cur: the new node
+ * @param ctxt the XInclude context
+ * @param cur the new node
*
* Add a new node to process to an XInclude context
*/
@@ -600,9 +592,8 @@ error:
}
/**
- * xmlXIncludeRecurseDoc:
- * @ctxt: the XInclude context
- * @doc: the new document
+ * @param ctxt the XInclude context
+ * @param doc the new document
*
* The XInclude recursive nature is handled at this point.
*/
@@ -703,15 +694,14 @@ done:
}
/**
- * xmlXIncludeCopyNode:
- * @ctxt: the XInclude context
- * @elem: the element
- * @copyChildren: copy children instead of node if true
- * @targetBase: the xml:base of the target node
+ * @param ctxt the XInclude context
+ * @param elem the element
+ * @param copyChildren copy children instead of node if true
+ * @param targetBase the xml:base of the target node
*
* Make a copy of the node while expanding nested XIncludes.
*
- * Returns a node list, not a single node.
+ * @returns a node list, not a single node.
*/
static xmlNodePtr
xmlXIncludeCopyNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr elem,
@@ -826,15 +816,14 @@ error:
#ifdef LIBXML_XPTR_ENABLED
/**
- * xmlXIncludeCopyXPointer:
- * @ctxt: the XInclude context
- * @obj: the XPointer result from the evaluation.
- * @targetBase: the xml:base of the target node
+ * @param ctxt the XInclude context
+ * @param obj the XPointer result from the evaluation.
+ * @param targetBase the xml:base of the target node
*
* Build a node list tree copy of the XPointer result.
* This will drop Attributes and Namespace declarations.
*
- * Returns an xmlNodePtr list or NULL.
+ * @returns an xmlNodePtr list or NULL.
* the caller has to free the node tree.
*/
static xmlNodePtr
@@ -925,10 +914,9 @@ struct _xmlXIncludeMergeData {
};
/**
- * xmlXIncludeMergeOneEntity:
- * @payload: the entity
- * @vdata: the merge data
- * @name: unused
+ * @param payload the entity
+ * @param vdata the merge data
+ * @param name unused
*
* Implements the merge of one entity
*/
@@ -1006,14 +994,13 @@ error:
}
/**
- * xmlXIncludeMergeEntities:
- * @ctxt: an XInclude context
- * @doc: the including doc
- * @from: the included doc
+ * @param ctxt an XInclude context
+ * @param doc the including doc
+ * @param from the included doc
*
* Implements the entity merge
*
- * Returns 0 if merge succeeded, -1 if some processing failed
+ * @returns 0 if merge succeeded, -1 if some processing failed
*/
static int
xmlXIncludeMergeEntities(xmlXIncludeCtxtPtr ctxt, xmlDocPtr doc,
@@ -1069,13 +1056,12 @@ xmlXIncludeMergeEntities(xmlXIncludeCtxtPtr ctxt, xmlDocPtr doc,
}
/**
- * xmlXIncludeLoadDoc:
- * @ctxt: the XInclude context
- * @ref: an XMLXincludeRefPtr
+ * @param ctxt the XInclude context
+ * @param ref an XMLXincludeRefPtr
*
* Load the document, and store the result in the XInclude context
*
- * Returns 0 in case of success, -1 in case of failure
+ * @returns 0 in case of success, -1 in case of failure
*/
static int
xmlXIncludeLoadDoc(xmlXIncludeCtxtPtr ctxt, xmlXIncludeRefPtr ref) {
@@ -1345,13 +1331,12 @@ error:
}
/**
- * xmlXIncludeLoadTxt:
- * @ctxt: the XInclude context
- * @ref: an XMLXincludeRefPtr
+ * @param ctxt the XInclude context
+ * @param ref an XMLXincludeRefPtr
*
* Load the content, and store the result in the XInclude context
*
- * Returns 0 in case of success, -1 in case of failure
+ * @returns 0 in case of success, -1 in case of failure
*/
static int
xmlXIncludeLoadTxt(xmlXIncludeCtxtPtr ctxt, xmlXIncludeRefPtr ref) {
@@ -1543,15 +1528,14 @@ error:
}
/**
- * xmlXIncludeLoadFallback:
- * @ctxt: the XInclude context
- * @fallback: the fallback node
- * @ref: an XMLXincludeRefPtr
+ * @param ctxt the XInclude context
+ * @param fallback the fallback node
+ * @param ref an XMLXincludeRefPtr
*
* Load the content of the fallback node, and store the result
* in the XInclude context
*
- * Returns 0 in case of success, -1 in case of failure
+ * @returns 0 in case of success, -1 in case of failure
*/
static int
xmlXIncludeLoadFallback(xmlXIncludeCtxtPtr ctxt, xmlNodePtr fallback,
@@ -1585,14 +1569,13 @@ xmlXIncludeLoadFallback(xmlXIncludeCtxtPtr ctxt, xmlNodePtr fallback,
************************************************************************/
/**
- * xmlXIncludeExpandNode:
- * @ctxt: an XInclude context
- * @node: an XInclude node
+ * @param ctxt an XInclude context
+ * @param node an XInclude node
*
* If the XInclude node wasn't processed yet, create a new RefPtr,
* add it to ctxt->incTab and load the included items.
*
- * Returns the new or existing xmlXIncludeRefPtr, or NULL in case of error.
+ * @returns the new or existing xmlXIncludeRefPtr, or NULL in case of error.
*/
static xmlXIncludeRefPtr
xmlXIncludeExpandNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
@@ -1657,13 +1640,12 @@ xmlXIncludeExpandNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
}
/**
- * xmlXIncludeLoadNode:
- * @ctxt: an XInclude context
- * @ref: an xmlXIncludeRefPtr
+ * @param ctxt an XInclude context
+ * @param ref an xmlXIncludeRefPtr
*
* Find and load the infoset replacement for the given node.
*
- * Returns 0 if substitution succeeded, -1 if some processing failed
+ * @returns 0 if substitution succeeded, -1 if some processing failed
*/
static int
xmlXIncludeLoadNode(xmlXIncludeCtxtPtr ctxt, xmlXIncludeRefPtr ref) {
@@ -1712,13 +1694,12 @@ xmlXIncludeLoadNode(xmlXIncludeCtxtPtr ctxt, xmlXIncludeRefPtr ref) {
}
/**
- * xmlXIncludeIncludeNode:
- * @ctxt: an XInclude context
- * @ref: an xmlXIncludeRefPtr
+ * @param ctxt an XInclude context
+ * @param ref an xmlXIncludeRefPtr
*
* Implement the infoset replacement for the given node
*
- * Returns 0 if substitution succeeded, -1 if some processing failed
+ * @returns 0 if substitution succeeded, -1 if some processing failed
*/
static int
xmlXIncludeIncludeNode(xmlXIncludeCtxtPtr ctxt, xmlXIncludeRefPtr ref) {
@@ -1828,13 +1809,12 @@ err_memory:
}
/**
- * xmlXIncludeTestNode:
- * @ctxt: the XInclude processing context
- * @node: an XInclude node
+ * @param ctxt the XInclude processing context
+ * @param node an XInclude node
*
* test if the node is an XInclude node
*
- * Returns 1 true, 0 otherwise
+ * @returns 1 true, 0 otherwise
*/
static int
xmlXIncludeTestNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
@@ -1899,13 +1879,12 @@ xmlXIncludeTestNode(xmlXIncludeCtxtPtr ctxt, xmlNodePtr node) {
}
/**
- * xmlXIncludeDoProcess:
- * @ctxt: the XInclude processing context
- * @tree: the top of the tree to process
+ * @param ctxt the XInclude processing context
+ * @param tree the top of the tree to process
*
- * Implement the XInclude substitution on the XML document @doc
+ * Implement the XInclude substitution on the XML document `doc`
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
static int
@@ -1982,13 +1961,12 @@ xmlXIncludeDoProcess(xmlXIncludeCtxtPtr ctxt, xmlNodePtr tree) {
}
/**
- * xmlXIncludeDoProcessRoot:
- * @ctxt: the XInclude processing context
- * @tree: the top of the tree to process
+ * @param ctxt the XInclude processing context
+ * @param tree the top of the tree to process
*
- * Implement the XInclude substitution on the XML document @doc
+ * Implement the XInclude substitution on the XML document `doc`
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
static int
@@ -2002,12 +1980,11 @@ xmlXIncludeDoProcessRoot(xmlXIncludeCtxtPtr ctxt, xmlNodePtr tree) {
}
/**
- * xmlXIncludeGetLastError:
- * @ctxt: an XInclude processing context
+ * @param ctxt an XInclude processing context
*
* Available since 2.13.0.
*
- * Returns the last error code.
+ * @returns the last error code.
*/
int
xmlXIncludeGetLastError(xmlXIncludeCtxtPtr ctxt) {
@@ -2017,10 +1994,9 @@ xmlXIncludeGetLastError(xmlXIncludeCtxtPtr ctxt) {
}
/**
- * xmlXIncludeSetErrorHandler:
- * @ctxt: an XInclude processing context
- * @handler: error handler
- * @data: user data which will be passed to the handler
+ * @param ctxt an XInclude processing context
+ * @param handler error handler
+ * @param data user data which will be passed to the handler
*
* Register a callback function that will be called on errors and
* warnings. If handler is NULL, the error handler will be deactivated.
@@ -2037,10 +2013,9 @@ xmlXIncludeSetErrorHandler(xmlXIncludeCtxtPtr ctxt,
}
/**
- * xmlXIncludeSetResourceLoader:
- * @ctxt: an XInclude processing context
- * @loader: resource loader
- * @data: user data which will be passed to the loader
+ * @param ctxt an XInclude processing context
+ * @param loader resource loader
+ * @param data user data which will be passed to the loader
*
* Register a callback function that will be called to load included
* documents.
@@ -2057,13 +2032,12 @@ xmlXIncludeSetResourceLoader(xmlXIncludeCtxtPtr ctxt,
}
/**
- * xmlXIncludeSetFlags:
- * @ctxt: an XInclude processing context
- * @flags: a set of xmlParserOption used for parsing XML includes
+ * @param ctxt an XInclude processing context
+ * @param flags a set of xmlParserOption used for parsing XML includes
*
* Set the flags used for further processing of XML resources.
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlXIncludeSetFlags(xmlXIncludeCtxtPtr ctxt, int flags) {
@@ -2074,13 +2048,12 @@ xmlXIncludeSetFlags(xmlXIncludeCtxtPtr ctxt, int flags) {
}
/**
- * xmlXIncludeSetStreamingMode:
- * @ctxt: an XInclude processing context
- * @mode: whether streaming mode should be enabled
+ * @param ctxt an XInclude processing context
+ * @param mode whether streaming mode should be enabled
*
* In streaming mode, XPointer expressions aren't allowed.
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlXIncludeSetStreamingMode(xmlXIncludeCtxtPtr ctxt, int mode) {
@@ -2091,15 +2064,14 @@ xmlXIncludeSetStreamingMode(xmlXIncludeCtxtPtr ctxt, int mode) {
}
/**
- * xmlXIncludeProcessTreeFlagsData:
- * @tree: an XML node
- * @flags: a set of xmlParserOption used for parsing XML includes
- * @data: application data that will be passed to the parser context
+ * @param tree an XML node
+ * @param flags a set of xmlParserOption used for parsing XML includes
+ * @param data application data that will be passed to the parser context
* in the _private field of the parser context(s)
*
- * Implement the XInclude substitution on the XML node @tree
+ * Implement the XInclude substitution on the XML node `tree`
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
@@ -2126,15 +2098,14 @@ xmlXIncludeProcessTreeFlagsData(xmlNodePtr tree, int flags, void *data) {
}
/**
- * xmlXIncludeProcessFlagsData:
- * @doc: an XML document
- * @flags: a set of xmlParserOption used for parsing XML includes
- * @data: application data that will be passed to the parser context
+ * @param doc an XML document
+ * @param flags a set of xmlParserOption used for parsing XML includes
+ * @param data application data that will be passed to the parser context
* in the _private field of the parser context(s)
*
- * Implement the XInclude substitution on the XML document @doc
+ * Implement the XInclude substitution on the XML document `doc`
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
int
@@ -2150,13 +2121,12 @@ xmlXIncludeProcessFlagsData(xmlDocPtr doc, int flags, void *data) {
}
/**
- * xmlXIncludeProcessFlags:
- * @doc: an XML document
- * @flags: a set of xmlParserOption used for parsing XML includes
+ * @param doc an XML document
+ * @param flags a set of xmlParserOption used for parsing XML includes
*
- * Implement the XInclude substitution on the XML document @doc
+ * Implement the XInclude substitution on the XML document `doc`
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
int
@@ -2165,12 +2135,11 @@ xmlXIncludeProcessFlags(xmlDocPtr doc, int flags) {
}
/**
- * xmlXIncludeProcess:
- * @doc: an XML document
+ * @param doc an XML document
*
- * Implement the XInclude substitution on the XML document @doc
+ * Implement the XInclude substitution on the XML document `doc`
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
int
@@ -2179,13 +2148,12 @@ xmlXIncludeProcess(xmlDocPtr doc) {
}
/**
- * xmlXIncludeProcessTreeFlags:
- * @tree: a node in an XML document
- * @flags: a set of xmlParserOption used for parsing XML includes
+ * @param tree a node in an XML document
+ * @param flags a set of xmlParserOption used for parsing XML includes
*
* Implement the XInclude substitution for the given subtree
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
int
@@ -2209,12 +2177,11 @@ xmlXIncludeProcessTreeFlags(xmlNodePtr tree, int flags) {
}
/**
- * xmlXIncludeProcessTree:
- * @tree: a node in an XML document
+ * @param tree a node in an XML document
*
* Implement the XInclude substitution for the given subtree
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
int
@@ -2223,14 +2190,13 @@ xmlXIncludeProcessTree(xmlNodePtr tree) {
}
/**
- * xmlXIncludeProcessNode:
- * @ctxt: an existing XInclude context
- * @node: a node in an XML document
+ * @param ctxt an existing XInclude context
+ * @param node a node in an XML document
*
* Implement the XInclude substitution for the given subtree reusing
* the information and data coming from the given context.
*
- * Returns 0 if no substitution were done, -1 if some processing failed
+ * @returns 0 if no substitution were done, -1 if some processing failed
* or the number of substitutions done.
*/
int
diff --git a/xlink.c b/xlink.c
index 03f31b25..bdd58101 100644
--- a/xlink.c
+++ b/xlink.c
@@ -34,13 +34,12 @@ static xlinkHandlerPtr xlinkDefaultHandler = NULL;
static xlinkNodeDetectFunc xlinkDefaultDetect = NULL;
/**
- * xlinkGetDefaultHandler:
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Get the default xlink handler.
*
- * Returns the current xlinkHandlerPtr value.
+ * @returns the current xlinkHandlerPtr value.
*/
xlinkHandlerPtr
xlinkGetDefaultHandler(void) {
@@ -49,10 +48,9 @@ xlinkGetDefaultHandler(void) {
/**
- * xlinkSetDefaultHandler:
- * @handler: the new value for the xlink handler block
+ * @param handler the new value for the xlink handler block
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Set the default xlink handlers
*/
@@ -62,13 +60,12 @@ xlinkSetDefaultHandler(xlinkHandlerPtr handler) {
}
/**
- * xlinkGetDefaultDetect:
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Get the default xlink detection routine
*
- * Returns the current function or NULL;
+ * @returns the current function or NULL;
*/
xlinkNodeDetectFunc
xlinkGetDefaultDetect (void) {
@@ -76,10 +73,9 @@ xlinkGetDefaultDetect (void) {
}
/**
- * xlinkSetDefaultDetect:
- * @func: pointer to the new detection routine.
+ * @param func pointer to the new detection routine.
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Set the default xlink detection routine
*/
@@ -96,9 +92,8 @@ xlinkSetDefaultDetect (xlinkNodeDetectFunc func) {
/**
- * xlinkIsLink:
- * @doc: the document containing the node
- * @node: the node pointer itself
+ * @param doc the document containing the node
+ * @param node the node pointer itself
*
* Check whether the given node carries the attributes needed
* to be a link element (or is one of the linking elements issued
@@ -106,7 +101,7 @@ xlinkSetDefaultDetect (xlinkNodeDetectFunc func) {
* This routine don't try to do full checking of the link validity
* but tries to detect and return the appropriate link type.
*
- * Returns the xlinkType of the node (XLINK_TYPE_NONE if there is no
+ * @returns the xlinkType of the node (XLINK_TYPE_NONE if there is no
* link detected.
*/
xlinkType
diff --git a/xmlIO.c b/xmlIO.c
index d88c8120..f471d990 100644
--- a/xmlIO.c
+++ b/xmlIO.c
@@ -114,12 +114,11 @@ static int xmlOutputCallbackNr;
************************************************************************/
/**
- * xmlIOErr:
- * @err: the error number
+ * @param err the error number
*
* Convert errno to xmlParserErrors.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
static xmlParserErrors
xmlIOErr(int err)
@@ -290,7 +289,7 @@ xmlIOErr(int err)
/**
* __xmlIOWin32UTF8ToWChar:
- * @u8String: uft-8 string
+ * @param u8String uft-8 string
*
* Convert a string from utf-8 to wchar (WINDOWS ONLY!)
*/
@@ -330,12 +329,11 @@ __xmlIOWin32UTF8ToWChar(const char *u8String)
#endif
/**
- * xmlNormalizeWindowsPath:
- * @path: the input file path
+ * @param path the input file path
*
- * DEPRECATED: This never really worked.
+ * @deprecated This never really worked.
*
- * Returns a copy of path.
+ * @returns a copy of path.
*/
xmlChar *
xmlNormalizeWindowsPath(const xmlChar *path)
@@ -344,16 +342,15 @@ xmlNormalizeWindowsPath(const xmlChar *path)
}
/**
- * xmlCheckFilename:
- * @path: the path to check
+ * @param path the path to check
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* if stat is not available on the target machine,
- * returns 1. if stat fails, returns 0 (if calling
+ * @returns 1. if stat fails, returns 0 (if calling
* stat on the filename fails, it can't be right).
* if stat succeeds and the file is a directory,
- * returns 2. otherwise returns 1.
+ * @returns 2. otherwise returns 1.
*/
int
xmlCheckFilename(const char *path)
@@ -437,12 +434,11 @@ typedef struct {
} xmlFdIOCtxt;
/**
- * xmlFdOpen:
- * @filename: the URI for matching
- * @write: whether the fd is opened for writing
- * @out: pointer to resulting context
+ * @param filename the URI for matching
+ * @param write whether the fd is opened for writing
+ * @param out pointer to resulting context
*
- * Returns an xmlParserErrors code
+ * @returns an xmlParserErrors code
*/
static xmlParserErrors
xmlFdOpen(const char *filename, int write, int *out) {
@@ -505,14 +501,13 @@ xmlFdOpen(const char *filename, int write, int *out) {
}
/**
- * xmlFdRead:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to read
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to read
*
- * Read @len bytes to @buffer from the I/O channel.
+ * Read `len` bytes to `buffer` from the I/O channel.
*
- * Returns the number of bytes read
+ * @returns the number of bytes read
*/
static int
xmlFdRead(void *context, char *buffer, int len) {
@@ -544,14 +539,13 @@ xmlFdRead(void *context, char *buffer, int len) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlFdWrite:
- * @context: the I/O context
- * @buffer: where to get data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to get data
+ * @param len number of bytes to write
*
- * Write @len bytes from @buffer to the I/O channel.
+ * Write `len` bytes from `buffer` to the I/O channel.
*
- * Returns the number of bytes written
+ * @returns the number of bytes written
*/
static int
xmlFdWrite(void *context, const char *buffer, int len) {
@@ -580,12 +574,11 @@ xmlFdFree(void *context) {
}
/**
- * xmlFdClose:
- * @context: the I/O context
+ * @param context the I/O context
*
* Close an I/O channel
*
- * Returns 0 in case of success and error code otherwise
+ * @returns 0 in case of success and error code otherwise
*/
static int
xmlFdClose (void * context) {
@@ -604,12 +597,11 @@ xmlFdClose (void * context) {
}
/**
- * xmlFileMatch:
- * @filename: the URI for matching
+ * @param filename the URI for matching
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns 1 if matches, 0 otherwise
+ * @returns 1 if matches, 0 otherwise
*/
int
xmlFileMatch (const char *filename ATTRIBUTE_UNUSED) {
@@ -617,14 +609,13 @@ xmlFileMatch (const char *filename ATTRIBUTE_UNUSED) {
}
/**
- * xmlFileOpenSafe:
- * @filename: the URI for matching
- * @write: whether the file is opened for writing
- * @out: pointer to resulting context
+ * @param filename the URI for matching
+ * @param write whether the file is opened for writing
+ * @param out pointer to resulting context
*
* input from FILE *
*
- * Returns an xmlParserErrors code
+ * @returns an xmlParserErrors code
*/
static xmlParserErrors
xmlFileOpenSafe(const char *filename, int write, void **out) {
@@ -680,12 +671,11 @@ xmlFileOpenSafe(const char *filename, int write, void **out) {
}
/**
- * xmlFileOpen:
- * @filename: the URI for matching
+ * @param filename the URI for matching
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns an IO context or NULL in case or failure
+ * @returns an IO context or NULL in case or failure
*/
void *
xmlFileOpen(const char *filename) {
@@ -696,14 +686,13 @@ xmlFileOpen(const char *filename) {
}
/**
- * xmlFileRead:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to write
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns the number of bytes read or < 0 in case of failure
+ * @returns the number of bytes read or < 0 in case of failure
*/
int
xmlFileRead(void * context, char * buffer, int len) {
@@ -729,14 +718,13 @@ xmlFileRead(void * context, char * buffer, int len) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlFileWrite:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to write
*
- * Write @len bytes from @buffer to the I/O channel.
+ * Write `len` bytes from `buffer` to the I/O channel.
*
- * Returns the number of bytes written
+ * @returns the number of bytes written
*/
static int
xmlFileWrite(void *context, const char *buffer, int len) {
@@ -756,8 +744,7 @@ xmlFileWrite(void *context, const char *buffer, int len) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlFileFlush:
- * @context: the I/O context
+ * @param context the I/O context
*
* Flush an I/O channel
*/
@@ -775,12 +762,11 @@ xmlFileFlush (void * context) {
}
/**
- * xmlFileClose:
- * @context: the I/O context
+ * @param context the I/O context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
- * Returns 0 or -1 an error code case of error
+ * @returns 0 or -1 an error code case of error
*/
int
xmlFileClose (void * context) {
@@ -802,14 +788,13 @@ xmlFileClose (void * context) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlBufferWrite:
- * @context: the xmlBuffer
- * @buffer: the data to write
- * @len: number of bytes to write
+ * @param context the xmlBuffer
+ * @param buffer the data to write
+ * @param len number of bytes to write
*
- * Write @len bytes from @buffer to the xml buffer
+ * Write `len` bytes from `buffer` to the xml buffer
*
- * Returns the number of bytes written or a negative xmlParserErrors
+ * @returns the number of bytes written or a negative xmlParserErrors
* value.
*/
static int
@@ -831,14 +816,13 @@ xmlBufferWrite (void * context, const char * buffer, int len) {
************************************************************************/
/**
- * xmlGzfileRead:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to write
*
- * Read @len bytes to @buffer from the compressed I/O channel.
+ * Read `len` bytes to `buffer` from the compressed I/O channel.
*
- * Returns the number of bytes read.
+ * @returns the number of bytes read.
*/
static int
xmlGzfileRead (void * context, char * buffer, int len) {
@@ -852,14 +836,13 @@ xmlGzfileRead (void * context, char * buffer, int len) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlGzfileWrite:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to write
*
- * Write @len bytes from @buffer to the compressed I/O channel.
+ * Write `len` bytes from `buffer` to the compressed I/O channel.
*
- * Returns the number of bytes written
+ * @returns the number of bytes written
*/
static int
xmlGzfileWrite (void * context, const char * buffer, int len) {
@@ -873,8 +856,7 @@ xmlGzfileWrite (void * context, const char * buffer, int len) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlGzfileClose:
- * @context: the I/O context
+ * @param context the I/O context
*
* Close a compressed I/O channel
*/
@@ -897,14 +879,13 @@ xmlGzfileClose (void * context) {
#include "private/xzlib.h"
/**
- * xmlXzfileRead:
- * @context: the I/O context
- * @buffer: where to drop data
- * @len: number of bytes to write
+ * @param context the I/O context
+ * @param buffer where to drop data
+ * @param len number of bytes to write
*
- * Read @len bytes to @buffer from the compressed I/O channel.
+ * Read `len` bytes to `buffer` from the compressed I/O channel.
*
- * Returns the number of bytes written
+ * @returns the number of bytes written
*/
static int
xmlXzfileRead (void * context, char * buffer, int len) {
@@ -917,8 +898,7 @@ xmlXzfileRead (void * context, char * buffer, int len) {
}
/**
- * xmlXzfileClose:
- * @context: the I/O context
+ * @param context the I/O context
*
* Close a compressed I/O channel
*/
@@ -942,15 +922,14 @@ xmlIODefaultMatch(const char *filename ATTRIBUTE_UNUSED) {
}
/**
- * xmlInputFromFd:
- * @buf: parser input buffer
- * @fd: file descriptor
- * @flags: flags
+ * @param buf parser input buffer
+ * @param fd file descriptor
+ * @param flags flags
*
- * Update the buffer to read from @fd. Supports the XML_INPUT_UNZIP
+ * Update the buffer to read from `fd`. Supports the XML_INPUT_UNZIP
* flag.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
xmlParserErrors
xmlInputFromFd(xmlParserInputBufferPtr buf, int fd,
@@ -1057,12 +1036,11 @@ xmlInputFromFd(xmlParserInputBufferPtr buf, int fd,
}
/**
- * xmlInputDefaultOpen:
- * @buf: input buffer to be filled
- * @filename: filename or URI
- * @flags: XML_INPUT flags
+ * @param buf input buffer to be filled
+ * @param filename filename or URI
+ * @param flags XML_INPUT flags
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
static xmlParserErrors
xmlInputDefaultOpen(xmlParserInputBufferPtr buf, const char *filename,
@@ -1086,12 +1064,11 @@ xmlInputDefaultOpen(xmlParserInputBufferPtr buf, const char *filename,
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlOutputDefaultOpen:
- * @buf: input buffer to be filled
- * @filename: filename or URI
- * @compression: compression level or 0
+ * @param buf input buffer to be filled
+ * @param filename filename or URI
+ * @param compression compression level or 0
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
static xmlParserErrors
xmlOutputDefaultOpen(xmlOutputBufferPtr buf, const char *filename,
@@ -1150,10 +1127,9 @@ xmlOutputDefaultOpen(xmlOutputBufferPtr buf, const char *filename,
#endif
/**
- * xmlAllocParserInputBuffer:
- * @enc: the charset encoding if known (deprecated)
+ * @param enc the charset encoding if known (deprecated)
*
- * DEPRECATED: Use xmlNewInputFrom*.
+ * @deprecated Use xmlNewInputFrom*.
*
* Create a buffered parser input for progressive parsing.
*
@@ -1161,7 +1137,7 @@ xmlOutputDefaultOpen(xmlOutputBufferPtr buf, const char *filename,
* XML_CHAR_ENCODING_NONE. The encoding can be changed with
* xmlSwitchEncoding or xmlSwitchEncodingName later on.
*
- * Returns the new parser input or NULL
+ * @returns the new parser input or NULL
*/
xmlParserInputBufferPtr
xmlAllocParserInputBuffer(xmlCharEncoding enc) {
@@ -1199,14 +1175,13 @@ xmlAllocParserInputBuffer(xmlCharEncoding enc) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlAllocOutputBuffer:
- * @encoder: the encoding converter or NULL
+ * @param encoder the encoding converter or NULL
*
* Create a buffered parser output
*
- * Consumes @encoder even in error case.
+ * Consumes `encoder` even in error case.
*
- * Returns the new parser output or NULL
+ * @returns the new parser output or NULL
*/
xmlOutputBufferPtr
xmlAllocOutputBuffer(xmlCharEncodingHandlerPtr encoder) {
@@ -1249,8 +1224,7 @@ xmlAllocOutputBuffer(xmlCharEncodingHandlerPtr encoder) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlFreeParserInputBuffer:
- * @in: a buffered parser input
+ * @param in a buffered parser input
*
* Free up the memory used by a buffered parser input
*/
@@ -1278,13 +1252,12 @@ xmlFreeParserInputBuffer(xmlParserInputBufferPtr in) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlOutputBufferClose:
- * @out: a buffered output
+ * @param out a buffered output
*
* flushes and close the output I/O channel
* and free up all the associated resources
*
- * Returns the number of byte written or a negative xmlParserErrors
+ * @returns the number of byte written or a negative xmlParserErrors
* code in case of error.
*/
int
@@ -1334,13 +1307,12 @@ xmlOutputBufferClose(xmlOutputBufferPtr out)
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserInputBufferCreateUrl:
- * @URI: the filename or URI
- * @enc: encoding enum (deprecated)
- * @flags: XML_INPUT flags
- * @out: pointer to resulting input buffer
+ * @param URI the filename or URI
+ * @param enc encoding enum (deprecated)
+ * @param flags XML_INPUT flags
+ * @param out pointer to resulting input buffer
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
xmlParserErrors
xmlParserInputBufferCreateUrl(const char *URI, xmlCharEncoding enc,
@@ -1406,18 +1378,17 @@ __xmlParserInputBufferCreateFilename(const char *URI, xmlCharEncoding enc) {
}
/**
- * xmlParserInputBufferCreateFilename:
- * @URI: a C string containing the URI or filename
- * @enc: the charset encoding if known
+ * @param URI a C string containing the URI or filename
+ * @param enc the charset encoding if known
*
- * DEPRECATED: Use xmlNewInputFromUrl.
+ * @deprecated Use xmlNewInputFromUrl.
*
* Create a buffered parser input for the progressive parsing of a file
* Automatic support for ZLIB/Compress compressed document is provided
* by default if found at compile-time.
* Do an encoding check if enc == XML_CHAR_ENCODING_NONE
*
- * Returns the new parser input or NULL
+ * @returns the new parser input or NULL
*/
xmlParserInputBufferPtr
xmlParserInputBufferCreateFilename(const char *URI, xmlCharEncoding enc) {
@@ -1520,10 +1491,9 @@ error:
}
/**
- * xmlOutputBufferCreateFilename:
- * @URI: a C string containing the URI or filename
- * @encoder: the encoding converter or NULL
- * @compression: the compression ration (0 none, 9 max).
+ * @param URI a C string containing the URI or filename
+ * @param encoder the encoding converter or NULL
+ * @param compression the compression ration (0 none, 9 max).
*
* Create a buffered output for the progressive saving of a file
* If filename is "-' then we use stdout as the output.
@@ -1532,9 +1502,9 @@ error:
* TODO: currently if compression is set, the library only support
* writing to a local file.
*
- * Consumes @encoder even in error case.
+ * Consumes `encoder` even in error case.
*
- * Returns the new output or NULL
+ * @returns the new output or NULL
*/
xmlOutputBufferPtr
xmlOutputBufferCreateFilename(const char *URI,
@@ -1548,11 +1518,10 @@ xmlOutputBufferCreateFilename(const char *URI,
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserInputBufferCreateFile:
- * @file: a FILE*
- * @enc: the charset encoding if known (deprecated)
+ * @param file a FILE*
+ * @param enc the charset encoding if known (deprecated)
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Create a buffered parser input for the progressive parsing of a FILE *
* buffered C I/O
@@ -1561,7 +1530,7 @@ xmlOutputBufferCreateFilename(const char *URI,
* XML_CHAR_ENCODING_NONE. The encoding can be changed with
* xmlSwitchEncoding or xmlSwitchEncodingName later on.
*
- * Returns the new parser input or NULL
+ * @returns the new parser input or NULL
*/
xmlParserInputBufferPtr
xmlParserInputBufferCreateFile(FILE *file, xmlCharEncoding enc) {
@@ -1581,16 +1550,15 @@ xmlParserInputBufferCreateFile(FILE *file, xmlCharEncoding enc) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlOutputBufferCreateFile:
- * @file: a FILE*
- * @encoder: the encoding converter or NULL
+ * @param file a FILE*
+ * @param encoder the encoding converter or NULL
*
* Create a buffered output for the progressive saving to a FILE *
* buffered C I/O
*
- * Consumes @encoder even in error case.
+ * Consumes `encoder` even in error case.
*
- * Returns the new parser output or NULL
+ * @returns the new parser output or NULL
*/
xmlOutputBufferPtr
xmlOutputBufferCreateFile(FILE *file, xmlCharEncodingHandlerPtr encoder) {
@@ -1612,15 +1580,14 @@ xmlOutputBufferCreateFile(FILE *file, xmlCharEncodingHandlerPtr encoder) {
}
/**
- * xmlOutputBufferCreateBuffer:
- * @buffer: a xmlBufferPtr
- * @encoder: the encoding converter or NULL
+ * @param buffer a xmlBufferPtr
+ * @param encoder the encoding converter or NULL
*
* Create a buffered output for the progressive saving to a xmlBuffer
*
- * Consumes @encoder even in error case.
+ * Consumes `encoder` even in error case.
*
- * Returns the new parser output or NULL
+ * @returns the new parser output or NULL
*/
xmlOutputBufferPtr
xmlOutputBufferCreateBuffer(xmlBufferPtr buffer,
@@ -1639,12 +1606,11 @@ xmlOutputBufferCreateBuffer(xmlBufferPtr buffer,
}
/**
- * xmlOutputBufferGetContent:
- * @out: an xmlOutputBufferPtr
+ * @param out an xmlOutputBufferPtr
*
* Gives a pointer to the data currently held in the output buffer
*
- * Returns a pointer to the data or NULL in case of error
+ * @returns a pointer to the data or NULL in case of error
*/
const xmlChar *
xmlOutputBufferGetContent(xmlOutputBufferPtr out) {
@@ -1655,12 +1621,11 @@ xmlOutputBufferGetContent(xmlOutputBufferPtr out) {
}
/**
- * xmlOutputBufferGetSize:
- * @out: an xmlOutputBufferPtr
+ * @param out an xmlOutputBufferPtr
*
* Gives the length of the data currently held in the output buffer
*
- * Returns 0 in case or error or no data is held, the size otherwise
+ * @returns 0 in case or error or no data is held, the size otherwise
*/
size_t
xmlOutputBufferGetSize(xmlOutputBufferPtr out) {
@@ -1674,11 +1639,10 @@ xmlOutputBufferGetSize(xmlOutputBufferPtr out) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserInputBufferCreateFd:
- * @fd: a file descriptor number
- * @enc: the charset encoding if known (deprecated)
+ * @param fd a file descriptor number
+ * @param enc the charset encoding if known (deprecated)
*
- * DEPRECATED: Use xmlNewInputFromFd.
+ * @deprecated Use xmlNewInputFromFd.
*
* Create a buffered parser input for the progressive parsing for the input
* from a file descriptor
@@ -1687,7 +1651,7 @@ xmlOutputBufferGetSize(xmlOutputBufferPtr out) {
* XML_CHAR_ENCODING_NONE. The encoding can be changed with
* xmlSwitchEncoding or xmlSwitchEncodingName later on.
*
- * Returns the new parser input or NULL
+ * @returns the new parser input or NULL
*/
xmlParserInputBufferPtr
xmlParserInputBufferCreateFd(int fd, xmlCharEncoding enc) {
@@ -1741,15 +1705,14 @@ xmlMemClose(void *vctxt) {
}
/**
- * xmlNewInputBufferMemory:
- * @mem: memory buffer
- * @size: size of buffer
- * @flags: flags
- * @enc: the charset encoding if known (deprecated)
+ * @param mem memory buffer
+ * @param size size of buffer
+ * @param flags flags
+ * @param enc the charset encoding if known (deprecated)
*
* Create an input buffer for memory.
*
- * Returns the new input buffer or NULL.
+ * @returns the new input buffer or NULL.
*/
xmlParserInputBufferPtr
xmlNewInputBufferMemory(const void *mem, size_t size,
@@ -1799,12 +1762,11 @@ xmlNewInputBufferMemory(const void *mem, size_t size,
}
/**
- * xmlParserInputBufferCreateMem:
- * @mem: the memory input
- * @size: the length of the memory block
- * @enc: the charset encoding if known (deprecated)
+ * @param mem the memory input
+ * @param size the length of the memory block
+ * @param enc the charset encoding if known (deprecated)
*
- * DEPRECATED: Use xmlNewInputFromMemory.
+ * @deprecated Use xmlNewInputFromMemory.
*
* Create a parser input buffer for parsing from a memory area.
*
@@ -1817,7 +1779,7 @@ xmlNewInputBufferMemory(const void *mem, size_t size,
* XML_CHAR_ENCODING_NONE. The encoding can be changed with
* xmlSwitchEncoding or xmlSwitchEncodingName later on.
*
- * Returns the new parser input or NULL in case of error.
+ * @returns the new parser input or NULL in case of error.
*/
xmlParserInputBufferPtr
xmlParserInputBufferCreateMem(const char *mem, int size, xmlCharEncoding enc) {
@@ -1828,12 +1790,11 @@ xmlParserInputBufferCreateMem(const char *mem, int size, xmlCharEncoding enc) {
}
/**
- * xmlParserInputBufferCreateStatic:
- * @mem: the memory input
- * @size: the length of the memory block
- * @enc: the charset encoding if known
+ * @param mem the memory input
+ * @param size the length of the memory block
+ * @param enc the charset encoding if known
*
- * DEPRECATED: Use xmlNewInputFromMemory.
+ * @deprecated Use xmlNewInputFromMemory.
*
* Create a parser input buffer for parsing from a memory area.
*
@@ -1845,7 +1806,7 @@ xmlParserInputBufferCreateMem(const char *mem, int size, xmlCharEncoding enc) {
* XML_CHAR_ENCODING_NONE. The encoding can be changed with
* xmlSwitchEncoding or xmlSwitchEncodingName later on.
*
- * Returns the new parser input or NULL in case of error.
+ * @returns the new parser input or NULL in case of error.
*/
xmlParserInputBufferPtr
xmlParserInputBufferCreateStatic(const char *mem, int size,
@@ -1857,15 +1818,14 @@ xmlParserInputBufferCreateStatic(const char *mem, int size,
}
/**
- * xmlNewInputBufferString:
- * @str: C string
- * @flags: flags
+ * @param str C string
+ * @param flags flags
*
- * DEPRECATED: Use xmlNewInputFromString.
+ * @deprecated Use xmlNewInputFromString.
*
* Create an input buffer for a null-terminated C string.
*
- * Returns the new input buffer or NULL.
+ * @returns the new input buffer or NULL.
*/
xmlParserInputBufferPtr
xmlNewInputBufferString(const char *str, xmlParserInputFlags flags) {
@@ -1889,16 +1849,15 @@ xmlNewInputBufferString(const char *str, xmlParserInputFlags flags) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlOutputBufferCreateFd:
- * @fd: a file descriptor number
- * @encoder: the encoding converter or NULL
+ * @param fd a file descriptor number
+ * @param encoder the encoding converter or NULL
*
* Create a buffered output for the progressive saving
* to a file descriptor
*
- * Consumes @encoder even in error case.
+ * Consumes `encoder` even in error case.
*
- * Returns the new parser output or NULL
+ * @returns the new parser output or NULL
*/
xmlOutputBufferPtr
xmlOutputBufferCreateFd(int fd, xmlCharEncodingHandlerPtr encoder) {
@@ -1929,13 +1888,12 @@ xmlOutputBufferCreateFd(int fd, xmlCharEncodingHandlerPtr encoder) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserInputBufferCreateIO:
- * @ioread: an I/O read function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @enc: the charset encoding if known (deprecated)
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param enc the charset encoding if known (deprecated)
*
- * DEPRECATED: Use xmlNewInputFromIO.
+ * @deprecated Use xmlNewInputFromIO.
*
* Create a buffered parser input for the progressive parsing for the input
* from an I/O handler
@@ -1944,7 +1902,7 @@ xmlOutputBufferCreateFd(int fd, xmlCharEncodingHandlerPtr encoder) {
* XML_CHAR_ENCODING_NONE. The encoding can be changed with
* xmlSwitchEncoding or xmlSwitchEncodingName later on.
*
- * Returns the new parser input or NULL
+ * @returns the new parser input or NULL
*/
xmlParserInputBufferPtr
xmlParserInputBufferCreateIO(xmlInputReadCallback ioread,
@@ -1965,18 +1923,17 @@ xmlParserInputBufferCreateIO(xmlInputReadCallback ioread,
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlOutputBufferCreateIO:
- * @iowrite: an I/O write function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @encoder: the charset encoding if known
+ * @param iowrite an I/O write function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param encoder the charset encoding if known
*
* Create a buffered output for the progressive saving
* to an I/O handler
*
- * Consumes @encoder even in error case.
+ * Consumes `encoder` even in error case.
*
- * Returns the new parser output or NULL
+ * @returns the new parser output or NULL
*/
xmlOutputBufferPtr
xmlOutputBufferCreateIO(xmlOutputWriteCallback iowrite,
@@ -2001,14 +1958,13 @@ xmlOutputBufferCreateIO(xmlOutputWriteCallback iowrite,
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserInputBufferCreateFilenameDefault:
- * @func: function pointer to the new ParserInputBufferCreateFilenameFunc
+ * @param func function pointer to the new ParserInputBufferCreateFilenameFunc
*
- * DEPRECATED: Use xmlCtxtSetResourceLoader or similar functions.
+ * @deprecated Use xmlCtxtSetResourceLoader or similar functions.
*
* Registers a callback for URI input file handling
*
- * Returns the old value of the registration function
+ * @returns the old value of the registration function
*/
xmlParserInputBufferCreateFilenameFunc
xmlParserInputBufferCreateFilenameDefault(
@@ -2027,12 +1983,11 @@ xmlParserInputBufferCreateFilenameDefault(
}
/**
- * xmlOutputBufferCreateFilenameDefault:
- * @func: function pointer to the new OutputBufferCreateFilenameFunc
+ * @param func function pointer to the new OutputBufferCreateFilenameFunc
*
* Registers a callback for URI output file handling
*
- * Returns the old value of the registration function
+ * @returns the old value of the registration function
*/
xmlOutputBufferCreateFilenameFunc
xmlOutputBufferCreateFilenameDefault(xmlOutputBufferCreateFilenameFunc func)
@@ -2048,18 +2003,17 @@ xmlOutputBufferCreateFilenameDefault(xmlOutputBufferCreateFilenameFunc func)
}
/**
- * xmlParserInputBufferPush:
- * @in: a buffered parser input
- * @len: the size in bytes of the array.
- * @buf: an char array
+ * @param in a buffered parser input
+ * @param len the size in bytes of the array.
+ * @param buf an char array
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Push the content of the arry in the input buffer
* This routine handle the I18N transcoding to internal UTF-8
* This is used when operating the parser in progressive (push) mode.
*
- * Returns the number of chars read and stored in the buffer, or -1
+ * @returns the number of chars read and stored in the buffer, or -1
* in case of error.
*/
int
@@ -2121,17 +2075,16 @@ endOfInput (void * context ATTRIBUTE_UNUSED,
}
/**
- * xmlParserInputBufferGrow:
- * @in: a buffered parser input
- * @len: indicative value of the amount of chars to read
+ * @param in a buffered parser input
+ * @param len indicative value of the amount of chars to read
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Grow up the content of the input buffer, the old data are preserved
* This routine handle the I18N transcoding to internal UTF-8
* This routine is used when operating the parser in normal (pull) mode
*
- * Returns the number of chars read and stored in the buffer, or -1
+ * @returns the number of chars read and stored in the buffer, or -1
* in case of error.
*/
int
@@ -2212,15 +2165,14 @@ xmlParserInputBufferGrow(xmlParserInputBufferPtr in, int len) {
}
/**
- * xmlParserInputBufferRead:
- * @in: a buffered parser input
- * @len: indicative value of the amount of chars to read
+ * @param in a buffered parser input
+ * @param len indicative value of the amount of chars to read
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Same as xmlParserInputBufferGrow.
*
- * Returns the number of chars read and stored in the buffer, or -1
+ * @returns the number of chars read and stored in the buffer, or -1
* in case of error.
*/
int
@@ -2230,17 +2182,16 @@ xmlParserInputBufferRead(xmlParserInputBufferPtr in, int len) {
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlOutputBufferWrite:
- * @out: a buffered parser output
- * @len: the size in bytes of the array.
- * @data: an char array
+ * @param out a buffered parser output
+ * @param len the size in bytes of the array.
+ * @param data an char array
*
* Write the content of the array in the output I/O buffer
* This routine handle the I18N transcoding from internal UTF-8
* The buffer is lossless, i.e. will store in case of partial
* or delayed writes.
*
- * Returns the number of chars immediately written, or -1
+ * @returns the number of chars immediately written, or -1
* in case of error.
*/
int
@@ -2331,10 +2282,9 @@ xmlOutputBufferWrite(xmlOutputBufferPtr out, int len, const char *data) {
}
/**
- * xmlOutputBufferWriteEscape:
- * @out: a buffered parser output
- * @str: a zero terminated UTF-8 string
- * @escaping: an optional escaping function (or NULL)
+ * @param out a buffered parser output
+ * @param str a zero terminated UTF-8 string
+ * @param escaping an optional escaping function (or NULL)
*
* Write the content of the string in the output I/O buffer
* This routine escapes the characters and then handle the I18N
@@ -2342,7 +2292,7 @@ xmlOutputBufferWrite(xmlOutputBufferPtr out, int len, const char *data) {
* The buffer is lossless, i.e. will store in case of partial
* or delayed writes.
*
- * Returns the number of chars immediately written, or -1
+ * @returns the number of chars immediately written, or -1
* in case of error.
*/
int
@@ -2407,16 +2357,15 @@ xmlOutputBufferWriteEscape(xmlOutputBufferPtr out, const xmlChar *str,
}
/**
- * xmlOutputBufferWriteString:
- * @out: a buffered parser output
- * @str: a zero terminated C string
+ * @param out a buffered parser output
+ * @param str a zero terminated C string
*
* Write the content of the string in the output I/O buffer
* This routine handle the I18N transcoding from internal UTF-8
* The buffer is lossless, i.e. will store in case of partial
* or delayed writes.
*
- * Returns the number of chars immediately written, or -1
+ * @returns the number of chars immediately written, or -1
* in case of error.
*/
int
@@ -2434,12 +2383,11 @@ xmlOutputBufferWriteString(xmlOutputBufferPtr out, const char *str) {
}
/**
- * xmlOutputBufferWriteQuotedString:
- * @buf: output buffer
- * @string: the string to add
+ * @param buf output buffer
+ * @param string the string to add
*
* routine which manage and grows an output buffer. This one writes
- * a quoted or double quoted #xmlChar string, checking first if it holds
+ * a quoted or double quoted \#xmlChar string, checking first if it holds
* quote or double-quotes internally
*/
void
@@ -2484,12 +2432,11 @@ xmlOutputBufferWriteQuotedString(xmlOutputBufferPtr buf,
}
/**
- * xmlOutputBufferFlush:
- * @out: a buffered output
+ * @param out a buffered output
*
* flushes the output I/O channel
*
- * Returns the number of byte written or -1 in case of error.
+ * @returns the number of byte written or -1 in case of error.
*/
int
xmlOutputBufferFlush(xmlOutputBufferPtr out) {
@@ -2541,12 +2488,11 @@ xmlOutputBufferFlush(xmlOutputBufferPtr out) {
#endif /* LIBXML_OUTPUT_ENABLED */
/**
- * xmlParserGetDirectory:
- * @filename: the path to a file
+ * @param filename the path to a file
*
* lookup the directory for that file
*
- * Returns a new allocated string containing the directory, or NULL.
+ * @returns a new allocated string containing the directory, or NULL.
*/
char *
xmlParserGetDirectory(const char *filename) {
@@ -2581,14 +2527,13 @@ xmlParserGetDirectory(const char *filename) {
}
/**
- * xmlNoNetExists:
- * @filename: the path to check
+ * @param filename the path to check
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Like xmlCheckFilename but handles file URIs.
*
- * Returns 0, 1, or 2.
+ * @returns 0, 1, or 2.
*/
int
xmlNoNetExists(const char *filename) {
@@ -2617,7 +2562,6 @@ xmlNoNetExists(const char *filename) {
************************************************************************/
/**
- * xmlInitIOCallbacks:
*
* Initialize callback tables.
*/
@@ -2634,17 +2578,16 @@ xmlInitIOCallbacks(void)
}
/**
- * xmlRegisterInputCallbacks:
- * @matchFunc: the xmlInputMatchCallback
- * @openFunc: the xmlInputOpenCallback
- * @readFunc: the xmlInputReadCallback
- * @closeFunc: the xmlInputCloseCallback
+ * @param matchFunc the xmlInputMatchCallback
+ * @param openFunc the xmlInputOpenCallback
+ * @param readFunc the xmlInputReadCallback
+ * @param closeFunc the xmlInputCloseCallback
*
- * DEPRECATED: Use xmlCtxtSetResourceLoader or similar functions.
+ * @deprecated Use xmlCtxtSetResourceLoader or similar functions.
*
* Register a new set of I/O callback for handling parser input.
*
- * Returns the registered handler number or -1 in case of error
+ * @returns the registered handler number or -1 in case of error
*/
int
xmlRegisterInputCallbacks(xmlInputMatchCallback matchFunc,
@@ -2663,7 +2606,6 @@ xmlRegisterInputCallbacks(xmlInputMatchCallback matchFunc,
}
/**
- * xmlRegisterDefaultInputCallbacks:
*
* Registers the default compiled-in I/O handlers.
*/
@@ -2673,12 +2615,11 @@ xmlRegisterDefaultInputCallbacks(void) {
}
/**
- * xmlPopInputCallbacks:
*
* Clear the top input callback from the input stack. this includes the
* compiled-in I/O.
*
- * Returns the number of input callback registered or -1 in case of error.
+ * @returns the number of input callback registered or -1 in case of error.
*/
int
xmlPopInputCallbacks(void)
@@ -2694,7 +2635,6 @@ xmlPopInputCallbacks(void)
}
/**
- * xmlCleanupInputCallbacks:
*
* clears the entire input callback table. this includes the
* compiled-in I/O.
@@ -2709,15 +2649,14 @@ xmlCleanupInputCallbacks(void)
#ifdef LIBXML_OUTPUT_ENABLED
/**
- * xmlRegisterOutputCallbacks:
- * @matchFunc: the xmlOutputMatchCallback
- * @openFunc: the xmlOutputOpenCallback
- * @writeFunc: the xmlOutputWriteCallback
- * @closeFunc: the xmlOutputCloseCallback
+ * @param matchFunc the xmlOutputMatchCallback
+ * @param openFunc the xmlOutputOpenCallback
+ * @param writeFunc the xmlOutputWriteCallback
+ * @param closeFunc the xmlOutputCloseCallback
*
* Register a new set of I/O callback for handling output.
*
- * Returns the registered handler number or -1 in case of error
+ * @returns the registered handler number or -1 in case of error
*/
int
xmlRegisterOutputCallbacks(xmlOutputMatchCallback matchFunc,
@@ -2736,7 +2675,6 @@ xmlRegisterOutputCallbacks(xmlOutputMatchCallback matchFunc,
}
/**
- * xmlRegisterDefaultOutputCallbacks:
*
* Registers the default compiled-in I/O handlers.
*/
@@ -2746,12 +2684,11 @@ xmlRegisterDefaultOutputCallbacks (void) {
}
/**
- * xmlPopOutputCallbacks:
*
* Remove the top output callbacks from the output stack. This includes the
* compiled-in I/O.
*
- * Returns the number of output callback registered or -1 in case of error.
+ * @returns the number of output callback registered or -1 in case of error.
*/
int
xmlPopOutputCallbacks(void)
@@ -2767,7 +2704,6 @@ xmlPopOutputCallbacks(void)
}
/**
- * xmlCleanupOutputCallbacks:
*
* clears the entire output callback table. this includes the
* compiled-in I/O callbacks.
diff --git a/xmlcatalog.c b/xmlcatalog.c
index c694905c..32c62899 100644
--- a/xmlcatalog.c
+++ b/xmlcatalog.c
@@ -59,12 +59,11 @@ static char *filename = NULL;
* *
************************************************************************/
/**
- * xmlShellReadline:
- * @prompt: the prompt value
+ * @param prompt the prompt value
*
* Read a string
*
- * Returns a pointer to it or NULL on EOF the caller is expected to
+ * @returns a pointer to it or NULL on EOF the caller is expected to
* free the returned string.
*/
static char *
diff --git a/xmlmemory.c b/xmlmemory.c
index 0078e211..cbe5f766 100644
--- a/xmlmemory.c
+++ b/xmlmemory.c
@@ -56,14 +56,13 @@ typedef struct memnod {
#define HDR_2_CLIENT(a) ((void *) (((char *) (a)) + RESERVE_SIZE))
/**
- * xmlMallocLoc:
- * @size: an int specifying the size in byte to allocate.
- * @file: the file name or NULL
- * @line: the line number
+ * @param size an int specifying the size in byte to allocate.
+ * @param file the file name or NULL
+ * @param line the line number
*
- * DEPRECATED: don't use
+ * @deprecated don't use
*
- * Returns a pointer to the allocated area or NULL in case of lack of memory.
+ * @returns a pointer to the allocated area or NULL in case of lack of memory.
*/
void *
xmlMallocLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
@@ -73,14 +72,13 @@ xmlMallocLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
}
/**
- * xmlMallocAtomicLoc:
- * @size: an unsigned int specifying the size in byte to allocate.
- * @file: the file name or NULL
- * @line: the line number
+ * @param size an unsigned int specifying the size in byte to allocate.
+ * @param file the file name or NULL
+ * @param line the line number
*
- * DEPRECATED: don't use
+ * @deprecated don't use
*
- * Returns a pointer to the allocated area or NULL in case of lack of memory.
+ * @returns a pointer to the allocated area or NULL in case of lack of memory.
*/
void *
xmlMallocAtomicLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
@@ -90,12 +88,11 @@ xmlMallocAtomicLoc(size_t size, const char *file ATTRIBUTE_UNUSED,
}
/**
- * xmlMemMalloc:
- * @size: an int specifying the size in byte to allocate.
+ * @param size an int specifying the size in byte to allocate.
*
* a malloc() equivalent, with logging of the allocation info.
*
- * Returns a pointer to the allocated area or NULL in case of lack of memory.
+ * @returns a pointer to the allocated area or NULL in case of lack of memory.
*/
void *
xmlMemMalloc(size_t size)
@@ -122,15 +119,14 @@ xmlMemMalloc(size_t size)
}
/**
- * xmlReallocLoc:
- * @ptr: the initial memory block pointer
- * @size: an int specifying the size in byte to allocate.
- * @file: the file name or NULL
- * @line: the line number
+ * @param ptr the initial memory block pointer
+ * @param size an int specifying the size in byte to allocate.
+ * @param file the file name or NULL
+ * @param line the line number
*
- * DEPRECATED: don't use
+ * @deprecated don't use
*
- * Returns a pointer to the allocated area or NULL in case of lack of memory.
+ * @returns a pointer to the allocated area or NULL in case of lack of memory.
*/
void *
xmlReallocLoc(void *ptr, size_t size, const char *file ATTRIBUTE_UNUSED,
@@ -140,13 +136,12 @@ xmlReallocLoc(void *ptr, size_t size, const char *file ATTRIBUTE_UNUSED,
}
/**
- * xmlMemRealloc:
- * @ptr: the initial memory block pointer
- * @size: an int specifying the size in byte to allocate.
+ * @param ptr the initial memory block pointer
+ * @param size an int specifying the size in byte to allocate.
*
* a realloc() equivalent, with logging of the allocation info.
*
- * Returns a pointer to the allocated area or NULL in case of lack of memory.
+ * @returns a pointer to the allocated area or NULL in case of lack of memory.
*/
void *
xmlMemRealloc(void *ptr, size_t size) {
@@ -187,8 +182,7 @@ xmlMemRealloc(void *ptr, size_t size) {
}
/**
- * xmlMemFree:
- * @ptr: the memory block pointer
+ * @param ptr the memory block pointer
*
* a free() equivalent, with error checking.
*/
@@ -222,14 +216,13 @@ xmlMemFree(void *ptr)
}
/**
- * xmlMemStrdupLoc:
- * @str: the initial string pointer
- * @file: the file name or NULL
- * @line: the line number
+ * @param str the initial string pointer
+ * @param file the file name or NULL
+ * @param line the line number
*
- * DEPRECATED: don't use
+ * @deprecated don't use
*
- * Returns a pointer to the new string or NULL if allocation error occurred.
+ * @returns a pointer to the new string or NULL if allocation error occurred.
*/
char *
xmlMemStrdupLoc(const char *str, const char *file ATTRIBUTE_UNUSED,
@@ -239,12 +232,11 @@ xmlMemStrdupLoc(const char *str, const char *file ATTRIBUTE_UNUSED,
}
/**
- * xmlMemoryStrdup:
- * @str: the initial string pointer
+ * @param str the initial string pointer
*
* a strdup() equivalent, with logging of the allocation info.
*
- * Returns a pointer to the new string or NULL if allocation error occurred.
+ * @returns a pointer to the new string or NULL if allocation error occurred.
*/
char *
xmlMemoryStrdup(const char *str) {
@@ -276,10 +268,9 @@ xmlMemoryStrdup(const char *str) {
}
/**
- * xmlMemSize:
- * @ptr: pointer to the memory allocation
+ * @param ptr pointer to the memory allocation
*
- * Returns the size of a memory allocation.
+ * @returns the size of a memory allocation.
*/
size_t
@@ -297,11 +288,10 @@ xmlMemSize(void *ptr) {
}
/**
- * xmlMemUsed:
*
* Provides the amount of memory currently allocated
*
- * Returns an int representing the amount of memory allocated.
+ * @returns an int representing the amount of memory allocated.
*/
int
@@ -310,11 +300,10 @@ xmlMemUsed(void) {
}
/**
- * xmlMemBlocks:
*
* Provides the number of memory areas currently allocated
*
- * Returns an int representing the number of blocks
+ * @returns an int representing the number of blocks
*/
int
@@ -328,11 +317,10 @@ xmlMemBlocks(void) {
}
/**
- * xmlMemDisplayLast:
- * @fp: a FILE descriptor
- * @nbBytes: the amount of memory to dump
+ * @param fp a FILE descriptor
+ * @param nbBytes the amount of memory to dump
*
- * DEPRECATED: This feature was removed.
+ * @deprecated This feature was removed.
*/
void
xmlMemDisplayLast(FILE *fp ATTRIBUTE_UNUSED, long nbBytes ATTRIBUTE_UNUSED)
@@ -340,10 +328,9 @@ xmlMemDisplayLast(FILE *fp ATTRIBUTE_UNUSED, long nbBytes ATTRIBUTE_UNUSED)
}
/**
- * xmlMemDisplay:
- * @fp: a FILE descriptor
+ * @param fp a FILE descriptor
*
- * DEPRECATED: This feature was removed.
+ * @deprecated This feature was removed.
*/
void
xmlMemDisplay(FILE *fp ATTRIBUTE_UNUSED)
@@ -351,11 +338,10 @@ xmlMemDisplay(FILE *fp ATTRIBUTE_UNUSED)
}
/**
- * xmlMemShow:
- * @fp: a FILE descriptor
- * @nr: number of entries to dump
+ * @param fp a FILE descriptor
+ * @param nr number of entries to dump
*
- * DEPRECATED: This feature was removed.
+ * @deprecated This feature was removed.
*/
void
xmlMemShow(FILE *fp ATTRIBUTE_UNUSED, int nr ATTRIBUTE_UNUSED)
@@ -363,9 +349,8 @@ xmlMemShow(FILE *fp ATTRIBUTE_UNUSED, int nr ATTRIBUTE_UNUSED)
}
/**
- * xmlMemoryDump:
*
- * DEPRECATED: This feature was removed.
+ * @deprecated This feature was removed.
*/
void
xmlMemoryDump(void)
@@ -380,11 +365,10 @@ xmlMemoryDump(void)
****************************************************************/
/**
- * xmlInitMemory:
*
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
*
- * Returns 0.
+ * @returns 0.
*/
int
xmlInitMemory(void) {
@@ -393,7 +377,6 @@ xmlInitMemory(void) {
}
/**
- * xmlInitMemoryInternal:
*
* Initialize the memory layer.
*/
@@ -403,9 +386,8 @@ xmlInitMemoryInternal(void) {
}
/**
- * xmlCleanupMemory:
*
- * DEPRECATED: This function is a no-op. Call xmlCleanupParser
+ * @deprecated This function is a no-op. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have call cleanup functions at all.
@@ -415,7 +397,6 @@ xmlCleanupMemory(void) {
}
/**
- * xmlCleanupMemoryInternal:
*
* Free up all the memory allocated by the library for its own
* use. This should not be called by user level code.
@@ -435,11 +416,10 @@ xmlCleanupMemoryInternal(void) {
}
/**
- * xmlMemSetup:
- * @freeFunc: the free() function to use
- * @mallocFunc: the malloc() function to use
- * @reallocFunc: the realloc() function to use
- * @strdupFunc: the strdup() function to use
+ * @param freeFunc the free() function to use
+ * @param mallocFunc the malloc() function to use
+ * @param reallocFunc the realloc() function to use
+ * @param strdupFunc the strdup() function to use
*
* Override the default memory access functions with a new set
* This has to be called before any other libxml routines !
@@ -447,7 +427,7 @@ xmlCleanupMemoryInternal(void) {
* Should this be blocked if there was already some allocations
* done ?
*
- * Returns 0 on success
+ * @returns 0 on success
*/
int
xmlMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
@@ -469,15 +449,14 @@ xmlMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
}
/**
- * xmlMemGet:
- * @freeFunc: place to save the free() function in use
- * @mallocFunc: place to save the malloc() function in use
- * @reallocFunc: place to save the realloc() function in use
- * @strdupFunc: place to save the strdup() function in use
+ * @param freeFunc place to save the free() function in use
+ * @param mallocFunc place to save the malloc() function in use
+ * @param reallocFunc place to save the realloc() function in use
+ * @param strdupFunc place to save the strdup() function in use
*
* Provides the memory access functions set currently in use
*
- * Returns 0 on success
+ * @returns 0 on success
*/
int
xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
@@ -490,14 +469,13 @@ xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
}
/**
- * xmlGcMemSetup:
- * @freeFunc: the free() function to use
- * @mallocFunc: the malloc() function to use
- * @mallocAtomicFunc: the malloc() function to use for atomic allocations
- * @reallocFunc: the realloc() function to use
- * @strdupFunc: the strdup() function to use
+ * @param freeFunc the free() function to use
+ * @param mallocFunc the malloc() function to use
+ * @param mallocAtomicFunc the malloc() function to use for atomic allocations
+ * @param reallocFunc the realloc() function to use
+ * @param strdupFunc the strdup() function to use
*
- * DEPRECATED: Use xmlMemSetup.
+ * @deprecated Use xmlMemSetup.
*
* Override the default memory access functions with a new set
* This has to be called before any other libxml routines !
@@ -507,7 +485,7 @@ xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
* Should this be blocked if there was already some allocations
* done ?
*
- * Returns 0 on success
+ * @returns 0 on success
*/
int
xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
@@ -532,20 +510,19 @@ xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc,
}
/**
- * xmlGcMemGet:
- * @freeFunc: place to save the free() function in use
- * @mallocFunc: place to save the malloc() function in use
- * @mallocAtomicFunc: place to save the atomic malloc() function in use
- * @reallocFunc: place to save the realloc() function in use
- * @strdupFunc: place to save the strdup() function in use
+ * @param freeFunc place to save the free() function in use
+ * @param mallocFunc place to save the malloc() function in use
+ * @param mallocAtomicFunc place to save the atomic malloc() function in use
+ * @param reallocFunc place to save the realloc() function in use
+ * @param strdupFunc place to save the strdup() function in use
*
- * DEPRECATED: xmlMemGet.
+ * @deprecated xmlMemGet.
*
* Provides the memory access functions set currently in use
* The mallocAtomicFunc is specialized for atomic block
* allocations (i.e. of areas useful for garbage collected memory allocators
*
- * Returns 0 on success
+ * @returns 0 on success
*/
int
xmlGcMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc,
diff --git a/xmlmodule.c b/xmlmodule.c
index fe516909..4e0dc788 100644
--- a/xmlmodule.c
+++ b/xmlmodule.c
@@ -42,18 +42,17 @@ static int xmlModulePlatformSymbol(void *handle, const char *name, void **result
************************************************************************/
/**
- * xmlModuleOpen:
- * @name: the module name
- * @options: a set of xmlModuleOption
+ * @param name the module name
+ * @param options a set of xmlModuleOption
*
* Opens a module/shared library given its name or path
* NOTE: that due to portability issues, behaviour can only be
- * guaranteed with @name using ASCII. We cannot guarantee that
+ * guaranteed with `name` using ASCII. We cannot guarantee that
* an UTF-8 string would work, which is why name is a const char *
* and not a const xmlChar * .
* TODO: options are not yet implemented.
*
- * Returns a handle for the module or NULL in case of error
+ * @returns a handle for the module or NULL in case of error
*/
xmlModulePtr
xmlModuleOpen(const char *name, int options ATTRIBUTE_UNUSED)
@@ -78,18 +77,17 @@ xmlModuleOpen(const char *name, int options ATTRIBUTE_UNUSED)
}
/**
- * xmlModuleSymbol:
- * @module: the module
- * @name: the name of the symbol
- * @symbol: the resulting symbol address
+ * @param module the module
+ * @param name the name of the symbol
+ * @param symbol the resulting symbol address
*
* Lookup for a symbol address in the given module
* NOTE: that due to portability issues, behaviour can only be
- * guaranteed with @name using ASCII. We cannot guarantee that
+ * guaranteed with `name` using ASCII. We cannot guarantee that
* an UTF-8 string would work, which is why name is a const char *
* and not a const xmlChar * .
*
- * Returns 0 if the symbol was found, or -1 in case of error
+ * @returns 0 if the symbol was found, or -1 in case of error
*/
int
xmlModuleSymbol(xmlModulePtr module, const char *name, void **symbol)
@@ -108,13 +106,12 @@ xmlModuleSymbol(xmlModulePtr module, const char *name, void **symbol)
}
/**
- * xmlModuleClose:
- * @module: the module handle
+ * @param module the module handle
*
* The close operations unload the associated module and free the
* data associated to the module.
*
- * Returns 0 in case of success, -1 in case of argument error and -2
+ * @returns 0 in case of success, -1 in case of argument error and -2
* if the module could not be closed/unloaded.
*/
int
@@ -135,14 +132,13 @@ xmlModuleClose(xmlModulePtr module)
}
/**
- * xmlModuleFree:
- * @module: the module handle
+ * @param module the module handle
*
* The free operations free the data associated to the module
* but does not unload the associated shared library which may still
* be in use.
*
- * Returns 0 in case of success, -1 in case of argument error
+ * @returns 0 in case of success, -1 in case of argument error
*/
int
xmlModuleFree(xmlModulePtr module)
@@ -164,10 +160,9 @@ xmlModuleFree(xmlModulePtr module)
#endif
/**
- * xmlModulePlatformOpen:
- * @name: path to the module
+ * @param name path to the module
*
- * returns a handle on success, and zero on error.
+ * @returns a handle on success, and zero on error.
*/
static void *
@@ -177,10 +172,9 @@ xmlModulePlatformOpen(const char *name)
}
/*
- * xmlModulePlatformClose:
- * @handle: handle to the module
+ * @param handle handle to the module
*
- * returns 0 on success, and non-zero on error.
+ * @returns 0 on success, and non-zero on error.
*/
static int
@@ -190,9 +184,8 @@ xmlModulePlatformClose(void *handle)
}
/*
- * xmlModulePlatformSymbol:
* http://www.opengroup.org/onlinepubs/009695399/functions/dlsym.html
- * returns 0 on success and the loaded symbol in result, and -1 on error.
+ * @returns 0 on success and the loaded symbol in result, and -1 on error.
*/
static int
@@ -210,8 +203,7 @@ xmlModulePlatformSymbol(void *handle, const char *name, void **symbol)
#ifdef HAVE_SHLLOAD /* HAVE_SHLLOAD */
#include
/*
- * xmlModulePlatformOpen:
- * returns a handle on success, and zero on error.
+ * @returns a handle on success, and zero on error.
*/
static void *
@@ -221,8 +213,7 @@ xmlModulePlatformOpen(const char *name)
}
/*
- * xmlModulePlatformClose:
- * returns 0 on success, and non-zero on error.
+ * @returns 0 on success, and non-zero on error.
*/
static int
@@ -232,9 +223,8 @@ xmlModulePlatformClose(void *handle)
}
/*
- * xmlModulePlatformSymbol:
* http://docs.hp.com/en/B2355-90683/shl_load.3X.html
- * returns 0 on success and the loaded symbol in result, and -1 on error.
+ * @returns 0 on success and the loaded symbol in result, and -1 on error.
*/
static int
@@ -256,8 +246,7 @@ xmlModulePlatformSymbol(void *handle, const char *name, void **symbol)
#include
/*
- * xmlModulePlatformOpen:
- * returns a handle on success, and zero on error.
+ * @returns a handle on success, and zero on error.
*/
static void *
@@ -267,8 +256,7 @@ xmlModulePlatformOpen(const char *name)
}
/*
- * xmlModulePlatformClose:
- * returns 0 on success, and non-zero on error.
+ * @returns 0 on success, and non-zero on error.
*/
static int
@@ -281,9 +269,8 @@ xmlModulePlatformClose(void *handle)
}
/*
- * xmlModulePlatformSymbol:
* http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getprocaddress.asp
- * returns 0 on success and the loaded symbol in result, and -1 on error.
+ * @returns 0 on success and the loaded symbol in result, and -1 on error.
*/
static int
diff --git a/xmlreader.c b/xmlreader.c
index bb5616ce..19a712ed 100644
--- a/xmlreader.c
+++ b/xmlreader.c
@@ -176,7 +176,7 @@ static int xmlTextReaderNextTree(xmlTextReaderPtr reader);
/**
* DICT_FREE:
- * @str: a string
+ * @param str a string
*
* Free a string if it is not owned by the "dict" dictionary in the
* current scope
@@ -264,9 +264,8 @@ constQString(xmlTextReaderPtr reader, const xmlChar *prefix,
************************************************************************/
/**
- * xmlTextReaderFreeProp:
- * @reader: the xmlTextReaderPtr used
- * @cur: the node
+ * @param reader the xmlTextReaderPtr used
+ * @param cur the node
*
* Free a node.
*/
@@ -310,9 +309,8 @@ xmlTextReaderFreeProp(xmlTextReaderPtr reader, xmlAttrPtr cur) {
}
/**
- * xmlTextReaderFreePropList:
- * @reader: the xmlTextReaderPtr used
- * @cur: the first property in the list
+ * @param reader the xmlTextReaderPtr used
+ * @param cur the first property in the list
*
* Free a property and all its siblings, all the children are freed too.
*/
@@ -328,9 +326,8 @@ xmlTextReaderFreePropList(xmlTextReaderPtr reader, xmlAttrPtr cur) {
}
/**
- * xmlTextReaderFreeNodeList:
- * @reader: the xmlTextReaderPtr used
- * @cur: the first node in the list
+ * @param reader the xmlTextReaderPtr used
+ * @param cur the first node in the list
*
* Free a node and all its siblings, this is a recursive behaviour, all
* the children are freed too.
@@ -423,9 +420,8 @@ xmlTextReaderFreeNodeList(xmlTextReaderPtr reader, xmlNodePtr cur) {
}
/**
- * xmlTextReaderFreeNode:
- * @reader: the xmlTextReaderPtr used
- * @cur: the node
+ * @param reader the xmlTextReaderPtr used
+ * @param cur the node
*
* Free a node, this is a recursive behaviour, all the children are freed too.
* This doesn't unlink the child from the list, use xmlUnlinkNode() first.
@@ -499,9 +495,8 @@ xmlTextReaderFreeNode(xmlTextReaderPtr reader, xmlNodePtr cur) {
}
/**
- * xmlTextReaderFreeDoc:
- * @reader: the xmlTextReaderPtr used
- * @cur: pointer to the document
+ * @param reader the xmlTextReaderPtr used
+ * @param cur pointer to the document
*
* Free up all the structures used by a document, tree included.
*/
@@ -583,13 +578,12 @@ xmlTextReaderStructuredRelay(void *userData, const xmlError *error)
}
/**
- * xmlTextReaderEntPush:
- * @reader: the xmlTextReaderPtr used
- * @value: the entity reference node
+ * @param reader the xmlTextReaderPtr used
+ * @param value the entity reference node
*
* Pushes a new entity reference node on top of the entities stack
*
- * Returns -1 in case of error, the index in the stack otherwise
+ * @returns -1 in case of error, the index in the stack otherwise
*/
static int
xmlTextReaderEntPush(xmlTextReaderPtr reader, xmlNodePtr value)
@@ -618,12 +612,11 @@ xmlTextReaderEntPush(xmlTextReaderPtr reader, xmlNodePtr value)
}
/**
- * xmlTextReaderEntPop:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Pops the top element entity from the entities stack
*
- * Returns the entity just removed
+ * @returns the entity just removed
*/
static xmlNodePtr
xmlTextReaderEntPop(xmlTextReaderPtr reader)
@@ -643,10 +636,9 @@ xmlTextReaderEntPop(xmlTextReaderPtr reader)
}
/**
- * xmlTextReaderStartElement:
- * @ctx: the user data (XML parser context)
- * @fullname: The element name, including namespace prefix
- * @atts: An array of name/value attributes pairs, NULL terminated
+ * @param ctx the user data (XML parser context)
+ * @param fullname The element name, including namespace prefix
+ * @param atts An array of name/value attributes pairs, NULL terminated
*
* called when an opening tag has been processed.
*/
@@ -668,9 +660,8 @@ xmlTextReaderStartElement(void *ctx, const xmlChar *fullname,
}
/**
- * xmlTextReaderEndElement:
- * @ctx: the user data (XML parser context)
- * @fullname: The element name, including namespace prefix
+ * @param ctx the user data (XML parser context)
+ * @param fullname The element name, including namespace prefix
*
* called when an ending tag has been processed.
*/
@@ -685,16 +676,15 @@ xmlTextReaderEndElement(void *ctx, const xmlChar *fullname) {
}
/**
- * xmlTextReaderStartElementNs:
- * @ctx: the user data (XML parser context)
- * @localname: the local name of the element
- * @prefix: the element namespace prefix if available
- * @URI: the element namespace name if available
- * @nb_namespaces: number of namespace definitions on that node
- * @namespaces: pointer to the array of prefix/URI pairs namespace definitions
- * @nb_attributes: the number of attributes on that node
- * @nb_defaulted: the number of defaulted attributes.
- * @attributes: pointer to the array of (localname/prefix/URI/value/end)
+ * @param ctx the user data (XML parser context)
+ * @param localname the local name of the element
+ * @param prefix the element namespace prefix if available
+ * @param URI the element namespace name if available
+ * @param nb_namespaces number of namespace definitions on that node
+ * @param namespaces pointer to the array of prefix/URI pairs namespace definitions
+ * @param nb_attributes the number of attributes on that node
+ * @param nb_defaulted the number of defaulted attributes.
+ * @param attributes pointer to the array of (localname/prefix/URI/value/end)
* attribute values.
*
* called when an opening tag has been processed.
@@ -727,11 +717,10 @@ xmlTextReaderStartElementNs(void *ctx,
}
/**
- * xmlTextReaderEndElementNs:
- * @ctx: the user data (XML parser context)
- * @localname: the local name of the element
- * @prefix: the element namespace prefix if available
- * @URI: the element namespace name if available
+ * @param ctx the user data (XML parser context)
+ * @param localname the local name of the element
+ * @param prefix the element namespace prefix if available
+ * @param URI the element namespace name if available
*
* called when an ending tag has been processed.
*/
@@ -751,10 +740,9 @@ xmlTextReaderEndElementNs(void *ctx,
/**
- * xmlTextReaderCharacters:
- * @ctx: the user data (XML parser context)
- * @ch: a xmlChar string
- * @len: the number of xmlChar
+ * @param ctx the user data (XML parser context)
+ * @param ch a xmlChar string
+ * @param len the number of xmlChar
*
* receiving some chars from the parser.
*/
@@ -770,10 +758,9 @@ xmlTextReaderCharacters(void *ctx, const xmlChar *ch, int len)
}
/**
- * xmlTextReaderCDataBlock:
- * @ctx: the user data (XML parser context)
- * @ch: The pcdata content
- * @len: the block length
+ * @param ctx the user data (XML parser context)
+ * @param ch The pcdata content
+ * @param len the block length
*
* called when a pcdata block has been parsed
*/
@@ -789,13 +776,12 @@ xmlTextReaderCDataBlock(void *ctx, const xmlChar *ch, int len)
}
/**
- * xmlTextReaderPushData:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Push data down the progressive parser until a significant callback
* got raised.
*
- * Returns -1 in case of failure, 0 otherwise
+ * @returns -1 in case of failure, 0 otherwise
*/
static int
xmlTextReaderPushData(xmlTextReaderPtr reader) {
@@ -900,8 +886,7 @@ xmlTextReaderPushData(xmlTextReaderPtr reader) {
#ifdef LIBXML_REGEXP_ENABLED
/**
- * xmlTextReaderValidatePush:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Push the current node for validation
*/
@@ -968,10 +953,9 @@ xmlTextReaderValidatePush(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderValidateCData:
- * @reader: the xmlTextReaderPtr used
- * @data: pointer to the CData
- * @len: length of the CData block in bytes.
+ * @param reader the xmlTextReaderPtr used
+ * @param data pointer to the CData
+ * @param len length of the CData block in bytes.
*
* Push some CData for validation
*/
@@ -999,8 +983,7 @@ xmlTextReaderValidateCData(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderValidatePop:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Pop the current node from validation
*/
@@ -1057,8 +1040,7 @@ xmlTextReaderValidatePop(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderValidateEntity:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Handle the validation when an entity reference is encountered and
* entity substitution is not activated. As a result the parser interface
@@ -1153,12 +1135,11 @@ skip_children:
/**
- * xmlTextReaderGetSuccessor:
- * @cur: the current node
+ * @param cur the current node
*
* Get the successor of a node if available.
*
- * Returns the successor node or NULL
+ * @returns the successor node or NULL
*/
static xmlNodePtr
xmlTextReaderGetSuccessor(xmlNodePtr cur) {
@@ -1173,14 +1154,13 @@ xmlTextReaderGetSuccessor(xmlNodePtr cur) {
}
/**
- * xmlTextReaderDoExpand:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Makes sure that the current node is fully read as well as all its
* descendant. It means the full DOM subtree must be available at the
* end of the call.
*
- * Returns 1 if the node was expanded successfully, 0 if there is no more
+ * @returns 1 if the node was expanded successfully, 0 if there is no more
* nodes to read, or -1 in case of error
*/
static int
@@ -1210,13 +1190,12 @@ xmlTextReaderDoExpand(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderRead:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Moves the position of the current instance to the next node in
* the stream, exposing its properties.
*
- * Returns 1 if the node was read successfully, 0 if there is no more
+ * @returns 1 if the node was read successfully, 0 if there is no more
* nodes to read, or -1 in case of error
*/
int
@@ -1571,12 +1550,11 @@ node_end:
}
/**
- * xmlTextReaderReadState:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Gets the read state of the reader.
*
- * Returns the state value, or -1 in case of error
+ * @returns the state value, or -1 in case of error
*/
int
xmlTextReaderReadState(xmlTextReaderPtr reader) {
@@ -1586,13 +1564,12 @@ xmlTextReaderReadState(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderExpand:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Reads the contents of the current node and the full subtree. It then makes
* the subtree available until the next xmlTextReaderRead() call
*
- * Returns a node pointer valid until the next xmlTextReaderRead() call
+ * @returns a node pointer valid until the next xmlTextReaderRead() call
* or NULL in case of error.
*/
xmlNodePtr
@@ -1609,13 +1586,12 @@ xmlTextReaderExpand(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderNext:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Skip to the node following the current one in document order while
* avoiding the subtree if any.
*
- * Returns 1 if the node was read successfully, 0 if there is no more
+ * @returns 1 if the node was read successfully, 0 if there is no more
* nodes to read, or -1 in case of error
*/
int
@@ -1675,12 +1651,11 @@ xmlTextReaderDumpCopy(xmlTextReaderPtr reader, xmlOutputBufferPtr output,
}
/**
- * xmlTextReaderReadInnerXml:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Reads the contents of the current node, including child nodes and markup.
*
- * Returns a string containing the XML content, or NULL if the current node
+ * @returns a string containing the XML content, or NULL if the current node
* is neither an element nor attribute, or has no child nodes. The
* string must be deallocated by the caller.
*/
@@ -1716,12 +1691,11 @@ xmlTextReaderReadInnerXml(xmlTextReaderPtr reader)
}
/**
- * xmlTextReaderReadOuterXml:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Reads the contents of the current node, including child nodes and markup.
*
- * Returns a string containing the node and any XML content, or NULL if the
+ * @returns a string containing the node and any XML content, or NULL if the
* current node cannot be serialized. The string must be deallocated
* by the caller.
*/
@@ -1757,12 +1731,11 @@ xmlTextReaderReadOuterXml(xmlTextReaderPtr reader)
#endif
/**
- * xmlTextReaderReadString:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Reads the contents of an element or a text node as a string.
*
- * Returns a string containing the contents of the non-empty Element or
+ * @returns a string containing the contents of the non-empty Element or
* Text node (including CDATA sections), or NULL if the reader
* is positioned on any other type of node.
* The string must be deallocated by the caller.
@@ -1903,13 +1876,12 @@ xmlTextReaderNextTree(xmlTextReaderPtr reader)
}
/**
- * xmlTextReaderReadTree:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Moves the position of the current instance to the next node in
* the stream, exposing its properties.
*
- * Returns 1 if the node was read successfully, 0 if there is no more
+ * @returns 1 if the node was read successfully, 0 if there is no more
* nodes to read, or -1 in case of error
*/
static int
@@ -1976,14 +1948,13 @@ found_node:
}
/**
- * xmlTextReaderNextSibling:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Skip to the node following the current one in document order while
* avoiding the subtree if any.
* Currently implemented only for Readers built on a document
*
- * Returns 1 if the node was read successfully, 0 if there is no more
+ * @returns 1 if the node was read successfully, 0 if there is no more
* nodes to read, or -1 in case of error
*/
int
@@ -2016,13 +1987,12 @@ xmlTextReaderNextSibling(xmlTextReaderPtr reader) {
* *
************************************************************************/
/**
- * xmlNewTextReader:
- * @input: the xmlParserInputBufferPtr used to read data
- * @URI: the URI information for the source if available
+ * @param input the xmlParserInputBufferPtr used to read data
+ * @param URI the URI information for the source if available
*
- * Create an xmlTextReader structure fed with @input
+ * Create an xmlTextReader structure fed with `input`
*
- * Returns the new xmlTextReaderPtr or NULL in case of error
+ * @returns the new xmlTextReaderPtr or NULL in case of error
*/
xmlTextReaderPtr
xmlNewTextReader(xmlParserInputBufferPtr input, const char *URI) {
@@ -2118,12 +2088,11 @@ xmlNewTextReader(xmlParserInputBufferPtr input, const char *URI) {
}
/**
- * xmlNewTextReaderFilename:
- * @URI: the URI of the resource to process
+ * @param URI the URI of the resource to process
*
- * Create an xmlTextReader structure fed with the resource at @URI
+ * Create an xmlTextReader structure fed with the resource at `URI`
*
- * Returns the new xmlTextReaderPtr or NULL in case of error
+ * @returns the new xmlTextReaderPtr or NULL in case of error
*/
xmlTextReaderPtr
xmlNewTextReaderFilename(const char *URI) {
@@ -2162,8 +2131,7 @@ xmlNewTextReaderFilename(const char *URI) {
}
/**
- * xmlFreeTextReader:
- * @reader: the xmlTextReaderPtr
+ * @param reader the xmlTextReaderPtr
*
* Deallocate all the resources associated to the reader
*/
@@ -2237,13 +2205,12 @@ xmlFreeTextReader(xmlTextReaderPtr reader) {
************************************************************************/
/**
- * xmlTextReaderClose:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* This method releases any resources allocated by the current instance
* changes the state to Closed and close any underlying input.
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
int
xmlTextReaderClose(xmlTextReaderPtr reader) {
@@ -2284,14 +2251,13 @@ xmlTextReaderClose(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderGetAttributeNo:
- * @reader: the xmlTextReaderPtr used
- * @no: the zero-based index of the attribute relative to the containing element
+ * @param reader the xmlTextReaderPtr used
+ * @param no the zero-based index of the attribute relative to the containing element
*
* Provides the value of the attribute with the specified index relative
* to the containing element.
*
- * Returns a string containing the value of the specified attribute, or NULL
+ * @returns a string containing the value of the specified attribute, or NULL
* in case of error. The string must be deallocated by the caller.
*/
xmlChar *
@@ -2337,13 +2303,12 @@ xmlTextReaderGetAttributeNo(xmlTextReaderPtr reader, int no) {
}
/**
- * xmlTextReaderGetAttribute:
- * @reader: the xmlTextReaderPtr used
- * @name: the qualified name of the attribute.
+ * @param reader the xmlTextReaderPtr used
+ * @param name the qualified name of the attribute.
*
* Provides the value of the attribute with the specified qualified name.
*
- * Returns a string containing the value of the specified attribute, or NULL
+ * @returns a string containing the value of the specified attribute, or NULL
* in case of error. The string must be deallocated by the caller.
*/
xmlChar *
@@ -2422,14 +2387,13 @@ xmlTextReaderGetAttribute(xmlTextReaderPtr reader, const xmlChar *name) {
/**
- * xmlTextReaderGetAttributeNs:
- * @reader: the xmlTextReaderPtr used
- * @localName: the local name of the attribute.
- * @namespaceURI: the namespace URI of the attribute.
+ * @param reader the xmlTextReaderPtr used
+ * @param localName the local name of the attribute.
+ * @param namespaceURI the namespace URI of the attribute.
*
* Provides the value of the specified attribute
*
- * Returns a string containing the value of the specified attribute, or NULL
+ * @returns a string containing the value of the specified attribute, or NULL
* in case of error. The string must be deallocated by the caller.
*/
xmlChar *
@@ -2474,8 +2438,7 @@ xmlTextReaderGetAttributeNs(xmlTextReaderPtr reader, const xmlChar *localName,
}
/**
- * xmlTextReaderGetRemainder:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Method to get the remainder of the buffered XML. this method stops the
* parser, set its state to End Of File and return the input stream with
@@ -2485,7 +2448,7 @@ xmlTextReaderGetAttributeNs(xmlTextReaderPtr reader, const xmlChar *localName,
* what's left in reader->input, and there is an allocation problem. Best
* would be to rewrite it differently.
*
- * Returns the xmlParserInputBufferPtr attached to the XML or NULL
+ * @returns the xmlParserInputBufferPtr attached to the XML or NULL
* in case of error.
*/
xmlParserInputBufferPtr
@@ -2525,14 +2488,13 @@ xmlTextReaderGetRemainder(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderLookupNamespace:
- * @reader: the xmlTextReaderPtr used
- * @prefix: the prefix whose namespace URI is to be resolved. To return
+ * @param reader the xmlTextReaderPtr used
+ * @param prefix the prefix whose namespace URI is to be resolved. To return
* the default namespace, specify NULL
*
* Resolves a namespace prefix in the scope of the current element.
*
- * Returns a string containing the namespace URI to which the prefix maps
+ * @returns a string containing the namespace URI to which the prefix maps
* or NULL in case of error. The string must be deallocated by the caller.
*/
xmlChar *
@@ -2556,15 +2518,14 @@ xmlTextReaderLookupNamespace(xmlTextReaderPtr reader, const xmlChar *prefix) {
}
/**
- * xmlTextReaderMoveToAttributeNo:
- * @reader: the xmlTextReaderPtr used
- * @no: the zero-based index of the attribute relative to the containing
+ * @param reader the xmlTextReaderPtr used
+ * @param no the zero-based index of the attribute relative to the containing
* element.
*
* Moves the position of the current instance to the attribute with
* the specified index relative to the containing element.
*
- * Returns 1 in case of success, -1 in case of error, 0 if not found
+ * @returns 1 in case of success, -1 in case of error, 0 if not found
*/
int
xmlTextReaderMoveToAttributeNo(xmlTextReaderPtr reader, int no) {
@@ -2606,14 +2567,13 @@ xmlTextReaderMoveToAttributeNo(xmlTextReaderPtr reader, int no) {
}
/**
- * xmlTextReaderMoveToAttribute:
- * @reader: the xmlTextReaderPtr used
- * @name: the qualified name of the attribute.
+ * @param reader the xmlTextReaderPtr used
+ * @param name the qualified name of the attribute.
*
* Moves the position of the current instance to the attribute with
* the specified qualified name.
*
- * Returns 1 in case of success, -1 in case of error, 0 if not found
+ * @returns 1 in case of success, -1 in case of error, 0 if not found
*/
int
xmlTextReaderMoveToAttribute(xmlTextReaderPtr reader, const xmlChar *name) {
@@ -2709,15 +2669,14 @@ found:
}
/**
- * xmlTextReaderMoveToAttributeNs:
- * @reader: the xmlTextReaderPtr used
- * @localName: the local name of the attribute.
- * @namespaceURI: the namespace URI of the attribute.
+ * @param reader the xmlTextReaderPtr used
+ * @param localName the local name of the attribute.
+ * @param namespaceURI the namespace URI of the attribute.
*
* Moves the position of the current instance to the attribute with the
* specified local name and namespace URI.
*
- * Returns 1 in case of success, -1 in case of error, 0 if not found
+ * @returns 1 in case of success, -1 in case of error, 0 if not found
*/
int
xmlTextReaderMoveToAttributeNs(xmlTextReaderPtr reader,
@@ -2770,13 +2729,12 @@ xmlTextReaderMoveToAttributeNs(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderMoveToFirstAttribute:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Moves the position of the current instance to the first attribute
* associated with the current node.
*
- * Returns 1 in case of success, -1 in case of error, 0 if not found
+ * @returns 1 in case of success, -1 in case of error, 0 if not found
*/
int
xmlTextReaderMoveToFirstAttribute(xmlTextReaderPtr reader) {
@@ -2799,13 +2757,12 @@ xmlTextReaderMoveToFirstAttribute(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderMoveToNextAttribute:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Moves the position of the current instance to the next attribute
* associated with the current node.
*
- * Returns 1 in case of success, -1 in case of error, 0 if not found
+ * @returns 1 in case of success, -1 in case of error, 0 if not found
*/
int
xmlTextReaderMoveToNextAttribute(xmlTextReaderPtr reader) {
@@ -2838,13 +2795,12 @@ xmlTextReaderMoveToNextAttribute(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderMoveToElement:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Moves the position of the current instance to the node that
* contains the current Attribute node.
*
- * Returns 1 in case of success, -1 in case of error, 0 if not moved
+ * @returns 1 in case of success, -1 in case of error, 0 if not moved
*/
int
xmlTextReaderMoveToElement(xmlTextReaderPtr reader) {
@@ -2862,12 +2818,11 @@ xmlTextReaderMoveToElement(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderReadAttributeValue:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Parses an attribute value into one or more Text and EntityReference nodes.
*
- * Returns 1 in case of success, 0 if the reader was not positioned on an
+ * @returns 1 in case of success, 0 if the reader was not positioned on an
* attribute node or all the attribute values have been read, or -1
* in case of error.
*/
@@ -2918,12 +2873,11 @@ xmlTextReaderReadAttributeValue(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstEncoding:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Determine the encoding of the document being read.
*
- * Returns a string containing the encoding of the document or NULL in
+ * @returns a string containing the encoding of the document or NULL in
* case of error. The string is deallocated with the reader.
*/
const xmlChar *
@@ -2948,12 +2902,11 @@ xmlTextReaderConstEncoding(xmlTextReaderPtr reader) {
* *
************************************************************************/
/**
- * xmlTextReaderAttributeCount:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Provides the number of attributes of the current node
*
- * Returns 0 i no attributes, -1 in case of error or the attribute count
+ * @returns 0 i no attributes, -1 in case of error or the attribute count
*/
int
xmlTextReaderAttributeCount(xmlTextReaderPtr reader) {
@@ -2992,14 +2945,13 @@ xmlTextReaderAttributeCount(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderNodeType:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Get the node type of the current node
* Reference:
* http://www.gnu.org/software/dotgnu/pnetlib-doc/System/Xml/XmlNodeType.html
*
- * Returns the xmlReaderTypes of the current node or -1 in case of error
+ * @returns the xmlReaderTypes of the current node or -1 in case of error
*/
int
xmlTextReaderNodeType(xmlTextReaderPtr reader) {
@@ -3063,12 +3015,11 @@ xmlTextReaderNodeType(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderIsEmptyElement:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Check if the current node is empty
*
- * Returns 1 if empty, 0 if not and -1 in case of error
+ * @returns 1 if empty, 0 if not and -1 in case of error
*/
int
xmlTextReaderIsEmptyElement(xmlTextReaderPtr reader) {
@@ -3092,12 +3043,11 @@ xmlTextReaderIsEmptyElement(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderLocalName:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The local name of the node.
*
- * Returns the local name or NULL if not available,
+ * @returns the local name or NULL if not available,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -3123,12 +3073,11 @@ xmlTextReaderLocalName(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstLocalName:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The local name of the node.
*
- * Returns the local name or NULL if not available, the
+ * @returns the local name or NULL if not available, the
* string will be deallocated with the reader.
*/
const xmlChar *
@@ -3154,12 +3103,11 @@ xmlTextReaderConstLocalName(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderName:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The qualified name of the node, equal to Prefix :LocalName.
*
- * Returns the local name or NULL if not available,
+ * @returns the local name or NULL if not available,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -3227,12 +3175,11 @@ xmlTextReaderName(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstName:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The qualified name of the node, equal to Prefix :LocalName.
*
- * Returns the local name or NULL if not available, the string is
+ * @returns the local name or NULL if not available, the string is
* deallocated with the reader.
*/
const xmlChar *
@@ -3292,12 +3239,11 @@ xmlTextReaderConstName(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderPrefix:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* A shorthand reference to the namespace associated with the node.
*
- * Returns the prefix or NULL if not available,
+ * @returns the prefix or NULL if not available,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -3324,12 +3270,11 @@ xmlTextReaderPrefix(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstPrefix:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* A shorthand reference to the namespace associated with the node.
*
- * Returns the prefix or NULL if not available, the string is deallocated
+ * @returns the prefix or NULL if not available, the string is deallocated
* with the reader.
*/
const xmlChar *
@@ -3356,12 +3301,11 @@ xmlTextReaderConstPrefix(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderNamespaceUri:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The URI defining the namespace associated with the node.
*
- * Returns the namespace URI or NULL if not available,
+ * @returns the namespace URI or NULL if not available,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -3384,12 +3328,11 @@ xmlTextReaderNamespaceUri(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstNamespaceUri:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The URI defining the namespace associated with the node.
*
- * Returns the namespace URI or NULL if not available, the string
+ * @returns the namespace URI or NULL if not available, the string
* will be deallocated with the reader
*/
const xmlChar *
@@ -3412,12 +3355,11 @@ xmlTextReaderConstNamespaceUri(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderBaseUri:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The base URI of the node.
*
- * Returns the base URI or NULL if not available,
+ * @returns the base URI or NULL if not available,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -3435,12 +3377,11 @@ xmlTextReaderBaseUri(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstBaseUri:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The base URI of the node.
*
- * Returns the base URI or NULL if not available, the string
+ * @returns the base URI or NULL if not available, the string
* will be deallocated with the reader
*/
const xmlChar *
@@ -3462,12 +3403,11 @@ xmlTextReaderConstBaseUri(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderDepth:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The depth of the node in the tree.
*
- * Returns the depth or -1 in case of error
+ * @returns the depth or -1 in case of error
*/
int
xmlTextReaderDepth(xmlTextReaderPtr reader) {
@@ -3486,12 +3426,11 @@ xmlTextReaderDepth(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderHasAttributes:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Whether the node has attributes.
*
- * Returns 1 if true, 0 if false, and -1 in case or error
+ * @returns 1 if true, 0 if false, and -1 in case or error
*/
int
xmlTextReaderHasAttributes(xmlTextReaderPtr reader) {
@@ -3513,12 +3452,11 @@ xmlTextReaderHasAttributes(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderHasValue:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Whether the node can have a text value.
*
- * Returns 1 if true, 0 if false, and -1 in case or error
+ * @returns 1 if true, 0 if false, and -1 in case or error
*/
int
xmlTextReaderHasValue(xmlTextReaderPtr reader) {
@@ -3547,12 +3485,11 @@ xmlTextReaderHasValue(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderValue:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Provides the text value of the node if present
*
- * Returns the string or NULL if not available. The result must be deallocated
+ * @returns the string or NULL if not available. The result must be deallocated
* with xmlFree()
*/
xmlChar *
@@ -3596,12 +3533,11 @@ xmlTextReaderValue(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstValue:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Provides the text value of the node if present
*
- * Returns the string or NULL if not available. The result will be
+ * @returns the string or NULL if not available. The result will be
* deallocated on the next Read() operation.
*/
const xmlChar *
@@ -3658,13 +3594,12 @@ xmlTextReaderConstValue(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderIsDefault:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Whether an Attribute node was generated from the default value
* defined in the DTD or schema.
*
- * Returns 0 if not defaulted, 1 if defaulted, and -1 in case of error
+ * @returns 0 if not defaulted, 1 if defaulted, and -1 in case of error
*/
int
xmlTextReaderIsDefault(xmlTextReaderPtr reader) {
@@ -3674,12 +3609,11 @@ xmlTextReaderIsDefault(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderQuoteChar:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The quotation mark character used to enclose the value of an attribute.
*
- * Returns " or ' and -1 in case of error
+ * @returns " or ' and -1 in case of error
*/
int
xmlTextReaderQuoteChar(xmlTextReaderPtr reader) {
@@ -3690,12 +3624,11 @@ xmlTextReaderQuoteChar(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderXmlLang:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The xml:lang scope within which the node resides.
*
- * Returns the xml:lang value or NULL if none exists.,
+ * @returns the xml:lang value or NULL if none exists.,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -3708,12 +3641,11 @@ xmlTextReaderXmlLang(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstXmlLang:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The xml:lang scope within which the node resides.
*
- * Returns the xml:lang value or NULL if none exists.
+ * @returns the xml:lang value or NULL if none exists.
*/
const xmlChar *
xmlTextReaderConstXmlLang(xmlTextReaderPtr reader) {
@@ -3733,14 +3665,13 @@ xmlTextReaderConstXmlLang(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstString:
- * @reader: the xmlTextReaderPtr used
- * @str: the string to intern.
+ * @param reader the xmlTextReaderPtr used
+ * @param str the string to intern.
*
* Get an interned string from the reader, allows for example to
* speedup string name comparisons
*
- * Returns an interned copy of the string or NULL in case of error. The
+ * @returns an interned copy of the string or NULL in case of error. The
* string will be deallocated with the reader.
*/
const xmlChar *
@@ -3751,16 +3682,15 @@ xmlTextReaderConstString(xmlTextReaderPtr reader, const xmlChar *str) {
}
/**
- * xmlTextReaderNormalization:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* The value indicating whether to normalize white space and attribute values.
* Since attribute value and end of line normalizations are a MUST in the XML
* specification only the value true is accepted. The broken behaviour of
- * accepting out of range character entities like � is of course not
+ * accepting out of range character entities like &\#0; is of course not
* supported either.
*
- * Returns 1 or -1 in case of error.
+ * @returns 1 or -1 in case of error.
*/
int
xmlTextReaderNormalization(xmlTextReaderPtr reader) {
@@ -3776,16 +3706,15 @@ xmlTextReaderNormalization(xmlTextReaderPtr reader) {
************************************************************************/
/**
- * xmlTextReaderSetParserProp:
- * @reader: the xmlTextReaderPtr used
- * @prop: the xmlParserProperties to set
- * @value: usually 0 or 1 to (de)activate it
+ * @param reader the xmlTextReaderPtr used
+ * @param prop the xmlParserProperties to set
+ * @param value usually 0 or 1 to (de)activate it
*
* Change the parser processing behaviour by changing some of its internal
* properties. Note that some properties can only be changed before any
* read has been done.
*
- * Returns 0 if the call was successful, or -1 in case of error
+ * @returns 0 if the call was successful, or -1 in case of error
*/
int
xmlTextReaderSetParserProp(xmlTextReaderPtr reader, int prop, int value) {
@@ -3843,13 +3772,12 @@ xmlTextReaderSetParserProp(xmlTextReaderPtr reader, int prop, int value) {
}
/**
- * xmlTextReaderGetParserProp:
- * @reader: the xmlTextReaderPtr used
- * @prop: the xmlParserProperties to get
+ * @param reader the xmlTextReaderPtr used
+ * @param prop the xmlParserProperties to get
*
* Read the parser internal property.
*
- * Returns the value, usually 0 or 1, or -1 in case of error.
+ * @returns the value, usually 0 or 1, or -1 in case of error.
*/
int
xmlTextReaderGetParserProp(xmlTextReaderPtr reader, int prop) {
@@ -3879,12 +3807,11 @@ xmlTextReaderGetParserProp(xmlTextReaderPtr reader, int prop) {
/**
- * xmlTextReaderGetParserLineNumber:
- * @reader: the user data (XML reader context)
+ * @param reader the user data (XML reader context)
*
* Provide the line number of the current parsing point.
*
- * Returns an int or 0 if not available
+ * @returns an int or 0 if not available
*/
int
xmlTextReaderGetParserLineNumber(xmlTextReaderPtr reader)
@@ -3897,12 +3824,11 @@ xmlTextReaderGetParserLineNumber(xmlTextReaderPtr reader)
}
/**
- * xmlTextReaderGetParserColumnNumber:
- * @reader: the user data (XML reader context)
+ * @param reader the user data (XML reader context)
*
* Provide the column number of the current parsing point.
*
- * Returns an int or 0 if not available
+ * @returns an int or 0 if not available
*/
int
xmlTextReaderGetParserColumnNumber(xmlTextReaderPtr reader)
@@ -3915,14 +3841,13 @@ xmlTextReaderGetParserColumnNumber(xmlTextReaderPtr reader)
}
/**
- * xmlTextReaderCurrentNode:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Hacking interface allowing to get the xmlNodePtr corresponding to the
* current node being accessed by the xmlTextReader. This is dangerous
* because the underlying node may be destroyed on the next Reads.
*
- * Returns the xmlNodePtr or NULL in case of error.
+ * @returns the xmlNodePtr or NULL in case of error.
*/
xmlNodePtr
xmlTextReaderCurrentNode(xmlTextReaderPtr reader) {
@@ -3935,14 +3860,13 @@ xmlTextReaderCurrentNode(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderPreserve:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* This tells the XML Reader to preserve the current node.
* The caller must also use xmlTextReaderCurrentDoc() to
* keep an handle on the resulting document once parsing has finished
*
- * Returns the xmlNodePtr or NULL in case of error.
+ * @returns the xmlNodePtr or NULL in case of error.
*/
xmlNodePtr
xmlTextReaderPreserve(xmlTextReaderPtr reader) {
@@ -3972,16 +3896,15 @@ xmlTextReaderPreserve(xmlTextReaderPtr reader) {
#ifdef LIBXML_PATTERN_ENABLED
/**
- * xmlTextReaderPreservePattern:
- * @reader: the xmlTextReaderPtr used
- * @pattern: an XPath subset pattern
- * @namespaces: the prefix definitions, array of [URI, prefix] or NULL
+ * @param reader the xmlTextReaderPtr used
+ * @param pattern an XPath subset pattern
+ * @param namespaces the prefix definitions, array of [URI, prefix] or NULL
*
* This tells the XML Reader to preserve all nodes matched by the
* pattern. The caller must also use xmlTextReaderCurrentDoc() to
* keep an handle on the resulting document once parsing has finished
*
- * Returns a non-negative number in case of success and -1 in case of error
+ * @returns a non-negative number in case of success and -1 in case of error
*/
int
xmlTextReaderPreservePattern(xmlTextReaderPtr reader, const xmlChar *pattern,
@@ -4020,8 +3943,7 @@ xmlTextReaderPreservePattern(xmlTextReaderPtr reader, const xmlChar *pattern,
#endif
/**
- * xmlTextReaderCurrentDoc:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Hacking interface allowing to get the xmlDocPtr corresponding to the
* current document being accessed by the xmlTextReader.
@@ -4029,7 +3951,7 @@ xmlTextReaderPreservePattern(xmlTextReaderPtr reader, const xmlChar *pattern,
* associated XML document and calling xmlFreeDoc() on the result
* is needed once the reader parsing has finished.
*
- * Returns the xmlDocPtr or NULL in case of error.
+ * @returns the xmlDocPtr or NULL in case of error.
*/
xmlDocPtr
xmlTextReaderCurrentDoc(xmlTextReaderPtr reader) {
@@ -4046,17 +3968,16 @@ xmlTextReaderCurrentDoc(xmlTextReaderPtr reader) {
#ifdef LIBXML_RELAXNG_ENABLED
/**
- * xmlTextReaderRelaxNGSetSchema:
- * @reader: the xmlTextReaderPtr used
- * @schema: a precompiled RelaxNG schema
+ * @param reader the xmlTextReaderPtr used
+ * @param schema a precompiled RelaxNG schema
*
* Use RelaxNG to validate the document as it is processed.
* Activation is only possible before the first Read().
- * if @schema is NULL, then RelaxNG validation is deactivated.
- * The @schema should not be freed until the reader is deallocated
+ * if `schema` is NULL, then RelaxNG validation is deactivated.
+ * The `schema` should not be freed until the reader is deallocated
* or its use has been deactivated.
*
- * Returns 0 in case the RelaxNG validation could be (de)activated and
+ * @returns 0 in case the RelaxNG validation could be (de)activated and
* -1 in case of error.
*/
int
@@ -4103,14 +4024,13 @@ xmlTextReaderRelaxNGSetSchema(xmlTextReaderPtr reader, xmlRelaxNGPtr schema) {
#ifdef LIBXML_SCHEMAS_ENABLED
/**
- * xmlTextReaderLocator:
- * @ctx: the xmlTextReaderPtr used
- * @file: returned file information
- * @line: returned line information
+ * @param ctx the xmlTextReaderPtr used
+ * @param file returned file information
+ * @param line returned line information
*
* Internal locator function for the readers
*
- * Returns 0 in case the Schema validation could be (de)activated and
+ * @returns 0 in case the Schema validation could be (de)activated and
* -1 in case of error.
*/
static int
@@ -4157,17 +4077,16 @@ xmlTextReaderLocator(void *ctx, const char **file, unsigned long *line) {
}
/**
- * xmlTextReaderSetSchema:
- * @reader: the xmlTextReaderPtr used
- * @schema: a precompiled Schema schema
+ * @param reader the xmlTextReaderPtr used
+ * @param schema a precompiled Schema schema
*
* Use XSD Schema to validate the document as it is processed.
* Activation is only possible before the first Read().
- * if @schema is NULL, then Schema validation is deactivated.
- * The @schema should not be freed until the reader is deallocated
+ * if `schema` is NULL, then Schema validation is deactivated.
+ * The `schema` should not be freed until the reader is deallocated
* or its use has been deactivated.
*
- * Returns 0 in case the Schema validation could be (de)activated and
+ * @returns 0 in case the Schema validation could be (de)activated and
* -1 in case of error.
*/
int
@@ -4238,17 +4157,16 @@ xmlTextReaderSetSchema(xmlTextReaderPtr reader, xmlSchemaPtr schema) {
#ifdef LIBXML_RELAXNG_ENABLED
/**
- * xmlTextReaderRelaxNGValidateInternal:
- * @reader: the xmlTextReaderPtr used
- * @rng: the path to a RelaxNG schema or NULL
- * @ctxt: the RelaxNG schema validation context or NULL
- * @options: options (not yet used)
+ * @param reader the xmlTextReaderPtr used
+ * @param rng the path to a RelaxNG schema or NULL
+ * @param ctxt the RelaxNG schema validation context or NULL
+ * @param options options (not yet used)
*
* Use RelaxNG to validate the document as it is processed.
* Activation is only possible before the first Read().
- * If both @rng and @ctxt are NULL, then RelaxNG validation is deactivated.
+ * If both `rng` and `ctxt` are NULL, then RelaxNG validation is deactivated.
*
- * Returns 0 in case the RelaxNG validation could be (de)activated and
+ * @returns 0 in case the RelaxNG validation could be (de)activated and
* -1 in case of error.
*/
static int
@@ -4328,17 +4246,16 @@ xmlTextReaderRelaxNGValidateInternal(xmlTextReaderPtr reader,
#ifdef LIBXML_SCHEMAS_ENABLED
/**
- * xmlTextReaderSchemaValidateInternal:
- * @reader: the xmlTextReaderPtr used
- * @xsd: the path to a W3C XSD schema or NULL
- * @ctxt: the XML Schema validation context or NULL
- * @options: options (not used yet)
+ * @param reader the xmlTextReaderPtr used
+ * @param xsd the path to a W3C XSD schema or NULL
+ * @param ctxt the XML Schema validation context or NULL
+ * @param options options (not used yet)
*
* Validate the document as it is processed using XML Schema.
* Activation is only possible before the first Read().
- * If both @xsd and @ctxt are NULL then XML Schema validation is deactivated.
+ * If both `xsd` and `ctxt` are NULL then XML Schema validation is deactivated.
*
- * Returns 0 in case the schemas validation could be (de)activated and
+ * @returns 0 in case the schemas validation could be (de)activated and
* -1 in case of error.
*/
static int
@@ -4437,16 +4354,15 @@ xmlTextReaderSchemaValidateInternal(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderSchemaValidateCtxt:
- * @reader: the xmlTextReaderPtr used
- * @ctxt: the XML Schema validation context or NULL
- * @options: options (not used yet)
+ * @param reader the xmlTextReaderPtr used
+ * @param ctxt the XML Schema validation context or NULL
+ * @param options options (not used yet)
*
* Use W3C XSD schema context to validate the document as it is processed.
* Activation is only possible before the first Read().
- * If @ctxt is NULL, then XML Schema validation is deactivated.
+ * If `ctxt` is NULL, then XML Schema validation is deactivated.
*
- * Returns 0 in case the schemas validation could be (de)activated and
+ * @returns 0 in case the schemas validation could be (de)activated and
* -1 in case of error.
*/
int
@@ -4458,15 +4374,14 @@ xmlTextReaderSchemaValidateCtxt(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderSchemaValidate:
- * @reader: the xmlTextReaderPtr used
- * @xsd: the path to a W3C XSD schema or NULL
+ * @param reader the xmlTextReaderPtr used
+ * @param xsd the path to a W3C XSD schema or NULL
*
* Use W3C XSD schema to validate the document as it is processed.
* Activation is only possible before the first Read().
- * If @xsd is NULL, then XML Schema validation is deactivated.
+ * If `xsd` is NULL, then XML Schema validation is deactivated.
*
- * Returns 0 in case the schemas validation could be (de)activated and
+ * @returns 0 in case the schemas validation could be (de)activated and
* -1 in case of error.
*/
int
@@ -4478,16 +4393,15 @@ xmlTextReaderSchemaValidate(xmlTextReaderPtr reader, const char *xsd)
#ifdef LIBXML_RELAXNG_ENABLED
/**
- * xmlTextReaderRelaxNGValidateCtxt:
- * @reader: the xmlTextReaderPtr used
- * @ctxt: the RelaxNG schema validation context or NULL
- * @options: options (not used yet)
+ * @param reader the xmlTextReaderPtr used
+ * @param ctxt the RelaxNG schema validation context or NULL
+ * @param options options (not used yet)
*
* Use RelaxNG schema context to validate the document as it is processed.
* Activation is only possible before the first Read().
- * If @ctxt is NULL, then RelaxNG schema validation is deactivated.
+ * If `ctxt` is NULL, then RelaxNG schema validation is deactivated.
*
- * Returns 0 in case the schemas validation could be (de)activated and
+ * @returns 0 in case the schemas validation could be (de)activated and
* -1 in case of error.
*/
int
@@ -4499,15 +4413,14 @@ xmlTextReaderRelaxNGValidateCtxt(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderRelaxNGValidate:
- * @reader: the xmlTextReaderPtr used
- * @rng: the path to a RelaxNG schema or NULL
+ * @param reader the xmlTextReaderPtr used
+ * @param rng the path to a RelaxNG schema or NULL
*
* Use RelaxNG schema to validate the document as it is processed.
* Activation is only possible before the first Read().
- * If @rng is NULL, then RelaxNG schema validation is deactivated.
+ * If `rng` is NULL, then RelaxNG schema validation is deactivated.
*
- * Returns 0 in case the schemas validation could be (de)activated and
+ * @returns 0 in case the schemas validation could be (de)activated and
* -1 in case of error.
*/
int
@@ -4518,13 +4431,12 @@ xmlTextReaderRelaxNGValidate(xmlTextReaderPtr reader, const char *rng)
#endif /* LIBXML_RELAXNG_ENABLED */
/**
- * xmlTextReaderIsNamespaceDecl:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Determine whether the current node is a namespace declaration
* rather than a regular attribute.
*
- * Returns 1 if the current node is a namespace declaration, 0 if it
+ * @returns 1 if the current node is a namespace declaration, 0 if it
* is a regular attribute or other type of node, or -1 in case of
* error.
*/
@@ -4547,12 +4459,11 @@ xmlTextReaderIsNamespaceDecl(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderConstXmlVersion:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Determine the XML version of the document being read.
*
- * Returns a string containing the XML version of the document or NULL
+ * @returns a string containing the XML version of the document or NULL
* in case of error. The string is deallocated with the reader.
*/
const xmlChar *
@@ -4574,12 +4485,11 @@ xmlTextReaderConstXmlVersion(xmlTextReaderPtr reader) {
}
/**
- * xmlTextReaderStandalone:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Determine the standalone status of the document being read.
*
- * Returns 1 if the document was declared to be standalone, 0 if it
+ * @returns 1 if the document was declared to be standalone, 0 if it
* was declared to be not standalone, or -1 if the document did not
* specify its standalone status or in case of error.
*/
@@ -4605,12 +4515,11 @@ xmlTextReaderStandalone(xmlTextReaderPtr reader) {
************************************************************************/
/**
- * xmlTextReaderLocatorLineNumber:
- * @locator: the xmlTextReaderLocatorPtr used
+ * @param locator the xmlTextReaderLocatorPtr used
*
* Obtain the line number for the given locator.
*
- * Returns the line number or -1 in case of error.
+ * @returns the line number or -1 in case of error.
*/
int
xmlTextReaderLocatorLineNumber(xmlTextReaderLocatorPtr locator) {
@@ -4641,12 +4550,11 @@ xmlTextReaderLocatorLineNumber(xmlTextReaderLocatorPtr locator) {
}
/**
- * xmlTextReaderLocatorBaseURI:
- * @locator: the xmlTextReaderLocatorPtr used
+ * @param locator the xmlTextReaderLocatorPtr used
*
* Obtain the base URI for the given locator.
*
- * Returns the base URI or NULL in case of error,
+ * @returns the base URI or NULL in case of error,
* if non NULL it need to be freed by the caller.
*/
xmlChar *
@@ -4678,16 +4586,15 @@ xmlTextReaderLocatorBaseURI(xmlTextReaderLocatorPtr locator) {
}
/**
- * xmlTextReaderSetErrorHandler:
- * @reader: the xmlTextReaderPtr used
- * @f: the callback function to call on error and warnings
- * @arg: a user argument to pass to the callback function
+ * @param reader the xmlTextReaderPtr used
+ * @param f the callback function to call on error and warnings
+ * @param arg a user argument to pass to the callback function
*
- * DEPRECATED: Use xmlTextReaderSetStructuredErrorHandler.
+ * @deprecated Use xmlTextReaderSetStructuredErrorHandler.
*
* Register a callback function that will be called on error and warnings.
*
- * If @f is NULL, the default error and warning handlers are restored.
+ * If `f` is NULL, the default error and warning handlers are restored.
*/
void
xmlTextReaderSetErrorHandler(xmlTextReaderPtr reader,
@@ -4737,13 +4644,13 @@ xmlTextReaderSetErrorHandler(xmlTextReaderPtr reader,
/**
* xmlTextReaderSetStructuredErrorHandler:
- * @reader: the xmlTextReaderPtr used
- * @f: the callback function to call on error and warnings
- * @arg: a user argument to pass to the callback function
+ * @param reader the xmlTextReaderPtr used
+ * @param f the callback function to call on error and warnings
+ * @param arg a user argument to pass to the callback function
*
* Register a callback function that will be called on error and warnings.
*
- * If @f is NULL, the default error and warning handlers are restored.
+ * If `f` is NULL, the default error and warning handlers are restored.
*/
void
xmlTextReaderSetStructuredErrorHandler(xmlTextReaderPtr reader,
@@ -4792,10 +4699,9 @@ xmlTextReaderSetStructuredErrorHandler(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderGetErrorHandler:
- * @reader: the xmlTextReaderPtr used
- * @f: the callback function or NULL is no callback has been registered
- * @arg: a user argument
+ * @param reader the xmlTextReaderPtr used
+ * @param f the callback function or NULL is no callback has been registered
+ * @param arg a user argument
*
* Retrieve the error callback function and user argument.
*/
@@ -4810,10 +4716,9 @@ xmlTextReaderGetErrorHandler(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderSetResourceLoader:
- * @reader: thr reader
- * @loader: resource loader
- * @data: user data which will be passed to the loader
+ * @param reader thr reader
+ * @param loader resource loader
+ * @param data user data which will be passed to the loader
*
* Register a callback function that will be called to load external
* resources like entities.
@@ -4833,12 +4738,11 @@ xmlTextReaderSetResourceLoader(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderIsValid:
- * @reader: the xmlTextReaderPtr used
+ * @param reader the xmlTextReaderPtr used
*
* Retrieve the validity status from the parser context
*
- * Returns the flag value 1 if valid, 0 if no, and -1 in case of error
+ * @returns the flag value 1 if valid, 0 if no, and -1 in case of error
*/
int
xmlTextReaderIsValid(xmlTextReaderPtr reader)
@@ -4865,17 +4769,16 @@ xmlTextReaderIsValid(xmlTextReaderPtr reader)
************************************************************************/
/**
- * xmlTextReaderSetup:
- * @reader: an XML reader
- * @input: xmlParserInputBufferPtr used to feed the reader, will
+ * @param reader an XML reader
+ * @param input xmlParserInputBufferPtr used to feed the reader, will
* be destroyed with it.
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Setup an XML reader with new options
*
- * Returns 0 in case of success and -1 in case of error.
+ * @returns 0 in case of success and -1 in case of error.
*/
int
xmlTextReaderSetup(xmlTextReaderPtr reader,
@@ -5064,9 +4967,8 @@ xmlTextReaderSetup(xmlTextReaderPtr reader,
}
/**
- * xmlTextReaderSetMaxAmplification:
- * @reader: an XML reader
- * @maxAmpl: maximum amplification factor
+ * @param reader an XML reader
+ * @param maxAmpl maximum amplification factor
*
* Set the maximum amplification factor. See xmlCtxtSetMaxAmplification.
*/
@@ -5079,12 +4981,11 @@ xmlTextReaderSetMaxAmplification(xmlTextReaderPtr reader, unsigned maxAmpl)
}
/**
- * xmlTextReaderGetLastError:
- * @reader: an XML reader
+ * @param reader an XML reader
*
* Available since 2.13.0.
*
- * Returns the last error.
+ * @returns the last error.
*/
const xmlError *
xmlTextReaderGetLastError(xmlTextReaderPtr reader)
@@ -5095,10 +4996,9 @@ xmlTextReaderGetLastError(xmlTextReaderPtr reader)
}
/**
- * xmlTextReaderByteConsumed:
- * @reader: an XML reader
+ * @param reader an XML reader
*
- * DEPRECATED: The returned value is mostly random and useless.
+ * @deprecated The returned value is mostly random and useless.
* It reflects the parser reading ahead and is in no way related to
* the current node.
*
@@ -5108,7 +5008,7 @@ xmlTextReaderGetLastError(xmlTextReaderPtr reader)
* for the parser context associated with the reader.
* See xmlBytesConsumed() for more information.
*
- * Returns the index in bytes from the beginning of the entity or -1
+ * @returns the index in bytes from the beginning of the entity or -1
* in case the index could not be computed.
*/
long
@@ -5125,12 +5025,11 @@ xmlTextReaderByteConsumed(xmlTextReaderPtr reader) {
/**
- * xmlReaderWalker:
- * @doc: a preparsed document
+ * @param doc a preparsed document
*
* Create an xmltextReader for a preparsed document.
*
- * Returns the new reader or NULL in case of error.
+ * @returns the new reader or NULL in case of error.
*/
xmlTextReaderPtr
xmlReaderWalker(xmlDocPtr doc)
@@ -5160,16 +5059,15 @@ xmlReaderWalker(xmlDocPtr doc)
}
/**
- * xmlReaderForDoc:
- * @cur: a pointer to a zero terminated string
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param cur a pointer to a zero terminated string
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Create an xmltextReader for an XML in-memory document.
- * The parsing flags @options are a combination of xmlParserOption.
+ * The parsing flags `options` are a combination of xmlParserOption.
*
- * Returns the new reader or NULL in case of error.
+ * @returns the new reader or NULL in case of error.
*/
xmlTextReaderPtr
xmlReaderForDoc(const xmlChar * cur, const char *URL, const char *encoding,
@@ -5186,15 +5084,14 @@ xmlReaderForDoc(const xmlChar * cur, const char *URL, const char *encoding,
}
/**
- * xmlReaderForFile:
- * @filename: a file or URL
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param filename a file or URL
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* parse an XML file from the filesystem or the network.
- * The parsing flags @options are a combination of xmlParserOption.
+ * The parsing flags `options` are a combination of xmlParserOption.
*
- * Returns the new reader or NULL in case of error.
+ * @returns the new reader or NULL in case of error.
*/
xmlTextReaderPtr
xmlReaderForFile(const char *filename, const char *encoding, int options)
@@ -5212,17 +5109,16 @@ xmlReaderForFile(const char *filename, const char *encoding, int options)
}
/**
- * xmlReaderForMemory:
- * @buffer: a pointer to a char array
- * @size: the size of the array
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Create an xmltextReader for an XML in-memory document.
- * The parsing flags @options are a combination of xmlParserOption.
+ * The parsing flags `options` are a combination of xmlParserOption.
*
- * Returns the new reader or NULL in case of error.
+ * @returns the new reader or NULL in case of error.
*/
xmlTextReaderPtr
xmlReaderForMemory(const char *buffer, int size, const char *URL,
@@ -5249,18 +5145,17 @@ xmlReaderForMemory(const char *buffer, int size, const char *URL,
}
/**
- * xmlReaderForFd:
- * @fd: an open file descriptor
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param fd an open file descriptor
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Create an xmltextReader for an XML from a file descriptor.
- * The parsing flags @options are a combination of xmlParserOption.
+ * The parsing flags `options` are a combination of xmlParserOption.
* NOTE that the file descriptor will not be closed when the
* reader is closed or reset.
*
- * Returns the new reader or NULL in case of error.
+ * @returns the new reader or NULL in case of error.
*/
xmlTextReaderPtr
xmlReaderForFd(int fd, const char *URL, const char *encoding, int options)
@@ -5305,18 +5200,17 @@ xmlReaderForFd(int fd, const char *URL, const char *encoding, int options)
}
/**
- * xmlReaderForIO:
- * @ioread: an I/O read function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Create an xmltextReader for an XML document from I/O functions and source.
- * The parsing flags @options are a combination of xmlParserOption.
+ * The parsing flags `options` are a combination of xmlParserOption.
*
- * Returns the new reader or NULL in case of error.
+ * @returns the new reader or NULL in case of error.
*/
xmlTextReaderPtr
xmlReaderForIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose,
@@ -5350,14 +5244,13 @@ xmlReaderForIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose,
}
/**
- * xmlReaderNewWalker:
- * @reader: an XML reader
- * @doc: a preparsed document
+ * @param reader an XML reader
+ * @param doc a preparsed document
*
* Setup an xmltextReader to parse a preparsed XML document.
- * This reuses the existing @reader xmlTextReader.
+ * This reuses the existing `reader` xmlTextReader.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlReaderNewWalker(xmlTextReaderPtr reader, xmlDocPtr doc)
@@ -5394,18 +5287,17 @@ xmlReaderNewWalker(xmlTextReaderPtr reader, xmlDocPtr doc)
}
/**
- * xmlReaderNewDoc:
- * @reader: an XML reader
- * @cur: a pointer to a zero terminated string
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param reader an XML reader
+ * @param cur a pointer to a zero terminated string
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Setup an xmltextReader to parse an XML in-memory document.
- * The parsing flags @options are a combination of xmlParserOption.
- * This reuses the existing @reader xmlTextReader.
+ * The parsing flags `options` are a combination of xmlParserOption.
+ * This reuses the existing `reader` xmlTextReader.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlReaderNewDoc(xmlTextReaderPtr reader, const xmlChar * cur,
@@ -5425,17 +5317,16 @@ xmlReaderNewDoc(xmlTextReaderPtr reader, const xmlChar * cur,
}
/**
- * xmlReaderNewFile:
- * @reader: an XML reader
- * @filename: a file or URL
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param reader an XML reader
+ * @param filename a file or URL
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* parse an XML file from the filesystem or the network.
- * The parsing flags @options are a combination of xmlParserOption.
- * This reuses the existing @reader xmlTextReader.
+ * The parsing flags `options` are a combination of xmlParserOption.
+ * This reuses the existing `reader` xmlTextReader.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlReaderNewFile(xmlTextReaderPtr reader, const char *filename,
@@ -5482,19 +5373,18 @@ xmlReaderNewFile(xmlTextReaderPtr reader, const char *filename,
}
/**
- * xmlReaderNewMemory:
- * @reader: an XML reader
- * @buffer: a pointer to a char array
- * @size: the size of the array
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param reader an XML reader
+ * @param buffer a pointer to a char array
+ * @param size the size of the array
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Setup an xmltextReader to parse an XML in-memory document.
- * The parsing flags @options are a combination of xmlParserOption.
- * This reuses the existing @reader xmlTextReader.
+ * The parsing flags `options` are a combination of xmlParserOption.
+ * This reuses the existing `reader` xmlTextReader.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlReaderNewMemory(xmlTextReaderPtr reader, const char *buffer, int size,
@@ -5516,20 +5406,19 @@ xmlReaderNewMemory(xmlTextReaderPtr reader, const char *buffer, int size,
}
/**
- * xmlReaderNewFd:
- * @reader: an XML reader
- * @fd: an open file descriptor
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param reader an XML reader
+ * @param fd an open file descriptor
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Setup an xmltextReader to parse an XML from a file descriptor.
* NOTE that the file descriptor will not be closed when the
* reader is closed or reset.
- * The parsing flags @options are a combination of xmlParserOption.
- * This reuses the existing @reader xmlTextReader.
+ * The parsing flags `options` are a combination of xmlParserOption.
+ * This reuses the existing `reader` xmlTextReader.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlReaderNewFd(xmlTextReaderPtr reader, int fd,
@@ -5567,21 +5456,20 @@ xmlReaderNewFd(xmlTextReaderPtr reader, int fd,
}
/**
- * xmlReaderNewIO:
- * @reader: an XML reader
- * @ioread: an I/O read function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @URL: the base URL to use for the document
- * @encoding: the document encoding, or NULL
- * @options: a combination of xmlParserOption
+ * @param reader an XML reader
+ * @param ioread an I/O read function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param URL the base URL to use for the document
+ * @param encoding the document encoding, or NULL
+ * @param options a combination of xmlParserOption
*
* Setup an xmltextReader to parse an XML document from I/O functions
* and source.
- * The parsing flags @options are a combination of xmlParserOption.
- * This reuses the existing @reader xmlTextReader.
+ * The parsing flags `options` are a combination of xmlParserOption.
+ * This reuses the existing `reader` xmlTextReader.
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlReaderNewIO(xmlTextReaderPtr reader, xmlInputReadCallback ioread,
diff --git a/xmlregexp.c b/xmlregexp.c
index 08c4d664..a53db356 100644
--- a/xmlregexp.c
+++ b/xmlregexp.c
@@ -355,8 +355,7 @@ static int xmlRegCheckCharacterRange(xmlRegAtomType type, int codepoint,
* *
************************************************************************/
/**
- * xmlRegexpErrMemory:
- * @ctxt: regexp parser context
+ * @param ctxt regexp parser context
*
* Handle an out of memory condition
*/
@@ -370,9 +369,8 @@ xmlRegexpErrMemory(xmlRegParserCtxtPtr ctxt)
}
/**
- * xmlRegexpErrCompile:
- * @ctxt: regexp parser context
- * @extra: extra information
+ * @param ctxt regexp parser context
+ * @param extra extra information
*
* Handle a compilation failure
*/
@@ -406,14 +404,13 @@ xmlRegexpErrCompile(xmlRegParserCtxtPtr ctxt, const char *extra)
static int xmlFAComputesDeterminism(xmlRegParserCtxtPtr ctxt);
/**
- * xmlRegCalloc2:
- * @dim1: size of first dimension
- * @dim2: size of second dimension
- * @elemSize: size of element
+ * @param dim1 size of first dimension
+ * @param dim2 size of second dimension
+ * @param elemSize size of element
*
* Allocate a two-dimensional array and set all elements to zero.
*
- * Returns the new array or NULL in case of error.
+ * @returns the new array or NULL in case of error.
*/
static void*
xmlRegCalloc2(size_t dim1, size_t dim2, size_t elemSize) {
@@ -432,12 +429,11 @@ xmlRegCalloc2(size_t dim1, size_t dim2, size_t elemSize) {
}
/**
- * xmlRegEpxFromParse:
- * @ctxt: the parser context used to build it
+ * @param ctxt the parser context used to build it
*
* Allocate a new regexp and fill it with the result from the parser
*
- * Returns the new regexp or NULL in case of error
+ * @returns the new regexp or NULL in case of error
*/
static xmlRegexpPtr
xmlRegEpxFromParse(xmlRegParserCtxtPtr ctxt) {
@@ -662,12 +658,11 @@ not_determ:
}
/**
- * xmlRegNewParserCtxt:
- * @string: the string to parse
+ * @param string the string to parse
*
* Allocate a new regexp parser context
*
- * Returns the new context or NULL in case of error
+ * @returns the new context or NULL in case of error
*/
static xmlRegParserCtxtPtr
xmlRegNewParserCtxt(const xmlChar *string) {
@@ -693,16 +688,15 @@ xmlRegNewParserCtxt(const xmlChar *string) {
}
/**
- * xmlRegNewRange:
- * @ctxt: the regexp parser context
- * @neg: is that negative
- * @type: the type of range
- * @start: the start codepoint
- * @end: the end codepoint
+ * @param ctxt the regexp parser context
+ * @param neg is that negative
+ * @param type the type of range
+ * @param start the start codepoint
+ * @param end the end codepoint
*
* Allocate a new regexp range
*
- * Returns the new range or NULL in case of error
+ * @returns the new range or NULL in case of error
*/
static xmlRegRangePtr
xmlRegNewRange(xmlRegParserCtxtPtr ctxt,
@@ -722,8 +716,7 @@ xmlRegNewRange(xmlRegParserCtxtPtr ctxt,
}
/**
- * xmlRegFreeRange:
- * @range: the regexp range
+ * @param range the regexp range
*
* Free a regexp range
*/
@@ -738,13 +731,12 @@ xmlRegFreeRange(xmlRegRangePtr range) {
}
/**
- * xmlRegCopyRange:
- * @ctxt: regexp parser context
- * @range: the regexp range
+ * @param ctxt regexp parser context
+ * @param range the regexp range
*
* Copy a regexp range
*
- * Returns the new copy or NULL in case of error.
+ * @returns the new copy or NULL in case of error.
*/
static xmlRegRangePtr
xmlRegCopyRange(xmlRegParserCtxtPtr ctxt, xmlRegRangePtr range) {
@@ -769,13 +761,12 @@ xmlRegCopyRange(xmlRegParserCtxtPtr ctxt, xmlRegRangePtr range) {
}
/**
- * xmlRegNewAtom:
- * @ctxt: the regexp parser context
- * @type: the type of atom
+ * @param ctxt the regexp parser context
+ * @param type the type of atom
*
* Allocate a new atom
*
- * Returns the new atom or NULL in case of error
+ * @returns the new atom or NULL in case of error
*/
static xmlRegAtomPtr
xmlRegNewAtom(xmlRegParserCtxtPtr ctxt, xmlRegAtomType type) {
@@ -795,8 +786,7 @@ xmlRegNewAtom(xmlRegParserCtxtPtr ctxt, xmlRegAtomType type) {
}
/**
- * xmlRegFreeAtom:
- * @atom: the regexp atom
+ * @param atom the regexp atom
*
* Free a regexp atom
*/
@@ -821,13 +811,12 @@ xmlRegFreeAtom(xmlRegAtomPtr atom) {
}
/**
- * xmlRegCopyAtom:
- * @ctxt: the regexp parser context
- * @atom: the original atom
+ * @param ctxt the regexp parser context
+ * @param atom the original atom
*
* Allocate a new regexp range
*
- * Returns the new atom or NULL in case of error
+ * @returns the new atom or NULL in case of error
*/
static xmlRegAtomPtr
xmlRegCopyAtom(xmlRegParserCtxtPtr ctxt, xmlRegAtomPtr atom) {
@@ -882,8 +871,7 @@ xmlRegNewState(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlRegFreeState:
- * @state: the regexp state
+ * @param state the regexp state
*
* Free a regexp state
*/
@@ -900,8 +888,7 @@ xmlRegFreeState(xmlRegStatePtr state) {
}
/**
- * xmlRegFreeParserCtxt:
- * @ctxt: the regexp parser context
+ * @param ctxt the regexp parser context
*
* Free a regexp parser context
*/
@@ -1275,8 +1262,8 @@ xmlRegPrintStateCompact(FILE* output, xmlRegexpPtr regexp, int state)
/*
* xmlRegPrintCompact
- * @output an output stream
- * @regexp the regexp instance
+ * `output` an output stream
+ * `regexp` the regexp instance
*
* Print the compact representation of a regexp, in the same fashion as the
* public xmlRegexpPrint function.
@@ -1562,11 +1549,10 @@ xmlRegStatePush(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAGenerateAllTransition:
- * @ctxt: a regexp parser context
- * @from: the from state
- * @to: the target state or NULL for building a new one
- * @lax:
+ * @param ctxt a regexp parser context
+ * @param from the from state
+ * @param to the target state or NULL for building a new one
+ * @param lax
*
*/
static int
@@ -1587,10 +1573,9 @@ xmlFAGenerateAllTransition(xmlRegParserCtxtPtr ctxt,
}
/**
- * xmlFAGenerateEpsilonTransition:
- * @ctxt: a regexp parser context
- * @from: the from state
- * @to: the target state or NULL for building a new one
+ * @param ctxt a regexp parser context
+ * @param from the from state
+ * @param to the target state or NULL for building a new one
*
*/
static int
@@ -1607,11 +1592,10 @@ xmlFAGenerateEpsilonTransition(xmlRegParserCtxtPtr ctxt,
}
/**
- * xmlFAGenerateCountedEpsilonTransition:
- * @ctxt: a regexp parser context
- * @from: the from state
- * @to: the target state or NULL for building a new one
- * @counter: the counter for that transition
+ * @param ctxt a regexp parser context
+ * @param from the from state
+ * @param to the target state or NULL for building a new one
+ * @param counter the counter for that transition
*/
static int
xmlFAGenerateCountedEpsilonTransition(xmlRegParserCtxtPtr ctxt,
@@ -1627,11 +1611,10 @@ xmlFAGenerateCountedEpsilonTransition(xmlRegParserCtxtPtr ctxt,
}
/**
- * xmlFAGenerateCountedTransition:
- * @ctxt: a regexp parser context
- * @from: the from state
- * @to: the target state or NULL for building a new one
- * @counter: the counter for that transition
+ * @param ctxt a regexp parser context
+ * @param from the from state
+ * @param to the target state or NULL for building a new one
+ * @param counter the counter for that transition
*/
static int
xmlFAGenerateCountedTransition(xmlRegParserCtxtPtr ctxt,
@@ -1647,13 +1630,12 @@ xmlFAGenerateCountedTransition(xmlRegParserCtxtPtr ctxt,
}
/**
- * xmlFAGenerateTransitions:
- * @ctxt: a regexp parser context
- * @from: the from state
- * @to: the target state or NULL for building a new one
- * @atom: the atom generating the transition
+ * @param ctxt a regexp parser context
+ * @param from the from state
+ * @param to the target state or NULL for building a new one
+ * @param atom the atom generating the transition
*
- * Returns 0 if success and -1 in case of error.
+ * @returns 0 if success and -1 in case of error.
*/
static int
xmlFAGenerateTransitions(xmlRegParserCtxtPtr ctxt, xmlRegStatePtr from,
@@ -1880,11 +1862,10 @@ xmlFAGenerateTransitions(xmlRegParserCtxtPtr ctxt, xmlRegStatePtr from,
}
/**
- * xmlFAReduceEpsilonTransitions:
- * @ctxt: a regexp parser context
- * @fromnr: the from state
- * @tonr: the to state
- * @counter: should that transition be associated to a counted
+ * @param ctxt a regexp parser context
+ * @param fromnr the from state
+ * @param tonr the to state
+ * @param counter should that transition be associated to a counted
*
*/
static void
@@ -1942,9 +1923,8 @@ xmlFAReduceEpsilonTransitions(xmlRegParserCtxtPtr ctxt, int fromnr,
}
/**
- * xmlFAFinishReduceEpsilonTransitions:
- * @ctxt: a regexp parser context
- * @tonr: the to state
+ * @param ctxt a regexp parser context
+ * @param tonr the to state
*/
static void
xmlFAFinishReduceEpsilonTransitions(xmlRegParserCtxtPtr ctxt, int tonr) {
@@ -1967,8 +1947,7 @@ xmlFAFinishReduceEpsilonTransitions(xmlRegParserCtxtPtr ctxt, int tonr) {
}
/**
- * xmlFAEliminateSimpleEpsilonTransitions:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* Eliminating general epsilon transitions can get costly in the general
* algorithm due to the large amount of generated new transitions and
@@ -2036,8 +2015,7 @@ xmlFAEliminateSimpleEpsilonTransitions(xmlRegParserCtxtPtr ctxt) {
}
}
/**
- * xmlFAEliminateEpsilonTransitions:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
*/
static void
@@ -2338,14 +2316,13 @@ xmlFACompareRanges(xmlRegRangePtr range1, xmlRegRangePtr range2) {
}
/**
- * xmlFACompareAtomTypes:
- * @type1: an atom type
- * @type2: an atom type
+ * @param type1 an atom type
+ * @param type2 an atom type
*
* Compares two atoms type to check whether they intersect in some ways,
* this is used by xmlFACompareAtoms only
*
- * Returns 1 if they may intersect and 0 otherwise
+ * @returns 1 if they may intersect and 0 otherwise
*/
static int
xmlFACompareAtomTypes(xmlRegAtomType type1, xmlRegAtomType type2) {
@@ -2539,15 +2516,14 @@ xmlFACompareAtomTypes(xmlRegAtomType type1, xmlRegAtomType type2) {
}
/**
- * xmlFAEqualAtoms:
- * @atom1: an atom
- * @atom2: an atom
- * @deep: if not set only compare string pointers
+ * @param atom1 an atom
+ * @param atom2 an atom
+ * @param deep if not set only compare string pointers
*
* Compares two atoms to check whether they are the same exactly
* this is used to remove equivalent transitions
*
- * Returns 1 if same and 0 otherwise
+ * @returns 1 if same and 0 otherwise
*/
static int
xmlFAEqualAtoms(xmlRegAtomPtr atom1, xmlRegAtomPtr atom2, int deep) {
@@ -2584,15 +2560,14 @@ xmlFAEqualAtoms(xmlRegAtomPtr atom1, xmlRegAtomPtr atom2, int deep) {
}
/**
- * xmlFACompareAtoms:
- * @atom1: an atom
- * @atom2: an atom
- * @deep: if not set only compare string pointers
+ * @param atom1 an atom
+ * @param atom2 an atom
+ * @param deep if not set only compare string pointers
*
* Compares two atoms to check whether they intersect in some ways,
* this is used by xmlFAComputesDeterminism and xmlFARecurseDeterminism only
*
- * Returns 1 if yes and 0 otherwise
+ * @returns 1 if yes and 0 otherwise
*/
static int
xmlFACompareAtoms(xmlRegAtomPtr atom1, xmlRegAtomPtr atom2, int deep) {
@@ -2683,12 +2658,11 @@ not_determinist:
}
/**
- * xmlFARecurseDeterminism:
- * @ctxt: a regexp parser context
- * @state: regexp state
- * @fromnr: the from state
- * @tonr: the to state
- * @atom: the atom
+ * @param ctxt a regexp parser context
+ * @param state regexp state
+ * @param fromnr the from state
+ * @param tonr the to state
+ * @param atom the atom
*
* Check whether the associated regexp is determinist,
* should be called after xmlFAEliminateEpsilonTransitions()
@@ -2746,9 +2720,8 @@ xmlFARecurseDeterminism(xmlRegParserCtxtPtr ctxt, xmlRegStatePtr state,
}
/**
- * xmlFAFinishRecurseDeterminism:
- * @ctxt: a regexp parser context
- * @state: regexp state
+ * @param ctxt a regexp parser context
+ * @param state regexp state
*
* Reset flags after checking determinism.
*/
@@ -2771,8 +2744,7 @@ xmlFAFinishRecurseDeterminism(xmlRegParserCtxtPtr ctxt, xmlRegStatePtr state) {
}
/**
- * xmlFAComputesDeterminism:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* Check whether the associated regexp is determinist,
* should be called after xmlFAEliminateEpsilonTransitions()
@@ -3580,15 +3552,14 @@ error:
************************************************************************/
/**
- * xmlRegNewExecCtxt:
- * @comp: a precompiled regular expression
- * @callback: a callback function used for handling progresses in the
+ * @param comp a precompiled regular expression
+ * @param callback a callback function used for handling progresses in the
* automata matching phase
- * @data: the context data associated to the callback in this context
+ * @param data the context data associated to the callback in this context
*
* Build a context used for progressive evaluation of a regexp.
*
- * Returns the new context
+ * @returns the new context
*/
xmlRegExecCtxtPtr
xmlRegNewExecCtxt(xmlRegexpPtr comp, xmlRegExecCallbacks callback, void *data) {
@@ -3643,8 +3614,7 @@ xmlRegNewExecCtxt(xmlRegexpPtr comp, xmlRegExecCallbacks callback, void *data) {
}
/**
- * xmlRegFreeExecCtxt:
- * @exec: a regular expression evaluation context
+ * @param exec a regular expression evaluation context
*
* Free the structures associated to a regular expression evaluation context.
*/
@@ -3736,15 +3706,14 @@ xmlFARegExecSaveInputString(xmlRegExecCtxtPtr exec, const xmlChar *value,
}
/**
- * xmlRegStrEqualWildcard:
- * @expStr: the string to be evaluated
- * @valStr: the validation string
+ * @param expStr the string to be evaluated
+ * @param valStr the validation string
*
* Checks if both strings are equal or have the same content. "*"
- * can be used as a wildcard in @valStr; "|" is used as a separator of
- * substrings in both @expStr and @valStr.
+ * can be used as a wildcard in `valStr`; "|" is used as a separator of
+ * substrings in both `expStr` and `valStr`.
*
- * Returns 1 if the comparison is satisfied and the number of substrings
+ * @returns 1 if the comparison is satisfied and the number of substrings
* is equal, 0 otherwise.
*/
@@ -3786,15 +3755,14 @@ xmlRegStrEqualWildcard(const xmlChar *expStr, const xmlChar *valStr) {
}
/**
- * xmlRegCompactPushString:
- * @exec: a regexp execution context
- * @comp: the precompiled exec with a compact table
- * @value: a string token input
- * @data: data associated to the token to reuse in callbacks
+ * @param exec a regexp execution context
+ * @param comp the precompiled exec with a compact table
+ * @param value a string token input
+ * @param data data associated to the token to reuse in callbacks
*
* Push one input token in the execution context
*
- * Returns: 1 if the regexp reached a final state, 0 if non-final, and
+ * @returns 1 if the regexp reached a final state, 0 if non-final, and
* a negative value in case of error.
*/
static int
@@ -3854,15 +3822,14 @@ error:
}
/**
- * xmlRegExecPushStringInternal:
- * @exec: a regexp execution context or NULL to indicate the end
- * @value: a string token input
- * @data: data associated to the token to reuse in callbacks
- * @compound: value was assembled from 2 strings
+ * @param exec a regexp execution context or NULL to indicate the end
+ * @param value a string token input
+ * @param data data associated to the token to reuse in callbacks
+ * @param compound value was assembled from 2 strings
*
* Push one input token in the execution context
*
- * Returns: 1 if the regexp reached a final state, 0 if non-final, and
+ * @returns 1 if the regexp reached a final state, 0 if non-final, and
* a negative value in case of error.
*/
static int
@@ -4166,14 +4133,13 @@ progress:
}
/**
- * xmlRegExecPushString:
- * @exec: a regexp execution context or NULL to indicate the end
- * @value: a string token input
- * @data: data associated to the token to reuse in callbacks
+ * @param exec a regexp execution context or NULL to indicate the end
+ * @param value a string token input
+ * @param data data associated to the token to reuse in callbacks
*
* Push one input token in the execution context
*
- * Returns: 1 if the regexp reached a final state, 0 if non-final, and
+ * @returns 1 if the regexp reached a final state, 0 if non-final, and
* a negative value in case of error.
*/
int
@@ -4183,15 +4149,14 @@ xmlRegExecPushString(xmlRegExecCtxtPtr exec, const xmlChar *value,
}
/**
- * xmlRegExecPushString2:
- * @exec: a regexp execution context or NULL to indicate the end
- * @value: the first string token input
- * @value2: the second string token input
- * @data: data associated to the token to reuse in callbacks
+ * @param exec a regexp execution context or NULL to indicate the end
+ * @param value the first string token input
+ * @param value2 the second string token input
+ * @param data data associated to the token to reuse in callbacks
*
* Push one input token in the execution context
*
- * Returns: 1 if the regexp reached a final state, 0 if non-final, and
+ * @returns 1 if the regexp reached a final state, 0 if non-final, and
* a negative value in case of error.
*/
int
@@ -4239,18 +4204,17 @@ xmlRegExecPushString2(xmlRegExecCtxtPtr exec, const xmlChar *value,
}
/**
- * xmlRegExecGetValues:
- * @exec: a regexp execution context
- * @err: error extraction or normal one
- * @nbval: pointer to the number of accepted values IN/OUT
- * @nbneg: return number of negative transitions
- * @values: pointer to the array of acceptable values
- * @terminal: return value if this was a terminal state
+ * @param exec a regexp execution context
+ * @param err error extraction or normal one
+ * @param nbval pointer to the number of accepted values IN/OUT
+ * @param nbneg return number of negative transitions
+ * @param values pointer to the array of acceptable values
+ * @param terminal return value if this was a terminal state
*
* Extract information from the regexp execution, internal routine to
* implement xmlRegExecNextValues() and xmlRegExecErrInfo()
*
- * Returns: 0 in case of success or -1 in case of error.
+ * @returns 0 in case of success or -1 in case of error.
*/
static int
xmlRegExecGetValues(xmlRegExecCtxtPtr exec, int err,
@@ -4397,21 +4361,20 @@ xmlRegExecGetValues(xmlRegExecCtxtPtr exec, int err,
}
/**
- * xmlRegExecNextValues:
- * @exec: a regexp execution context
- * @nbval: pointer to the number of accepted values IN/OUT
- * @nbneg: return number of negative transitions
- * @values: pointer to the array of acceptable values
- * @terminal: return value if this was a terminal state
+ * @param exec a regexp execution context
+ * @param nbval pointer to the number of accepted values IN/OUT
+ * @param nbneg return number of negative transitions
+ * @param values pointer to the array of acceptable values
+ * @param terminal return value if this was a terminal state
*
* Extract information from the regexp execution,
- * the parameter @values must point to an array of @nbval string pointers
+ * the parameter `values` must point to an array of `nbval` string pointers
* on return nbval will contain the number of possible strings in that
- * state and the @values array will be updated with them. The string values
- * returned will be freed with the @exec context and don't need to be
+ * state and the `values` array will be updated with them. The string values
+ * returned will be freed with the `exec` context and don't need to be
* deallocated.
*
- * Returns: 0 in case of success or -1 in case of error.
+ * @returns 0 in case of success or -1 in case of error.
*/
int
xmlRegExecNextValues(xmlRegExecCtxtPtr exec, int *nbval, int *nbneg,
@@ -4420,23 +4383,22 @@ xmlRegExecNextValues(xmlRegExecCtxtPtr exec, int *nbval, int *nbneg,
}
/**
- * xmlRegExecErrInfo:
- * @exec: a regexp execution context generating an error
- * @string: return value for the error string
- * @nbval: pointer to the number of accepted values IN/OUT
- * @nbneg: return number of negative transitions
- * @values: pointer to the array of acceptable values
- * @terminal: return value if this was a terminal state
+ * @param exec a regexp execution context generating an error
+ * @param string return value for the error string
+ * @param nbval pointer to the number of accepted values IN/OUT
+ * @param nbneg return number of negative transitions
+ * @param values pointer to the array of acceptable values
+ * @param terminal return value if this was a terminal state
*
* Extract error information from the regexp execution, the parameter
- * @string will be updated with the value pushed and not accepted,
- * the parameter @values must point to an array of @nbval string pointers
+ * `string` will be updated with the value pushed and not accepted,
+ * the parameter `values` must point to an array of `nbval` string pointers
* on return nbval will contain the number of possible strings in that
- * state and the @values array will be updated with them. The string values
- * returned will be freed with the @exec context and don't need to be
+ * state and the `values` array will be updated with them. The string values
+ * returned will be freed with the `exec` context and don't need to be
* deallocated.
*
- * Returns: 0 in case of success or -1 in case of error.
+ * @returns 0 in case of success or -1 in case of error.
*/
int
xmlRegExecErrInfo(xmlRegExecCtxtPtr exec, const xmlChar **string,
@@ -4460,10 +4422,9 @@ xmlRegExecErrInfo(xmlRegExecCtxtPtr exec, const xmlChar **string,
************************************************************************/
/**
- * xmlFAIsChar:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
- * [10] Char ::= [^.\?*+()|#x5B#x5D]
+ * [10] Char ::= [^.\?*+()|\#x5B\#x5D]
*/
static int
xmlFAIsChar(xmlRegParserCtxtPtr ctxt) {
@@ -4485,8 +4446,7 @@ xmlFAIsChar(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseCharProp:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [27] charProp ::= IsCategory | IsBlock
* [28] IsCategory ::= Letters | Marks | Numbers | Punctuation |
@@ -4498,7 +4458,7 @@ xmlFAIsChar(xmlRegParserCtxtPtr ctxt) {
* [33] Separators ::= 'Z' [slp]?
* [34] Symbols ::= 'S' [mcko]?
* [35] Others ::= 'C' [cfon]?
- * [36] IsBlock ::= 'Is' [a-zA-Z0-9#x2D]+
+ * [36] IsBlock ::= 'Is' [a-zA-Z0-9\#x2D]+
*/
static void
xmlFAParseCharProp(xmlRegParserCtxtPtr ctxt) {
@@ -4756,12 +4716,11 @@ static int parse_escaped_codepoint(xmlRegParserCtxtPtr ctxt)
}
/**
- * xmlFAParseCharClassEsc:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* ```
* [23] charClassEsc ::= ( SingleCharEsc | MultiCharEsc | catEsc | complEsc )
- * [24] SingleCharEsc ::= '\' [nrt\|.?*+(){}#x2D#x5B#x5D#x5E]
+ * [24] SingleCharEsc ::= '\' [nrt\|.?*+(){}\#x2D\#x5B\#x5D\#x5E]
* [25] catEsc ::= '\p{' charProp '}'
* [26] complEsc ::= '\P{' charProp '}'
* [37] MultiCharEsc ::= '.' | ('\' [sSiIcCdDwW])
@@ -4928,15 +4887,14 @@ xmlFAParseCharClassEsc(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseCharRange:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* ```
* [17] charRange ::= seRange | XmlCharRef | XmlCharIncDash
* [18] seRange ::= charOrEsc '-' charOrEsc
* [20] charOrEsc ::= XmlChar | SingleCharEsc
- * [21] XmlChar ::= [^\#x2D#x5B#x5D]
- * [22] XmlCharIncDash ::= [^\#x5B#x5D]
+ * [21] XmlChar ::= [^\\#x2D\#x5B\#x5D]
+ * [22] XmlCharIncDash ::= [^\\#x5B\#x5D]
* ```
*/
static void
@@ -5035,8 +4993,7 @@ xmlFAParseCharRange(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParsePosCharGroup:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [14] posCharGroup ::= ( charRange | charClassEsc )+
*/
@@ -5053,8 +5010,7 @@ xmlFAParsePosCharGroup(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseCharGroup:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [13] charGroup ::= posCharGroup | negCharGroup | charClassSub
* [15] negCharGroup ::= '^' posCharGroup
@@ -5091,8 +5047,7 @@ xmlFAParseCharGroup(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseCharClass:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [11] charClass ::= charClassEsc | charClassExpr
* [12] charClassExpr ::= '[' charGroup ']'
@@ -5116,12 +5071,11 @@ xmlFAParseCharClass(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseQuantExact:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [8] QuantExact ::= [0-9]+
*
- * Returns 0 if success or -1 in case of error
+ * @returns 0 if success or -1 in case of error
*/
static int
xmlFAParseQuantExact(xmlRegParserCtxtPtr ctxt) {
@@ -5151,8 +5105,7 @@ xmlFAParseQuantExact(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseQuantifier:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [4] quantifier ::= [?*+] | ( '{' quantity '}' )
* [5] quantity ::= quantRange | quantMin | QuantExact
@@ -5218,8 +5171,7 @@ xmlFAParseQuantifier(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseAtom:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [9] atom ::= Char | charClass | ( '(' regExp ')' )
*/
@@ -5290,8 +5242,7 @@ xmlFAParseAtom(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParsePiece:
- * @ctxt: a regexp parser context
+ * @param ctxt a regexp parser context
*
* [3] piece ::= atom quantifier?
*/
@@ -5311,11 +5262,10 @@ xmlFAParsePiece(xmlRegParserCtxtPtr ctxt) {
}
/**
- * xmlFAParseBranch:
- * @ctxt: a regexp parser context
- * @to: optional target to the end of the branch
+ * @param ctxt a regexp parser context
+ * @param to optional target to the end of the branch
*
- * @to is used to optimize by removing duplicate path in automata
+ * `to` is used to optimize by removing duplicate path in automata
* in expressions like (a|b)(c|d)
*
* [2] branch ::= piece*
@@ -5359,9 +5309,8 @@ xmlFAParseBranch(xmlRegParserCtxtPtr ctxt, xmlRegStatePtr to) {
}
/**
- * xmlFAParseRegExp:
- * @ctxt: a regexp parser context
- * @top: is this the top-level expression ?
+ * @param ctxt a regexp parser context
+ * @param top is this the top-level expression ?
*
* [1] regExp ::= branch ( '|' branch )*
*/
@@ -5400,11 +5349,10 @@ xmlFAParseRegExp(xmlRegParserCtxtPtr ctxt, int top) {
************************************************************************/
/**
- * xmlRegexpPrint:
- * @output: the file for the output debug
- * @regexp: the compiled regexp
+ * @param output the file for the output debug
+ * @param regexp the compiled regexp
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* No-op since 2.14.0.
*/
@@ -5414,14 +5362,13 @@ xmlRegexpPrint(FILE *output ATTRIBUTE_UNUSED,
}
/**
- * xmlRegexpCompile:
- * @regexp: a regular expression string
+ * @param regexp a regular expression string
*
* Parses a regular expression conforming to XML Schemas Part 2 Datatype
* Appendix F and builds an automata suitable for testing strings against
* that regular expression
*
- * Returns the compiled expression or NULL in case of error
+ * @returns the compiled expression or NULL in case of error
*/
xmlRegexpPtr
xmlRegexpCompile(const xmlChar *regexp) {
@@ -5467,13 +5414,12 @@ error:
}
/**
- * xmlRegexpExec:
- * @comp: the compiled regular expression
- * @content: the value to check against the regular expression
+ * @param comp the compiled regular expression
+ * @param content the value to check against the regular expression
*
* Check if the regular expression generates the value
*
- * Returns 1 if it matches, 0 if not and a negative value in case of error
+ * @returns 1 if it matches, 0 if not and a negative value in case of error
*/
int
xmlRegexpExec(xmlRegexpPtr comp, const xmlChar *content) {
@@ -5483,12 +5429,11 @@ xmlRegexpExec(xmlRegexpPtr comp, const xmlChar *content) {
}
/**
- * xmlRegexpIsDeterminist:
- * @comp: the compiled regular expression
+ * @param comp the compiled regular expression
*
* Check if the regular expression is determinist
*
- * Returns 1 if it yes, 0 if not and a negative value in case of error
+ * @returns 1 if it yes, 0 if not and a negative value in case of error
*/
int
xmlRegexpIsDeterminist(xmlRegexpPtr comp) {
@@ -5525,8 +5470,7 @@ xmlRegexpIsDeterminist(xmlRegexpPtr comp) {
}
/**
- * xmlRegFreeRegexp:
- * @regexp: the regexp
+ * @param regexp the regexp
*
* Free a regexp
*/
@@ -5570,11 +5514,10 @@ xmlRegFreeRegexp(xmlRegexpPtr regexp) {
************************************************************************/
/**
- * xmlNewAutomata:
*
* Create a new automata
*
- * Returns the new object or NULL in case of failure
+ * @returns the new object or NULL in case of failure
*/
xmlAutomataPtr
xmlNewAutomata(void) {
@@ -5600,8 +5543,7 @@ xmlNewAutomata(void) {
}
/**
- * xmlFreeAutomata:
- * @am: an automata
+ * @param am an automata
*
* Free an automata
*/
@@ -5613,9 +5555,8 @@ xmlFreeAutomata(xmlAutomataPtr am) {
}
/**
- * xmlAutomataSetFlags:
- * @am: an automata
- * @flags: a set of internal flags
+ * @param am an automata
+ * @param flags a set of internal flags
*
* Set some flags on the automata
*/
@@ -5627,12 +5568,11 @@ xmlAutomataSetFlags(xmlAutomataPtr am, int flags) {
}
/**
- * xmlAutomataGetInitState:
- * @am: an automata
+ * @param am an automata
*
* Initial state lookup
*
- * Returns the initial state of the automata
+ * @returns the initial state of the automata
*/
xmlAutomataStatePtr
xmlAutomataGetInitState(xmlAutomataPtr am) {
@@ -5642,13 +5582,12 @@ xmlAutomataGetInitState(xmlAutomataPtr am) {
}
/**
- * xmlAutomataSetFinalState:
- * @am: an automata
- * @state: a state in this automata
+ * @param am an automata
+ * @param state a state in this automata
*
* Makes that state a final state
*
- * Returns 0 or -1 in case of error
+ * @returns 0 or -1 in case of error
*/
int
xmlAutomataSetFinalState(xmlAutomataPtr am, xmlAutomataStatePtr state) {
@@ -5659,18 +5598,17 @@ xmlAutomataSetFinalState(xmlAutomataPtr am, xmlAutomataStatePtr state) {
}
/**
- * xmlAutomataNewTransition:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the input string associated to that transition
- * @data: data passed to the callback function if the transition is activated
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the input string associated to that transition
+ * @param data data passed to the callback function if the transition is activated
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by the value of @token
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by the value of `token`
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewTransition(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -5701,19 +5639,18 @@ xmlAutomataNewTransition(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataNewTransition2:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the first input string associated to that transition
- * @token2: the second input string associated to that transition
- * @data: data passed to the callback function if the transition is activated
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the first input string associated to that transition
+ * @param token2 the second input string associated to that transition
+ * @param data data passed to the callback function if the transition is activated
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by the value of @token
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by the value of `token`
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewTransition2(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -5759,21 +5696,20 @@ xmlAutomataNewTransition2(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataNewNegTrans:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the first input string associated to that transition
- * @token2: the second input string associated to that transition
- * @data: data passed to the callback function if the transition is activated
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the first input string associated to that transition
+ * @param token2 the second input string associated to that transition
+ * @param data data passed to the callback function if the transition is activated
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by any value except (@token,@token2)
- * Note that if @token2 is not NULL, then (X, NULL) won't match to follow
- * the semantic of XSD ##other
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by any value except (`token`,`token2`)
+ * Note that if `token2` is not NULL, then (X, NULL) won't match to follow
+ * the semantic of XSD \#\#other
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewNegTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -5825,22 +5761,21 @@ xmlAutomataNewNegTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataNewCountTrans2:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the input string associated to that transition
- * @token2: the second input string associated to that transition
- * @min: the minimum successive occurrences of token
- * @max: the maximum successive occurrences of token
- * @data: data associated to the transition
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the input string associated to that transition
+ * @param token2 the second input string associated to that transition
+ * @param min the minimum successive occurrences of token
+ * @param max the maximum successive occurrences of token
+ * @param data data associated to the transition
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by a succession of input of value @token and @token2 and
- * whose number is between @min and @max
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by a succession of input of value `token` and `token2` and
+ * whose number is between `min` and `max`
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewCountTrans2(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -5921,21 +5856,20 @@ error:
}
/**
- * xmlAutomataNewCountTrans:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the input string associated to that transition
- * @min: the minimum successive occurrences of token
- * @max: the maximum successive occurrences of token
- * @data: data associated to the transition
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the input string associated to that transition
+ * @param min the minimum successive occurrences of token
+ * @param max the maximum successive occurrences of token
+ * @param data data associated to the transition
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by a succession of input of value @token and whose number
- * is between @min and @max
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by a succession of input of value `token` and whose number
+ * is between `min` and `max`
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewCountTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -5997,23 +5931,22 @@ error:
}
/**
- * xmlAutomataNewOnceTrans2:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the input string associated to that transition
- * @token2: the second input string associated to that transition
- * @min: the minimum successive occurrences of token
- * @max: the maximum successive occurrences of token
- * @data: data associated to the transition
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the input string associated to that transition
+ * @param token2 the second input string associated to that transition
+ * @param min the minimum successive occurrences of token
+ * @param max the maximum successive occurrences of token
+ * @param data data associated to the transition
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by a succession of input of value @token and @token2 and whose
- * number is between @min and @max, moreover that transition can only be
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by a succession of input of value `token` and `token2` and whose
+ * number is between `min` and `max`, moreover that transition can only be
* crossed once.
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewOnceTrans2(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -6086,22 +6019,21 @@ error:
/**
- * xmlAutomataNewOnceTrans:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @token: the input string associated to that transition
- * @min: the minimum successive occurrences of token
- * @max: the maximum successive occurrences of token
- * @data: data associated to the transition
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param token the input string associated to that transition
+ * @param min the minimum successive occurrences of token
+ * @param max the maximum successive occurrences of token
+ * @param data data associated to the transition
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a transition from the @from state to the target state
- * activated by a succession of input of value @token and whose number
- * is between @min and @max, moreover that transition can only be crossed
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a transition from the `from` state to the target state
+ * activated by a succession of input of value `token` and whose number
+ * is between `min` and `max`, moreover that transition can only be crossed
* once.
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewOnceTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -6151,12 +6083,11 @@ error:
}
/**
- * xmlAutomataNewState:
- * @am: an automata
+ * @param am an automata
*
* Create a new disconnected state in the automata
*
- * Returns the new state or NULL in case of error
+ * @returns the new state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewState(xmlAutomataPtr am) {
@@ -6166,16 +6097,15 @@ xmlAutomataNewState(xmlAutomataPtr am) {
}
/**
- * xmlAutomataNewEpsilon:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds an epsilon transition from the @from state to the
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds an epsilon transition from the `from` state to the
* target state
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewEpsilon(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -6189,18 +6119,17 @@ xmlAutomataNewEpsilon(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataNewAllTrans:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @lax: allow to transition if not all all transitions have been activated
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param lax allow to transition if not all all transitions have been activated
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds a an ALL transition from the @from state to the
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds a an ALL transition from the `from` state to the
* target state. That transition is an epsilon transition allowed only when
- * all transitions from the @from node have been activated.
+ * all transitions from the `from` node have been activated.
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewAllTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -6214,14 +6143,13 @@ xmlAutomataNewAllTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataNewCounter:
- * @am: an automata
- * @min: the minimal value on the counter
- * @max: the maximal value on the counter
+ * @param am an automata
+ * @param min the minimal value on the counter
+ * @param max the maximal value on the counter
*
* Create a new counter
*
- * Returns the counter number or -1 in case of error
+ * @returns the counter number or -1 in case of error
*/
int
xmlAutomataNewCounter(xmlAutomataPtr am, int min, int max) {
@@ -6239,17 +6167,16 @@ xmlAutomataNewCounter(xmlAutomataPtr am, int min, int max) {
}
/**
- * xmlAutomataNewCountedTrans:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @counter: the counter associated to that transition
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param counter the counter associated to that transition
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds an epsilon transition from the @from state to the target state
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds an epsilon transition from the `from` state to the target state
* which will increment the counter provided
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewCountedTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -6263,17 +6190,16 @@ xmlAutomataNewCountedTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataNewCounterTrans:
- * @am: an automata
- * @from: the starting point of the transition
- * @to: the target point of the transition or NULL
- * @counter: the counter associated to that transition
+ * @param am an automata
+ * @param from the starting point of the transition
+ * @param to the target point of the transition or NULL
+ * @param counter the counter associated to that transition
*
- * If @to is NULL, this creates first a new target state in the automata
- * and then adds an epsilon transition from the @from state to the target state
+ * If `to` is NULL, this creates first a new target state in the automata
+ * and then adds an epsilon transition from the `from` state to the target state
* which will be allowed only if the counter is within the right range.
*
- * Returns the target state or NULL in case of error
+ * @returns the target state or NULL in case of error
*/
xmlAutomataStatePtr
xmlAutomataNewCounterTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
@@ -6287,13 +6213,12 @@ xmlAutomataNewCounterTrans(xmlAutomataPtr am, xmlAutomataStatePtr from,
}
/**
- * xmlAutomataCompile:
- * @am: an automata
+ * @param am an automata
*
* Compile the automata into a Reg Exp ready for being executed.
* The automata should be free after this point.
*
- * Returns the compiled regexp or NULL in case of error
+ * @returns the compiled regexp or NULL in case of error
*/
xmlRegexpPtr
xmlAutomataCompile(xmlAutomataPtr am) {
@@ -6310,12 +6235,11 @@ xmlAutomataCompile(xmlAutomataPtr am) {
}
/**
- * xmlAutomataIsDeterminist:
- * @am: an automata
+ * @param am an automata
*
* Checks if an automata is determinist.
*
- * Returns 1 if true, 0 if not, and -1 in case of error
+ * @returns 1 if true, 0 if not, and -1 in case of error
*/
int
xmlAutomataIsDeterminist(xmlAutomataPtr am) {
@@ -6329,7 +6253,7 @@ xmlAutomataIsDeterminist(xmlAutomataPtr am) {
}
#ifdef LIBXML_EXPR_ENABLED
-/** DOC_DISABLE */
+/** @cond IGNORE */
/************************************************************************
* *
* Formal Expression handling code *
@@ -6462,13 +6386,12 @@ struct _xmlExpCtxt {
};
/**
- * xmlExpNewCtxt:
- * @maxNodes: the maximum number of nodes
- * @dict: optional dictionary to use internally
+ * @param maxNodes the maximum number of nodes
+ * @param dict optional dictionary to use internally
*
* Creates a new context for manipulating expressions
*
- * Returns the context or NULL in case of error
+ * @returns the context or NULL in case of error
*/
xmlExpCtxtPtr
xmlExpNewCtxt(int maxNodes, xmlDictPtr dict) {
@@ -6506,8 +6429,7 @@ xmlExpNewCtxt(int maxNodes, xmlDictPtr dict) {
}
/**
- * xmlExpFreeCtxt:
- * @ctxt: an expression context
+ * @param ctxt an expression context
*
* Free an expression context
*/
@@ -6590,7 +6512,6 @@ xmlExpNodePtr emptyExp = &emptyExpNode;
* *
************************************************************************/
/*
- * xmlExpHashNameComputeKey:
* Calculate the hash key for a token
*/
static unsigned short
@@ -6608,7 +6529,6 @@ xmlExpHashNameComputeKey(const xmlChar *name) {
}
/*
- * xmlExpHashComputeKey:
* Calculate the hash key for a compound expression
*/
static unsigned short
@@ -6660,14 +6580,13 @@ xmlExpNewNode(xmlExpCtxtPtr ctxt, xmlExpNodeType type) {
}
/**
- * xmlExpHashGetEntry:
- * @table: the hash table
+ * @param table the hash table
*
* Get the unique entry from the hash table. The entry is created if
- * needed. @left and @right are consumed, i.e. their ref count will
+ * needed. `left` and `right` are consumed, i.e. their ref count will
* be decremented by the operation.
*
- * Returns the pointer or NULL in case of error
+ * @returns the pointer or NULL in case of error
*/
static xmlExpNodePtr
xmlExpHashGetEntry(xmlExpCtxtPtr ctxt, xmlExpNodeType type,
@@ -6897,9 +6816,8 @@ xmlExpHashGetEntry(xmlExpCtxtPtr ctxt, xmlExpNodeType type,
}
/**
- * xmlExpFree:
- * @ctxt: the expression context
- * @exp: the expression
+ * @param ctxt the expression context
+ * @param exp the expression
*
* Dereference the expression
*/
@@ -6940,8 +6858,7 @@ xmlExpFree(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp) {
}
/**
- * xmlExpRef:
- * @exp: the expression
+ * @param exp the expression
*
* Increase the reference count of the expression
*/
@@ -6952,14 +6869,13 @@ xmlExpRef(xmlExpNodePtr exp) {
}
/**
- * xmlExpNewAtom:
- * @ctxt: the expression context
- * @name: the atom name
- * @len: the atom name length in byte (or -1);
+ * @param ctxt the expression context
+ * @param name the atom name
+ * @param len the atom name length in byte (or -1);
*
* Get the atom associated to this name from that context
*
- * Returns the node or NULL in case of error
+ * @returns the node or NULL in case of error
*/
xmlExpNodePtr
xmlExpNewAtom(xmlExpCtxtPtr ctxt, const xmlChar *name, int len) {
@@ -6972,17 +6888,16 @@ xmlExpNewAtom(xmlExpCtxtPtr ctxt, const xmlChar *name, int len) {
}
/**
- * xmlExpNewOr:
- * @ctxt: the expression context
- * @left: left expression
- * @right: right expression
+ * @param ctxt the expression context
+ * @param left left expression
+ * @param right right expression
*
- * Get the atom associated to the choice @left | @right
- * Note that @left and @right are consumed in the operation, to keep
+ * Get the atom associated to the choice `left` | `right`
+ * Note that `left` and `right` are consumed in the operation, to keep
* an handle on them use xmlExpRef() and use xmlExpFree() to release them,
* this is true even in case of failure (unless ctxt == NULL).
*
- * Returns the node or NULL in case of error
+ * @returns the node or NULL in case of error
*/
xmlExpNodePtr
xmlExpNewOr(xmlExpCtxtPtr ctxt, xmlExpNodePtr left, xmlExpNodePtr right) {
@@ -6997,17 +6912,16 @@ xmlExpNewOr(xmlExpCtxtPtr ctxt, xmlExpNodePtr left, xmlExpNodePtr right) {
}
/**
- * xmlExpNewSeq:
- * @ctxt: the expression context
- * @left: left expression
- * @right: right expression
+ * @param ctxt the expression context
+ * @param left left expression
+ * @param right right expression
*
- * Get the atom associated to the sequence @left , @right
- * Note that @left and @right are consumed in the operation, to keep
+ * Get the atom associated to the sequence `left` , `right`
+ * Note that `left` and `right` are consumed in the operation, to keep
* an handle on them use xmlExpRef() and use xmlExpFree() to release them,
* this is true even in case of failure (unless ctxt == NULL).
*
- * Returns the node or NULL in case of error
+ * @returns the node or NULL in case of error
*/
xmlExpNodePtr
xmlExpNewSeq(xmlExpCtxtPtr ctxt, xmlExpNodePtr left, xmlExpNodePtr right) {
@@ -7022,18 +6936,17 @@ xmlExpNewSeq(xmlExpCtxtPtr ctxt, xmlExpNodePtr left, xmlExpNodePtr right) {
}
/**
- * xmlExpNewRange:
- * @ctxt: the expression context
- * @subset: the expression to be repeated
- * @min: the lower bound for the repetition
- * @max: the upper bound for the repetition, -1 means infinite
+ * @param ctxt the expression context
+ * @param subset the expression to be repeated
+ * @param min the lower bound for the repetition
+ * @param max the upper bound for the repetition, -1 means infinite
*
- * Get the atom associated to the range (@subset){@min, @max}
- * Note that @subset is consumed in the operation, to keep
+ * Get the atom associated to the range (`subset`){`min`, `max`}
+ * Note that `subset` is consumed in the operation, to keep
* an handle on it use xmlExpRef() and use xmlExpFree() to release it,
* this is true even in case of failure (unless ctxt == NULL).
*
- * Returns the node or NULL in case of error
+ * @returns the node or NULL in case of error
*/
xmlExpNodePtr
xmlExpNewRange(xmlExpCtxtPtr ctxt, xmlExpNodePtr subset, int min, int max) {
@@ -7088,16 +7001,15 @@ tail:
}
/**
- * xmlExpGetLanguage:
- * @ctxt: the expression context
- * @exp: the expression
- * @langList: where to store the tokens
- * @len: the allocated length of @list
+ * @param ctxt the expression context
+ * @param exp the expression
+ * @param langList where to store the tokens
+ * @param len the allocated length of `list`
*
- * Find all the strings used in @exp and store them in @list
+ * Find all the strings used in `exp` and store them in `list`
*
- * Returns the number of unique strings found, -1 in case of errors and
- * -2 if there is more than @len strings
+ * @returns the number of unique strings found, -1 in case of errors and
+ * -2 if there is more than `len` strings
*/
int
xmlExpGetLanguage(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp,
@@ -7154,18 +7066,17 @@ tail:
}
/**
- * xmlExpGetStart:
- * @ctxt: the expression context
- * @exp: the expression
- * @tokList: where to store the tokens
- * @len: the allocated length of @list
+ * @param ctxt the expression context
+ * @param exp the expression
+ * @param tokList where to store the tokens
+ * @param len the allocated length of `list`
*
* Find all the strings that appears at the start of the languages
- * accepted by @exp and store them in @list. E.g. for (a, b) | c
+ * accepted by `exp` and store them in `list`. E.g. for (a, b) | c
* it will return the list [a, c]
*
- * Returns the number of unique strings found, -1 in case of errors and
- * -2 if there is more than @len strings
+ * @returns the number of unique strings found, -1 in case of errors and
+ * -2 if there is more than `len` strings
*/
int
xmlExpGetStart(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp,
@@ -7176,12 +7087,11 @@ xmlExpGetStart(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp,
}
/**
- * xmlExpIsNillable:
- * @exp: the expression
+ * @param exp the expression
*
* Finds if the expression is nillable, i.e. if it accepts the empty sequence
*
- * Returns 1 if nillable, 0 if not and -1 in case of error
+ * @returns 1 if nillable, 0 if not and -1 in case of error
*/
int
xmlExpIsNillable(xmlExpNodePtr exp) {
@@ -7274,16 +7184,15 @@ xmlExpStringDeriveInt(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp, const xmlChar *str)
}
/**
- * xmlExpStringDerive:
- * @ctxt: the expression context
- * @exp: the expression
- * @str: the string
- * @len: the string len in bytes if available
+ * @param ctxt the expression context
+ * @param exp the expression
+ * @param str the string
+ * @param len the string len in bytes if available
*
- * Do one step of Brzozowski derivation of the expression @exp with
+ * Do one step of Brzozowski derivation of the expression `exp` with
* respect to the input string
*
- * Returns the resulting expression or NULL in case of internal error
+ * @returns the resulting expression or NULL in case of internal error
*/
xmlExpNodePtr
xmlExpStringDerive(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp,
@@ -7320,17 +7229,16 @@ xmlExpCheckCard(xmlExpNodePtr exp, xmlExpNodePtr sub) {
static xmlExpNodePtr xmlExpExpDeriveInt(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp,
xmlExpNodePtr sub);
/**
- * xmlExpDivide:
- * @ctxt: the expressions context
- * @exp: the englobing expression
- * @sub: the subexpression
- * @mult: the multiple expression
- * @remain: the remain from the derivation of the multiple
+ * @param ctxt the expressions context
+ * @param exp the englobing expression
+ * @param sub the subexpression
+ * @param mult the multiple expression
+ * @param remain the remain from the derivation of the multiple
*
* Check if exp is a multiple of sub, i.e. if there is a finite number n
* so that sub{n} subsume exp
*
- * Returns the multiple value if successful, 0 if it is not a multiple
+ * @returns the multiple value if successful, 0 if it is not a multiple
* and -1 in case of internal error.
*/
@@ -7379,15 +7287,14 @@ xmlExpDivide(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp, xmlExpNodePtr sub,
}
/**
- * xmlExpExpDeriveInt:
- * @ctxt: the expressions context
- * @exp: the englobing expression
- * @sub: the subexpression
+ * @param ctxt the expressions context
+ * @param exp the englobing expression
+ * @param sub the subexpression
*
* Try to do a step of Brzozowski derivation but at a higher level
* the input being a subexpression.
*
- * Returns the resulting expression or NULL in case of internal error
+ * @returns the resulting expression or NULL in case of internal error
*/
static xmlExpNodePtr
xmlExpExpDeriveInt(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp, xmlExpNodePtr sub) {
@@ -7737,17 +7644,16 @@ xmlExpExpDeriveInt(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp, xmlExpNodePtr sub) {
}
/**
- * xmlExpExpDerive:
- * @ctxt: the expressions context
- * @exp: the englobing expression
- * @sub: the subexpression
+ * @param ctxt the expressions context
+ * @param exp the englobing expression
+ * @param sub the subexpression
*
- * Evaluates the expression resulting from @exp consuming a sub expression @sub
+ * Evaluates the expression resulting from `exp` consuming a sub expression `sub`
* Based on algebraic derivation and sometimes direct Brzozowski derivation
* it usually takes less than linear time and can handle expressions generating
* infinite languages.
*
- * Returns the resulting expression or NULL in case of internal error, the
+ * @returns the resulting expression or NULL in case of internal error, the
* result must be freed
*/
xmlExpNodePtr
@@ -7768,15 +7674,14 @@ xmlExpExpDerive(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp, xmlExpNodePtr sub) {
}
/**
- * xmlExpSubsume:
- * @ctxt: the expressions context
- * @exp: the englobing expression
- * @sub: the subexpression
+ * @param ctxt the expressions context
+ * @param exp the englobing expression
+ * @param sub the subexpression
*
- * Check whether @exp accepts all the languages accepted by @sub
+ * Check whether `exp` accepts all the languages accepted by `sub`
* the input being a subexpression.
*
- * Returns 1 if true 0 if false and -1 in case of failure.
+ * @returns 1 if true 0 if false and -1 in case of failure.
*/
int
xmlExpSubsume(xmlExpCtxtPtr ctxt, xmlExpNodePtr exp, xmlExpNodePtr sub) {
@@ -7964,9 +7869,8 @@ xmlExpParseExpr(xmlExpCtxtPtr ctxt) {
}
/**
- * xmlExpParse:
- * @ctxt: the expressions context
- * @expr: the 0 terminated string
+ * @param ctxt the expressions context
+ * @param expr the 0 terminated string
*
* Minimal parser for regexps, it understand the following constructs
* - string terminals
@@ -7978,7 +7882,7 @@ xmlExpParseExpr(xmlExpCtxtPtr ctxt) {
* - infinite sequences { min, * }
* There is minimal checkings made especially no checking on strings values
*
- * Returns a new expression or NULL in case of failure
+ * @returns a new expression or NULL in case of failure
*/
xmlExpNodePtr
xmlExpParse(xmlExpCtxtPtr ctxt, const char *expr) {
@@ -8073,9 +7977,8 @@ xmlExpDumpInt(xmlBufferPtr buf, xmlExpNodePtr expr, int glob) {
xmlBufferWriteChar(buf, ")");
}
/**
- * xmlExpDump:
- * @buf: a buffer to receive the output
- * @expr: the compiled expression
+ * @param buf a buffer to receive the output
+ * @param expr the compiled expression
*
* Serialize the expression as compiled to the buffer
*/
@@ -8087,12 +7990,11 @@ xmlExpDump(xmlBufferPtr buf, xmlExpNodePtr expr) {
}
/**
- * xmlExpMaxToken:
- * @expr: a compiled expression
+ * @param expr a compiled expression
*
* Indicate the maximum number of input a expression can accept
*
- * Returns the maximum length or -1 in case of error
+ * @returns the maximum length or -1 in case of error
*/
int
xmlExpMaxToken(xmlExpNodePtr expr) {
@@ -8102,12 +8004,11 @@ xmlExpMaxToken(xmlExpNodePtr expr) {
}
/**
- * xmlExpCtxtNbNodes:
- * @ctxt: an expression context
+ * @param ctxt an expression context
*
* Debugging facility provides the number of allocated nodes at a that point
*
- * Returns the number of nodes in use or -1 in case of error
+ * @returns the number of nodes in use or -1 in case of error
*/
int
xmlExpCtxtNbNodes(xmlExpCtxtPtr ctxt) {
@@ -8117,12 +8018,11 @@ xmlExpCtxtNbNodes(xmlExpCtxtPtr ctxt) {
}
/**
- * xmlExpCtxtNbCons:
- * @ctxt: an expression context
+ * @param ctxt an expression context
*
* Debugging facility provides the number of allocated nodes over lifetime
*
- * Returns the number of nodes ever allocated or -1 in case of error
+ * @returns the number of nodes ever allocated or -1 in case of error
*/
int
xmlExpCtxtNbCons(xmlExpCtxtPtr ctxt) {
@@ -8131,7 +8031,7 @@ xmlExpCtxtNbCons(xmlExpCtxtPtr ctxt) {
return(ctxt->nb_cons);
}
-/** DOC_ENABLE */
+/** @endcond */
#endif /* LIBXML_EXPR_ENABLED */
#endif /* LIBXML_REGEXP_ENABLED */
diff --git a/xmlsave.c b/xmlsave.c
index a3722ef8..3ae1a5d4 100644
--- a/xmlsave.c
+++ b/xmlsave.c
@@ -51,8 +51,7 @@ struct _xmlSaveCtxt {
* *
************************************************************************/
/**
- * xmlSaveErrMemory:
- * @out: an output buffer
+ * @param out an output buffer
*
* Handle an out of memory condition
*/
@@ -65,11 +64,10 @@ xmlSaveErrMemory(xmlOutputBufferPtr out)
}
/**
- * xmlSaveErr:
- * @out: an output buffer
- * @code: the error number
- * @node: the location of the error.
- * @extra: extra information
+ * @param out an output buffer
+ * @param code the error number
+ * @param node the location of the error.
+ * @param extra extra information
*
* Handle an out of memory condition
*/
@@ -225,15 +223,14 @@ xmlSerializeText(xmlOutputBufferPtr buf, const xmlChar *string,
************************************************************************/
/**
- * xmlSaveSetIndentString:
- * @ctxt: save context
- * @indent: indent string
+ * @param ctxt save context
+ * @param indent indent string
*
* Sets the indent string.
*
* Available since 2.14.0.
*
- * Returns 0 on success, -1 if the string is NULL, empty or too long.
+ * @returns 0 on success, -1 if the string is NULL, empty or too long.
*/
int
xmlSaveSetIndentString(xmlSaveCtxtPtr ctxt, const char *indent) {
@@ -256,9 +253,8 @@ xmlSaveSetIndentString(xmlSaveCtxtPtr ctxt, const char *indent) {
}
/**
- * xmlSaveCtxtInit:
- * @ctxt: the saving context
- * @options: save options
+ * @param ctxt the saving context
+ * @param options save options
*
* Initialize a saving context
*/
@@ -282,7 +278,6 @@ xmlSaveCtxtInit(xmlSaveCtxtPtr ctxt, int options)
}
/**
- * xmlFreeSaveCtxt:
*
* Free a saving context, destroying the output in any remaining buffer
*/
@@ -298,11 +293,10 @@ xmlFreeSaveCtxt(xmlSaveCtxtPtr ctxt)
}
/**
- * xmlNewSaveCtxt:
*
* Create a new saving context
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSaveCtxtPtr
xmlNewSaveCtxt(const char *encoding, int options)
@@ -349,9 +343,8 @@ xmlSaveWriteText(xmlSaveCtxt *ctxt, const xmlChar *text, unsigned flags) {
}
/**
- * xmlSaveWriteAttrContent:
- * @ctxt: save context
- * @attr: the attribute pointer
+ * @param ctxt save context
+ * @param attr the attribute pointer
*
* Serialize the attribute in the buffer
*/
@@ -381,9 +374,8 @@ xmlSaveWriteAttrContent(xmlSaveCtxt *ctxt, xmlAttrPtr attr)
}
/**
- * xmlBufDumpNotationDecl:
- * @buf: the XML buffer output
- * @nota: A notation declaration
+ * @param buf the XML buffer output
+ * @param nota A notation declaration
*
* This will dump the content the notation declaration as an XML DTD definition
*/
@@ -408,10 +400,9 @@ xmlBufDumpNotationDecl(xmlOutputBufferPtr buf, xmlNotationPtr nota) {
}
/**
- * xmlBufDumpNotationDeclScan:
- * @nota: A notation declaration
- * @buf: the XML buffer output
- * @name: unused
+ * @param nota A notation declaration
+ * @param buf the XML buffer output
+ * @param name unused
*
* This is called with the hash scan function, and just reverses args
*/
@@ -422,9 +413,8 @@ xmlBufDumpNotationDeclScan(void *nota, void *buf,
}
/**
- * xmlBufDumpNotationTable:
- * @buf: an xmlBufPtr output
- * @table: A notation table
+ * @param buf an xmlBufPtr output
+ * @param table A notation table
*
* This will dump the content of the notation table as an XML DTD definition
*/
@@ -434,9 +424,8 @@ xmlBufDumpNotationTable(xmlOutputBufferPtr buf, xmlNotationTablePtr table) {
}
/**
- * xmlBufDumpElementOccur:
- * @buf: output buffer
- * @cur: element table
+ * @param buf output buffer
+ * @param cur element table
*
* Dump the occurrence operator of an element.
*/
@@ -458,9 +447,8 @@ xmlBufDumpElementOccur(xmlOutputBufferPtr buf, xmlElementContentPtr cur) {
}
/**
- * xmlBufDumpElementContent:
- * @buf: output buffer
- * @content: element table
+ * @param buf output buffer
+ * @param content element table
*
* This will dump the content of the element table as an XML DTD definition
*/
@@ -531,9 +519,8 @@ xmlBufDumpElementContent(xmlOutputBufferPtr buf,
}
/**
- * xmlBufDumpElementDecl:
- * @buf: an xmlBufPtr output
- * @elem: An element table
+ * @param buf an xmlBufPtr output
+ * @param elem An element table
*
* This will dump the content of the element declaration as an XML
* DTD definition
@@ -568,9 +555,8 @@ xmlBufDumpElementDecl(xmlOutputBufferPtr buf, xmlElementPtr elem) {
}
/**
- * xmlBufDumpEnumeration:
- * @buf: output buffer
- * @cur: an enumeration
+ * @param buf output buffer
+ * @param cur an enumeration
*
* This will dump the content of the enumeration
*/
@@ -587,9 +573,8 @@ xmlBufDumpEnumeration(xmlOutputBufferPtr buf, xmlEnumerationPtr cur) {
xmlOutputBufferWrite(buf, 1, ")");
}
/**
- * xmlBufDumpAttributeDecl:
- * @buf: output buffer
- * @attr: An attribute declaration
+ * @param buf output buffer
+ * @param attr An attribute declaration
*
* This will dump the content of the attribute declaration as an XML
* DTD definition
@@ -669,9 +654,8 @@ xmlBufDumpAttributeDecl(xmlOutputBufferPtr buf, xmlAttributePtr attr) {
}
/**
- * xmlBufDumpEntityContent:
- * @buf: output buffer
- * @content: entity content.
+ * @param buf output buffer
+ * @param content entity content.
*
* This will dump the quoted string value, taking care of the special
* treatment required by %
@@ -709,9 +693,8 @@ xmlBufDumpEntityContent(xmlOutputBufferPtr buf, const xmlChar *content) {
}
/**
- * xmlBufDumpEntityDecl:
- * @buf: an xmlBufPtr output
- * @ent: An entity table
+ * @param buf an xmlBufPtr output
+ * @param ent An entity table
*
* This will dump the content of the entity table as an XML DTD definition
*/
@@ -852,9 +835,8 @@ xmlSaveWriteIndent(xmlSaveCtxtPtr ctxt, int extra)
}
/**
- * xmlOutputBufferWriteWSNonSig:
- * @ctxt: The save context
- * @extra: Number of extra indents to apply to ctxt->level
+ * @param ctxt The save context
+ * @param extra Number of extra indents to apply to ctxt->level
*
* Write out formatting for non-significant whitespace output.
*/
@@ -874,14 +856,13 @@ xmlOutputBufferWriteWSNonSig(xmlSaveCtxtPtr ctxt, int extra)
}
/**
- * xmlNsDumpOutput:
- * @buf: the XML buffer output
- * @cur: a namespace
- * @ctxt: the output save context. Optional.
+ * @param buf the XML buffer output
+ * @param cur a namespace
+ * @param ctxt the output save context. Optional.
*
* Dump a local Namespace definition.
* Should be called in the context of attributes dumps.
- * If @ctxt is supplied, @buf should be its buffer.
+ * If `ctxt` is supplied, `buf` should be its buffer.
*/
static void
xmlNsDumpOutput(xmlOutputBufferPtr buf, xmlNsPtr cur, xmlSaveCtxtPtr ctxt) {
@@ -915,8 +896,8 @@ xmlNsDumpOutput(xmlOutputBufferPtr buf, xmlNsPtr cur, xmlSaveCtxtPtr ctxt) {
/**
* xmlNsListDumpOutputCtxt
- * @ctxt: the save context
- * @cur: the first namespace
+ * @param ctxt the save context
+ * @param cur the first namespace
*
* Dump a list of local namespace definitions to a save context.
* Should be called in the context of attribute dumps.
@@ -930,9 +911,8 @@ xmlNsListDumpOutputCtxt(xmlSaveCtxtPtr ctxt, xmlNsPtr cur) {
}
/**
- * xmlNsListDumpOutput:
- * @buf: the XML buffer output
- * @cur: the first namespace
+ * @param buf the XML buffer output
+ * @param cur the first namespace
*
* Dump a list of local Namespace definitions.
* Should be called in the context of attributes dumps.
@@ -946,9 +926,8 @@ xmlNsListDumpOutput(xmlOutputBufferPtr buf, xmlNsPtr cur) {
}
/**
- * xmlDtdDumpOutput:
- * @ctxt: the save context
- * @dtd: the pointer to the DTD
+ * @param ctxt the save context
+ * @param dtd the pointer to the DTD
*
* Dump the XML document DTD, if any.
*/
@@ -1001,9 +980,8 @@ xmlDtdDumpOutput(xmlSaveCtxtPtr ctxt, xmlDtdPtr dtd) {
}
/**
- * xmlAttrDumpOutput:
- * @ctxt: the save context
- * @cur: the attribute pointer
+ * @param ctxt the save context
+ * @param cur the attribute pointer
*
* Dump an XML attribute
*/
@@ -1042,9 +1020,8 @@ xmlAttrDumpOutput(xmlSaveCtxtPtr ctxt, xmlAttrPtr cur) {
#ifdef LIBXML_HTML_ENABLED
/**
- * htmlNodeDumpOutputInternal:
- * @ctxt: the save context
- * @cur: the current node
+ * @param ctxt the save context
+ * @param cur the current node
*
* Dump an HTML node, recursive behaviour, children are printed too.
*/
@@ -1094,9 +1071,8 @@ htmlNodeDumpOutputInternal(xmlSaveCtxtPtr ctxt, xmlNodePtr cur) {
#endif
/**
- * xmlNodeDumpOutputInternal:
- * @ctxt: the save context
- * @cur: the current node
+ * @param ctxt the save context
+ * @param cur the current node
*
* Dump an XML node, recursive behaviour, children are printed too.
*/
@@ -1358,10 +1334,9 @@ xmlNodeDumpOutputInternal(xmlSaveCtxtPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlSaveDocInternal:
- * @ctxt: the save context
- * @cur: the document
- * @encoding: character encoding (optional)
+ * @param ctxt the save context
+ * @param cur the document
+ * @param encoding character encoding (optional)
*
* Dump an XML document.
*/
@@ -1496,11 +1471,11 @@ xmlSaveDocInternal(xmlSaveCtxtPtr ctxt, xmlDocPtr cur,
/**
* xhtmlIsEmpty:
- * @node: the node
+ * @param node the node
*
* Check if a node is an empty xhtml node
*
- * Returns 1 if the node is an empty node, 0 if not and -1 in case of error
+ * @returns 1 if the node is an empty node, 0 if not and -1 in case of error
*/
static int
xhtmlIsEmpty(xmlNodePtr node) {
@@ -1563,8 +1538,8 @@ xhtmlIsEmpty(xmlNodePtr node) {
/**
* xhtmlAttrListDumpOutput:
- * @ctxt: the save context
- * @cur: the first attribute pointer
+ * @param ctxt the save context
+ * @param cur the first attribute pointer
*
* Dump a list of XML attributes
*/
@@ -1632,8 +1607,8 @@ xhtmlAttrListDumpOutput(xmlSaveCtxtPtr ctxt, xmlAttrPtr cur) {
/**
* xhtmlNodeDumpOutput:
- * @ctxt: the save context
- * @cur: the current node
+ * @param ctxt the save context
+ * @param cur the current node
*
* Dump an XHTML node, recursive behaviour, children are printed too.
*/
@@ -1965,15 +1940,14 @@ xhtmlNodeDumpOutput(xmlSaveCtxtPtr ctxt, xmlNodePtr cur) {
************************************************************************/
/**
- * xmlSaveToFd:
- * @fd: a file descriptor number
- * @encoding: the encoding name to use or NULL
- * @options: a set of xmlSaveOptions
+ * @param fd a file descriptor number
+ * @param encoding the encoding name to use or NULL
+ * @param options a set of xmlSaveOptions
*
* Create a document saving context serializing to a file descriptor
* with the encoding and the options given.
*
- * Returns a new serialization context or NULL in case of error.
+ * @returns a new serialization context or NULL in case of error.
*/
xmlSaveCtxtPtr
xmlSaveToFd(int fd, const char *encoding, int options)
@@ -1991,16 +1965,15 @@ xmlSaveToFd(int fd, const char *encoding, int options)
}
/**
- * xmlSaveToFilename:
- * @filename: a file name or an URL
- * @encoding: the encoding name to use or NULL
- * @options: a set of xmlSaveOptions
+ * @param filename a file name or an URL
+ * @param encoding the encoding name to use or NULL
+ * @param options a set of xmlSaveOptions
*
* Create a document saving context serializing to a filename or possibly
* to an URL (but this is less reliable) with the encoding and the options
* given.
*
- * Returns a new serialization context or NULL in case of error.
+ * @returns a new serialization context or NULL in case of error.
*/
xmlSaveCtxtPtr
xmlSaveToFilename(const char *filename, const char *encoding, int options)
@@ -2020,15 +1993,14 @@ xmlSaveToFilename(const char *filename, const char *encoding, int options)
}
/**
- * xmlSaveToBuffer:
- * @buffer: a buffer
- * @encoding: the encoding name to use or NULL
- * @options: a set of xmlSaveOptions
+ * @param buffer a buffer
+ * @param encoding the encoding name to use or NULL
+ * @param options a set of xmlSaveOptions
*
* Create a document saving context serializing to a buffer
* with the encoding and the options given
*
- * Returns a new serialization context or NULL in case of error.
+ * @returns a new serialization context or NULL in case of error.
*/
xmlSaveCtxtPtr
@@ -2047,17 +2019,16 @@ xmlSaveToBuffer(xmlBufferPtr buffer, const char *encoding, int options)
}
/**
- * xmlSaveToIO:
- * @iowrite: an I/O write function
- * @ioclose: an I/O close function
- * @ioctx: an I/O handler
- * @encoding: the encoding name to use or NULL
- * @options: a set of xmlSaveOptions
+ * @param iowrite an I/O write function
+ * @param ioclose an I/O close function
+ * @param ioctx an I/O handler
+ * @param encoding the encoding name to use or NULL
+ * @param options a set of xmlSaveOptions
*
* Create a document saving context serializing to a file descriptor
* with the encoding and the options given
*
- * Returns a new serialization context or NULL in case of error.
+ * @returns a new serialization context or NULL in case of error.
*/
xmlSaveCtxtPtr
xmlSaveToIO(xmlOutputWriteCallback iowrite,
@@ -2077,15 +2048,14 @@ xmlSaveToIO(xmlOutputWriteCallback iowrite,
}
/**
- * xmlSaveDoc:
- * @ctxt: a document saving context
- * @doc: a document
+ * @param ctxt a document saving context
+ * @param doc a document
*
* Save a full document to a saving context
* TODO: The function is not fully implemented yet as it does not return the
* byte count but 0 instead
*
- * Returns the number of byte written or -1 in case of error
+ * @returns the number of byte written or -1 in case of error
*/
long
xmlSaveDoc(xmlSaveCtxtPtr ctxt, xmlDocPtr doc)
@@ -2099,15 +2069,14 @@ xmlSaveDoc(xmlSaveCtxtPtr ctxt, xmlDocPtr doc)
}
/**
- * xmlSaveTree:
- * @ctxt: a document saving context
- * @cur: the top node of the subtree to save
+ * @param ctxt a document saving context
+ * @param cur the top node of the subtree to save
*
* Save a subtree starting at the node parameter to a saving context
* TODO: The function is not fully implemented yet as it does not return the
* byte count but 0 instead
*
- * Returns the number of byte written or -1 in case of error
+ * @returns the number of byte written or -1 in case of error
*/
long
xmlSaveTree(xmlSaveCtxtPtr ctxt, xmlNodePtr cur)
@@ -2133,13 +2102,12 @@ xmlSaveTree(xmlSaveCtxtPtr ctxt, xmlNodePtr cur)
}
/**
- * xmlSaveNotationDecl:
- * @ctxt: save context
- * @cur: notation
+ * @param ctxt save context
+ * @param cur notation
*
* Serialize a notation declaration.
*
- * Return 0 on succes, -1 on error.
+ * @returns 0 on succes, -1 on error.
*/
int
xmlSaveNotationDecl(xmlSaveCtxtPtr ctxt, xmlNotationPtr cur) {
@@ -2150,13 +2118,12 @@ xmlSaveNotationDecl(xmlSaveCtxtPtr ctxt, xmlNotationPtr cur) {
}
/**
- * xmlSaveNotationTable:
- * @ctxt: save context
- * @cur: notation table
+ * @param ctxt save context
+ * @param cur notation table
*
* Serialize notation declarations of a document.
*
- * Return 0 on succes, -1 on error.
+ * @returns 0 on succes, -1 on error.
*/
int
xmlSaveNotationTable(xmlSaveCtxtPtr ctxt, xmlNotationTablePtr cur) {
@@ -2167,13 +2134,12 @@ xmlSaveNotationTable(xmlSaveCtxtPtr ctxt, xmlNotationTablePtr cur) {
}
/**
- * xmlSaveFlush:
- * @ctxt: a document saving context
+ * @param ctxt a document saving context
*
* Flush a document saving context, i.e. make sure that all bytes have
* been output.
*
- * Returns the number of byte written or -1 in case of error.
+ * @returns the number of byte written or -1 in case of error.
*/
int
xmlSaveFlush(xmlSaveCtxtPtr ctxt)
@@ -2184,13 +2150,12 @@ xmlSaveFlush(xmlSaveCtxtPtr ctxt)
}
/**
- * xmlSaveClose:
- * @ctxt: a document saving context
+ * @param ctxt a document saving context
*
* Close a document saving context, i.e. make sure that all bytes have
* been output and free the associated data.
*
- * Returns the number of byte written or -1 in case of error.
+ * @returns the number of byte written or -1 in case of error.
*/
int
xmlSaveClose(xmlSaveCtxtPtr ctxt)
@@ -2204,15 +2169,14 @@ xmlSaveClose(xmlSaveCtxtPtr ctxt)
}
/**
- * xmlSaveFinish:
- * @ctxt: a document saving context
+ * @param ctxt a document saving context
*
* Close a document saving context, i.e. make sure that all bytes have
* been output and free the associated data.
*
* Available since 2.13.0.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
xmlParserErrors
xmlSaveFinish(xmlSaveCtxtPtr ctxt)
@@ -2234,15 +2198,14 @@ xmlSaveFinish(xmlSaveCtxtPtr ctxt)
}
/**
- * xmlSaveSetEscape:
- * @ctxt: a document saving context
- * @escape: the escaping function
+ * @param ctxt a document saving context
+ * @param escape the escaping function
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Set a custom escaping function to be used for text in element content
*
- * Returns 0 if successful or -1 in case of error.
+ * @returns 0 if successful or -1 in case of error.
*/
int
xmlSaveSetEscape(xmlSaveCtxtPtr ctxt, xmlCharEncodingOutputFunc escape)
@@ -2253,15 +2216,14 @@ xmlSaveSetEscape(xmlSaveCtxtPtr ctxt, xmlCharEncodingOutputFunc escape)
}
/**
- * xmlSaveSetAttrEscape:
- * @ctxt: a document saving context
- * @escape: the escaping function
+ * @param ctxt a document saving context
+ * @param escape the escaping function
*
- * DEPRECATED: Don't use.
+ * @deprecated Don't use.
*
* Has no effect.
*
- * Returns 0 if successful or -1 in case of error.
+ * @returns 0 if successful or -1 in case of error.
*/
int
xmlSaveSetAttrEscape(xmlSaveCtxtPtr ctxt,
@@ -2278,10 +2240,9 @@ xmlSaveSetAttrEscape(xmlSaveCtxtPtr ctxt,
************************************************************************/
/**
- * xmlBufAttrSerializeTxtContent:
- * @buf: output buffer
- * @doc: the document
- * @string: the text content
+ * @param buf output buffer
+ * @param doc the document
+ * @param string the text content
*
* Serialize text attribute values to an xmlBufPtr
*/
@@ -2297,11 +2258,10 @@ xmlBufAttrSerializeTxtContent(xmlOutputBufferPtr buf, xmlDocPtr doc,
}
/**
- * xmlAttrSerializeTxtContent:
- * @buf: the XML buffer output
- * @doc: the document
- * @attr: the attribute node
- * @string: the text content
+ * @param buf the XML buffer output
+ * @param doc the document
+ * @param attr the attribute node
+ * @param string the text content
*
* Serialize text attribute values to an xml simple buffer
*/
@@ -2323,20 +2283,19 @@ xmlAttrSerializeTxtContent(xmlBufferPtr buf, xmlDocPtr doc,
}
/**
- * xmlNodeDump:
- * @buf: the XML buffer output
- * @doc: the document
- * @cur: the current node
- * @level: the imbrication level for indenting
- * @format: is formatting allowed
+ * @param buf the XML buffer output
+ * @param doc the document
+ * @param cur the current node
+ * @param level the imbrication level for indenting
+ * @param 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.
* Since this is using xmlBuffer structures it is limited to 2GB and somehow
* deprecated, use xmlNodeDumpOutput() instead.
*
- * 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
*/
int
xmlNodeDump(xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur, int level,
@@ -2363,19 +2322,18 @@ xmlNodeDump(xmlBufferPtr buf, xmlDocPtr doc, xmlNodePtr cur, int level,
}
/**
- * xmlBufNodeDump:
- * @buf: the XML buffer output
- * @doc: the document
- * @cur: the current node
- * @level: the imbrication level for indenting
- * @format: is formatting allowed
+ * @param buf the XML buffer output
+ * @param doc the document
+ * @param cur the current node
+ * @param level the imbrication level for indenting
+ * @param 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, in case of error 0
- * is returned or @buf stores the error
+ * @returns the number of bytes written to the buffer, in case of error 0
+ * is returned or `buf` stores the error
*/
size_t
@@ -2418,10 +2376,9 @@ xmlBufNodeDump(xmlBufPtr buf, xmlDocPtr doc, xmlNodePtr cur, int level,
}
/**
- * xmlElemDump:
- * @f: the FILE * for the output
- * @doc: the document
- * @cur: the current node
+ * @param f the FILE * for the output
+ * @param doc the document
+ * @param cur the current node
*
* Dump an XML/HTML node, recursive behaviour, children are printed too.
*/
@@ -2455,16 +2412,15 @@ xmlElemDump(FILE * f, xmlDocPtr doc, xmlNodePtr cur)
************************************************************************/
/**
- * xmlNodeDumpOutput:
- * @buf: the XML buffer output
- * @doc: the document
- * @cur: the current node
- * @level: the imbrication level for indenting
- * @format: is formatting allowed
- * @encoding: an optional encoding string
+ * @param buf the XML buffer output
+ * @param doc the document
+ * @param cur the current node
+ * @param level the imbrication level for indenting
+ * @param format is formatting allowed
+ * @param 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
@@ -2543,17 +2499,16 @@ xmlDocDumpInternal(xmlOutputBufferPtr buf, xmlDocPtr doc, const char *encoding,
}
/**
- * xmlDocDumpFormatMemoryEnc:
- * @out_doc: Document to generate XML text from
- * @doc_txt_ptr: Memory pointer for allocated XML text
- * @doc_txt_len: Length of the generated XML text
- * @txt_encoding: Character encoding to use when generating XML text
- * @format: should formatting spaces been added
+ * @param out_doc Document to generate XML text from
+ * @param doc_txt_ptr Memory pointer for allocated XML text
+ * @param doc_txt_len Length of the generated XML text
+ * @param txt_encoding Character encoding to use when generating XML text
+ * @param format should formatting spaces been added
*
* 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
*/
@@ -2593,12 +2548,11 @@ xmlDocDumpFormatMemoryEnc(xmlDocPtr out_doc, xmlChar **doc_txt_ptr,
}
/**
- * xmlDocDumpMemory:
- * @cur: the document
- * @mem: OUT: the memory pointer
- * @size: OUT: the memory length
+ * @param cur the document
+ * @param mem OUT: the memory pointer
+ * @param size OUT: the memory length
*
- * 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
* in bytes. It's up to the caller to free the memory with xmlFree().
* The resulting byte array is zero terminated, though the last 0 is not
* included in the returned size.
@@ -2609,16 +2563,15 @@ xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int *size) {
}
/**
- * xmlDocDumpFormatMemory:
- * @cur: the document
- * @mem: OUT: the memory pointer
- * @size: OUT: the memory length
- * @format: should formatting spaces been added
+ * @param cur the document
+ * @param mem OUT: the memory pointer
+ * @param size OUT: the memory length
+ * @param format should formatting spaces been added
*
*
- * 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().
- * 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
@@ -2627,11 +2580,10 @@ xmlDocDumpFormatMemory(xmlDocPtr cur, xmlChar**mem, int *size, int format) {
}
/**
- * xmlDocDumpMemoryEnc:
- * @out_doc: Document to generate XML text from
- * @doc_txt_ptr: Memory pointer for allocated XML text
- * @doc_txt_len: Length of the generated XML text
- * @txt_encoding: Character encoding to use when generating XML text
+ * @param out_doc Document to generate XML text from
+ * @param doc_txt_ptr Memory pointer for allocated XML text
+ * @param doc_txt_len Length of the generated XML text
+ * @param txt_encoding Character encoding to use when generating XML text
*
* 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
@@ -2646,15 +2598,14 @@ xmlDocDumpMemoryEnc(xmlDocPtr out_doc, xmlChar **doc_txt_ptr,
}
/**
- * xmlDocFormatDump:
- * @f: the FILE*
- * @cur: the document
- * @format: should formatting spaces been added
+ * @param f the FILE*
+ * @param cur the document
+ * @param format should formatting spaces been added
*
* 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
+ * @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
@@ -2674,13 +2625,12 @@ xmlDocFormatDump(FILE *f, xmlDocPtr cur, int format) {
}
/**
- * xmlDocDump:
- * @f: the FILE*
- * @cur: the document
+ * @param f the FILE*
+ * @param cur the document
*
* 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.
*/
int
xmlDocDump(FILE *f, xmlDocPtr cur) {
@@ -2688,16 +2638,15 @@ xmlDocDump(FILE *f, xmlDocPtr cur) {
}
/**
- * xmlSaveFileTo:
- * @buf: an output I/O buffer
- * @cur: the document
- * @encoding: the encoding if any assuming the I/O layer handles the transcoding
+ * @param buf an output I/O buffer
+ * @param cur the document
+ * @param encoding the encoding if any assuming the I/O layer handles the transcoding
*
* Dump an XML document to an I/O buffer.
* Warning ! This call xmlOutputBufferClose() on buf which is not available
* after this call.
*
- * returns: the number of bytes written or -1 in case of failure.
+ * @returns the number of bytes written or -1 in case of failure.
*/
int
xmlSaveFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding) {
@@ -2705,17 +2654,16 @@ xmlSaveFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur, const char *encoding) {
}
/**
- * xmlSaveFormatFileTo:
- * @buf: an output I/O buffer
- * @cur: the document
- * @encoding: the encoding if any assuming the I/O layer handles the transcoding
- * @format: should formatting spaces been added
+ * @param buf an output I/O buffer
+ * @param cur the document
+ * @param encoding the encoding if any assuming the I/O layer handles the transcoding
+ * @param format should formatting spaces been added
*
* Dump an XML document to an I/O buffer.
* Warning ! This call xmlOutputBufferClose() on buf which is not available
* after this call.
*
- * returns: the number of bytes written or -1 in case of failure.
+ * @returns the number of bytes written or -1 in case of failure.
*/
int
xmlSaveFormatFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur,
@@ -2735,16 +2683,15 @@ xmlSaveFormatFileTo(xmlOutputBufferPtr buf, xmlDocPtr cur,
}
/**
- * xmlSaveFormatFileEnc:
- * @filename: the filename or URL to output
- * @cur: the document being saved
- * @encoding: the name of the encoding to use or NULL.
- * @format: should formatting spaces be added.
+ * @param filename the filename or URL to output
+ * @param cur the document being saved
+ * @param encoding the name of the encoding to use or NULL.
+ * @param format should formatting spaces be added.
*
* 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
+ * @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
@@ -2771,14 +2718,13 @@ xmlSaveFormatFileEnc( const char * filename, xmlDocPtr cur,
/**
- * xmlSaveFileEnc:
- * @filename: the filename (or URL)
- * @cur: the document
- * @encoding: the name of an encoding (or NULL)
+ * @param filename the filename (or URL)
+ * @param cur the document
+ * @param encoding the name of an encoding (or NULL)
*
* Dump an XML document, converting it to the given encoding
*
- * returns: the number of bytes written or -1 in case of failure.
+ * @returns the number of bytes written or -1 in case of failure.
*/
int
xmlSaveFileEnc(const char *filename, xmlDocPtr cur, const char *encoding) {
@@ -2786,18 +2732,17 @@ xmlSaveFileEnc(const char *filename, xmlDocPtr cur, const char *encoding) {
}
/**
- * xmlSaveFormatFile:
- * @filename: the filename (or URL)
- * @cur: the document
- * @format: should formatting spaces been added
+ * @param filename the filename (or URL)
+ * @param cur the document
+ * @param format should formatting spaces been added
*
* 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
+ * 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.
+ * @returns the number of bytes written or -1 in case of failure.
*/
int
xmlSaveFormatFile(const char *filename, xmlDocPtr cur, int format) {
@@ -2805,14 +2750,13 @@ xmlSaveFormatFile(const char *filename, xmlDocPtr cur, int format) {
}
/**
- * xmlSaveFile:
- * @filename: the filename (or URL)
- * @cur: the document
+ * @param filename the filename (or URL)
+ * @param cur the document
*
* 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.
- * returns: the number of bytes written or -1 in case of failure.
+ * @returns the number of bytes written or -1 in case of failure.
*/
int
xmlSaveFile(const char *filename, xmlDocPtr cur) {
diff --git a/xmlschemas.c b/xmlschemas.c
index c3d938d9..1693a5ba 100644
--- a/xmlschemas.c
+++ b/xmlschemas.c
@@ -383,7 +383,6 @@ typedef xmlSchemaBucket *xmlSchemaBucketPtr;
#define XML_SCHEMA_SCHEMA_REDEFINE 3
/**
- * xmlSchemaSchemaRelation:
*
* Used to create a graph of schema relationships.
*/
@@ -416,7 +415,6 @@ struct _xmlSchemaBucket {
};
/**
- * xmlSchemaImport:
* (extends xmlSchemaBucket)
*
* Reflects a schema. Holds some information
@@ -474,7 +472,6 @@ struct _xmlSchemaInclude {
};
/**
- * xmlSchemaBasicItem:
*
* The abstract base type for schema components.
*/
@@ -486,7 +483,6 @@ struct _xmlSchemaBasicItem {
};
/**
- * xmlSchemaAnnotItem:
*
* The abstract base type for annotated schema components.
* (Extends xmlSchemaBasicItem)
@@ -499,7 +495,6 @@ struct _xmlSchemaAnnotItem {
};
/**
- * xmlSchemaTreeItem:
*
* The abstract base type for tree-like structured schema components.
* (Extends xmlSchemaAnnotItem)
@@ -516,7 +511,6 @@ struct _xmlSchemaTreeItem {
#define XML_SCHEMA_ATTR_USE_FIXED 1<<0
/**
- * xmlSchemaAttributeUsePtr:
*
* The abstract base type for tree-like structured schema components.
* (Extends xmlSchemaTreeItem)
@@ -541,7 +535,6 @@ struct _xmlSchemaAttributeUse {
};
/**
- * xmlSchemaAttributeUseProhibPtr:
*
* A helper component to reflect attribute prohibitions.
* (Extends xmlSchemaBasicItem)
@@ -557,7 +550,6 @@ struct _xmlSchemaAttributeUseProhib {
};
/**
- * xmlSchemaRedef:
*/
typedef struct _xmlSchemaRedef xmlSchemaRedef;
typedef xmlSchemaRedef *xmlSchemaRedefPtr;
@@ -573,7 +565,6 @@ struct _xmlSchemaRedef {
};
/**
- * xmlSchemaConstructionCtxt:
*/
typedef struct _xmlSchemaConstructionCtxt xmlSchemaConstructionCtxt;
typedef xmlSchemaConstructionCtxt *xmlSchemaConstructionCtxtPtr;
@@ -647,7 +638,6 @@ struct _xmlSchemaParserCtxt {
};
/**
- * xmlSchemaQNameRef:
*
* A component reference item (not a schema component)
* (Extends xmlSchemaBasicItem)
@@ -664,7 +654,6 @@ struct _xmlSchemaQNameRef {
};
/**
- * xmlSchemaParticle:
*
* A particle component.
* (Extends xmlSchemaTreeItem)
@@ -684,7 +673,6 @@ struct _xmlSchemaParticle {
};
/**
- * xmlSchemaModelGroup:
*
* A model group component.
* (Extends xmlSchemaTreeItem)
@@ -702,7 +690,6 @@ struct _xmlSchemaModelGroup {
#define XML_SCHEMA_MODEL_GROUP_DEF_MARKED 1<<0
#define XML_SCHEMA_MODEL_GROUP_DEF_REDEFINED 1<<1
/**
- * xmlSchemaModelGroupDef:
*
* A model group definition component.
* (Extends xmlSchemaTreeItem)
@@ -724,7 +711,6 @@ typedef struct _xmlSchemaIDC xmlSchemaIDC;
typedef xmlSchemaIDC *xmlSchemaIDCPtr;
/**
- * xmlSchemaIDCSelect:
*
* The identity-constraint "field" and "selector" item, holding the
* XPath expression.
@@ -740,7 +726,6 @@ struct _xmlSchemaIDCSelect {
};
/**
- * xmlSchemaIDC:
*
* The identity-constraint definition component.
* (Extends xmlSchemaAnnotItem)
@@ -760,7 +745,6 @@ struct _xmlSchemaIDC {
};
/**
- * xmlSchemaIDCAug:
*
* The augmented IDC information used for validation.
*/
@@ -774,7 +758,6 @@ struct _xmlSchemaIDCAug {
};
/**
- * xmlSchemaPSVIIDCKeySequence:
*
* The key sequence of a node table item.
*/
@@ -786,7 +769,6 @@ struct _xmlSchemaPSVIIDCKey {
};
/**
- * xmlSchemaPSVIIDCNode:
*
* The node table item of a node table.
*/
@@ -801,7 +783,6 @@ struct _xmlSchemaPSVIIDCNode {
};
/**
- * xmlSchemaPSVIIDCBinding:
*
* The identity-constraint binding item of the [identity-constraint table].
*/
@@ -827,7 +808,6 @@ typedef struct _xmlSchemaIDCMatcher xmlSchemaIDCMatcher;
typedef xmlSchemaIDCMatcher *xmlSchemaIDCMatcherPtr;
/**
- * xmlSchemaIDCStateObj:
*
* The state object used to evaluate XPath expressions.
*/
@@ -849,7 +829,6 @@ struct _xmlSchemaIDCStateObj {
#define IDC_MATCHER 0
/**
- * xmlSchemaIDCMatcher:
*
* Used to evaluate IDC selectors (and fields).
*/
@@ -886,7 +865,6 @@ struct _xmlSchemaIDCMatcher {
#define XML_SCHEMA_NODE_INFO_ERR_BAD_TYPE (1<<10)
/**
- * xmlSchemaNodeInfo:
*
* Holds information of an element node.
*/
@@ -971,7 +949,6 @@ struct _xmlSchemaAttrInfo {
#define XML_SCHEMA_VALID_CTXT_FLAG_STREAM 1
/**
- * xmlSchemaValidCtxt:
*
* A Schemas validation context
*/
@@ -1050,7 +1027,6 @@ struct _xmlSchemaValidCtxt {
};
/**
- * xmlSchemaSubstGroup:
*
*
*/
@@ -1062,7 +1038,6 @@ struct _xmlSchemaSubstGroup {
};
/**
- * xmlIDCHashEntry:
*
* an entry in hash tables to quickly look up keys/uniques
*/
@@ -1134,10 +1109,9 @@ xmlSchemaParseAttributeGroupRef(xmlSchemaParserCtxtPtr pctxt,
************************************************************************/
/**
- * xmlSchemaItemTypeToStr:
- * @type: the type of the schema item
+ * @param type the type of the schema item
*
- * Returns the component name of a schema item.
+ * @returns the component name of a schema item.
*/
static const xmlChar *
xmlSchemaItemTypeToStr(xmlSchemaTypeType type)
@@ -1190,10 +1164,9 @@ xmlSchemaItemTypeToStr(xmlSchemaTypeType type)
}
/**
- * xmlSchemaGetComponentTypeStr:
- * @item: the type of the schema item
+ * @param item the type of the schema item
*
- * Returns the component name of a schema item.
+ * @returns the component name of a schema item.
*/
static const xmlChar *
xmlSchemaGetComponentTypeStr(xmlSchemaBasicItemPtr item)
@@ -1210,10 +1183,9 @@ xmlSchemaGetComponentTypeStr(xmlSchemaBasicItemPtr item)
}
/**
- * xmlSchemaGetComponentNode:
- * @item: a schema component
+ * @param item a schema component
*
- * Returns node associated with the schema component.
+ * @returns node associated with the schema component.
* NOTE that such a node need not be available; plus, a component's
* node need not to reflect the component directly, since there is no
* one-to-one relationship between the XML Schema representation and
@@ -1262,10 +1234,9 @@ xmlSchemaGetComponentNode(xmlSchemaBasicItemPtr item)
#if 0
/**
- * xmlSchemaGetNextComponent:
- * @item: a schema component
+ * @param item a schema component
*
- * Returns the next sibling of the schema component.
+ * @returns the next sibling of the schema component.
*/
static xmlSchemaBasicItemPtr
xmlSchemaGetNextComponent(xmlSchemaBasicItemPtr item)
@@ -1303,15 +1274,14 @@ xmlSchemaGetNextComponent(xmlSchemaBasicItemPtr item)
/**
- * xmlSchemaFormatQName:
- * @buf: the string buffer
- * @namespaceName: the namespace name
- * @localName: the local name
+ * @param buf the string buffer
+ * @param namespaceName the namespace name
+ * @param localName the local name
*
- * Returns the given QName in the format "{namespaceName}localName" or
- * just "localName" if @namespaceName is NULL.
+ * @returns the given QName in the format "{namespaceName}localName" or
+ * just "localName" if `namespaceName` is NULL.
*
- * Returns the localName if @namespaceName is NULL, a formatted
+ * @returns the localName if `namespaceName` is NULL, a formatted
* string otherwise.
*/
static const xmlChar*
@@ -1476,10 +1446,9 @@ xmlSchemaGetIDCDesignation(xmlChar **buf, xmlSchemaIDCPtr idc)
}
/**
- * xmlSchemaWildcardPCToString:
- * @pc: the type of processContents
+ * @param pc the type of processContents
*
- * Returns a string representation of the type of
+ * @returns a string representation of the type of
* processContents.
*/
static const xmlChar *
@@ -1498,16 +1467,15 @@ xmlSchemaWildcardPCToString(int pc)
}
/**
- * xmlSchemaGetCanonValueWhtspExt:
- * @val: the precomputed value
- * @retValue: the returned value
- * @ws: the whitespace type of the value
- * @for_hash: non-zero if this is supposed to generate a string for hashing
+ * @param val the precomputed value
+ * @param retValue the returned value
+ * @param ws the whitespace type of the value
+ * @param for_hash non-zero if this is supposed to generate a string for hashing
*
* Get a the canonical representation of the value.
* The caller has to free the returned retValue.
*
- * Returns 0 if the value could be built and -1 in case of
+ * @returns 0 if the value could be built and -1 in case of
* API errors or if the value type is not supported yet.
*/
static int
@@ -1605,13 +1573,12 @@ xmlSchemaGetCanonValueHash(xmlSchemaValPtr val,
}
/**
- * xmlSchemaFormatItemForReport:
- * @buf: the string buffer
- * @itemDes: the designation of the item
- * @item: the item as an object
- * @itemNode: the node of the item
+ * @param buf the string buffer
+ * @param itemDes the designation of the item
+ * @param item the item as an object
+ * @param itemNode the node of the item
*
- * Returns a representation of the given item used
+ * @returns a representation of the given item used
* for error reports.
*
* The following order is used to build the resulting
@@ -1625,7 +1592,7 @@ xmlSchemaGetCanonValueHash(xmlSchemaValPtr val,
* If the itemNode is an attribute node, the name of the attribute
* will be appended to the result.
*
- * Returns the formatted string and sets @buf to the resulting value.
+ * @returns the formatted string and sets `buf` to the resulting value.
*/
static xmlChar*
xmlSchemaFormatItemForReport(xmlChar **buf,
@@ -1835,14 +1802,13 @@ xmlSchemaFormatItemForReport(xmlChar **buf,
}
/**
- * xmlSchemaFormatFacetEnumSet:
- * @actxt: schema context
- * @buf: the string buffer
- * @type: the type holding the enumeration facets
+ * @param actxt schema context
+ * @param buf the string buffer
+ * @param type the type holding the enumeration facets
*
* Builds a string consisting of all enumeration elements.
*
- * Returns a string of all enumeration elements.
+ * @returns a string of all enumeration elements.
*/
static const xmlChar *
xmlSchemaFormatFacetEnumSet(xmlSchemaAbstractCtxtPtr actxt,
@@ -1909,8 +1875,7 @@ xmlSchemaFormatFacetEnumSet(xmlSchemaAbstractCtxtPtr actxt,
************************************************************************/
/**
- * xmlSchemaPErrMemory:
- * @ctxt: schema parser context
+ * @param ctxt schema parser context
*
* Handle an out of memory condition
*/
@@ -1978,13 +1943,12 @@ xmlSchemaPErrFull(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node, int code,
}
/**
- * xmlSchemaPErr:
- * @ctxt: the parsing context
- * @node: the context node
- * @code: the error code
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt the parsing context
+ * @param node the context node
+ * @param code the error code
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Handle a parser error
*/
@@ -1997,14 +1961,13 @@ xmlSchemaPErr(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node, int code,
}
/**
- * xmlSchemaPErr2:
- * @ctxt: the parsing context
- * @node: the context node
- * @child: the current child
- * @error: the error code
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt the parsing context
+ * @param node the context node
+ * @param child the current child
+ * @param error the error code
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Handle a parser error
*/
@@ -2021,19 +1984,18 @@ xmlSchemaPErr2(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
/**
- * xmlSchemaPErrExt:
- * @ctxt: the parsing context
- * @node: the context node
- * @code: the error code
- * @strData1: extra data
- * @strData2: extra data
- * @strData3: extra data
- * @msg: the message
- * @str1: extra parameter for the message display
- * @str2: extra parameter for the message display
- * @str3: extra parameter for the message display
- * @str4: extra parameter for the message display
- * @str5: extra parameter for the message display
+ * @param ctxt the parsing context
+ * @param node the context node
+ * @param code the error code
+ * @param strData1 extra data
+ * @param strData2 extra data
+ * @param strData3 extra data
+ * @param msg the message
+ * @param str1 extra parameter for the message display
+ * @param str2 extra parameter for the message display
+ * @param str3 extra parameter for the message display
+ * @param str4 extra parameter for the message display
+ * @param str5 extra parameter for the message display
*
* Handle a parser error
*/
@@ -2056,8 +2018,7 @@ xmlSchemaPErrExt(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node, int code,
************************************************************************/
/**
- * xmlSchemaVTypeErrMemory:
- * @ctxt: schema validation context
+ * @param ctxt schema validation context
*
* Handle an out of memory condition
*/
@@ -2127,17 +2088,16 @@ xmlSchemaVErrFull(xmlSchemaValidCtxtPtr ctxt, xmlNodePtr node, int code,
#define WXS_ERROR_TYPE_ERROR 1
#define WXS_ERROR_TYPE_WARNING 2
/**
- * xmlSchemaErr4Line:
- * @ctxt: the validation context
- * @errorLevel: the error level
- * @code: the error code
- * @node: the context node
- * @line: the line number
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
- * @str3: extra data
- * @str4: extra data
+ * @param ctxt the validation context
+ * @param errorLevel the error level
+ * @param code the error code
+ * @param node the context node
+ * @param line the line number
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
+ * @param str3 extra data
+ * @param str4 extra data
*
* Handle a validation error
*/
@@ -2223,14 +2183,13 @@ xmlSchemaErr4Line(xmlSchemaAbstractCtxtPtr ctxt,
}
/**
- * xmlSchemaErr3:
- * @actxt: the validation context
- * @error: the error code
- * @node: the context node
- * @msg: the error message
- * @str1: extra data
- * @str2: extra data
- * @str3: extra data
+ * @param actxt the validation context
+ * @param error the error code
+ * @param node the context node
+ * @param msg the error message
+ * @param str1 extra data
+ * @param str2 extra data
+ * @param str3 extra data
*
* Handle a validation error
*/
@@ -2861,13 +2820,12 @@ xmlSchemaFacetErr(xmlSchemaAbstractCtxtPtr actxt,
/**
- * xmlSchemaPMissingAttrErr:
- * @ctxt: the schema validation context
- * @error: the error code
- * @ownerItem: the owner as a schema object
- * @ownerElem: the owner as an element node
- * @name: name of the attribute
- * @message: the error message
+ * @param ctxt the schema validation context
+ * @param error the error code
+ * @param ownerItem the owner as a schema object
+ * @param ownerElem the owner as an element node
+ * @param name name of the attribute
+ * @param message the error message
*
* Reports an illegal attribute.
*/
@@ -2894,16 +2852,15 @@ xmlSchemaPMissingAttrErr(xmlSchemaParserCtxtPtr ctxt,
/**
- * xmlSchemaPResCompAttrErr:
- * @ctxt: the schema validation context
- * @error: the error code
- * @ownerItem: the owner as a schema object
- * @ownerElem: the owner as an element node
- * @name: the name of the attribute holding the QName
- * @refName: the referenced local name
- * @refURI: the referenced namespace URI
- * @refType: the referenced type
- * @refTypeStr: the referenced type string
+ * @param ctxt the schema validation context
+ * @param error the error code
+ * @param ownerItem the owner as a schema object
+ * @param ownerElem the owner as an element node
+ * @param name the name of the attribute holding the QName
+ * @param refName the referenced local name
+ * @param refURI the referenced namespace URI
+ * @param refType the referenced type
+ * @param refTypeStr the referenced type string
*
* Used to report QName attribute values that failed to resolve
* to schema components.
@@ -2935,13 +2892,12 @@ xmlSchemaPResCompAttrErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPCustomAttrErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @ownerDes: the designation of the owner
- * @ownerItem: the owner as a schema object
- * @attr: the illegal attribute node
- * @msg: the error message
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param ownerDes the designation of the owner
+ * @param ownerItem the owner as a schema object
+ * @param attr the illegal attribute node
+ * @param msg the error message
*
* Reports an illegal attribute during the parse.
*/
@@ -2977,11 +2933,10 @@ xmlSchemaPCustomAttrErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPIllegalAttrErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @ownerComp: the attribute's owner item (unused)
- * @attr: the illegal attribute node
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param ownerComp the attribute's owner item (unused)
+ * @param attr the illegal attribute node
*
* Reports an illegal attribute during the parse.
*/
@@ -3003,15 +2958,14 @@ xmlSchemaPIllegalAttrErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPCustomErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @item: the schema item
- * @itemElem: the node of the schema item
- * @message: the error message
- * @str1: an optional param for the error message
- * @str2: an optional param for the error message
- * @str3: an optional param for the error message
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param item the schema item
+ * @param itemElem the node of the schema item
+ * @param message the error message
+ * @param str1 an optional param for the error message
+ * @param str2 an optional param for the error message
+ * @param str3 an optional param for the error message
*
* Reports an error during parsing.
*/
@@ -3040,13 +2994,12 @@ xmlSchemaPCustomErrExt(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPCustomErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @item: the schema item
- * @itemElem: the node of the schema item
- * @message: the error message
- * @str1: the optional param for the error message
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param item the schema item
+ * @param itemElem the node of the schema item
+ * @param message the error message
+ * @param str1 the optional param for the error message
*
* Reports an error during parsing.
*/
@@ -3063,17 +3016,16 @@ xmlSchemaPCustomErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPAttrUseErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @node: the context node
- * @ownerItem: the owner as a schema object
- * @attruse: the invalid schema attribute
- * @message: the error message
- * @str1: the optional param for the error message
- * @str2: the optional param for the error message
- * @str3: the optional param for the error message
- * @str4: the optional param for the error message
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param node the context node
+ * @param ownerItem the owner as a schema object
+ * @param attruse the invalid schema attribute
+ * @param message the error message
+ * @param str1 the optional param for the error message
+ * @param str2 the optional param for the error message
+ * @param str3 the optional param for the error message
+ * @param str4 the optional param for the error message
*
* Reports an attribute use error during parsing.
*/
@@ -3104,12 +3056,11 @@ xmlSchemaPAttrUseErr4(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPIllegalFacetAtomicErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @type: the schema type
- * @baseType: the base type of type
- * @facet: the illegal facet
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param type the schema type
+ * @param baseType the base type of type
+ * @param facet the illegal facet
*
* Reports an illegal facet for atomic simple types.
*/
@@ -3134,11 +3085,10 @@ xmlSchemaPIllegalFacetAtomicErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPIllegalFacetListUnionErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @type: the schema type
- * @facet: the illegal facet
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param type the schema type
+ * @param facet the illegal facet
*
* Reports an illegal facet for `` and ``.
*/
@@ -3159,13 +3109,12 @@ xmlSchemaPIllegalFacetListUnionErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPMutualExclAttrErr:
- * @ctxt: the schema validation context
- * @error: the error code
- * @ownerItem: the owner as a schema object
- * @attr: the bad attribute node
- * @name1: first mutually exclusive name
- * @name2: second mutually exclusive name
+ * @param ctxt the schema validation context
+ * @param error the error code
+ * @param ownerItem the owner as a schema object
+ * @param attr the bad attribute node
+ * @param name1 first mutually exclusive name
+ * @param name2 second mutually exclusive name
*
* Reports an illegal attribute.
*/
@@ -3187,17 +3136,16 @@ xmlSchemaPMutualExclAttrErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPSimpleTypeErr:
- * @ctxt: the schema validation context
- * @error: the error code
- * @ownerItem: the schema object if existent
- * @node: the validated node
- * @type: the type specifier
- * @expected: the expected value
- * @value: the validated value
- * @message: error message
- * @str1: extra data
- * @str2: extra data
+ * @param ctxt the schema validation context
+ * @param error the error code
+ * @param ownerItem the schema object if existent
+ * @param node the validated node
+ * @param type the type specifier
+ * @param expected the expected value
+ * @param value the validated value
+ * @param message error message
+ * @param str1 extra data
+ * @param str2 extra data
*
* Reports a simple type validation error.
* TODO: Should this report the value of an element as well?
@@ -3284,14 +3232,13 @@ xmlSchemaPSimpleTypeErr(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPContentErr:
- * @ctxt: the schema parser context
- * @error: the error code
- * @ownerItem: the owner item of the holder of the content
- * @ownerElem: the node of the holder of the content
- * @child: the invalid child node
- * @message: the optional error message
- * @content: the optional string describing the correct content
+ * @param ctxt the schema parser context
+ * @param error the error code
+ * @param ownerItem the owner item of the holder of the content
+ * @param ownerElem the node of the holder of the content
+ * @param child the invalid child node
+ * @param message the optional error message
+ * @param content the optional string describing the correct content
*
* Reports an error concerning the content of a schema element.
*/
@@ -3348,12 +3295,11 @@ xmlSchemaPContentErr(xmlSchemaParserCtxtPtr ctxt,
************************************************************************/
/**
- * xmlSchemaNewSchemaForParserCtxt:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* Allocate a new Schema structure.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlSchemaPtr
xmlSchemaNewSchema(xmlSchemaParserCtxtPtr ctxt)
@@ -3373,11 +3319,10 @@ xmlSchemaNewSchema(xmlSchemaParserCtxtPtr ctxt)
}
/**
- * xmlSchemaNewFacet:
*
* Allocate a new Facet structure.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
xmlSchemaFacetPtr
xmlSchemaNewFacet(void)
@@ -3394,13 +3339,12 @@ xmlSchemaNewFacet(void)
}
/**
- * xmlSchemaNewAnnot:
- * @ctxt: a schema validation context
- * @node: a node
+ * @param ctxt a schema validation context
+ * @param node a node
*
* Allocate a new annotation structure.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static xmlSchemaAnnotPtr
xmlSchemaNewAnnot(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node)
@@ -3534,8 +3478,7 @@ xmlSchemaItemListRemove(xmlSchemaItemListPtr list, int idx)
}
/**
- * xmlSchemaItemListFree:
- * @list: a schema type structure
+ * @param list a schema type structure
*
* Deallocate a annotation structure
*/
@@ -3735,8 +3678,7 @@ xmlSchemaAddItemSize(xmlSchemaItemListPtr *list, int initialSize, void *item)
}
/**
- * xmlSchemaFreeAnnot:
- * @annot: a schema type structure
+ * @param annot a schema type structure
*
* Deallocate a annotation structure
*/
@@ -3759,8 +3701,7 @@ xmlSchemaFreeAnnot(xmlSchemaAnnotPtr annot)
}
/**
- * xmlSchemaFreeNotation:
- * @nota: a schema notation structure
+ * @param nota a schema notation structure
*
* Deallocate a Schema Notation structure.
*/
@@ -3775,8 +3716,7 @@ xmlSchemaFreeNotation(xmlSchemaNotationPtr nota)
}
/**
- * xmlSchemaFreeAttribute:
- * @attr: an attribute declaration
+ * @param attr an attribute declaration
*
* Deallocates an attribute declaration structure.
*/
@@ -3793,8 +3733,7 @@ xmlSchemaFreeAttribute(xmlSchemaAttributePtr attr)
}
/**
- * xmlSchemaFreeAttributeUse:
- * @use: an attribute use
+ * @param use an attribute use
*
* Deallocates an attribute use structure.
*/
@@ -3811,8 +3750,7 @@ xmlSchemaFreeAttributeUse(xmlSchemaAttributeUsePtr use)
}
/**
- * xmlSchemaFreeAttributeUseProhib:
- * @prohib: an attribute use prohibition
+ * @param prohib an attribute use prohibition
*
* Deallocates an attribute use structure.
*/
@@ -3825,7 +3763,6 @@ xmlSchemaFreeAttributeUseProhib(xmlSchemaAttributeUseProhibPtr prohib)
}
/**
- * xmlSchemaFreeWildcardNsSet:
* set: a schema wildcard namespace
*
* Deallocates a list of wildcard constraint structures.
@@ -3843,8 +3780,7 @@ xmlSchemaFreeWildcardNsSet(xmlSchemaWildcardNsPtr set)
}
/**
- * xmlSchemaFreeWildcard:
- * @wildcard: a wildcard structure
+ * @param wildcard a wildcard structure
*
* Deallocates a wildcard structure.
*/
@@ -3863,8 +3799,7 @@ xmlSchemaFreeWildcard(xmlSchemaWildcardPtr wildcard)
}
/**
- * xmlSchemaFreeAttributeGroup:
- * @attrGr: a schema attribute group structure
+ * @param attrGr a schema attribute group structure
*
* Deallocate a Schema Attribute Group structure.
*/
@@ -3881,8 +3816,7 @@ xmlSchemaFreeAttributeGroup(xmlSchemaAttributeGroupPtr attrGr)
}
/**
- * xmlSchemaFreeQNameRef:
- * @item: a QName reference structure
+ * @param item a QName reference structure
*
* Deallocatea a QName reference structure.
*/
@@ -3893,8 +3827,7 @@ xmlSchemaFreeQNameRef(xmlSchemaQNameRefPtr item)
}
/**
- * xmlSchemaFreeTypeLinkList:
- * @link: a type link
+ * @param link a type link
*
* Deallocate a list of types.
*/
@@ -3926,8 +3859,7 @@ xmlSchemaFreeIDCStateObjList(xmlSchemaIDCStateObjPtr sto)
}
/**
- * xmlSchemaFreeIDC:
- * @idcDef: a identity-constraint definition
+ * @param idcDef a identity-constraint definition
*
* Deallocates an identity-constraint definition.
*/
@@ -3961,8 +3893,7 @@ xmlSchemaFreeIDC(xmlSchemaIDCPtr idcDef)
}
/**
- * xmlSchemaFreeElement:
- * @elem: a schema element structure
+ * @param elem a schema element structure
*
* Deallocate a Schema Element structure.
*/
@@ -3981,8 +3912,7 @@ xmlSchemaFreeElement(xmlSchemaElementPtr elem)
}
/**
- * xmlSchemaFreeFacet:
- * @facet: a schema facet structure
+ * @param facet a schema facet structure
*
* Deallocate a Schema Facet structure.
*/
@@ -4001,8 +3931,7 @@ xmlSchemaFreeFacet(xmlSchemaFacetPtr facet)
}
/**
- * xmlSchemaFreeType:
- * @type: a schema type structure
+ * @param type a schema type structure
*
* Deallocate a Schema Type structure.
*/
@@ -4043,8 +3972,7 @@ xmlSchemaFreeType(xmlSchemaTypePtr type)
}
/**
- * xmlSchemaFreeModelGroupDef:
- * @item: a schema model group definition
+ * @param item a schema model group definition
*
* Deallocates a schema model group definition.
*/
@@ -4057,8 +3985,7 @@ xmlSchemaFreeModelGroupDef(xmlSchemaModelGroupDefPtr item)
}
/**
- * xmlSchemaFreeModelGroup:
- * @item: a schema model group
+ * @param item a schema model group
*
* Deallocates a schema model group structure.
*/
@@ -4145,8 +4072,7 @@ xmlSchemaComponentListFree(xmlSchemaItemListPtr list)
}
/**
- * xmlSchemaFree:
- * @schema: a schema structure
+ * @param schema a schema structure
*
* Deallocate a Schema structure.
*/
@@ -4205,12 +4131,11 @@ static void
xmlSchemaTypeDump(xmlSchemaTypePtr type, FILE * output); /* forward */
/**
- * xmlSchemaElementDump:
- * @payload: an element
- * @data: the file output
- * @name: unused
- * @namespace: unused
- * @context: unused
+ * @param payload an element
+ * @param data the file output
+ * @param name unused
+ * @param namespace unused
+ * @param context unused
*
* Dump the element
*/
@@ -4295,9 +4220,8 @@ xmlSchemaElementDump(void *payload, void *data,
}
/**
- * xmlSchemaAnnotDump:
- * @output: the file output
- * @annot: a annotation
+ * @param output the file output
+ * @param annot a annotation
*
* Dump the annotation
*/
@@ -4318,10 +4242,9 @@ xmlSchemaAnnotDump(FILE * output, xmlSchemaAnnotPtr annot)
}
/**
- * xmlSchemaContentModelDump:
- * @particle: the schema particle
- * @output: the file output
- * @depth: the depth used for indentation
+ * @param particle the schema particle
+ * @param output the file output
+ * @param depth the depth used for indentation
*
* Dump a SchemaType structure
*/
@@ -4392,9 +4315,8 @@ xmlSchemaContentModelDump(xmlSchemaParticlePtr particle, FILE * output, int dept
}
/**
- * xmlSchemaAttrUsesDump:
- * @uses: attribute uses list
- * @output: the file output
+ * @param uses attribute uses list
+ * @param output the file output
*
* Dumps a list of attribute use components.
*/
@@ -4436,9 +4358,8 @@ xmlSchemaAttrUsesDump(xmlSchemaItemListPtr uses, FILE * output)
}
/**
- * xmlSchemaTypeDump:
- * @output: the file output
- * @type: a type structure
+ * @param output the file output
+ * @param type a type structure
*
* Dump a SchemaType structure
*/
@@ -4544,9 +4465,8 @@ xmlSchemaTypeDumpEntry(void *type, void *output,
}
/**
- * xmlSchemaDump:
- * @output: the file output
- * @schema: a schema structure
+ * @param output the file output
+ * @param schema a schema structure
*
* Dump a Schema structure.
*/
@@ -4584,14 +4504,13 @@ xmlSchemaDump(FILE * output, xmlSchemaPtr schema)
************************************************************************/
/**
- * xmlSchemaGetPropNode:
- * @node: the element node
- * @name: the name of the attribute
+ * @param node the element node
+ * @param name the name of the attribute
*
- * Seeks an attribute with a name of @name in
+ * Seeks an attribute with a name of `name` in
* no namespace.
*
- * Returns the attribute or NULL if not present.
+ * @returns the attribute or NULL if not present.
*/
static xmlAttrPtr
xmlSchemaGetPropNode(xmlNodePtr node, const char *name)
@@ -4610,15 +4529,14 @@ xmlSchemaGetPropNode(xmlNodePtr node, const char *name)
}
/**
- * xmlSchemaGetPropNodeNs:
- * @node: the element node
- * @uri: the uri
- * @name: the name of the attribute
+ * @param node the element node
+ * @param uri the uri
+ * @param name the name of the attribute
*
- * Seeks an attribute with a local name of @name and
- * a namespace URI of @uri.
+ * Seeks an attribute with a local name of `name` and
+ * a namespace URI of `uri`.
*
- * Returns the attribute or NULL if not present.
+ * @returns the attribute or NULL if not present.
*/
static xmlAttrPtr
xmlSchemaGetPropNodeNs(xmlNodePtr node, const char *uri, const char *name)
@@ -4661,14 +4579,13 @@ xmlSchemaGetNodeContentNoDict(xmlNodePtr node)
}
/**
- * xmlSchemaGetProp:
- * @ctxt: the parser context
- * @node: the node
- * @name: the property name
+ * @param ctxt the parser context
+ * @param node the node
+ * @param name the property name
*
* Read a attribute value and internalize the string
*
- * Returns the string or NULL if not present.
+ * @returns the string or NULL if not present.
*/
static const xmlChar *
xmlSchemaGetProp(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
@@ -4709,14 +4626,13 @@ xmlSchemaGetProp(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
}
/**
- * xmlSchemaGetElem:
- * @schema: the schema context
- * @name: the element name
- * @nsName: the element namespace
+ * @param schema the schema context
+ * @param name the element name
+ * @param nsName the element namespace
*
* Lookup a global element declaration in the schema.
*
- * Returns the element declaration or NULL if not found.
+ * @returns the element declaration or NULL if not found.
*/
static xmlSchemaElementPtr
xmlSchemaGetElem(xmlSchemaPtr schema, const xmlChar * name,
@@ -4734,14 +4650,13 @@ exit:
}
/**
- * xmlSchemaGetType:
- * @schema: the main schema
- * @name: the type's name
- * @nsName: the type's namespace
+ * @param schema the main schema
+ * @param name the type's name
+ * @param nsName the type's namespace
*
* Lookup a type in the schemas or the predefined types
*
- * Returns the group definition or NULL if not found.
+ * @returns the group definition or NULL if not found.
*/
static xmlSchemaTypePtr
xmlSchemaGetType(xmlSchemaPtr schema, const xmlChar * name,
@@ -4772,14 +4687,13 @@ exit:
}
/**
- * xmlSchemaGetAttributeDecl:
- * @schema: the context of the schema
- * @name: the name of the attribute
- * @nsName: the target namespace of the attribute
+ * @param schema the context of the schema
+ * @param name the name of the attribute
+ * @param nsName the target namespace of the attribute
*
* Lookup a an attribute in the schema or imported schemas
*
- * Returns the attribute declaration or NULL if not found.
+ * @returns the attribute declaration or NULL if not found.
*/
static xmlSchemaAttributePtr
xmlSchemaGetAttributeDecl(xmlSchemaPtr schema, const xmlChar * name,
@@ -4797,14 +4711,13 @@ exit:
}
/**
- * xmlSchemaGetAttributeGroup:
- * @schema: the context of the schema
- * @name: the name of the attribute group
- * @nsName: the target namespace of the attribute group
+ * @param schema the context of the schema
+ * @param name the name of the attribute group
+ * @param nsName the target namespace of the attribute group
*
* Lookup a an attribute group in the schema or imported schemas
*
- * Returns the attribute group definition or NULL if not found.
+ * @returns the attribute group definition or NULL if not found.
*/
static xmlSchemaAttributeGroupPtr
xmlSchemaGetAttributeGroup(xmlSchemaPtr schema, const xmlChar * name,
@@ -4828,14 +4741,13 @@ exit:
}
/**
- * xmlSchemaGetGroup:
- * @schema: the context of the schema
- * @name: the name of the group
- * @nsName: the target namespace of the group
+ * @param schema the context of the schema
+ * @param name the name of the group
+ * @param nsName the target namespace of the group
*
* Lookup a group in the schema or imported schemas
*
- * Returns the group definition or NULL if not found.
+ * @returns the group definition or NULL if not found.
*/
static xmlSchemaModelGroupDefPtr
xmlSchemaGetGroup(xmlSchemaPtr schema, const xmlChar * name,
@@ -4886,15 +4798,14 @@ exit:
}
/**
- * xmlSchemaGetNamedComponent:
- * @schema: the schema
- * @itemType: the item type
- * @name: the name of the group
- * @targetNs: the target namespace of the group
+ * @param schema the schema
+ * @param itemType the item type
+ * @param name the name of the group
+ * @param targetNs the target namespace of the group
*
* Lookup a group in the schema or imported schemas
*
- * Returns the group definition or NULL if not found.
+ * @returns the group definition or NULL if not found.
*/
static xmlSchemaBasicItemPtr
xmlSchemaGetNamedComponent(xmlSchemaPtr schema,
@@ -4925,13 +4836,12 @@ xmlSchemaGetNamedComponent(xmlSchemaPtr schema,
(((n)->type == XML_TEXT_NODE) && (xmlSchemaIsBlank((n)->content, -1)))
/**
- * xmlSchemaIsBlank:
- * @str: a string
- * @len: the length of the string or -1
+ * @param str a string
+ * @param len the length of the string or -1
*
* Check if a string is ignorable
*
- * Returns 1 if the string is NULL or made of blanks chars, 0 otherwise
+ * @returns 1 if the string is NULL or made of blanks chars, 0 otherwise
*/
static int
xmlSchemaIsBlank(xmlChar * str, int len)
@@ -5042,17 +4952,16 @@ subschemas:
}
/**
- * xmlSchemaAddNotation:
- * @ctxt: a schema parser context
- * @schema: the schema being built
- * @name: the item name
- * @nsName: the element namespace
- * @node: unused
+ * @param ctxt a schema parser context
+ * @param schema the schema being built
+ * @param name the item name
+ * @param nsName the element namespace
+ * @param node unused
*
* Add an XML schema annotation declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaNotationPtr
xmlSchemaAddNotation(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -5080,18 +4989,17 @@ xmlSchemaAddNotation(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaAddAttribute:
- * @ctxt: a schema parser context
- * @schema: the schema being built
- * @name: the item name
- * @nsName: the item namespace
- * @node: the context node
- * @topLevel: whether this is a top-level element
+ * @param ctxt a schema parser context
+ * @param schema the schema being built
+ * @param name the item name
+ * @param nsName the item namespace
+ * @param node the context node
+ * @param topLevel whether this is a top-level element
*
* Add an XML schema Attribute declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaAttributePtr
xmlSchemaAddAttribute(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -5123,14 +5031,13 @@ xmlSchemaAddAttribute(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaAddAttributeUse:
- * @pctxt: a schema parser context
- * @node: the context node
+ * @param pctxt a schema parser context
+ * @param node the context node
*
* Add an XML schema Attribute declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaAttributeUsePtr
xmlSchemaAddAttributeUse(xmlSchemaParserCtxtPtr pctxt,
@@ -5190,16 +5097,15 @@ xmlSchemaAddRedef(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaAddAttributeGroupDefinition:
- * @pctxt: a schema parser context
- * @schema: the schema being built
- * @name: the item name
- * @nsName: the target namespace
- * @node: the corresponding node
+ * @param pctxt a schema parser context
+ * @param schema the schema being built
+ * @param name the item name
+ * @param nsName the target namespace
+ * @param node the corresponding node
*
* Add an XML schema Attribute Group definition.
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaAttributeGroupPtr
xmlSchemaAddAttributeGroupDefinition(xmlSchemaParserCtxtPtr pctxt,
@@ -5242,17 +5148,16 @@ xmlSchemaAddAttributeGroupDefinition(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaAddElement:
- * @ctxt: a schema parser context
- * @name: the type name
- * @nsName: the type namespace
- * @node: the context node
- * @topLevel: whether this is a top-level element
+ * @param ctxt a schema parser context
+ * @param name the type name
+ * @param nsName the type namespace
+ * @param node the context node
+ * @param topLevel whether this is a top-level element
*
* Add an XML schema Element declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaElementPtr
xmlSchemaAddElement(xmlSchemaParserCtxtPtr ctxt,
@@ -5284,19 +5189,18 @@ xmlSchemaAddElement(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaAddType:
- * @ctxt: a schema parser context
- * @schema: the schema being built
- * @type: the type
- * @name: the item name
- * @nsName: the namespace
- * @node: the context node
- * @topLevel: whether this is a top-level element
+ * @param ctxt a schema parser context
+ * @param schema the schema being built
+ * @param type the type
+ * @param name the item name
+ * @param nsName the namespace
+ * @param node the context node
+ * @param topLevel whether this is a top-level element
*
* Add an XML schema item
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaTypePtr
xmlSchemaAddType(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -5382,16 +5286,15 @@ xmlSchemaAddAttributeUseProhib(xmlSchemaParserCtxtPtr pctxt)
/**
- * xmlSchemaAddModelGroup:
- * @ctxt: a schema parser context
- * @schema: the schema being built
- * @type: the "compositor" type of the model group
- * @node: the node in the schema doc
+ * @param ctxt a schema parser context
+ * @param schema the schema being built
+ * @param type the "compositor" type of the model group
+ * @param node the node in the schema doc
*
* Adds a schema model group
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaModelGroupPtr
xmlSchemaAddModelGroup(xmlSchemaParserCtxtPtr ctxt,
@@ -5422,16 +5325,15 @@ xmlSchemaAddModelGroup(xmlSchemaParserCtxtPtr ctxt,
/**
- * xmlSchemaAddParticle:
- * @ctxt: a schema parser context
- * @node: the corresponding node in the schema doc
- * @min: the minOccurs
- * @max: the maxOccurs
+ * @param ctxt a schema parser context
+ * @param node the corresponding node in the schema doc
+ * @param min the minOccurs
+ * @param max the maxOccurs
*
* Adds an XML schema particle component.
* *WARNING* this interface is highly subject to change
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaParticlePtr
xmlSchemaAddParticle(xmlSchemaParserCtxtPtr ctxt,
@@ -5466,16 +5368,15 @@ xmlSchemaAddParticle(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaAddModelGroupDefinition:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @name: the group name
- * @nsName: the group namespace
- * @node: the context node
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param name the group name
+ * @param nsName the group namespace
+ * @param node the context node
*
* Add an XML schema Group definition
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaModelGroupDefPtr
xmlSchemaAddModelGroupDefinition(xmlSchemaParserCtxtPtr ctxt,
@@ -5516,12 +5417,11 @@ xmlSchemaAddModelGroupDefinition(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaNewWildcardNs:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* Creates a new wildcard namespace constraint.
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaWildcardNsPtr
xmlSchemaNewWildcardNsConstraint(xmlSchemaParserCtxtPtr ctxt)
@@ -5571,16 +5471,15 @@ xmlSchemaAddIDC(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaAddWildcard:
- * @ctxt: a schema validation context
- * @schema: a schema
- * @type: the type
- * @node: the context node
+ * @param ctxt a schema validation context
+ * @param schema a schema
+ * @param type the type
+ * @param node the context node
*
* Adds a wildcard.
* It corresponds to a xsd:anyAttribute and xsd:any.
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaWildcardPtr
xmlSchemaAddWildcard(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -5668,14 +5567,13 @@ xmlSchemaSubstGroupGet(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaAddElementSubstitutionMember:
- * @pctxt: a schema parser context
- * @head: the head of the substitution group
- * @member: the new member of the substitution group
+ * @param pctxt a schema parser context
+ * @param head the head of the substitution group
+ * @param member the new member of the substitution group
*
* Allocate a new annotation structure.
*
- * Returns the newly allocated structure or NULL in case or error
+ * @returns the newly allocated structure or NULL in case or error
*/
static int
xmlSchemaAddElementSubstitutionMember(xmlSchemaParserCtxtPtr pctxt,
@@ -5704,20 +5602,19 @@ xmlSchemaAddElementSubstitutionMember(xmlSchemaParserCtxtPtr pctxt,
************************************************************************/
/**
- * xmlSchemaPValAttrNodeQNameValue:
- * @ctxt: a schema parser context
- * @schema: the schema context
- * @attr: the attribute node
- * @ownerItem: the parent as a schema object
- * @value: the QName value
- * @uri: the resulting namespace URI if found
- * @local: the resulting local part if found, the attribute value otherwise
+ * @param ctxt a schema parser context
+ * @param schema the schema context
+ * @param attr the attribute node
+ * @param ownerItem the parent as a schema object
+ * @param value the QName value
+ * @param uri the resulting namespace URI if found
+ * @param local the resulting local part if found, the attribute value otherwise
*
* Extracts the local name and the URI of a QName value and validates it.
* This one is intended to be used on attribute values that
* should resolve to schema components.
*
- * Returns 0, in case the QName is valid, a positive error code
+ * @returns 0, in case the QName is valid, a positive error code
* if not valid and -1 if an internal error occurs.
*/
static int
@@ -5785,19 +5682,18 @@ xmlSchemaPValAttrNodeQNameValue(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPValAttrNodeQName:
- * @ctxt: a schema parser context
- * @schema: the schema context
- * @ownerItem: the owner as a schema object
- * @attr: the attribute node
- * @uri: the resulting namespace URI if found
- * @local: the resulting local part if found, the attribute value otherwise
+ * @param ctxt a schema parser context
+ * @param schema the schema context
+ * @param ownerItem the owner as a schema object
+ * @param attr the attribute node
+ * @param uri the resulting namespace URI if found
+ * @param local the resulting local part if found, the attribute value otherwise
*
* Extracts and validates the QName of an attribute value.
* This one is intended to be used on attribute values that
* should resolve to schema components.
*
- * Returns 0, in case the QName is valid, a positive error code
+ * @returns 0, in case the QName is valid, a positive error code
* if not valid and -1 if an internal error occurs.
*/
static int
@@ -5816,18 +5712,17 @@ xmlSchemaPValAttrNodeQName(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPValAttrQName:
- * @ctxt: a schema parser context
- * @schema: the schema context
- * @ownerItem: the owner as a schema object
- * @ownerElem: the parent node of the attribute
- * @name: the name of the attribute
- * @uri: the resulting namespace URI if found
- * @local: the resulting local part if found, the attribute value otherwise
+ * @param ctxt a schema parser context
+ * @param schema the schema context
+ * @param ownerItem the owner as a schema object
+ * @param ownerElem the parent node of the attribute
+ * @param name the name of the attribute
+ * @param uri the resulting namespace URI if found
+ * @param local the resulting local part if found, the attribute value otherwise
*
* Extracts and validates the QName of an attribute value.
*
- * Returns 0, in case the QName is valid, a positive error code
+ * @returns 0, in case the QName is valid, a positive error code
* if not valid and -1 if an internal error occurs.
*/
static int
@@ -5852,13 +5747,12 @@ xmlSchemaPValAttrQName(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPValAttrID:
- * @ctxt: a schema parser context
- * @attr: attribute node
+ * @param ctxt a schema parser context
+ * @param attr attribute node
*
* Extracts and validates the ID of an attribute value.
*
- * Returns 0, in case the ID is valid, a positive error code
+ * @returns 0, in case the ID is valid, a positive error code
* if not valid and -1 if an internal error occurs.
*/
static int
@@ -5932,17 +5826,16 @@ xmlSchemaPValAttrID(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlGetMaxOccurs:
- * @ctxt: a schema validation context
- * @node: a subtree containing XML Schema information
- * @min: minimum
- * @max: maximum
- * @def: default
- * @expected: expected
+ * @param ctxt a schema validation context
+ * @param node a subtree containing XML Schema information
+ * @param min minimum
+ * @param max maximum
+ * @param def default
+ * @param expected expected
*
* Get the maxOccurs property
*
- * Returns the default if not found, or the value
+ * @returns the default if not found, or the value
*/
static int
xmlGetMaxOccurs(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
@@ -6012,17 +5905,16 @@ xmlGetMaxOccurs(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
}
/**
- * xmlGetMinOccurs:
- * @ctxt: a schema validation context
- * @node: a subtree containing XML Schema information
- * @min: minimum
- * @max: maximum
- * @def: default
- * @expected: expected
+ * @param ctxt a schema validation context
+ * @param node a subtree containing XML Schema information
+ * @param min minimum
+ * @param max maximum
+ * @param def default
+ * @param expected expected
*
* Get the minOccurs property
*
- * Returns the default if not found, or the value
+ * @returns the default if not found, or the value
*/
static int
xmlGetMinOccurs(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
@@ -6079,14 +5971,13 @@ xmlGetMinOccurs(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node,
}
/**
- * xmlSchemaPGetBoolNodeValue:
- * @ctxt: a schema validation context
- * @ownerItem: the owner as a schema item
- * @node: the node holding the value
+ * @param ctxt a schema validation context
+ * @param ownerItem the owner as a schema item
+ * @param node the node holding the value
*
* Converts a boolean string value into 1 or 0.
*
- * Returns 0 or 1.
+ * @returns 0 or 1.
*/
static int
xmlSchemaPGetBoolNodeValue(xmlSchemaParserCtxtPtr ctxt,
@@ -6124,15 +6015,14 @@ xmlSchemaPGetBoolNodeValue(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlGetBooleanProp:
- * @ctxt: a schema validation context
- * @node: a subtree containing XML Schema information
- * @name: the attribute name
- * @def: the default value
+ * @param ctxt a schema validation context
+ * @param node a subtree containing XML Schema information
+ * @param name the attribute name
+ * @param def the default value
*
* Evaluate if a boolean property is set
*
- * Returns the default if not found, 0 if found to be false,
+ * @returns the default if not found, 0 if found to be false,
* 1 if found to be true
*/
static int
@@ -6202,19 +6092,18 @@ xmlSchemaParseAnyAttribute(xmlSchemaParserCtxtPtr ctxt,
xmlSchemaPtr schema, xmlNodePtr node);
/**
- * xmlSchemaPValAttrNodeValue:
*
- * @pctxt: a schema parser context
- * @ownerItem: the schema object owner if existent
- * @attr: the schema attribute node being validated
- * @value: the value
- * @type: the built-in type to be validated against
+ * @param pctxt a schema parser context
+ * @param ownerItem the schema object owner if existent
+ * @param attr the schema attribute node being validated
+ * @param value the value
+ * @param type the built-in type to be validated against
*
* Validates a value against the given built-in type.
* This one is intended to be used internally for validation
* of schema attribute values during parsing of the schema.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* number otherwise and -1 in case of an internal or API error.
*/
static int
@@ -6274,19 +6163,18 @@ xmlSchemaPValAttrNodeValue(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaPValAttrNode:
*
- * @ctxt: a schema parser context
- * @ownerItem: the schema object owner if existent
- * @attr: the schema attribute node being validated
- * @type: the built-in type to be validated against
- * @value: the resulting value if any
+ * @param ctxt a schema parser context
+ * @param ownerItem the schema object owner if existent
+ * @param attr the schema attribute node being validated
+ * @param type the built-in type to be validated against
+ * @param value the resulting value if any
*
* Extracts and validates a value against the given built-in type.
* This one is intended to be used internally for validation
* of schema attribute values during parsing of the schema.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* number otherwise and -1 in case of an internal or API error.
*/
static int
@@ -6310,20 +6198,19 @@ xmlSchemaPValAttrNode(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaPValAttr:
*
- * @ctxt: a schema parser context
- * @ownerItem: the schema object owner if existent
- * @ownerElem: the owner element node
- * @name: the name of the schema attribute node
- * @type: the built-in type to be validated against
- * @value: the resulting value if any
+ * @param ctxt a schema parser context
+ * @param ownerItem the schema object owner if existent
+ * @param ownerElem the owner element node
+ * @param name the name of the schema attribute node
+ * @param type the built-in type to be validated against
+ * @param value the resulting value if any
*
* Extracts and validates a value against the given built-in type.
* This one is intended to be used internally for validation
* of schema attribute values during parsing of the schema.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* number otherwise and -1 in case of an internal or API error.
*/
static int
@@ -6410,13 +6297,12 @@ xmlSchemaCheckReference(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaParseLocalAttributes:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @child: a subtree containing XML Schema information
- * @list: an item list
- * @parentType: the hosting type where the attributes will be anchored
- * @hasRefs: set if references were found
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param child a subtree containing XML Schema information
+ * @param list an item list
+ * @param parentType the hosting type where the attributes will be anchored
+ * @param hasRefs set if references were found
*
* Parses attribute uses and attribute declarations and
* attribute group references.
@@ -6454,15 +6340,14 @@ xmlSchemaParseLocalAttributes(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseAnnotation:
- * @ctxt: a schema validation context
- * @node: a subtree containing XML Schema information
- * @needed: needed
+ * @param ctxt a schema validation context
+ * @param node a subtree containing XML Schema information
+ * @param needed needed
*
* parse a XML schema Attribute declaration
* *WARNING* this interface is highly subject to change
*
- * Returns -1 in case of error, 0 if the declaration is improper and
+ * @returns -1 in case of error, 0 if the declaration is improper and
* 1 in case of success.
*/
static xmlSchemaAnnotPtr
@@ -6574,15 +6459,14 @@ xmlSchemaParseAnnotation(xmlSchemaParserCtxtPtr ctxt, xmlNodePtr node, int neede
}
/**
- * xmlSchemaParseFacet:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema Facet declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the new type structure or NULL in case of error
+ * @returns the new type structure or NULL in case of error
*/
static xmlSchemaFacetPtr
xmlSchemaParseFacet(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -6665,17 +6549,16 @@ xmlSchemaParseFacet(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseWildcardNs:
- * @ctxt: a schema parser context
- * @schema: unused
- * @wildc: the wildcard, already created
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema parser context
+ * @param schema unused
+ * @param wildc the wildcard, already created
+ * @param node a subtree containing XML Schema information
*
* Parses the attribute "processContents" and "namespace"
* of a xsd:anyAttribute and xsd:any.
* *WARNING* this interface is highly subject to change
*
- * Returns 0 if everything goes fine, a positive error code
+ * @returns 0 if everything goes fine, a positive error code
* if something is not valid and -1 if an internal error occurs.
*/
static int
@@ -6835,17 +6718,16 @@ xmlSchemaPCheckParticleCorrect_2(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaParseAny:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* Parsea a XML schema `` element. A particle and wildcard
* will be created (except if minOccurs==maxOccurs==0, in this case
* nothing will be created).
* *WARNING* this interface is highly subject to change
*
- * Returns the particle or NULL in case of error or if minOccurs==maxOccurs==0
+ * @returns the particle or NULL in case of error or if minOccurs==maxOccurs==0
*/
static xmlSchemaParticlePtr
xmlSchemaParseAny(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -6930,14 +6812,13 @@ xmlSchemaParseAny(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseNotation:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema Notation declaration
*
- * Returns the new structure or NULL in case of error
+ * @returns the new structure or NULL in case of error
*/
static xmlSchemaNotationPtr
xmlSchemaParseNotation(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -6977,15 +6858,14 @@ xmlSchemaParseNotation(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseAnyAttribute:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema AnyAttribute declaration
* *WARNING* this interface is highly subject to change
*
- * Returns a wildcard or NULL.
+ * @returns a wildcard or NULL.
*/
static xmlSchemaWildcardPtr
xmlSchemaParseAnyAttribute(xmlSchemaParserCtxtPtr ctxt,
@@ -7047,17 +6927,16 @@ xmlSchemaParseAnyAttribute(xmlSchemaParserCtxtPtr ctxt,
/**
- * xmlSchemaParseAttribute:
- * @pctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @uses: attribute uses list
- * @parentType: parent type
+ * @param pctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param uses attribute uses list
+ * @param parentType parent type
*
* parse a XML schema Attribute declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the attribute declaration.
+ * @returns the attribute declaration.
*/
static xmlSchemaBasicItemPtr
xmlSchemaParseLocalAttribute(xmlSchemaParserCtxtPtr pctxt,
@@ -7592,17 +7471,16 @@ xmlSchemaParseGlobalAttribute(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaParseAttributeGroupRef:
- * @pctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param pctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* Parse an attribute group definition reference.
* Note that a reference to an attribute group does not
* correspond to any component at all.
* *WARNING* this interface is highly subject to change
*
- * Returns the attribute group or NULL in case of error.
+ * @returns the attribute group or NULL in case of error.
*/
static xmlSchemaQNameRefPtr
xmlSchemaParseAttributeGroupRef(xmlSchemaParserCtxtPtr pctxt,
@@ -7725,15 +7603,14 @@ xmlSchemaParseAttributeGroupRef(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaParseAttributeGroupDefinition:
- * @pctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param pctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema Attribute Group declaration
* *WARNING* this interface is highly subject to change
*
- * Returns the attribute group definition or NULL in case of error.
+ * @returns the attribute group definition or NULL in case of error.
*/
static xmlSchemaAttributeGroupPtr
xmlSchemaParseAttributeGroupDefinition(xmlSchemaParserCtxtPtr pctxt,
@@ -7825,12 +7702,11 @@ xmlSchemaParseAttributeGroupDefinition(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaPValAttrFormDefault:
- * @value: the value
- * @flags: the flags to be modified
- * @flagQualified: the specific flag for "qualified"
+ * @param value the value
+ * @param flags the flags to be modified
+ * @param flagQualified the specific flag for "qualified"
*
- * Returns 0 if the value is valid, 1 otherwise.
+ * @returns 0 if the value is valid, 1 otherwise.
*/
static int
xmlSchemaPValAttrFormDefault(const xmlChar *value,
@@ -7847,20 +7723,19 @@ xmlSchemaPValAttrFormDefault(const xmlChar *value,
}
/**
- * xmlSchemaPValAttrBlockFinal:
- * @value: the value
- * @flags: the flags to be modified
- * @flagAll: the specific flag for "#all"
- * @flagExtension: the specific flag for "extension"
- * @flagRestriction: the specific flag for "restriction"
- * @flagSubstitution: the specific flag for "substitution"
- * @flagList: the specific flag for "list"
- * @flagUnion: the specific flag for "union"
+ * @param value the value
+ * @param flags the flags to be modified
+ * @param flagAll the specific flag for "\#all"
+ * @param flagExtension the specific flag for "extension"
+ * @param flagRestriction the specific flag for "restriction"
+ * @param flagSubstitution the specific flag for "substitution"
+ * @param flagList the specific flag for "list"
+ * @param flagUnion the specific flag for "union"
*
* Validates the value of the attribute "final" and "block". The value
- * is converted into the specified flag values and returned in @flags.
+ * is converted into the specified flag values and returned in `flags`.
*
- * Returns 0 if the value is valid, 1 otherwise.
+ * @returns 0 if the value is valid, 1 otherwise.
*/
static int
@@ -8061,13 +7936,12 @@ xmlSchemaCheckCSelectorXPath(xmlSchemaParserCtxtPtr ctxt,
cur->next = annot;
/**
- * xmlSchemaAssignAnnotation:
- * @annItem: the schema component
- * @annot: the annotation
+ * @param annItem the schema component
+ * @param annot the annotation
*
* Adds the annotation to the given schema component.
*
- * Returns the given annotation.
+ * @returns the given annotation.
*/
static xmlSchemaAnnotPtr
xmlSchemaAddAnnotation(xmlSchemaAnnotItemPtr annItem,
@@ -8157,16 +8031,15 @@ xmlSchemaAddAnnotation(xmlSchemaAnnotItemPtr annItem,
}
/**
- * xmlSchemaParseIDCSelectorAndField:
- * @ctxt: a schema validation context
- * @idc: the identity-constraint definition
- * @node: a subtree containing XML Schema information
- * @isField: field indicator
+ * @param ctxt a schema validation context
+ * @param idc the identity-constraint definition
+ * @param node a subtree containing XML Schema information
+ * @param isField field indicator
*
* Parses a XML Schema identity-constraint definition's
* `` and `` elements.
*
- * Returns the parsed identity-constraint definition.
+ * @returns the parsed identity-constraint definition.
*/
static xmlSchemaIDCSelectPtr
xmlSchemaParseIDCSelectorAndField(xmlSchemaParserCtxtPtr ctxt,
@@ -8254,16 +8127,15 @@ xmlSchemaParseIDCSelectorAndField(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaParseIDC:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @idcCategory: the IDC category
- * @targetNamespace: the target namespace
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param idcCategory the IDC category
+ * @param targetNamespace the target namespace
*
* Parses a XML Schema identity-constraint definition.
*
- * Returns the parsed identity-constraint definition.
+ * @returns the parsed identity-constraint definition.
*/
static xmlSchemaIDCPtr
xmlSchemaParseIDC(xmlSchemaParserCtxtPtr ctxt,
@@ -8403,17 +8275,16 @@ xmlSchemaParseIDC(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaParseElement:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @isElemRef: set if the element is a reference
- * @topLevel: indicates if this is global declaration
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param isElemRef set if the element is a reference
+ * @param topLevel indicates if this is global declaration
*
* Parses a XML schema element declaration.
* *WARNING* this interface is highly subject to change
*
- * Returns the element declaration or a particle; NULL in case
+ * @returns the element declaration or a particle; NULL in case
* of an error or if the particle has minOccurs==maxOccurs==0.
*/
static xmlSchemaBasicItemPtr
@@ -8803,15 +8674,14 @@ return_null:
}
/**
- * xmlSchemaParseUnion:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema Union definition
* *WARNING* this interface is highly subject to change
*
- * Returns -1 in case of internal error, 0 in case of success and a positive
+ * @returns -1 in case of internal error, 0 in case of success and a positive
* error code otherwise.
*/
static int
@@ -8981,15 +8851,14 @@ xmlSchemaParseUnion(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseList:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema List definition
* *WARNING* this interface is highly subject to change
*
- * Returns -1 in case of error, 0 if the declaration is improper and
+ * @returns -1 in case of error, 0 if the declaration is improper and
* 1 in case of success.
*/
static xmlSchemaTypePtr
@@ -9092,16 +8961,15 @@ xmlSchemaParseList(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseSimpleType:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @topLevel: whether this is a top-level element
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param topLevel whether this is a top-level element
*
* parse a XML schema Simple Type definition
* *WARNING* this interface is highly subject to change
*
- * Returns -1 in case of error, 0 if the declaration is improper and
+ * @returns -1 in case of error, 0 if the declaration is improper and
* 1 in case of success.
*/
static xmlSchemaTypePtr
@@ -9308,10 +9176,9 @@ xmlSchemaParseSimpleType(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseModelGroupDefRef:
- * @ctxt: the parser context
- * @schema: the schema being built
- * @node: the node
+ * @param ctxt the parser context
+ * @param schema the schema being built
+ * @param node the node
*
* Parses a reference to a model group definition.
*
@@ -9404,10 +9271,9 @@ xmlSchemaParseModelGroupDefRef(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaParseModelGroupDefinition:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* Parses a XML schema model group definition.
*
@@ -9417,7 +9283,7 @@ xmlSchemaParseModelGroupDefRef(xmlSchemaParserCtxtPtr ctxt,
*
* *WARNING* this interface is highly subject to change
*
- * Returns -1 in case of error, 0 if the declaration is improper and
+ * @returns -1 in case of error, 0 if the declaration is improper and
* 1 in case of success.
*/
static xmlSchemaModelGroupDefPtr
@@ -9500,9 +9366,8 @@ xmlSchemaParseModelGroupDefinition(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCleanupDoc:
- * @ctxt: a schema validation context
- * @root: the root of the document.
+ * @param ctxt a schema validation context
+ * @param root the root of the document.
*
* removes unwanted nodes in a schemas document tree
*/
@@ -9710,12 +9575,11 @@ exit_failure:
}
/**
- * xmlSchemaParseSchemaTopLevel:
- * @ctxt: a schema validation context
- * @schema: the schemas
- * @nodes: the list of top level nodes
+ * @param ctxt a schema validation context
+ * @param schema the schemas
+ * @param nodes the list of top level nodes
*
- * Returns the internal XML Schema structure built from the resource or
+ * @returns the internal XML Schema structure built from the resource or
* NULL in case of error
*/
static int
@@ -9929,14 +9793,13 @@ xmlSchemaParserCtxtCreate(void)
}
/**
- * xmlSchemaNewParserCtxtUseDict:
- * @URL: the location of the schema
- * @dict: the dictionary to be used
+ * @param URL the location of the schema
+ * @param dict the dictionary to be used
*
* Create an XML Schemas parse context for that file/resource expected
* to contain an XML Schemas file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
static xmlSchemaParserCtxtPtr
xmlSchemaNewParserCtxtUseDict(const char *URL, xmlDictPtr dict)
@@ -9977,14 +9840,13 @@ xmlSchemaCreatePCtxtOnVCtxt(xmlSchemaValidCtxtPtr vctxt)
}
/**
- * xmlSchemaGetSchemaBucket:
- * @pctxt: the schema parser context
- * @schemaLocation: the URI of the schema document
+ * @param pctxt the schema parser context
+ * @param schemaLocation the URI of the schema document
*
- * Returns a schema bucket if it was already parsed.
+ * @returns a schema bucket if it was already parsed.
*
- * Returns a schema bucket if it was already parsed from
- * @schemaLocation, NULL otherwise.
+ * @returns a schema bucket if it was already parsed from
+ * `schemaLocation`, NULL otherwise.
*/
static xmlSchemaBucketPtr
xmlSchemaGetSchemaBucket(xmlSchemaParserCtxtPtr pctxt,
@@ -10238,21 +10100,20 @@ xmlSchemaBuildAbsoluteURI(xmlDictPtr dict, const xmlChar* location,
/**
- * xmlSchemaAddSchemaDoc:
- * @pctxt: a schema validation context
- * @type: import or include or redefine
- * @schemaLocation: schema location
- * @schemaDoc: schema document
- * @schemaBuffer: document buffer
- * @schemaBufferLen: buffer size
- * @invokingNode: invoking node
- * @sourceTargetNamespace: source target namespace
- * @importNamespace: import namespace
- * @bucket: bucket
+ * @param pctxt a schema validation context
+ * @param type import or include or redefine
+ * @param schemaLocation schema location
+ * @param schemaDoc schema document
+ * @param schemaBuffer document buffer
+ * @param schemaBufferLen buffer size
+ * @param invokingNode invoking node
+ * @param sourceTargetNamespace source target namespace
+ * @param importNamespace import namespace
+ * @param bucket bucket
*
* Parse an included (and to-be-redefined) XML schema document.
*
- * Returns 0 on success, a positive error code on errors and
+ * @returns 0 on success, a positive error code on errors and
* -1 in case of an internal or API error.
*/
@@ -10675,15 +10536,14 @@ exit_failure:
}
/**
- * xmlSchemaParseImport:
- * @pctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
+ * @param pctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
*
* parse a XML schema Import definition
* *WARNING* this interface is highly subject to change
*
- * Returns 0 in case of success, a positive error code if
+ * @returns 0 in case of success, a positive error code if
* not valid and -1 in case of an internal error.
*/
static int
@@ -11156,12 +11016,11 @@ xmlSchemaParseInclude(xmlSchemaParserCtxtPtr pctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseModelGroup:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @type: the "compositor" type
- * @withParticle: if a a model group with a particle
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param type the "compositor" type
+ * @param withParticle if a a model group with a particle
*
* parse a XML schema Sequence definition.
* Applies parts of:
@@ -11177,7 +11036,7 @@ xmlSchemaParseInclude(xmlSchemaParserCtxtPtr pctxt, xmlSchemaPtr schema,
*
* *WARNING* this interface is highly subject to change
*
- * Returns -1 in case of error, 0 if the declaration is improper and
+ * @returns -1 in case of error, 0 if the declaration is improper and
* 1 in case of success.
*/
static xmlSchemaTreeItemPtr
@@ -11436,16 +11295,15 @@ xmlSchemaParseModelGroup(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseRestriction:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @parentType: the parent type
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param parentType the parent type
*
* parse a XML schema Restriction definition
* *WARNING* this interface is highly subject to change
*
- * Returns the type definition or NULL in case of error
+ * @returns the type definition or NULL in case of error
*/
static xmlSchemaTypePtr
xmlSchemaParseRestriction(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -11740,17 +11598,16 @@ xmlSchemaParseRestriction(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseExtension:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @parentType: parent type
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param parentType parent type
*
* Parses an ``, which is found inside a
* `` or ``.
* *WARNING* this interface is highly subject to change.
*
- * Returns the type definition or NULL in case of error
+ * @returns the type definition or NULL in case of error
*/
static xmlSchemaTypePtr
xmlSchemaParseExtension(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -11877,16 +11734,15 @@ xmlSchemaParseExtension(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
}
/**
- * xmlSchemaParseSimpleContent:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @hasRestrictionOrExtension: set if restriction or extension was found
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param hasRestrictionOrExtension set if restriction or extension was found
*
* parse a XML schema SimpleContent definition
* *WARNING* this interface is highly subject to change
*
- * Returns the type definition or NULL in case of error
+ * @returns the type definition or NULL in case of error
*/
static int
xmlSchemaParseSimpleContent(xmlSchemaParserCtxtPtr ctxt,
@@ -11968,16 +11824,15 @@ xmlSchemaParseSimpleContent(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaParseComplexContent:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @hasRestrictionOrExtension: set if restriction or extension was found
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param hasRestrictionOrExtension set if restriction or extension was found
*
* parse a XML schema ComplexContent definition
* *WARNING* this interface is highly subject to change
*
- * Returns the type definition or NULL in case of error
+ * @returns the type definition or NULL in case of error
*/
static int
xmlSchemaParseComplexContent(xmlSchemaParserCtxtPtr ctxt,
@@ -12064,16 +11919,15 @@ xmlSchemaParseComplexContent(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaParseComplexType:
- * @ctxt: a schema validation context
- * @schema: the schema being built
- * @node: a subtree containing XML Schema information
- * @topLevel: whether this is a top-level element
+ * @param ctxt a schema validation context
+ * @param schema the schema being built
+ * @param node a subtree containing XML Schema information
+ * @param topLevel whether this is a top-level element
*
* parse a XML schema Complex Type definition
* *WARNING* this interface is highly subject to change
*
- * Returns the type definition or NULL in case of error
+ * @returns the type definition or NULL in case of error
*/
static xmlSchemaTypePtr
xmlSchemaParseComplexType(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
@@ -12363,13 +12217,12 @@ xmlSchemaParseComplexType(xmlSchemaParserCtxtPtr ctxt, xmlSchemaPtr schema,
#if 0 /* Will be enabled if it is clear what options are needed. */
/**
- * xmlSchemaParserCtxtSetOptions:
- * @ctxt: a schema parser context
- * @options: a combination of xmlSchemaParserOption
+ * @param ctxt a schema parser context
+ * @param options a combination of xmlSchemaParserOption
*
* Sets the options to be used during the parse.
*
- * Returns 0 in case of success, -1 in case of an
+ * @returns 0 in case of success, -1 in case of an
* API error.
*/
static int
@@ -12395,10 +12248,9 @@ xmlSchemaParserCtxtSetOptions(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaValidCtxtGetOptions:
- * @ctxt: a schema parser context
+ * @param ctxt a schema parser context
*
- * Returns the option combination of the parser context.
+ * @returns the option combination of the parser context.
*/
static int
xmlSchemaParserCtxtGetOptions(xmlSchemaParserCtxtPtr ctxt)
@@ -12412,13 +12264,12 @@ xmlSchemaParserCtxtGetOptions(xmlSchemaParserCtxtPtr ctxt)
#endif
/**
- * xmlSchemaNewParserCtxt:
- * @URL: the location of the schema
+ * @param URL the location of the schema
*
* Create an XML Schemas parse context for that file/resource expected
* to contain an XML Schemas file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlSchemaParserCtxtPtr
xmlSchemaNewParserCtxt(const char *URL)
@@ -12437,14 +12288,13 @@ xmlSchemaNewParserCtxt(const char *URL)
}
/**
- * xmlSchemaNewMemParserCtxt:
- * @buffer: a pointer to a char array containing the schemas
- * @size: the size of the array
+ * @param buffer a pointer to a char array containing the schemas
+ * @param size the size of the array
*
* Create an XML Schemas parse context for that memory buffer expected
* to contain an XML Schemas file.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlSchemaParserCtxtPtr
xmlSchemaNewMemParserCtxt(const char *buffer, int size)
@@ -12463,13 +12313,12 @@ xmlSchemaNewMemParserCtxt(const char *buffer, int size)
}
/**
- * xmlSchemaNewDocParserCtxt:
- * @doc: a preparsed document tree
+ * @param doc a preparsed document tree
*
* Create an XML Schemas parse context for that document.
* NB. The document may be modified during the parsing process.
*
- * Returns the parser context or NULL in case of error
+ * @returns the parser context or NULL in case of error
*/
xmlSchemaParserCtxtPtr
xmlSchemaNewDocParserCtxt(xmlDocPtr doc)
@@ -12490,8 +12339,7 @@ xmlSchemaNewDocParserCtxt(xmlDocPtr doc)
}
/**
- * xmlSchemaFreeParserCtxt:
- * @ctxt: the schema parser context
+ * @param ctxt the schema parser context
*
* Free the resources associated to the schema parser context
*/
@@ -12523,9 +12371,8 @@ xmlSchemaFreeParserCtxt(xmlSchemaParserCtxtPtr ctxt)
************************************************************************/
/**
- * xmlSchemaBuildContentModelForSubstGroup:
*
- * Returns 1 if nillable, 0 otherwise
+ * @returns 1 if nillable, 0 otherwise
*/
static int
xmlSchemaBuildContentModelForSubstGroup(xmlSchemaParserCtxtPtr pctxt,
@@ -12640,9 +12487,8 @@ xmlSchemaBuildContentModelForSubstGroup(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaBuildContentModelForElement:
*
- * Returns 1 if nillable, 0 otherwise
+ * @returns 1 if nillable, 0 otherwise
*/
static int
xmlSchemaBuildContentModelForElement(xmlSchemaParserCtxtPtr ctxt,
@@ -12700,13 +12546,12 @@ xmlSchemaBuildContentModelForElement(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaBuildAContentModel:
- * @pctxt: the schema parser context
- * @particle: the particle component
+ * @param pctxt the schema parser context
+ * @param particle the particle component
*
* Create the automaton for the {content type} of a complex type.
*
- * Returns 1 if the content is nillable, 0 otherwise
+ * @returns 1 if the content is nillable, 0 otherwise
*/
static int
xmlSchemaBuildAContentModel(xmlSchemaParserCtxtPtr pctxt,
@@ -13108,9 +12953,8 @@ xmlSchemaBuildAContentModel(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaBuildContentModel:
- * @type: the complex type definition
- * @ctxt: the schema parser context
+ * @param type the complex type definition
+ * @param ctxt the schema parser context
*
* Builds the content model of the complex type.
*/
@@ -13156,9 +13000,8 @@ xmlSchemaBuildContentModel(xmlSchemaTypePtr type,
}
/**
- * xmlSchemaResolveElementReferences:
- * @elemDecl: the schema element context
- * @ctxt: the schema parser context
+ * @param elemDecl the schema element context
+ * @param ctxt the schema parser context
*
* Resolves the references of an element declaration
* or particle, which has an element declaration as it's
@@ -13245,15 +13088,14 @@ xmlSchemaResolveElementReferences(xmlSchemaElementPtr elemDecl,
}
/**
- * xmlSchemaResolveUnionMemberTypes:
- * @ctxt: the schema parser context
- * @type: the schema simple type definition
+ * @param ctxt the schema parser context
+ * @param type the schema simple type definition
*
* Checks and builds the "member type definitions" property of the union
* simple type. This handles part (1), part (2) is done in
* xmlSchemaFinishMemberTypeDefinitionsProperty()
*
- * Returns -1 in case of an internal error, 0 otherwise.
+ * @returns -1 in case of an internal error, 0 otherwise.
*/
static int
xmlSchemaResolveUnionMemberTypes(xmlSchemaParserCtxtPtr ctxt,
@@ -13325,12 +13167,11 @@ xmlSchemaResolveUnionMemberTypes(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaIsDerivedFromBuiltInType:
- * @type: the type definition
- * @valType: the value type
+ * @param type the type definition
+ * @param valType the value type
*
*
- * Returns 1 if the type has the given value type, or
+ * @returns 1 if the type has the given value type, or
* is derived from such a type.
*/
static int
@@ -13353,13 +13194,12 @@ xmlSchemaIsDerivedFromBuiltInType(xmlSchemaTypePtr type, int valType)
#if 0
/**
- * xmlSchemaIsDerivedFromBuiltInType:
- * @ctxt: the schema parser context
- * @type: the type definition
- * @valType: the value type
+ * @param ctxt the schema parser context
+ * @param type the type definition
+ * @param valType the value type
*
*
- * Returns 1 if the type has the given value type, or
+ * @returns 1 if the type has the given value type, or
* is derived from such a type.
*/
static int
@@ -13393,10 +13233,9 @@ xmlSchemaQueryBuiltInType(xmlSchemaTypePtr type)
#endif
/**
- * xmlSchemaGetPrimitiveType:
- * @type: the simpleType definition
+ * @param type the simpleType definition
*
- * Returns the primitive type of the given type or
+ * @returns the primitive type of the given type or
* NULL in case of error.
*/
static xmlSchemaTypePtr
@@ -13419,10 +13258,9 @@ xmlSchemaGetPrimitiveType(xmlSchemaTypePtr type)
#if 0
/**
- * xmlSchemaGetBuiltInTypeAncestor:
- * @type: the simpleType definition
+ * @param type the simpleType definition
*
- * Returns the primitive type of the given type or
+ * @returns the primitive type of the given type or
* NULL in case of error.
*/
static xmlSchemaTypePtr
@@ -13441,14 +13279,13 @@ xmlSchemaGetBuiltInTypeAncestor(xmlSchemaTypePtr type)
#endif
/**
- * xmlSchemaCloneWildcardNsConstraints:
- * @ctxt: the schema parser context
- * @dest: the destination wildcard
- * @source: the source wildcard
+ * @param ctxt the schema parser context
+ * @param dest the destination wildcard
+ * @param source the source wildcard
*
* Clones the namespace constraints of source
* and assigns them to dest.
- * Returns -1 on internal error, 0 otherwise.
+ * @returns -1 on internal error, 0 otherwise.
*/
static int
xmlSchemaCloneWildcardNsConstraints(xmlSchemaParserCtxtPtr ctxt,
@@ -13487,14 +13324,13 @@ xmlSchemaCloneWildcardNsConstraints(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaUnionWildcards:
- * @ctxt: the schema parser context
- * @completeWild: the first wildcard
- * @curWild: the second wildcard
+ * @param ctxt the schema parser context
+ * @param completeWild the first wildcard
+ * @param curWild the second wildcard
*
* Unions the namespace constraints of the given wildcards.
- * @completeWild will hold the resulting union.
- * Returns a positive error code on failure, -1 in case of an
+ * `completeWild` will hold the resulting union.
+ * @returns a positive error code on failure, -1 in case of an
* internal error, 0 otherwise.
*/
static int
@@ -13747,14 +13583,13 @@ xmlSchemaUnionWildcards(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaIntersectWildcards:
- * @ctxt: the schema parser context
- * @completeWild: the first wildcard
- * @curWild: the second wildcard
+ * @param ctxt the schema parser context
+ * @param completeWild the first wildcard
+ * @param curWild the second wildcard
*
* Intersects the namespace constraints of the given wildcards.
- * @completeWild will hold the resulting intersection.
- * Returns a positive error code on failure, -1 in case of an
+ * `completeWild` will hold the resulting intersection.
+ * @returns a positive error code on failure, -1 in case of an
* internal error, 0 otherwise.
*/
static int
@@ -13925,14 +13760,13 @@ xmlSchemaIntersectWildcards(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaIsWildcardNsConstraintSubset:
- * @sub: the first wildcard
- * @super: the second wildcard
+ * @param sub the first wildcard
+ * @param super the second wildcard
*
* Schema Component Constraint: Wildcard Subset (cos-ns-subset)
*
- * Returns 0 if the namespace constraint of @sub is an intensional
- * subset of @super, 1 otherwise.
+ * @returns 0 if the namespace constraint of `sub` is an intensional
+ * subset of `super`, 1 otherwise.
*/
static int
xmlSchemaCheckCOSNSSubset(xmlSchemaWildcardPtr sub,
@@ -14027,14 +13861,13 @@ xmlSchemaGetEffectiveValueConstraint(xmlSchemaAttributeUsePtr attruse,
return(0);
}
/**
- * xmlSchemaCheckCVCWildcardNamespace:
- * @wild: the wildcard
- * @ns: the namespace
+ * @param wild the wildcard
+ * @param ns the namespace
*
* Validation Rule: Wildcard allows Namespace Name
* (cvc-wildcard-namespace)
*
- * Returns 0 if the given namespace matches the wildcard,
+ * @returns 0 if the given namespace matches the wildcard,
* 1 otherwise and -1 on API errors.
*/
static int
@@ -14369,13 +14202,12 @@ xmlSchemaExpandAttributeGroupRefs(xmlSchemaParserCtxtPtr pctxt,
xmlSchemaItemListPtr list,
xmlSchemaItemListPtr prohibs);
/**
- * xmlSchemaFixupTypeAttributeUses:
- * @pctxt: the schema parser context
- * @type: the complex type definition
+ * @param pctxt the schema parser context
+ * @param type the complex type definition
*
*
* Builds the wildcard and the attribute uses on the given complex type.
- * Returns -1 if an internal error occurs, 0 otherwise.
+ * @returns -1 if an internal error occurs, 0 otherwise.
*
* ATTENTION TODO: Experimentally this uses pointer comparisons for
* strings, so recheck this if we start to hardcode some schemata, since
@@ -14571,14 +14403,13 @@ exit_failure:
}
/**
- * xmlSchemaTypeFinalContains:
- * @type: the type definition
- * @final: the final
+ * @param type the type definition
+ * @param final the final
*
* Evaluates if a type definition contains the given "final".
* This does take "finalDefault" into account as well.
*
- * Returns 1 if the type does contain the given "final",
+ * @returns 1 if the type does contain the given "final",
* 0 otherwise.
*/
static int
@@ -14593,11 +14424,10 @@ xmlSchemaTypeFinalContains(xmlSchemaTypePtr type, int final)
}
/**
- * xmlSchemaGetUnionSimpleTypeMemberTypes:
- * @type: the Union Simple Type
+ * @param type the Union Simple Type
*
- * Returns a list of member types of @type if existing,
- * returns NULL otherwise.
+ * @returns a list of member types of `type` if existing,
+ * @returns NULL otherwise.
*/
static xmlSchemaTypeLinkPtr
xmlSchemaGetUnionSimpleTypeMemberTypes(xmlSchemaTypePtr type)
@@ -14613,13 +14443,12 @@ xmlSchemaGetUnionSimpleTypeMemberTypes(xmlSchemaTypePtr type)
#if 0
/**
- * xmlSchemaGetParticleTotalRangeMin:
- * @particle: the particle
+ * @param particle the particle
*
* Schema Component Constraint: Effective Total Range
* (all and sequence) + (choice)
*
- * Returns the minimum Effective Total Range.
+ * @returns the minimum Effective Total Range.
*/
static int
xmlSchemaGetParticleTotalRangeMin(xmlSchemaParticlePtr particle)
@@ -14668,13 +14497,12 @@ xmlSchemaGetParticleTotalRangeMin(xmlSchemaParticlePtr particle)
}
/**
- * xmlSchemaGetParticleTotalRangeMax:
- * @particle: the particle
+ * @param particle the particle
*
* Schema Component Constraint: Effective Total Range
* (all and sequence) + (choice)
*
- * Returns the maximum Effective Total Range.
+ * @returns the maximum Effective Total Range.
*/
static int
xmlSchemaGetParticleTotalRangeMax(xmlSchemaParticlePtr particle)
@@ -14729,10 +14557,9 @@ xmlSchemaGetParticleTotalRangeMax(xmlSchemaParticlePtr particle)
#endif
/**
- * xmlSchemaGetParticleEmptiable:
- * @particle: the particle
+ * @param particle the particle
*
- * Returns 1 if emptiable, 0 otherwise.
+ * @returns 1 if emptiable, 0 otherwise.
*/
static int
xmlSchemaGetParticleEmptiable(xmlSchemaParticlePtr particle)
@@ -14771,13 +14598,12 @@ xmlSchemaGetParticleEmptiable(xmlSchemaParticlePtr particle)
}
/**
- * xmlSchemaIsParticleEmptiable:
- * @particle: the particle
+ * @param particle the particle
*
* Schema Component Constraint: Particle Emptiable
* Checks whether the given particle is emptiable.
*
- * Returns 1 if emptiable, 0 otherwise.
+ * @returns 1 if emptiable, 0 otherwise.
*/
static int
xmlSchemaIsParticleEmptiable(xmlSchemaParticlePtr particle)
@@ -14798,19 +14624,18 @@ xmlSchemaIsParticleEmptiable(xmlSchemaParticlePtr particle)
}
/**
- * xmlSchemaCheckCOSSTDerivedOK:
- * @actxt: a context
- * @type: the derived simple type definition
- * @baseType: the base type definition
- * @subset: the subset of ('restriction', etc.)
+ * @param actxt a context
+ * @param type the derived simple type definition
+ * @param baseType the base type definition
+ * @param subset the subset of ('restriction', etc.)
*
* Schema Component Constraint:
* Type Derivation OK (Simple) (cos-st-derived-OK)
*
- * Checks whether @type can be validly
- * derived from @baseType.
+ * Checks whether `type` can be validly
+ * derived from `baseType`.
*
- * Returns 0 on success, an positive error code otherwise.
+ * @returns 0 on success, an positive error code otherwise.
*/
static int
xmlSchemaCheckCOSSTDerivedOK(xmlSchemaAbstractCtxtPtr actxt,
@@ -14901,15 +14726,14 @@ xmlSchemaCheckCOSSTDerivedOK(xmlSchemaAbstractCtxtPtr actxt,
}
/**
- * xmlSchemaCheckTypeDefCircularInternal:
- * @pctxt: the schema parser context
- * @ctxtType: the type definition
- * @ancestor: an ancestor of @ctxtType
+ * @param pctxt the schema parser context
+ * @param ctxtType the type definition
+ * @param ancestor an ancestor of `ctxtType`
*
* Checks st-props-correct (2) + ct-props-correct (3).
* Circular type definitions are not allowed.
*
- * Returns XML_SCHEMAP_ST_PROPS_CORRECT_2 if the given type is
+ * @returns XML_SCHEMAP_ST_PROPS_CORRECT_2 if the given type is
* circular, 0 otherwise.
*/
static int
@@ -14943,9 +14767,8 @@ xmlSchemaCheckTypeDefCircularInternal(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaCheckTypeDefCircular:
- * @item: the complex/simple type definition
- * @ctxt: the parser context
+ * @param item the complex/simple type definition
+ * @param ctxt the parser context
*
* Checks for circular type definitions.
*/
@@ -15024,9 +14847,8 @@ xmlSchemaCheckUnionTypeDefCircular(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaResolveTypeReferences:
- * @typeDef: the complex/simple type definition
- * @ctxt: the parser context
+ * @param typeDef the complex/simple type definition
+ * @param ctxt the parser context
*
* Resolves type definition references
*/
@@ -15149,13 +14971,12 @@ xmlSchemaResolveTypeReferences(xmlSchemaTypePtr typeDef,
/**
- * xmlSchemaCheckSTPropsCorrect:
- * @ctxt: the schema parser context
- * @type: the simple type definition
+ * @param ctxt the schema parser context
+ * @param type the simple type definition
*
* Checks st-props-correct.
*
- * Returns 0 if the properties are correct,
+ * @returns 0 if the properties are correct,
* if not, a positive error code and -1 on internal
* errors.
*/
@@ -15251,17 +15072,16 @@ xmlSchemaCheckSTPropsCorrect(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckCOSSTRestricts:
- * @pctxt: the schema parser context
- * @type: the simple type definition
+ * @param pctxt the schema parser context
+ * @param type the simple type definition
*
* Schema Component Constraint:
* Derivation Valid (Restriction, Simple) (cos-st-restricts)
- * Checks if the given @type (simpleType) is derived validly by restriction.
+ * Checks if the given `type` (simpleType) is derived validly by restriction.
* STATUS:
*
- * Returns -1 on internal errors, 0 if the type is validly derived,
+ * @returns -1 on internal errors, 0 if the type is validly derived,
* a positive error code otherwise.
*/
static int
@@ -15720,13 +15540,12 @@ xmlSchemaCheckCOSSTRestricts(xmlSchemaParserCtxtPtr pctxt,
#if 0
/**
- * xmlSchemaCheckSRCSimpleType:
- * @ctxt: the schema parser context
- * @type: the simple type definition
+ * @param ctxt the schema parser context
+ * @param type the simple type definition
*
* Checks crc-simple-type constraints.
*
- * Returns 0 if the constraints are satisfied,
+ * @returns 0 if the constraints are satisfied,
* if not a positive error code and -1 on internal
* errors.
*/
@@ -15798,19 +15617,18 @@ xmlSchemaVCheckCVCSimpleType(xmlSchemaAbstractCtxtPtr actxt,
int isNormalized);
/**
- * xmlSchemaParseCheckCOSValidDefault:
- * @pctxt: the schema parser context
- * @node: an optional node (the holder of the value)
- * @type: the simple type definition
- * @value: the default value
- * @val: resulting value
+ * @param pctxt the schema parser context
+ * @param node an optional node (the holder of the value)
+ * @param type the simple type definition
+ * @param value the default value
+ * @param val resulting value
*
* Schema Component Constraint: Element Default Valid (Immediate)
* (cos-valid-default)
* This will be used by the parser only. For the validator there's
* an other version.
*
- * Returns 0 if the constraints are satisfied,
+ * @returns 0 if the constraints are satisfied,
* if not, a positive error code and -1 on internal
* errors.
*/
@@ -15880,16 +15698,15 @@ xmlSchemaParseCheckCOSValidDefault(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaCheckCTPropsCorrect:
- * @pctxt: the schema parser context
- * @type: the complex type definition
+ * @param pctxt the schema parser context
+ * @param type the complex type definition
*
*.(4.6) Constraints on Complex Type Definition Schema Components
* Schema Component Constraint:
* Complex Type Definition Properties Correct (ct-props-correct)
* STATUS: (seems) complete
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16025,18 +15842,17 @@ xmlSchemaAreEqualTypes(xmlSchemaTypePtr typeA,
}
/**
- * xmlSchemaCheckCOSCTDerivedOK:
- * @actxt: the schema parser context
- * @type: the to-be derived complex type definition
- * @baseType: the base complex type definition
- * @set: the given set
+ * @param actxt the schema parser context
+ * @param type the to-be derived complex type definition
+ * @param baseType the base complex type definition
+ * @param set the given set
*
* Schema Component Constraint:
* Type Derivation OK (Complex) (cos-ct-derived-ok)
*
* STATUS: completed
*
- * Returns 0 if the constraints are satisfied, or 1
+ * @returns 0 if the constraints are satisfied, or 1
* if not.
*/
static int
@@ -16099,18 +15915,17 @@ xmlSchemaCheckCOSCTDerivedOK(xmlSchemaAbstractCtxtPtr actxt,
}
/**
- * xmlSchemaCheckCOSDerivedOK:
- * @actxt: the schema parser context
- * @type: the derived simple type definition
- * @baseType: the base type definition
- * @set: the given set
+ * @param actxt the schema parser context
+ * @param type the derived simple type definition
+ * @param baseType the base type definition
+ * @param set the given set
*
* Calls:
* Type Derivation OK (Simple) AND Type Derivation OK (Complex)
*
- * Checks whether @type can be validly derived from @baseType.
+ * Checks whether `type` can be validly derived from `baseType`.
*
- * Returns 0 on success, an positive error code otherwise.
+ * @returns 0 on success, an positive error code otherwise.
*/
static int
xmlSchemaCheckCOSDerivedOK(xmlSchemaAbstractCtxtPtr actxt,
@@ -16125,9 +15940,8 @@ xmlSchemaCheckCOSDerivedOK(xmlSchemaAbstractCtxtPtr actxt,
}
/**
- * xmlSchemaCheckCOSCTExtends:
- * @ctxt: the schema parser context
- * @type: the complex type definition
+ * @param ctxt the schema parser context
+ * @param type the complex type definition
*
* (3.4.6) Constraints on Complex Type Definition Schema Components
* Schema Component Constraint:
@@ -16138,7 +15952,7 @@ xmlSchemaCheckCOSDerivedOK(xmlSchemaAbstractCtxtPtr actxt,
* (1.5)
* (1.4.3.2.2.2) "Particle Valid (Extension)"
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16379,9 +16193,8 @@ xmlSchemaCheckCOSCTExtends(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckDerivationOKRestriction:
- * @ctxt: the schema parser context
- * @type: the complex type definition
+ * @param ctxt the schema parser context
+ * @param type the complex type definition
*
* (3.4.6) Constraints on Complex Type Definition Schema Components
* Schema Component Constraint:
@@ -16395,7 +16208,7 @@ xmlSchemaCheckCOSCTExtends(xmlSchemaParserCtxtPtr ctxt,
* In XML Schema 1.1 this will be:
* Validation Rule: Checking complex type subsumption
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16579,13 +16392,12 @@ xmlSchemaCheckDerivationOKRestriction(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckCTComponent:
- * @ctxt: the schema parser context
- * @type: the complex type definition
+ * @param ctxt the schema parser context
+ * @param type the complex type definition
*
* (3.4.6) Constraints on Complex Type Definition Schema Components
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16607,15 +16419,14 @@ xmlSchemaCheckCTComponent(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckSRCCT:
- * @ctxt: the schema parser context
- * @type: the complex type definition
+ * @param ctxt the schema parser context
+ * @param type the complex type definition
*
* (3.4.3) Constraints on XML Representations of Complex Type Definitions:
* Schema Representation Constraint:
* Complex Type Definition Representation OK (src-ct)
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16774,9 +16585,8 @@ xmlSchemaCheckSRCCT(xmlSchemaParserCtxtPtr ctxt,
#ifdef ENABLE_PARTICLE_RESTRICTION
/**
- * xmlSchemaCheckParticleRangeOK:
- * @ctxt: the schema parser context
- * @type: the complex type definition
+ * @param ctxt the schema parser context
+ * @param type the complex type definition
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -16784,7 +16594,7 @@ xmlSchemaCheckSRCCT(xmlSchemaParserCtxtPtr ctxt,
*
* STATUS: complete
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16800,10 +16610,9 @@ xmlSchemaCheckParticleRangeOK(int rmin, int rmax,
}
/**
- * xmlSchemaCheckRCaseNameAndTypeOK:
- * @ctxt: the schema parser context
- * @r: the restricting element declaration particle
- * @b: the base element declaration particle
+ * @param ctxt the schema parser context
+ * @param r the restricting element declaration particle
+ * @param b the base element declaration particle
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -16814,7 +16623,7 @@ xmlSchemaCheckParticleRangeOK(int rmin, int rmax,
* MISSING (3.2.3)
* CLARIFY: (3.2.2)
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16907,10 +16716,9 @@ xmlSchemaCheckRCaseNameAndTypeOK(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckRCaseNSCompat:
- * @ctxt: the schema parser context
- * @r: the restricting element declaration particle
- * @b: the base wildcard particle
+ * @param ctxt the schema parser context
+ * @param r the restricting element declaration particle
+ * @param b the base wildcard particle
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -16919,7 +16727,7 @@ xmlSchemaCheckRCaseNameAndTypeOK(xmlSchemaParserCtxtPtr ctxt,
*
* STATUS: complete
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16951,10 +16759,9 @@ xmlSchemaCheckRCaseNSCompat(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckRCaseRecurseAsIfGroup:
- * @ctxt: the schema parser context
- * @r: the restricting element declaration particle
- * @b: the base model group particle
+ * @param ctxt the schema parser context
+ * @param r the restricting element declaration particle
+ * @param b the base model group particle
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -16963,7 +16770,7 @@ xmlSchemaCheckRCaseNSCompat(xmlSchemaParserCtxtPtr ctxt,
*
* STATUS: TODO
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -16977,10 +16784,9 @@ xmlSchemaCheckRCaseRecurseAsIfGroup(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckRCaseNSSubset:
- * @ctxt: the schema parser context
- * @r: the restricting wildcard particle
- * @b: the base wildcard particle
+ * @param ctxt the schema parser context
+ * @param r the restricting wildcard particle
+ * @param b the base wildcard particle
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -16989,7 +16795,7 @@ xmlSchemaCheckRCaseRecurseAsIfGroup(xmlSchemaParserCtxtPtr ctxt,
*
* STATUS: complete
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -17029,9 +16835,8 @@ xmlSchemaCheckRCaseNSSubset(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaCheckCOSParticleRestrict:
- * @ctxt: the schema parser context
- * @type: the complex type definition
+ * @param ctxt the schema parser context
+ * @param type the complex type definition
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -17039,7 +16844,7 @@ xmlSchemaCheckRCaseNSSubset(xmlSchemaParserCtxtPtr ctxt,
*
* STATUS: TODO
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -17067,10 +16872,9 @@ xmlSchemaCheckCOSParticleRestrict(xmlSchemaParserCtxtPtr ctxt,
#if 0
/**
- * xmlSchemaCheckRCaseNSRecurseCheckCardinality:
- * @ctxt: the schema parser context
- * @r: the model group particle
- * @b: the base wildcard particle
+ * @param ctxt the schema parser context
+ * @param r the model group particle
+ * @param b the base wildcard particle
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -17080,7 +16884,7 @@ xmlSchemaCheckCOSParticleRestrict(xmlSchemaParserCtxtPtr ctxt,
*
* STATUS: TODO: subst-groups
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -17121,10 +16925,9 @@ xmlSchemaCheckRCaseNSRecurseCheckCardinality(xmlSchemaParserCtxtPtr ctxt,
#endif
/**
- * xmlSchemaCheckRCaseRecurse:
- * @ctxt: the schema parser context
- * @r: the or model group particle
- * @b: the base or model group particle
+ * @param ctxt the schema parser context
+ * @param r the or model group particle
+ * @param b the base or model group particle
*
* (3.9.6) Constraints on Particle Schema Components
* Schema Component Constraint:
@@ -17135,7 +16938,7 @@ xmlSchemaCheckRCaseNSRecurseCheckCardinality(xmlSchemaParserCtxtPtr ctxt,
* STATUS: ?
* TODO: subst-groups
*
- * Returns 0 if the constraints are satisfied, a positive
+ * @returns 0 if the constraints are satisfied, a positive
* error code if not and -1 if an internal error occurred.
*/
static int
@@ -18532,9 +18335,8 @@ exit_failure:
/**
- * xmlSchemaTypeFixup:
- * @type: the schema type definition
- * @actxt: the schema parser context
+ * @param type the schema type definition
+ * @param actxt the schema parser context
*
* Fixes the content model of the type.
* URGENT TODO: We need an int result!
@@ -18560,15 +18362,14 @@ xmlSchemaTypeFixup(xmlSchemaTypePtr type,
}
/**
- * xmlSchemaCheckFacet:
- * @facet: the facet
- * @typeDecl: the schema type definition
- * @pctxt: the schema parser context or NULL
- * @name: the optional name of the type
+ * @param facet the facet
+ * @param typeDecl the schema type definition
+ * @param pctxt the schema parser context or NULL
+ * @param name the optional name of the type
*
* Checks and computes the values of facets.
*
- * Returns 0 if valid, a positive error code if not valid and
+ * @returns 0 if valid, a positive error code if not valid and
* -1 in case of an internal or API error.
*/
int
@@ -18773,9 +18574,8 @@ internal_error:
}
/**
- * xmlSchemaCheckFacetValues:
- * @typeDecl: the schema type definition
- * @pctxt: the schema parser context
+ * @param typeDecl the schema type definition
+ * @param pctxt the schema parser context
*
* Checks the default values types, especially for facets
*/
@@ -18816,14 +18616,13 @@ exit_failure:
}
/**
- * xmlSchemaGetCircModelGrDefRef:
- * @groupDef: the searched model group
- * @particle: the first particle
+ * @param groupDef the searched model group
+ * @param particle the first particle
*
* This one is intended to be used by
* xmlSchemaCheckGroupDefCircular only.
*
- * Returns the particle with the circular model group definition reference,
+ * @returns the particle with the circular model group definition reference,
* otherwise NULL.
*/
static xmlSchemaTreeItemPtr
@@ -18873,9 +18672,8 @@ xmlSchemaGetCircModelGrDefRef(xmlSchemaModelGroupDefPtr groupDef,
}
/**
- * xmlSchemaCheckGroupDefCircular:
- * @item: the model group definition
- * @ctxt: the parser context
+ * @param item the model group definition
+ * @param ctxt the parser context
*
* Checks for circular references to model group definitions.
*/
@@ -18923,9 +18721,8 @@ xmlSchemaCheckGroupDefCircular(xmlSchemaModelGroupDefPtr item,
}
/**
- * xmlSchemaModelGroupToModelGroupDefFixup:
- * @ctxt: the parser context
- * @mg: the model group
+ * @param ctxt the parser context
+ * @param mg the model group
*
* Assigns the model group of model group definitions to the "term"
* of the referencing particle.
@@ -18970,14 +18767,13 @@ xmlSchemaModelGroupToModelGroupDefFixup(
}
/**
- * xmlSchemaCheckAttrGroupCircularRecur:
- * @ctxtGr: the searched attribute group
- * @list: the current attribute list to be processed
+ * @param ctxtGr the searched attribute group
+ * @param list the current attribute list to be processed
*
* This one is intended to be used by
* xmlSchemaCheckAttrGroupCircular only.
*
- * Returns the circular attribute group reference, otherwise NULL.
+ * @returns the circular attribute group reference, otherwise NULL.
*/
static xmlSchemaQNameRefPtr
xmlSchemaCheckAttrGroupCircularRecur(xmlSchemaAttributeGroupPtr ctxtGr,
@@ -19022,9 +18818,8 @@ xmlSchemaCheckAttrGroupCircularRecur(xmlSchemaAttributeGroupPtr ctxtGr,
}
/**
- * xmlSchemaCheckAttrGroupCircular:
- * @attrGr: the attribute group definition
- * @ctxt: the parser context
+ * @param attrGr the attribute group definition
+ * @param ctxt the parser context
*
* Checks for circular references of attribute groups.
*/
@@ -19083,17 +18878,16 @@ xmlSchemaAttributeGroupExpandRefs(xmlSchemaParserCtxtPtr pctxt,
xmlSchemaAttributeGroupPtr attrGr);
/**
- * xmlSchemaExpandAttributeGroupRefs:
- * @pctxt: the parser context
- * @item: the schema item
- * @completeWild: the intersected wildcard to be returned
- * @list: the attribute uses
- * @prohibs: the attribute prohibitions
+ * @param pctxt the parser context
+ * @param item the schema item
+ * @param completeWild the intersected wildcard to be returned
+ * @param list the attribute uses
+ * @param prohibs the attribute prohibitions
*
* Substitutes contained attribute group references
* for their attribute uses. Wildcards are intersected.
* Attribute use prohibitions are removed from the list
- * and returned via the @prohibs list.
+ * and returned via the `prohibs` list.
* Pointlessness of attr. prohibs, if a matching attr. decl
* is existent a well, are checked.
*/
@@ -19256,9 +19050,8 @@ xmlSchemaExpandAttributeGroupRefs(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaAttributeGroupExpandRefs:
- * @pctxt: the parser context
- * @attrGr: the attribute group definition
+ * @param pctxt the parser context
+ * @param attrGr the attribute group definition
*
* Computation of:
* {attribute uses} property
@@ -19283,9 +19076,8 @@ xmlSchemaAttributeGroupExpandRefs(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaAttributeGroupExpandRefs:
- * @pctxt: the parser context
- * @attrGr: the attribute group definition
+ * @param pctxt the parser context
+ * @param attrGr the attribute group definition
*
* Substitutes contained attribute group references
* for their attribute uses. Wildcards are intersected.
@@ -19383,9 +19175,8 @@ next_use: {}
}
/**
- * xmlSchemaResolveAttrGroupReferences:
- * @ref: the schema attribute definition
- * @ctxt: the schema parser context
+ * @param ref the schema attribute definition
+ * @param ctxt the schema parser context
*
* Resolves references to attribute group definitions.
*/
@@ -19413,9 +19204,8 @@ xmlSchemaResolveAttrGroupReferences(xmlSchemaQNameRefPtr ref,
}
/**
- * xmlSchemaCheckAttrPropsCorrect:
- * @pctxt: a schema parser context
- * @attr: an schema attribute declaration/use
+ * @param pctxt a schema parser context
+ * @param attr an schema attribute declaration/use
*
* Schema Component Constraint:
* Attribute Declaration Properties Correct (a-props-correct)
@@ -19511,9 +19301,8 @@ xmlSchemaCheckSubstGroupCircular(xmlSchemaElementPtr elemDecl,
}
/**
- * xmlSchemaCheckElemPropsCorrect:
- * @pctxt: a schema parser context
- * @elemDecl: the element declaration
+ * @param pctxt a schema parser context
+ * @param elemDecl the element declaration
*
* Schema Component Constraint:
* Element Declaration Properties Correct (e-props-correct)
@@ -19685,9 +19474,8 @@ xmlSchemaCheckElemPropsCorrect(xmlSchemaParserCtxtPtr pctxt,
}
/**
- * xmlSchemaCheckElemSubstGroup:
- * @ctxt: a schema parser context
- * @elemDecl: the element declaration
+ * @param ctxt a schema parser context
+ * @param elemDecl the element declaration
*
* Schema Component Constraint:
* Substitution Group (cos-equiv-class)
@@ -19805,12 +19593,12 @@ add_member:
#ifdef WXS_ELEM_DECL_CONS_ENABLED /* enable when finished */
/**
* xmlSchemaCheckElementDeclComponent
- * @pctxt: the schema parser context
- * @ctxtComponent: the context component (an element declaration)
- * @ctxtParticle: the first particle of the context component
- * @searchParticle: the element declaration particle to be analysed
- * @curParticle: the current particle
- * @search: search flag
+ * @param pctxt the schema parser context
+ * @param ctxtComponent the context component (an element declaration)
+ * @param ctxtParticle the first particle of the context component
+ * @param searchParticle the element declaration particle to be analysed
+ * @param curParticle the current particle
+ * @param search search flag
*
* Schema Component Constraint: Element Declarations Consistent
*/
@@ -19923,8 +19711,8 @@ exit:
/**
* xmlSchemaCheckElementDeclComponent
- * @elemDecl: an schema element declaration/particle
- * @ctxt: a schema parser context
+ * @param elemDecl an schema element declaration/particle
+ * @param ctxt a schema parser context
*
* Validates the value constraints of an element declaration.
* Adds substitution group members.
@@ -19947,9 +19735,8 @@ xmlSchemaCheckElementDeclComponent(xmlSchemaElementPtr elemDecl,
}
/**
- * xmlSchemaResolveModelGroupParticleReferences:
- * @ctxt: a parser context
- * @mg: a model group
+ * @param ctxt a parser context
+ * @param mg a model group
*
* Resolves references of a model group's {particles} to
* model group definitions and to element declarations.
@@ -20096,9 +19883,8 @@ xmlSchemaAreValuesEqual(xmlSchemaValPtr x,
}
/**
- * xmlSchemaResolveAttrUseReferences:
- * @ause: an attribute use
- * @ctxt: a parser context
+ * @param ause an attribute use
+ * @param ctxt a parser context
*
* Resolves the referenced attribute declaration.
*/
@@ -20134,9 +19920,8 @@ xmlSchemaResolveAttrUseReferences(xmlSchemaAttributeUsePtr ause,
}
/**
- * xmlSchemaCheckAttrUsePropsCorrect:
- * @ctxt: a parser context
- * @use: an attribute use
+ * @param ctxt a parser context
+ * @param use an attribute use
*
* Schema Component Constraint:
* Attribute Use Correct (au-props-correct)
@@ -20245,9 +20030,8 @@ xmlSchemaCheckAttrUsePropsCorrect(xmlSchemaParserCtxtPtr ctxt,
/**
- * xmlSchemaResolveAttrTypeReferences:
- * @item: an attribute declaration
- * @ctxt: a parser context
+ * @param item an attribute declaration
+ * @param ctxt a parser context
*
* Resolves the referenced type definition component.
*/
@@ -20291,9 +20075,8 @@ xmlSchemaResolveAttrTypeReferences(xmlSchemaAttributePtr item,
}
/**
- * xmlSchemaResolveIDCKeyReferences:
- * @idc: the identity-constraint definition
- * @pctxt: the schema parser context
+ * @param idc the identity-constraint definition
+ * @param pctxt the schema parser context
*
* Resolve keyRef references to key/unique IDCs.
* Schema Component Constraint:
@@ -21220,13 +21003,12 @@ exit:
return(ret);
}
/**
- * xmlSchemaParse:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* parse a schema definition resource and build an internal
* XML Schema structure which can be used to validate instances.
*
- * Returns the internal XML Schema structure built from the resource or
+ * @returns the internal XML Schema structure built from the resource or
* NULL in case of error
*/
xmlSchemaPtr
@@ -21345,13 +21127,12 @@ exit_failure:
}
/**
- * xmlSchemaSetParserErrors:
- * @ctxt: a schema validation context
- * @err: the error callback
- * @warn: the warning callback
- * @ctx: contextual data for the callbacks
+ * @param ctxt a schema validation context
+ * @param err the error callback
+ * @param warn the warning callback
+ * @param ctx contextual data for the callbacks
*
- * DEPRECATED: Use xmlSchemaSetParserStructuredErrors.
+ * @deprecated Use xmlSchemaSetParserStructuredErrors.
*
* Set the callback functions used to handle errors for a validation context
*/
@@ -21370,10 +21151,9 @@ xmlSchemaSetParserErrors(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaSetParserStructuredErrors:
- * @ctxt: a schema parser context
- * @serror: the structured error function
- * @ctx: the functions context
+ * @param ctxt a schema parser context
+ * @param serror the structured error function
+ * @param ctx the functions context
*
* Set the structured error callback
*/
@@ -21391,15 +21171,14 @@ xmlSchemaSetParserStructuredErrors(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaGetParserErrors:
- * @ctxt: a XMl-Schema parser context
- * @err: the error callback result
- * @warn: the warning callback result
- * @ctx: contextual data for the callbacks result
+ * @param ctxt a XMl-Schema parser context
+ * @param err the error callback result
+ * @param warn the warning callback result
+ * @param ctx contextual data for the callbacks result
*
* Get the callback information used to handle errors for a parser context
*
- * Returns -1 in case of failure, 0 otherwise
+ * @returns -1 in case of failure, 0 otherwise
*/
int
xmlSchemaGetParserErrors(xmlSchemaParserCtxtPtr ctxt,
@@ -21418,10 +21197,9 @@ xmlSchemaGetParserErrors(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaSetResourceLoader:
- * @ctxt: schema parser
- * @loader: resource loader
- * @data: user data which will be passed to the loader
+ * @param ctxt schema parser
+ * @param loader resource loader
+ * @param data user data which will be passed to the loader
*
* Register a callback function that will be called to load documents
* or external entities.
@@ -21438,12 +21216,11 @@ xmlSchemaSetResourceLoader(xmlSchemaParserCtxtPtr ctxt,
}
/**
- * xmlSchemaFacetTypeToString:
- * @type: the facet type
+ * @param type the facet type
*
* Convert the xmlSchemaTypeType to a char string.
*
- * Returns the char string representation of the facet type if the
+ * @returns the char string representation of the facet type if the
* type is a facet and an "Internal Error" string otherwise.
*/
static const xmlChar *
@@ -21537,16 +21314,15 @@ xmlSchemaGetWhiteSpaceFacetValue(xmlSchemaTypePtr type)
************************************************************************/
/**
- * xmlSchemaAssembleByLocation:
- * @vctxt: a schema validation context
- * @schema: the existing schema
- * @node: the node that fired the assembling
- * @nsName: the namespace name of the new schema
- * @location: the location of the schema
+ * @param vctxt a schema validation context
+ * @param schema the existing schema
+ * @param node the node that fired the assembling
+ * @param nsName the namespace name of the new schema
+ * @param location the location of the schema
*
* Expands an existing schema by an additional schema.
*
- * Returns 0 if the new schema is correct, a positive error code
+ * @returns 0 if the new schema is correct, a positive error code
* number otherwise and -1 in case of an internal or API error.
*/
static int
@@ -21676,15 +21452,14 @@ xmlSchemaGetMetaAttrInfo(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaAssembleByXSI:
- * @vctxt: a schema validation context
+ * @param vctxt a schema validation context
*
* Expands an existing schema by an additional schema using
* the xsi:schemaLocation or xsi:noNamespaceSchemaLocation attribute
- * of an instance. If xsi:noNamespaceSchemaLocation is used, @noNamespace
+ * of an instance. If xsi:noNamespaceSchemaLocation is used, `noNamespace`
* must be set to 1.
*
- * Returns 0 if the new schema is correct, a positive error code
+ * @returns 0 if the new schema is correct, a positive error code
* number otherwise and -1 in case of an internal or API error.
*/
static int
@@ -21938,14 +21713,13 @@ xmlSchemaVAddNodeQName(xmlSchemaValidCtxtPtr vctxt,
************************************************************************/
/**
- * xmlSchemaAugmentIDC:
- * @payload: the IDC definition
- * @data: validation context
- * @name: unused
+ * @param payload the IDC definition
+ * @param data validation context
+ * @param name unused
*
* Creates an augmented IDC definition item.
*
- * Returns the item, or NULL on internal errors.
+ * @returns the item, or NULL on internal errors.
*/
static void
xmlSchemaAugmentIDC(void *payload, void *data,
@@ -21978,10 +21752,9 @@ xmlSchemaAugmentIDC(void *payload, void *data,
}
/**
- * xmlSchemaAugmentImportedIDC:
- * @payload: the imported schema
- * @data: validation context
- * @name: unused
+ * @param payload the imported schema
+ * @param data validation context
+ * @param name unused
*
* Creates an augmented IDC definition for the imported schema.
*/
@@ -21996,12 +21769,11 @@ xmlSchemaAugmentImportedIDC(void *payload, void *data,
}
/**
- * xmlSchemaIDCNewBinding:
- * @idcDef: the IDC definition of this binding
+ * @param idcDef the IDC definition of this binding
*
* Creates a new IDC binding.
*
- * Returns the new IDC binding, NULL on internal errors.
+ * @returns the new IDC binding, NULL on internal errors.
*/
static xmlSchemaPSVIIDCBindingPtr
xmlSchemaIDCNewBinding(xmlSchemaIDCPtr idcDef)
@@ -22020,15 +21792,14 @@ xmlSchemaIDCNewBinding(xmlSchemaIDCPtr idcDef)
}
/**
- * xmlSchemaIDCStoreNodeTableItem:
- * @vctxt: the WXS validation context
- * @item: the IDC node table item
+ * @param vctxt the WXS validation context
+ * @param item the IDC node table item
*
* The validation context is used to store IDC node table items.
* They are stored to avoid copying them if IDC node-tables are merged
* with corresponding parent IDC node-tables (bubbling).
*
- * Returns 0 if succeeded, -1 on internal errors.
+ * @returns 0 if succeeded, -1 on internal errors.
*/
static int
xmlSchemaIDCStoreNodeTableItem(xmlSchemaValidCtxtPtr vctxt,
@@ -22062,13 +21833,12 @@ xmlSchemaIDCStoreNodeTableItem(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaIDCStoreKey:
- * @vctxt: the WXS validation context
- * @key: the IDC key
+ * @param vctxt the WXS validation context
+ * @param key the IDC key
*
* The validation context is used to store an IDC key.
*
- * Returns 0 if succeeded, -1 on internal errors.
+ * @returns 0 if succeeded, -1 on internal errors.
*/
static int
xmlSchemaIDCStoreKey(xmlSchemaValidCtxtPtr vctxt,
@@ -22102,13 +21872,12 @@ xmlSchemaIDCStoreKey(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaIDCAppendNodeTableItem:
- * @bind: the IDC binding
- * @ntItem: the node-table item
+ * @param bind the IDC binding
+ * @param ntItem the node-table item
*
* Appends the IDC node-table item to the binding.
*
- * Returns 0 on success and -1 on internal errors.
+ * @returns 0 on success and -1 on internal errors.
*/
static int
xmlSchemaIDCAppendNodeTableItem(xmlSchemaPSVIIDCBindingPtr bind,
@@ -22139,15 +21908,14 @@ xmlSchemaIDCAppendNodeTableItem(xmlSchemaPSVIIDCBindingPtr bind,
}
/**
- * xmlSchemaIDCAcquireBinding:
- * @vctxt: the WXS validation context
- * @matcher: the IDC matcher
+ * @param vctxt the WXS validation context
+ * @param matcher the IDC matcher
*
* Looks up an PSVI IDC binding, for the IDC definition and
* of the given matcher. If none found, a new one is created
* and added to the IDC table.
*
- * Returns an IDC binding or NULL on internal errors.
+ * @returns an IDC binding or NULL on internal errors.
*/
static xmlSchemaPSVIIDCBindingPtr
xmlSchemaIDCAcquireBinding(xmlSchemaValidCtxtPtr vctxt,
@@ -22194,8 +21962,7 @@ xmlSchemaIDCAcquireTargetList(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaIDCFreeKey:
- * @key: the IDC key
+ * @param key the IDC key
*
* Frees an IDC key together with its compiled value.
*/
@@ -22208,7 +21975,6 @@ xmlSchemaIDCFreeKey(xmlSchemaPSVIIDCKeyPtr key)
}
/**
- * xmlSchemaIDCFreeBinding:
*
* Frees an IDC binding. Note that the node table-items
* are not freed.
@@ -22224,8 +21990,7 @@ xmlSchemaIDCFreeBinding(xmlSchemaPSVIIDCBindingPtr bind)
}
/**
- * xmlSchemaIDCFreeIDCTable:
- * @bind: the first IDC binding in the list
+ * @param bind the first IDC binding in the list
*
* Frees an IDC table, i.e. all the IDC bindings in the list.
*/
@@ -22253,8 +22018,7 @@ xmlFreeIDCHashEntry (void *payload, const xmlChar *name ATTRIBUTE_UNUSED)
}
/**
- * xmlSchemaIDCFreeMatcherList:
- * @matcher: the first IDC matcher in the list
+ * @param matcher the first IDC matcher in the list
*
* Frees a list of IDC matchers.
*/
@@ -22298,9 +22062,8 @@ xmlSchemaIDCFreeMatcherList(xmlSchemaIDCMatcherPtr matcher)
}
/**
- * xmlSchemaIDCReleaseMatcherList:
- * @vctxt: the WXS validation context
- * @matcher: the first IDC matcher in the list
+ * @param vctxt the WXS validation context
+ * @param matcher the first IDC matcher in the list
*
* Caches a list of IDC matchers for reuse.
*/
@@ -22359,17 +22122,16 @@ xmlSchemaIDCReleaseMatcherList(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaIDCAddStateObject:
- * @vctxt: the WXS validation context
- * @matcher: the IDC matcher
- * @sel: the XPath information
- * @type: "selector" or "field"
+ * @param vctxt the WXS validation context
+ * @param matcher the IDC matcher
+ * @param sel the XPath information
+ * @param type "selector" or "field"
*
* Creates/reuses and activates state objects for the given
* XPath information; if the XPath expression consists of unions,
* multiple state objects are created for every unioned expression.
*
- * Returns 0 on success and -1 on internal errors.
+ * @returns 0 on success and -1 on internal errors.
*/
static int
xmlSchemaIDCAddStateObject(xmlSchemaValidCtxtPtr vctxt,
@@ -22430,13 +22192,12 @@ xmlSchemaIDCAddStateObject(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaXPathEvaluate:
- * @vctxt: the WXS validation context
- * @nodeType: the nodeType of the current node
+ * @param vctxt the WXS validation context
+ * @param nodeType the nodeType of the current node
*
* Evaluates all active XPath state objects.
*
- * Returns the number of IC "field" state objects which resolved to
+ * @returns the number of IC "field" state objects which resolved to
* this node, 0 if none resolved and -1 on internal errors.
*/
static int
@@ -22598,12 +22359,11 @@ xmlSchemaHashKeySequence(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaXPathPop:
- * @vctxt: the WXS validation context
+ * @param vctxt the WXS validation context
*
* Pops all XPath states.
*
- * Returns 0 on success and -1 on internal errors.
+ * @returns 0 on success and -1 on internal errors.
*/
static int
xmlSchemaXPathPop(xmlSchemaValidCtxtPtr vctxt)
@@ -22624,14 +22384,13 @@ xmlSchemaXPathPop(xmlSchemaValidCtxtPtr vctxt)
}
/**
- * xmlSchemaXPathProcessHistory:
- * @vctxt: the WXS validation context
- * @depth: depth
+ * @param vctxt the WXS validation context
+ * @param depth depth
*
* Processes and pops the history items of the IDC state objects.
* IDC key-sequences are validated/created on IDC bindings.
*
- * Returns 0 on success and -1 on internal errors.
+ * @returns 0 on success and -1 on internal errors.
*/
static int
xmlSchemaXPathProcessHistory(xmlSchemaValidCtxtPtr vctxt,
@@ -23135,14 +22894,13 @@ deregister_check:
}
/**
- * xmlSchemaIDCRegisterMatchers:
- * @vctxt: the WXS validation context
- * @elemDecl: the element declaration
+ * @param vctxt the WXS validation context
+ * @param elemDecl the element declaration
*
* Creates helper objects to evaluate IDC selectors/fields
* successively.
*
- * Returns 0 if OK and -1 on internal errors.
+ * @returns 0 if OK and -1 on internal errors.
*/
static int
xmlSchemaIDCRegisterMatchers(xmlSchemaValidCtxtPtr vctxt,
@@ -23446,15 +23204,14 @@ internal_error:
}
/**
- * xmlSchemaBubbleIDCNodeTables:
- * @vctxt: the WXS validation context
+ * @param vctxt the WXS validation context
*
- * Merges IDC bindings of an element at @depth into the corresponding IDC
+ * Merges IDC bindings of an element at `depth` into the corresponding IDC
* bindings of its parent element. If a duplicate note-table entry is found,
* both, the parent node-table entry and child entry are discarded from the
* node-table of the parent.
*
- * Returns 0 if OK and -1 on internal errors.
+ * @returns 0 if OK and -1 on internal errors.
*/
static int
xmlSchemaBubbleIDCNodeTables(xmlSchemaValidCtxtPtr vctxt)
@@ -23746,8 +23503,7 @@ internal_error:
}
/**
- * xmlSchemaCheckCVCIDCKeyRef:
- * @vctxt: the WXS validation context
+ * @param vctxt the WXS validation context
*
* Check the cvc-idc-keyref constraints.
*/
@@ -24027,9 +23783,8 @@ xmlSchemaValidatorPushAttribute(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaClearElemInfo:
- * @vctxt: the WXS validation context
- * @ielem: the element information item
+ * @param vctxt the WXS validation context
+ * @param ielem the element information item
*/
static void
xmlSchemaClearElemInfo(xmlSchemaValidCtxtPtr vctxt,
@@ -24088,13 +23843,12 @@ xmlSchemaClearElemInfo(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaGetFreshElemInfo:
- * @vctxt: the schema validation context
+ * @param vctxt the schema validation context
*
* Creates/reuses and initializes the element info item for
* the current tree depth.
*
- * Returns the element info item or NULL on API or internal errors.
+ * @returns the element info item or NULL on API or internal errors.
*/
static xmlSchemaNodeInfoPtr
xmlSchemaGetFreshElemInfo(xmlSchemaValidCtxtPtr vctxt)
@@ -27439,12 +27193,11 @@ internal_error:
************************************************************************/
/**
- * xmlSchemaNewValidCtxt:
- * @schema: a precompiled XML Schemas
+ * @param schema a precompiled XML Schemas
*
* Create an XML Schemas validation context based on the given schema.
*
- * Returns the validation context or NULL in case of error
+ * @returns the validation context or NULL in case of error
*/
xmlSchemaValidCtxtPtr
xmlSchemaNewValidCtxt(xmlSchemaPtr schema)
@@ -27473,9 +27226,8 @@ xmlSchemaNewValidCtxt(xmlSchemaPtr schema)
}
/**
- * xmlSchemaValidateSetFilename:
- * @vctxt: the schema validation context
- * @filename: the file name
+ * @param vctxt the schema validation context
+ * @param filename the file name
*
* Workaround to provide file error reporting information when this is
* not provided by current APIs
@@ -27493,8 +27245,7 @@ xmlSchemaValidateSetFilename(xmlSchemaValidCtxtPtr vctxt, const char *filename)
}
/**
- * xmlSchemaClearValidCtxt:
- * @vctxt: the schema validation context
+ * @param vctxt the schema validation context
*
* Free the resources associated to the schema validation context;
* leaves some fields alive intended for reuse of the context.
@@ -27618,8 +27369,7 @@ xmlSchemaClearValidCtxt(xmlSchemaValidCtxtPtr vctxt)
}
/**
- * xmlSchemaFreeValidCtxt:
- * @ctxt: the schema validation context
+ * @param ctxt the schema validation context
*
* Free the resources associated to the schema validation context
*/
@@ -27706,12 +27456,11 @@ xmlSchemaFreeValidCtxt(xmlSchemaValidCtxtPtr ctxt)
}
/**
- * xmlSchemaIsValid:
- * @ctxt: the schema validation context
+ * @param ctxt the schema validation context
*
* Check if any error was detected during validation.
*
- * Returns 1 if valid so far, 0 if errors were detected, and -1 in case
+ * @returns 1 if valid so far, 0 if errors were detected, and -1 in case
* of internal error.
*/
int
@@ -27723,13 +27472,12 @@ xmlSchemaIsValid(xmlSchemaValidCtxtPtr ctxt)
}
/**
- * xmlSchemaSetValidErrors:
- * @ctxt: a schema validation context
- * @err: the error function
- * @warn: the warning function
- * @ctx: the functions context
+ * @param ctxt a schema validation context
+ * @param err the error function
+ * @param warn the warning function
+ * @param ctx the functions context
*
- * DEPRECATED: Use xmlSchemaSetValidStructuredErrors.
+ * @deprecated Use xmlSchemaSetValidStructuredErrors.
*
* Set the error and warning callback information
*/
@@ -27748,10 +27496,9 @@ xmlSchemaSetValidErrors(xmlSchemaValidCtxtPtr ctxt,
}
/**
- * xmlSchemaSetValidStructuredErrors:
- * @ctxt: a schema validation context
- * @serror: the structured error function
- * @ctx: the functions context
+ * @param ctxt a schema validation context
+ * @param serror the structured error function
+ * @param ctx the functions context
*
* Set the structured error callback
*/
@@ -27770,15 +27517,14 @@ xmlSchemaSetValidStructuredErrors(xmlSchemaValidCtxtPtr ctxt,
}
/**
- * xmlSchemaGetValidErrors:
- * @ctxt: a XML-Schema validation context
- * @err: the error function result
- * @warn: the warning function result
- * @ctx: the functions context result
+ * @param ctxt a XML-Schema validation context
+ * @param err the error function result
+ * @param warn the warning function result
+ * @param ctx the functions context result
*
* Get the error and warning callback information
*
- * Returns -1 in case of error and 0 otherwise
+ * @returns -1 in case of error and 0 otherwise
*/
int
xmlSchemaGetValidErrors(xmlSchemaValidCtxtPtr ctxt,
@@ -27798,13 +27544,12 @@ xmlSchemaGetValidErrors(xmlSchemaValidCtxtPtr ctxt,
/**
- * xmlSchemaSetValidOptions:
- * @ctxt: a schema validation context
- * @options: a combination of xmlSchemaValidOption
+ * @param ctxt a schema validation context
+ * @param options a combination of xmlSchemaValidOption
*
* Sets the options to be used during the validation.
*
- * Returns 0 in case of success, -1 in case of an
+ * @returns 0 in case of success, -1 in case of an
* API error.
*/
int
@@ -27831,12 +27576,11 @@ xmlSchemaSetValidOptions(xmlSchemaValidCtxtPtr ctxt,
}
/**
- * xmlSchemaValidCtxtGetOptions:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* Get the validation context options.
*
- * Returns the option combination or -1 on error.
+ * @returns the option combination or -1 on error.
*/
int
xmlSchemaValidCtxtGetOptions(xmlSchemaValidCtxtPtr ctxt)
@@ -28132,13 +27876,12 @@ xmlSchemaVStart(xmlSchemaValidCtxtPtr vctxt)
}
/**
- * xmlSchemaValidateOneElement:
- * @ctxt: a schema validation context
- * @elem: an element node
+ * @param ctxt a schema validation context
+ * @param elem an element node
*
- * Validate a branch of a tree, starting with the given @elem.
+ * Validate a branch of a tree, starting with the given `elem`.
*
- * Returns 0 if the element and its subtree is valid, a positive error
+ * @returns 0 if the element and its subtree is valid, a positive error
* code number otherwise and -1 in case of an internal or API error.
*/
int
@@ -28157,13 +27900,12 @@ xmlSchemaValidateOneElement(xmlSchemaValidCtxtPtr ctxt, xmlNodePtr elem)
}
/**
- * xmlSchemaValidateDoc:
- * @ctxt: a schema validation context
- * @doc: a parsed document tree
+ * @param ctxt a schema validation context
+ * @param doc a parsed document tree
*
* Validate a document tree in memory.
*
- * Returns 0 if the document is schemas valid, a positive error code
+ * @returns 0 if the document is schemas valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
int
@@ -28527,16 +28269,15 @@ endElementNsSplit(void *ctx, const xmlChar * localname,
}
/**
- * xmlSchemaSAXPlug:
- * @ctxt: a schema validation context
- * @sax: a pointer to the original xmlSAXHandlerPtr
- * @user_data: a pointer to the original SAX user data pointer
+ * @param ctxt a schema validation context
+ * @param sax a pointer to the original xmlSAXHandlerPtr
+ * @param user_data a pointer to the original SAX user data pointer
*
* Plug a SAX based validation layer in a SAX parsing event flow.
- * The original @saxptr and @dataptr data are replaced by new pointers
+ * The original `saxptr` and `dataptr` data are replaced by new pointers
* but the calls to the original will be maintained.
*
- * Returns a pointer to a data structure needed to unplug the validation layer
+ * @returns a pointer to a data structure needed to unplug the validation layer
* or NULL in case of errors.
*/
xmlSchemaSAXPlugPtr
@@ -28673,13 +28414,12 @@ xmlSchemaSAXPlug(xmlSchemaValidCtxtPtr ctxt,
}
/**
- * xmlSchemaSAXUnplug:
- * @plug: a data structure returned by xmlSchemaSAXPlug
+ * @param plug a data structure returned by xmlSchemaSAXPlug
*
* Unplug a SAX based validation layer in a SAX parsing event flow.
* The original pointers used in the call are restored.
*
- * Returns 0 in case of success and -1 in case of failure.
+ * @returns 0 in case of success and -1 in case of failure.
*/
int
xmlSchemaSAXUnplug(xmlSchemaSAXPlugPtr plug)
@@ -28706,15 +28446,14 @@ xmlSchemaSAXUnplug(xmlSchemaSAXPlugPtr plug)
}
/**
- * xmlSchemaValidateSetLocator:
- * @vctxt: a schema validation context
- * @f: the locator function pointer
- * @ctxt: the locator context
+ * @param vctxt a schema validation context
+ * @param f the locator function pointer
+ * @param ctxt the locator context
*
* Allows to set a locator function to the validation context,
* which will be used to provide file and line information since
* those are not provided as part of the SAX validation flow
- * Setting @f to NULL disable the locator.
+ * Setting `f` to NULL disable the locator.
*/
void
@@ -28728,14 +28467,13 @@ xmlSchemaValidateSetLocator(xmlSchemaValidCtxtPtr vctxt,
}
/**
- * xmlSchemaValidateStreamLocator:
- * @ctx: the xmlTextReaderPtr used
- * @file: returned file information
- * @line: returned line information
+ * @param ctx the xmlTextReaderPtr used
+ * @param file returned file information
+ * @param line returned line information
*
* Internal locator function for the readers
*
- * Returns 0 in case the Schema validation could be (de)activated and
+ * @returns 0 in case the Schema validation could be (de)activated and
* -1 in case of error.
*/
static int
@@ -28763,11 +28501,10 @@ xmlSchemaValidateStreamLocator(void *ctx, const char **file,
}
/**
- * xmlSchemaValidateStreamInternal:
- * @ctxt: a schema validation context
- * @pctxt: a parser context
+ * @param ctxt a schema validation context
+ * @param pctxt a parser context
*
- * Returns 0 if the document is schemas valid, a positive error code
+ * @returns 0 if the document is schemas valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
static int
@@ -28812,18 +28549,17 @@ done:
}
/**
- * xmlSchemaValidateStream:
- * @ctxt: a schema validation context
- * @input: the input to use for reading the data
- * @enc: an optional encoding information
- * @sax: a SAX handler for the resulting events
- * @user_data: the context to provide to the SAX handler.
+ * @param ctxt a schema validation context
+ * @param input the input to use for reading the data
+ * @param enc an optional encoding information
+ * @param sax a SAX handler for the resulting events
+ * @param user_data the context to provide to the SAX handler.
*
* Validate an input based on a flow of SAX event from the parser
- * and forward the events to the @sax handler with the provided @user_data
- * the user provided @sax handler must be a SAX2 one.
+ * and forward the events to the `sax` handler with the provided `user_data`
+ * the user provided `sax` handler must be a SAX2 one.
*
- * Returns 0 if the document is schemas valid, a positive error code
+ * @returns 0 if the document is schemas valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
int
@@ -28882,15 +28618,14 @@ done:
}
/**
- * xmlSchemaValidateFile:
- * @ctxt: a schema validation context
- * @filename: the URI of the instance
- * @options: a future set of options, currently unused
+ * @param ctxt a schema validation context
+ * @param filename the URI of the instance
+ * @param options a future set of options, currently unused
*
* Do a schemas validation of the given resource, it will use the
* SAX streamable validation internally.
*
- * Returns 0 if the document is valid, a positive error code
+ * @returns 0 if the document is valid, a positive error code
* number otherwise and -1 in case of an internal or API error.
*/
int
@@ -28916,12 +28651,11 @@ xmlSchemaValidateFile(xmlSchemaValidCtxtPtr ctxt,
}
/**
- * xmlSchemaValidCtxtGetParserCtxt:
- * @ctxt: a schema validation context
+ * @param ctxt a schema validation context
*
* allow access to the parser context of the schema validation context
*
- * Returns the parser context of the schema validation context or NULL
+ * @returns the parser context of the schema validation context or NULL
* in case of error.
*/
xmlParserCtxtPtr
diff --git a/xmlschemastypes.c b/xmlschemastypes.c
index f7f601a9..d9ce6971 100644
--- a/xmlschemastypes.c
+++ b/xmlschemastypes.c
@@ -189,7 +189,6 @@ static xmlSchemaTypePtr xmlSchemaTypeNmtokensDef = NULL;
* *
************************************************************************/
/**
- * xmlSchemaTypeErrMemory:
*
* Handle an out of memory condition
*/
@@ -206,12 +205,11 @@ xmlSchemaTypeErrMemory(void)
************************************************************************/
/**
- * xmlSchemaNewValue:
- * @type: the value type
+ * @param type the value type
*
* Allocate a new simple type value
*
- * Returns a pointer to the new value or NULL in case of error
+ * @returns a pointer to the new value or NULL in case of error
*/
static xmlSchemaValPtr
xmlSchemaNewValue(xmlSchemaValType type) {
@@ -258,9 +256,8 @@ xmlSchemaNewMinLengthFacet(int value)
}
/*
- * xmlSchemaInitBasicType:
- * @name: the type name
- * @type: the value type associated
+ * @param name the type name
+ * @param type the value type associated
*
* Initialize one primitive built-in type
*/
@@ -366,11 +363,11 @@ xmlSchemaValDecimalGetSignificantDigitCount(const xmlSchemaValDecimal *decimal)
}
/**
- * @brief Compares two decimals
+ * `brief` Compares two decimals
*
- * @param lhs
- * @param rhs
- * @return positive value if lhs > rhs, negative if lhs < rhs, or 0 if lhs == rhs
+ * `param` lhs
+ * `param` rhs
+ * `return` positive value if lhs > rhs, negative if lhs < rhs, or 0 if lhs == rhs
*/
static int xmlSchemaValDecimalCompare(const xmlSchemaValDecimal *lhs, const xmlSchemaValDecimal *rhs)
{
@@ -482,7 +479,6 @@ xmlSchemaFreeTypeEntry(void *type, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlSchemaCleanupTypesInternal:
*
* Cleanup the default XML Schemas type library
*/
@@ -522,11 +518,10 @@ xmlSchemaCleanupTypesInternal(void) {
}
/*
- * xmlSchemaInitTypes:
*
* Initialize the default XML Schemas type library
*
- * Returns 0 on success, -1 on error.
+ * @returns 0 on success, -1 on error.
*/
int
xmlSchemaInitTypes(void)
@@ -868,9 +863,8 @@ error:
}
/**
- * xmlSchemaCleanupTypes:
*
- * DEPRECATED: This function will be made private. Call xmlCleanupParser
+ * @deprecated This function will be made private. Call xmlCleanupParser
* to free global state but see the warnings there. xmlCleanupParser
* should be only called once at program exit. In most cases, you don't
* have to call cleanup functions at all.
@@ -886,14 +880,13 @@ xmlSchemaCleanupTypes(void) {
}
/**
- * xmlSchemaIsBuiltInTypeFacet:
- * @type: the built-in type
- * @facetType: the facet type
+ * @param type the built-in type
+ * @param facetType the facet type
*
* Evaluates if a specific facet can be
* used in conjunction with a type.
*
- * Returns 1 if the facet can be used with the given built-in type,
+ * @returns 1 if the facet can be used with the given built-in type,
* 0 otherwise and -1 in case the type is not a built-in type.
*/
int
@@ -966,13 +959,12 @@ xmlSchemaIsBuiltInTypeFacet(xmlSchemaTypePtr type, int facetType)
}
/**
- * xmlSchemaGetBuiltInType:
- * @type: the type of the built in type
+ * @param type the type of the built in type
*
* Gives you the type struct for a built-in
* type by its type id.
*
- * Returns the type if found, NULL otherwise.
+ * @returns the type if found, NULL otherwise.
*/
xmlSchemaTypePtr
xmlSchemaGetBuiltInType(xmlSchemaValType type)
@@ -1080,13 +1072,12 @@ xmlSchemaGetBuiltInType(xmlSchemaValType type)
}
/**
- * xmlSchemaValueAppend:
- * @prev: the value
- * @cur: the value to be appended
+ * @param prev the value
+ * @param cur the value to be appended
*
* Appends a next sibling to a list of computed values.
*
- * Returns 0 if succeeded and -1 on API errors.
+ * @returns 0 if succeeded and -1 on API errors.
*/
int
xmlSchemaValueAppend(xmlSchemaValPtr prev, xmlSchemaValPtr cur) {
@@ -1098,12 +1089,11 @@ xmlSchemaValueAppend(xmlSchemaValPtr prev, xmlSchemaValPtr cur) {
}
/**
- * xmlSchemaValueGetNext:
- * @cur: the value
+ * @param cur the value
*
* Accessor for the next sibling of a list of computed values.
*
- * Returns the next value or NULL if there was none, or on
+ * @returns the next value or NULL if there was none, or on
* API errors.
*/
xmlSchemaValPtr
@@ -1115,12 +1105,11 @@ xmlSchemaValueGetNext(xmlSchemaValPtr cur) {
}
/**
- * xmlSchemaValueGetAsString:
- * @val: the value
+ * @param val the value
*
* Accessor for the string value of a computed value.
*
- * Returns the string value or NULL if there was none, or on
+ * @returns the string value or NULL if there was none, or on
* API errors.
*/
const xmlChar *
@@ -1149,12 +1138,11 @@ xmlSchemaValueGetAsString(xmlSchemaValPtr val)
}
/**
- * xmlSchemaValueGetAsBoolean:
- * @val: the value
+ * @param val the value
*
* Accessor for the boolean value of a computed value.
*
- * Returns 1 if true and 0 if false, or in case of an error. Hmm.
+ * @returns 1 if true and 0 if false, or in case of an error. Hmm.
*/
int
xmlSchemaValueGetAsBoolean(xmlSchemaValPtr val)
@@ -1165,9 +1153,8 @@ xmlSchemaValueGetAsBoolean(xmlSchemaValPtr val)
}
/**
- * xmlSchemaNewStringValue:
- * @type: the value type
- * @value: the value
+ * @param type the value type
+ * @param value the value
*
* Allocate a new simple type value. The type can be
* of XML_SCHEMAS_STRING.
@@ -1175,7 +1162,7 @@ xmlSchemaValueGetAsBoolean(xmlSchemaValPtr val)
* string based types. We need this for anySimpleType as well.
* The given value is consumed and freed with the struct.
*
- * Returns a pointer to the new value or NULL in case of error
+ * @returns a pointer to the new value or NULL in case of error
*/
xmlSchemaValPtr
xmlSchemaNewStringValue(xmlSchemaValType type,
@@ -1196,14 +1183,13 @@ xmlSchemaNewStringValue(xmlSchemaValType type,
}
/**
- * xmlSchemaNewNOTATIONValue:
- * @name: the notation name
- * @ns: the notation namespace name or NULL
+ * @param name the notation name
+ * @param ns the notation namespace name or NULL
*
* Allocate a new NOTATION value.
* The given values are consumed and freed with the struct.
*
- * Returns a pointer to the new value or NULL in case of error
+ * @returns a pointer to the new value or NULL in case of error
*/
xmlSchemaValPtr
xmlSchemaNewNOTATIONValue(const xmlChar *name,
@@ -1222,14 +1208,13 @@ xmlSchemaNewNOTATIONValue(const xmlChar *name,
}
/**
- * xmlSchemaNewQNameValue:
- * @namespaceName: the namespace name
- * @localName: the local name
+ * @param namespaceName the namespace name
+ * @param localName the local name
*
* Allocate a new QName value.
* The given values are consumed and freed with the struct.
*
- * Returns a pointer to the new value or NULL in case of an error.
+ * @returns a pointer to the new value or NULL in case of an error.
*/
xmlSchemaValPtr
xmlSchemaNewQNameValue(const xmlChar *namespaceName,
@@ -1247,8 +1232,7 @@ xmlSchemaNewQNameValue(const xmlChar *namespaceName,
}
/**
- * xmlSchemaFreeValue:
- * @value: the value to free
+ * @param value the value to free
*
* Cleanup the default XML Schemas type library
*/
@@ -1318,13 +1302,12 @@ xmlSchemaFreeValue(xmlSchemaValPtr value) {
}
/**
- * xmlSchemaGetPredefinedType:
- * @name: the type name
- * @ns: the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
+ * @param name the type name
+ * @param ns the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
*
* Lookup a type in the default XML Schemas type library
*
- * Returns the type if found, NULL otherwise
+ * @returns the type if found, NULL otherwise
*/
xmlSchemaTypePtr
xmlSchemaGetPredefinedType(const xmlChar *name, const xmlChar *ns) {
@@ -1337,12 +1320,11 @@ xmlSchemaGetPredefinedType(const xmlChar *name, const xmlChar *ns) {
}
/**
- * xmlSchemaGetBuiltInListSimpleTypeItemType:
- * @type: the built-in simple type.
+ * @param type the built-in simple type.
*
* Lookup function
*
- * Returns the item type of @type as defined by the built-in datatype
+ * @returns the item type of `type` as defined by the built-in datatype
* hierarchy of XML Schema Part 2: Datatypes, or NULL in case of an error.
*/
xmlSchemaTypePtr
@@ -1428,15 +1410,15 @@ static const long dayInLeapYearByMonth[12] =
/**
* _xmlSchemaParseGYear:
- * @dt: pointer to a date structure
- * @str: pointer to the string to analyze
+ * @param dt pointer to a date structure
+ * @param str pointer to the string to analyze
*
* Parses a xs:gYear without time zone and fills in the appropriate
- * field of the @dt structure. @str is updated to point just after the
- * xs:gYear. It is supposed that @dt->year is big enough to contain
+ * field of the `dt` structure. `str` is updated to point just after the
+ * xs:gYear. It is supposed that `dt`->year is big enough to contain
* the year.
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
_xmlSchemaParseGYear (xmlSchemaValDatePtr dt, const xmlChar **str) {
@@ -1484,14 +1466,14 @@ _xmlSchemaParseGYear (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* PARSE_2_DIGITS:
- * @num: the integer to fill in
- * @cur: an #xmlChar *
- * @invalid: an integer
+ * @param num the integer to fill in
+ * @param cur an \#xmlChar *
+ * @param invalid an integer
*
- * Parses a 2-digits integer and updates @num with the value. @cur is
+ * Parses a 2-digits integer and updates `num` with the value. `cur` is
* updated to point just after the integer.
- * In case of error, @invalid is set to %TRUE, values of @num and
- * @cur are undefined.
+ * In case of error, `invalid` is set to %TRUE, values of `num` and
+ * `cur` are undefined.
*/
#define PARSE_2_DIGITS(num, cur, invalid) \
if ((cur[0] < '0') || (cur[0] > '9') || \
@@ -1503,15 +1485,15 @@ _xmlSchemaParseGYear (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* PARSE_FLOAT:
- * @num: the double to fill in
- * @cur: an #xmlChar *
- * @invalid: an integer
+ * @param num the double to fill in
+ * @param cur an \#xmlChar *
+ * @param invalid an integer
*
- * Parses a float and updates @num with the value. @cur is
+ * Parses a float and updates `num` with the value. `cur` is
* updated to point just after the float. The float must have a
* 2-digits integer part and may or may not have a decimal part.
- * In case of error, @invalid is set to %TRUE, values of @num and
- * @cur are undefined.
+ * In case of error, `invalid` is set to %TRUE, values of `num` and
+ * `cur` are undefined.
*/
#define PARSE_FLOAT(num, cur, invalid) \
PARSE_2_DIGITS(num, cur, invalid); \
@@ -1529,14 +1511,14 @@ _xmlSchemaParseGYear (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* _xmlSchemaParseGMonth:
- * @dt: pointer to a date structure
- * @str: pointer to the string to analyze
+ * @param dt pointer to a date structure
+ * @param str pointer to the string to analyze
*
* Parses a xs:gMonth without time zone and fills in the appropriate
- * field of the @dt structure. @str is updated to point just after the
+ * field of the `dt` structure. `str` is updated to point just after the
* xs:gMonth.
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
_xmlSchemaParseGMonth (xmlSchemaValDatePtr dt, const xmlChar **str) {
@@ -1559,14 +1541,14 @@ _xmlSchemaParseGMonth (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* _xmlSchemaParseGDay:
- * @dt: pointer to a date structure
- * @str: pointer to the string to analyze
+ * @param dt pointer to a date structure
+ * @param str pointer to the string to analyze
*
* Parses a xs:gDay without time zone and fills in the appropriate
- * field of the @dt structure. @str is updated to point just after the
+ * field of the `dt` structure. `str` is updated to point just after the
* xs:gDay.
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
_xmlSchemaParseGDay (xmlSchemaValDatePtr dt, const xmlChar **str) {
@@ -1588,15 +1570,15 @@ _xmlSchemaParseGDay (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* _xmlSchemaParseTime:
- * @dt: pointer to a date structure
- * @str: pointer to the string to analyze
+ * @param dt pointer to a date structure
+ * @param str pointer to the string to analyze
*
* Parses a xs:time without time zone and fills in the appropriate
- * fields of the @dt structure. @str is updated to point just after the
+ * fields of the `dt` structure. `str` is updated to point just after the
* xs:time.
- * In case of error, values of @dt fields are undefined.
+ * In case of error, values of `dt` fields are undefined.
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
_xmlSchemaParseTime (xmlSchemaValDatePtr dt, const xmlChar **str) {
@@ -1640,14 +1622,14 @@ _xmlSchemaParseTime (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* _xmlSchemaParseTimeZone:
- * @dt: pointer to a date structure
- * @str: pointer to the string to analyze
+ * @param dt pointer to a date structure
+ * @param str pointer to the string to analyze
*
* Parses a time zone without time zone and fills in the appropriate
- * field of the @dt structure. @str is updated to point just after the
+ * field of the `dt` structure. `str` is updated to point just after the
* time zone.
*
- * Returns 0 or the error code
+ * @returns 0 or the error code
*/
static int
_xmlSchemaParseTimeZone (xmlSchemaValDatePtr dt, const xmlChar **str) {
@@ -1715,11 +1697,11 @@ _xmlSchemaParseTimeZone (xmlSchemaValDatePtr dt, const xmlChar **str) {
/**
* _xmlSchemaBase64Decode:
- * @ch: a character
+ * @param ch a character
*
* Converts a base64 encoded character to its base 64 value.
*
- * Returns 0-63 (value), 64 (pad), or -1 (not recognized)
+ * @returns 0-63 (value), 64 (pad), or -1 (not recognized)
*/
static int
_xmlSchemaBase64Decode (const xmlChar ch) {
@@ -1740,14 +1722,14 @@ _xmlSchemaBase64Decode (const xmlChar ch) {
/**
* PARSE_DIGITS:
- * @num: the integer to fill in
- * @cur: an #xmlChar *
- * @num_type: an integer flag
+ * @param num the integer to fill in
+ * @param cur an \#xmlChar *
+ * @param num_type an integer flag
*
- * Parses a digits integer and updates @num with the value. @cur is
+ * Parses a digits integer and updates `num` with the value. `cur` is
* updated to point just after the integer.
- * In case of error, @num_type is set to -1, values of @num and
- * @cur are undefined.
+ * In case of error, `num_type` is set to -1, values of `num` and
+ * `cur` are undefined.
*/
#define PARSE_DIGITS(num, cur, num_type) \
if ((*cur < '0') || (*cur > '9')) \
@@ -1760,16 +1742,16 @@ _xmlSchemaBase64Decode (const xmlChar ch) {
/**
* PARSE_NUM:
- * @num: the double to fill in
- * @cur: an #xmlChar *
- * @num_type: an integer flag
+ * @param num the double to fill in
+ * @param cur an \#xmlChar *
+ * @param num_type an integer flag
*
- * Parses a float or integer and updates @num with the value. @cur is
+ * Parses a float or integer and updates `num` with the value. `cur` is
* updated to point just after the number. If the number is a float,
- * then it must have an integer part and a decimal part; @num_type will
- * be set to 1. If there is no decimal part, @num_type is set to zero.
- * In case of error, @num_type is set to -1, values of @num and
- * @cur are undefined.
+ * then it must have an integer part and a decimal part; `num_type` will
+ * be set to 1. If there is no decimal part, `num_type` is set to zero.
+ * In case of error, `num_type` is set to -1, values of `num` and
+ * `cur` are undefined.
*/
#define PARSE_NUM(num, cur, num_type) \
num = 0; \
@@ -1789,16 +1771,15 @@ _xmlSchemaBase64Decode (const xmlChar ch) {
}
/**
- * xmlSchemaValidateDates:
- * @type: the expected type or XML_SCHEMAS_UNKNOWN
- * @dateTime: string to analyze
- * @val: the return computed value
- * @collapse: whether to collapse
+ * @param type the expected type or XML_SCHEMAS_UNKNOWN
+ * @param dateTime string to analyze
+ * @param val the return computed value
+ * @param collapse whether to collapse
*
- * Check that @dateTime conforms to the lexical space of one of the date types.
- * if true a value is computed and returned in @val.
+ * Check that `dateTime` conforms to the lexical space of one of the date types.
+ * if true a value is computed and returned in `val`.
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
static int
@@ -2013,16 +1994,15 @@ error:
}
/**
- * xmlSchemaValidateDuration:
- * @type: the predefined type
- * @duration: string to analyze
- * @val: the return computed value
- * @collapse: whether to collapse
+ * @param type the predefined type
+ * @param duration string to analyze
+ * @param val the return computed value
+ * @param collapse whether to collapse
*
- * Check that @duration conforms to the lexical space of the duration type.
- * if true a value is computed and returned in @val.
+ * Check that `duration` conforms to the lexical space of the duration type.
+ * if true a value is computed and returned in `val`.
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
static int
@@ -2188,12 +2168,11 @@ error:
}
/**
- * xmlSchemaStrip:
- * @value: a value
+ * @param value a value
*
* Removes the leading and ending spaces of a string
*
- * Returns the new string or NULL if no change was required.
+ * @returns the new string or NULL if no change was required.
*/
static xmlChar *
xmlSchemaStrip(const xmlChar *value) {
@@ -2212,12 +2191,11 @@ xmlSchemaStrip(const xmlChar *value) {
}
/**
- * xmlSchemaWhiteSpaceReplace:
- * @value: a value
+ * @param value a value
*
* Replaces 0xd, 0x9 and 0xa with a space.
*
- * Returns the new string or NULL if no change was required.
+ * @returns the new string or NULL if no change was required.
*/
xmlChar *
xmlSchemaWhiteSpaceReplace(const xmlChar *value) {
@@ -2247,12 +2225,11 @@ xmlSchemaWhiteSpaceReplace(const xmlChar *value) {
}
/**
- * xmlSchemaCollapseString:
- * @value: a value
+ * @param value a value
*
* Removes and normalize white spaces in the string
*
- * Returns the new string or NULL if no change was required.
+ * @returns the new string or NULL if no change was required.
*/
xmlChar *
xmlSchemaCollapseString(const xmlChar *value) {
@@ -2299,16 +2276,15 @@ xmlSchemaCollapseString(const xmlChar *value) {
}
/**
- * xmlSchemaValAtomicListNode:
- * @type: the predefined atomic type for a token in the list
- * @value: the list value to check
- * @ret: the return computed value
- * @node: the node containing the value
+ * @param type the predefined atomic type for a token in the list
+ * @param value the list value to check
+ * @param ret the return computed value
+ * @param node the node containing the value
*
* Check that a value conforms to the lexical space of the predefined
- * list type. if true a value is computed and returned in @ret.
+ * list type. if true a value is computed and returned in `ret`.
*
- * Returns the number of items if this validates, a negative error code
+ * @returns the number of items if this validates, a negative error code
* number otherwise
*/
static int
@@ -2369,13 +2345,12 @@ xmlSchemaValAtomicListNode(xmlSchemaTypePtr type, const xmlChar *value,
}
/**
- * xmlSchemaParseUInt:
- * @str: pointer to the string R/W
- * @val: pointer to the resulting decimal
+ * @param str pointer to the string R/W
+ * @param val pointer to the resulting decimal
*
* Parse an unsigned long into a decimal.
*
- * Returns the number of significant digits in the number or
+ * @returns the number of significant digits in the number or
* -1 if overflow of the capacity and -2 if it's not a number.
*/
static int xmlSchemaParseUInt(const xmlChar **str, xmlSchemaValDecimalPtr val) {
@@ -2418,12 +2393,12 @@ static int xmlSchemaParseUInt(const xmlChar **str, xmlSchemaValDecimalPtr val) {
/*
* xmlSchemaCheckLanguageType
- * @value: the value to check
+ * @param value the value to check
*
* Check that a value conforms to the lexical space of the language datatype.
* Must conform to [a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*
*
- * Returns 1 if this validates, 0 otherwise.
+ * @returns 1 if this validates, 0 otherwise.
*/
static int
xmlSchemaCheckLanguageType(const xmlChar* value) {
@@ -2455,22 +2430,21 @@ xmlSchemaCheckLanguageType(const xmlChar* value) {
}
/**
- * xmlSchemaValAtomicType:
- * @type: the predefined type
- * @value: the value to check
- * @val: the return computed value
- * @node: the node containing the value
- * @flags: flags to control the validation
- * @ws: whitespace value type
- * @normOnTheFly: whether to normalize on the fly
- * @applyNorm: whether to apply normalization
- * @createStringValue: whether to create a string value
+ * @param type the predefined type
+ * @param value the value to check
+ * @param val the return computed value
+ * @param node the node containing the value
+ * @param flags flags to control the validation
+ * @param ws whitespace value type
+ * @param normOnTheFly whether to normalize on the fly
+ * @param applyNorm whether to apply normalization
+ * @param createStringValue whether to create a string value
*
* Check that a value conforms to the lexical space of the atomic type.
- * if true a value is computed and returned in @val.
+ * if true a value is computed and returned in `val`.
* This checks the value space for list types as well (IDREFS, NMTOKENS).
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
static int
@@ -3642,16 +3616,15 @@ xmlSchemaValAtomicType(xmlSchemaTypePtr type, const xmlChar * value,
}
/**
- * xmlSchemaValPredefTypeNode:
- * @type: the predefined type
- * @value: the value to check
- * @val: the return computed value
- * @node: the node containing the value
+ * @param type the predefined type
+ * @param value the value to check
+ * @param val the return computed value
+ * @param node the node containing the value
*
* Check that a value conforms to the lexical space of the predefined type.
- * if true a value is computed and returned in @val.
+ * if true a value is computed and returned in `val`.
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -3662,17 +3635,16 @@ xmlSchemaValPredefTypeNode(xmlSchemaTypePtr type, const xmlChar *value,
}
/**
- * xmlSchemaValPredefTypeNodeNoNorm:
- * @type: the predefined type
- * @value: the value to check
- * @val: the return computed value
- * @node: the node containing the value
+ * @param type the predefined type
+ * @param value the value to check
+ * @param val the return computed value
+ * @param node the node containing the value
*
* Check that a value conforms to the lexical space of the predefined type.
- * if true a value is computed and returned in @val.
+ * if true a value is computed and returned in `val`.
* This one does apply any normalization to the value.
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -3683,15 +3655,14 @@ xmlSchemaValPredefTypeNodeNoNorm(xmlSchemaTypePtr type, const xmlChar *value,
}
/**
- * xmlSchemaValidatePredefinedType:
- * @type: the predefined type
- * @value: the value to check
- * @val: the return computed value
+ * @param type the predefined type
+ * @param value the value to check
+ * @param val the return computed value
*
* Check that a value conforms to the lexical space of the predefined type.
- * if true a value is computed and returned in @val.
+ * if true a value is computed and returned in `val`.
*
- * Returns 0 if this validates, a positive error code number otherwise
+ * @returns 0 if this validates, a positive error code number otherwise
* and -1 in case of internal or API error.
*/
int
@@ -3701,13 +3672,12 @@ xmlSchemaValidatePredefinedType(xmlSchemaTypePtr type, const xmlChar *value,
}
/**
- * xmlSchemaCompareDecimals:
- * @x: a first decimal value
- * @y: a second decimal value
+ * @param x a first decimal value
+ * @param y a second decimal value
*
* Compare 2 decimals
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y and -2 in case of error
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y and -2 in case of error
*/
static int
xmlSchemaCompareDecimals(xmlSchemaValPtr x, xmlSchemaValPtr y)
@@ -3725,13 +3695,12 @@ xmlSchemaCompareDecimals(xmlSchemaValPtr x, xmlSchemaValPtr y)
}
/**
- * xmlSchemaCompareDurations:
- * @x: a first duration value
- * @y: a second duration value
+ * @param x a first duration value
+ * @param y a second duration value
*
* Compare 2 durations
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
* case of error
*/
static int
@@ -3827,13 +3796,12 @@ xmlSchemaCompareDurations(xmlSchemaValPtr x, xmlSchemaValPtr y)
#define MODULO_RANGE(a,low,high) ((MODULO((a-low),(high-low)))+low)
/**
- * xmlSchemaDupVal:
- * @v: the #xmlSchemaValPtr value to duplicate
+ * @param v the \#xmlSchemaValPtr value to duplicate
*
- * Makes a copy of @v. The calling program is responsible for freeing
+ * Makes a copy of `v`. The calling program is responsible for freeing
* the returned value.
*
- * returns a pointer to a duplicated #xmlSchemaValPtr or NULL if error.
+ * @returns a pointer to a duplicated \#xmlSchemaValPtr or NULL if error.
*/
static xmlSchemaValPtr
xmlSchemaDupVal (xmlSchemaValPtr v)
@@ -3848,12 +3816,11 @@ xmlSchemaDupVal (xmlSchemaValPtr v)
}
/**
- * xmlSchemaCopyValue:
- * @val: the precomputed value to be copied
+ * @param val the precomputed value to be copied
*
* Copies the precomputed value. This duplicates any string within.
*
- * Returns the copy or NULL if a copy for a data-type is not implemented.
+ * @returns the copy or NULL if a copy for a data-type is not implemented.
*/
xmlSchemaValPtr
xmlSchemaCopyValue(xmlSchemaValPtr val)
@@ -3942,15 +3909,15 @@ xmlSchemaCopyValue(xmlSchemaValPtr val)
/**
* _xmlSchemaDateAdd:
- * @dt: an #xmlSchemaValPtr
- * @dur: an #xmlSchemaValPtr of type #XS_DURATION
+ * @param dt an \#xmlSchemaValPtr
+ * @param dur an \#xmlSchemaValPtr of type \#XS_DURATION
*
- * Compute a new date/time from @dt and @dur. This function assumes @dt
- * is either #XML_SCHEMAS_DATETIME, #XML_SCHEMAS_DATE, #XML_SCHEMAS_GYEARMONTH,
- * or #XML_SCHEMAS_GYEAR. The returned #xmlSchemaVal is the same type as
- * @dt. The calling program is responsible for freeing the returned value.
+ * Compute a new date/time from `dt` and `dur`. This function assumes `dt`
+ * is either \#XML_SCHEMAS_DATETIME, \#XML_SCHEMAS_DATE, \#XML_SCHEMAS_GYEARMONTH,
+ * or \#XML_SCHEMAS_GYEAR. The returned \#xmlSchemaVal is the same type as
+ * `dt`. The calling program is responsible for freeing the returned value.
*
- * Returns a pointer to a new #xmlSchemaVal or NULL if error.
+ * @returns a pointer to a new \#xmlSchemaVal or NULL if error.
*/
static xmlSchemaValPtr
_xmlSchemaDateAdd (xmlSchemaValPtr dt, xmlSchemaValPtr dur)
@@ -4096,14 +4063,13 @@ _xmlSchemaDateAdd (xmlSchemaValPtr dt, xmlSchemaValPtr dur)
}
/**
- * xmlSchemaDateNormalize:
- * @dt: an #xmlSchemaValPtr of a date/time type value.
- * @offset: number of seconds to adjust @dt by.
+ * @param dt an \#xmlSchemaValPtr of a date/time type value.
+ * @param offset number of seconds to adjust `dt` by.
*
- * Normalize @dt to GMT time. The @offset parameter is subtracted from
- * the return value is a time-zone offset is present on @dt.
+ * Normalize `dt` to GMT time. The `offset` parameter is subtracted from
+ * the return value is a time-zone offset is present on `dt`.
*
- * Returns a normalized copy of @dt or NULL if error.
+ * @returns a normalized copy of `dt` or NULL if error.
*/
static xmlSchemaValPtr
xmlSchemaDateNormalize (xmlSchemaValPtr dt, double offset)
@@ -4137,14 +4103,14 @@ xmlSchemaDateNormalize (xmlSchemaValPtr dt, double offset)
/**
* _xmlSchemaDateCastYMToDays:
- * @dt: an #xmlSchemaValPtr
+ * @param dt an \#xmlSchemaValPtr
*
- * Convert mon and year of @dt to total number of days. Take the
+ * Convert mon and year of `dt` to total number of days. Take the
* number of years since (or before) 1 AD and add the number of leap
* years. This is a function because negative
* years must be handled a little differently and there is no zero year.
*
- * Returns number of days.
+ * @returns number of days.
*/
static long
_xmlSchemaDateCastYMToDays (const xmlSchemaValPtr dt)
@@ -4171,11 +4137,11 @@ _xmlSchemaDateCastYMToDays (const xmlSchemaValPtr dt)
/**
* TIME_TO_NUMBER:
- * @dt: an #xmlSchemaValPtr
+ * @param dt an \#xmlSchemaValPtr
*
- * Calculates the number of seconds in the time portion of @dt.
+ * Calculates the number of seconds in the time portion of `dt`.
*
- * Returns seconds.
+ * @returns seconds.
*/
#define TIME_TO_NUMBER(dt) \
((double)((dt->value.date.hour * SECS_PER_HOUR) + \
@@ -4184,13 +4150,12 @@ _xmlSchemaDateCastYMToDays (const xmlSchemaValPtr dt)
dt->value.date.sec)
/**
- * xmlSchemaCompareDates:
- * @x: a first date/time value
- * @y: a second date/time value
+ * @param x a first date/time value
+ * @param y a second date/time value
*
* Compare 2 date/times
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
* case of error
*/
static int
@@ -4477,17 +4442,16 @@ xmlSchemaCompareDates (xmlSchemaValPtr x, xmlSchemaValPtr y)
}
/**
- * xmlSchemaComparePreserveReplaceStrings:
- * @x: a first string value
- * @y: a second string value
- * @invert: inverts the result if x < y or x > y.
+ * @param x a first string value
+ * @param y a second string value
+ * @param invert inverts the result if x < y or x > y.
*
* Compare 2 string for their normalized values.
- * @x is a string with whitespace of "preserve", @y is
- * a string with a whitespace of "replace". I.e. @x could
- * be an "xsd:string" and @y an "xsd:normalizedString".
+ * `x` is a string with whitespace of "preserve", `y` is
+ * a string with a whitespace of "replace". I.e. `x` could
+ * be an "xsd:string" and `y` an "xsd:normalizedString".
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
* case of error
*/
static int
@@ -4546,17 +4510,16 @@ xmlSchemaComparePreserveReplaceStrings(const xmlChar *x,
}
/**
- * xmlSchemaComparePreserveCollapseStrings:
- * @x: a first string value
- * @y: a second string value
- * @invert: whether to invert
+ * @param x a first string value
+ * @param y a second string value
+ * @param invert whether to invert
*
* Compare 2 string for their normalized values.
- * @x is a string with whitespace of "preserve", @y is
- * a string with a whitespace of "collapse". I.e. @x could
- * be an "xsd:string" and @y an "xsd:normalizedString".
+ * `x` is a string with whitespace of "preserve", `y` is
+ * a string with a whitespace of "collapse". I.e. `x` could
+ * be an "xsd:string" and `y` an "xsd:normalizedString".
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
* case of error
*/
static int
@@ -4636,17 +4599,16 @@ xmlSchemaComparePreserveCollapseStrings(const xmlChar *x,
}
/**
- * xmlSchemaComparePreserveCollapseStrings:
- * @x: a first string value
- * @y: a second string value
- * @invert: whether to invert
+ * @param x a first string value
+ * @param y a second string value
+ * @param invert whether to invert
*
* Compare 2 string for their normalized values.
- * @x is a string with whitespace of "preserve", @y is
- * a string with a whitespace of "collapse". I.e. @x could
- * be an "xsd:string" and @y an "xsd:normalizedString".
+ * `x` is a string with whitespace of "preserve", `y` is
+ * a string with a whitespace of "collapse". I.e. `x` could
+ * be an "xsd:string" and `y` an "xsd:normalizedString".
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
* case of error
*/
static int
@@ -4735,13 +4697,12 @@ xmlSchemaCompareReplaceCollapseStrings(const xmlChar *x,
/**
- * xmlSchemaCompareReplacedStrings:
- * @x: a first string value
- * @y: a second string value
+ * @param x a first string value
+ * @param y a second string value
*
* Compare 2 string for their normalized values.
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
* case of error
*/
static int
@@ -4782,13 +4743,12 @@ xmlSchemaCompareReplacedStrings(const xmlChar *x,
}
/**
- * xmlSchemaCompareNormStrings:
- * @x: a first string value
- * @y: a second string value
+ * @param x a first string value
+ * @param y a second string value
*
* Compare 2 string for their normalized values.
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, and -2 in
* case of error
*/
static int
@@ -4828,13 +4788,12 @@ xmlSchemaCompareNormStrings(const xmlChar *x,
}
/**
- * xmlSchemaCompareFloats:
- * @x: a first float or double value
- * @y: a second float or double value
+ * @param x a first float or double value
+ * @param y a second float or double value
*
* Compare 2 values
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
* case of error
*/
static int
@@ -4887,19 +4846,18 @@ xmlSchemaCompareFloats(xmlSchemaValPtr x, xmlSchemaValPtr y) {
}
/**
- * xmlSchemaCompareValues:
- * @xtype: first type
- * @x: a first value
- * @xvalue: the first value as a string (optional)
- * @xws: the whitespace type
- * @ytype: second type
- * @y: a second value
- * @yvalue: the second value as a string (optional)
- * @yws: the whitespace type
+ * @param xtype first type
+ * @param x a first value
+ * @param xvalue the first value as a string (optional)
+ * @param xws the whitespace type
+ * @param ytype second type
+ * @param y a second value
+ * @param yvalue the second value as a string (optional)
+ * @param yws the whitespace type
*
* Compare 2 values
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, 3 if not
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, 3 if not
* comparable and -2 in case of error
*/
static int
@@ -5139,13 +5097,12 @@ xmlSchemaCompareValuesInternal(xmlSchemaValType xtype,
}
/**
- * xmlSchemaCompareValues:
- * @x: a first value
- * @y: a second value
+ * @param x a first value
+ * @param y a second value
*
* Compare 2 values
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
* case of error
*/
int
@@ -5173,15 +5130,14 @@ xmlSchemaCompareValues(xmlSchemaValPtr x, xmlSchemaValPtr y) {
}
/**
- * xmlSchemaCompareValuesWhtsp:
- * @x: a first value
- * @xws: the whitespace value of x
- * @y: a second value
- * @yws: the whitespace value of y
+ * @param x a first value
+ * @param xws the whitespace value of x
+ * @param y a second value
+ * @param yws the whitespace value of y
*
* Compare 2 values
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
* case of error
*/
int
@@ -5197,19 +5153,18 @@ xmlSchemaCompareValuesWhtsp(xmlSchemaValPtr x,
}
/**
- * xmlSchemaCompareValuesWhtspExt:
- * @xtype: first type
- * @x: a first value
- * @xvalue: the first value as a string (optional)
- * @xws: the whitespace type
- * @ytype: second type
- * @y: a second value
- * @yvalue: the second value as a string (optional)
- * @yws: the whitespace type
+ * @param xtype first type
+ * @param x a first value
+ * @param xvalue the first value as a string (optional)
+ * @param xws the whitespace type
+ * @param ytype second type
+ * @param y a second value
+ * @param yvalue the second value as a string (optional)
+ * @param yws the whitespace type
*
* Compare 2 values
*
- * Returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
+ * @returns -1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
* case of error
*/
static int
@@ -5227,12 +5182,11 @@ xmlSchemaCompareValuesWhtspExt(xmlSchemaValType xtype,
}
/**
- * xmlSchemaNormLen:
- * @value: a string
+ * @param value a string
*
* Computes the UTF8 length of the normalized value of the string
*
- * Returns the length or -1 in case of error.
+ * @returns the length or -1 in case of error.
*/
static int
xmlSchemaNormLen(const xmlChar *value) {
@@ -5273,12 +5227,11 @@ xmlSchemaNormLen(const xmlChar *value) {
}
/**
- * xmlSchemaGetFacetValueAsULong:
- * @facet: an schemas type facet
+ * @param facet an schemas type facet
*
* Extract the value of a facet
*
- * Returns the value as a long
+ * @returns the value as a long
*/
unsigned long
xmlSchemaGetFacetValueAsULong(xmlSchemaFacetPtr facet)
@@ -5293,15 +5246,14 @@ xmlSchemaGetFacetValueAsULong(xmlSchemaFacetPtr facet)
}
/**
- * xmlSchemaValidateListSimpleTypeFacet:
- * @facet: the facet to check
- * @value: the lexical repr of the value to validate
- * @actualLen: the number of list items
- * @expectedLen: the resulting expected number of list items
+ * @param facet the facet to check
+ * @param value the lexical repr of the value to validate
+ * @param actualLen the number of list items
+ * @param expectedLen the resulting expected number of list items
*
* Checks the value of a list simple type against a facet.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* number otherwise and -1 in case of an internal error.
*/
int
@@ -5345,18 +5297,17 @@ xmlSchemaValidateListSimpleTypeFacet(xmlSchemaFacetPtr facet,
}
/**
- * xmlSchemaValidateLengthFacet:
- * @facet: the facet to check
- * @valType: the built-in type
- * @value: the lexical repr. of the value to be validated
- * @val: the precomputed value
- * @length: the actual length of the value
- * @ws: the whitespace type of the value
+ * @param facet the facet to check
+ * @param valType the built-in type
+ * @param value the lexical repr. of the value to be validated
+ * @param val the precomputed value
+ * @param length the actual length of the value
+ * @param ws the whitespace type of the value
*
* Checka a value against a "length", "minLength" and "maxLength"
- * facet; sets @length to the computed length of @value.
+ * facet; sets `length` to the computed length of `value`.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* otherwise and -1 in case of an internal or API error.
*/
static int
@@ -5462,17 +5413,16 @@ xmlSchemaValidateLengthFacetInternal(xmlSchemaFacetPtr facet,
}
/**
- * xmlSchemaValidateLengthFacet:
- * @type: the built-in type
- * @facet: the facet to check
- * @value: the lexical repr. of the value to be validated
- * @val: the precomputed value
- * @length: the actual length of the value
+ * @param type the built-in type
+ * @param facet the facet to check
+ * @param value the lexical repr. of the value to be validated
+ * @param val the precomputed value
+ * @param length the actual length of the value
*
* Checka a value against a "length", "minLength" and "maxLength"
- * facet; sets @length to the computed length of @value.
+ * facet; sets `length` to the computed length of `value`.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* otherwise and -1 in case of an internal or API error.
*/
int
@@ -5490,18 +5440,17 @@ xmlSchemaValidateLengthFacet(xmlSchemaTypePtr type,
}
/**
- * xmlSchemaValidateLengthFacetWhtsp:
- * @facet: the facet to check
- * @valType: the built-in type
- * @value: the lexical repr. of the value to be validated
- * @val: the precomputed value
- * @ws: the whitespace type of the value
- * @length: the actual length of the value
+ * @param facet the facet to check
+ * @param valType the built-in type
+ * @param value the lexical repr. of the value to be validated
+ * @param val the precomputed value
+ * @param ws the whitespace type of the value
+ * @param length the actual length of the value
*
* Checka a value against a "length", "minLength" and "maxLength"
- * facet; sets @length to the computed length of @value.
+ * facet; sets `length` to the computed length of `value`.
*
- * Returns 0 if the value is valid, a positive error code
+ * @returns 0 if the value is valid, a positive error code
* otherwise and -1 in case of an internal or API error.
*/
int
@@ -5517,17 +5466,16 @@ xmlSchemaValidateLengthFacetWhtsp(xmlSchemaFacetPtr facet,
}
/**
- * xmlSchemaValidateFacetInternal:
- * @facet: the facet to check
- * @fws: the whitespace type of the facet's value
- * @valType: the built-in type of the value
- * @value: the lexical repr of the value to validate
- * @val: the precomputed value
- * @ws: the whitespace type of the value
+ * @param facet the facet to check
+ * @param fws the whitespace type of the facet's value
+ * @param valType the built-in type of the value
+ * @param value the lexical repr of the value to validate
+ * @param val the precomputed value
+ * @param ws the whitespace type of the value
*
* Check a value against a facet condition
*
- * Returns 0 if the element is schemas valid, a positive error code
+ * @returns 0 if the element is schemas valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
static int
@@ -5753,15 +5701,14 @@ xmlSchemaValidateFacetInternal(xmlSchemaFacetPtr facet,
}
/**
- * xmlSchemaValidateFacet:
- * @base: the base type
- * @facet: the facet to check
- * @value: the lexical repr of the value to validate
- * @val: the precomputed value
+ * @param base the base type
+ * @param facet the facet to check
+ * @param value the lexical repr of the value to validate
+ * @param val the precomputed value
*
* Check a value against a facet condition
*
- * Returns 0 if the element is schemas valid, a positive error code
+ * @returns 0 if the element is schemas valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
int
@@ -5787,20 +5734,19 @@ xmlSchemaValidateFacet(xmlSchemaTypePtr base,
}
/**
- * xmlSchemaValidateFacetWhtsp:
- * @facet: the facet to check
- * @fws: the whitespace type of the facet's value
- * @valType: the built-in type of the value
- * @value: the lexical (or normalized for pattern) repr of the value to validate
- * @val: the precomputed value
- * @ws: the whitespace type of the value
+ * @param facet the facet to check
+ * @param fws the whitespace type of the facet's value
+ * @param valType the built-in type of the value
+ * @param value the lexical (or normalized for pattern) repr of the value to validate
+ * @param val the precomputed value
+ * @param ws the whitespace type of the value
*
* Check a value against a facet condition. This takes value normalization
* according to the specified whitespace types into account.
- * Note that @value needs to be the *normalized* value if the facet
+ * Note that `value` needs to be the *normalized* value if the facet
* is of type "pattern".
*
- * Returns 0 if the element is schemas valid, a positive error code
+ * @returns 0 if the element is schemas valid, a positive error code
* number otherwise and -1 in case of internal or API error.
*/
int
@@ -5816,22 +5762,21 @@ xmlSchemaValidateFacetWhtsp(xmlSchemaFacetPtr facet,
}
/**
- * xmlSchemaGetCanonValue:
- * @val: the precomputed value
- * @retValue: the returned value
+ * @param val the precomputed value
+ * @param retValue the returned value
*
* Get the canonical lexical representation of the value.
* The caller has to FREE the returned retValue.
*
* WARNING: Some value types are not supported yet, resulting
- * in a @retValue of "???".
+ * in a `retValue` of "???".
*
* TODO: XML Schema 1.0 does not define canonical representations
* for: duration, gYearMonth, gYear, gMonthDay, gMonth, gDay,
* anyURI, QName, NOTATION. This will be fixed in XML Schema 1.1.
*
*
- * Returns 0 if the value could be built, 1 if the value type is
+ * @returns 0 if the value could be built, 1 if the value type is
* not supported yet and -1 in case of API errors.
*/
int
@@ -6155,15 +6100,14 @@ xmlSchemaGetCanonValue(xmlSchemaValPtr val, const xmlChar **retValue)
}
/**
- * xmlSchemaGetCanonValueWhtsp:
- * @val: the precomputed value
- * @retValue: the returned value
- * @ws: the whitespace type of the value
+ * @param val the precomputed value
+ * @param retValue the returned value
+ * @param ws the whitespace type of the value
*
* Get the canonical representation of the value.
- * The caller has to free the returned @retValue.
+ * The caller has to free the returned `retValue`.
*
- * Returns 0 if the value could be built, 1 if the value type is
+ * @returns 0 if the value could be built, 1 if the value type is
* not supported yet and -1 in case of API errors.
*/
int
@@ -6208,12 +6152,11 @@ xmlSchemaGetCanonValueWhtsp(xmlSchemaValPtr val,
}
/**
- * xmlSchemaGetValType:
- * @val: a schemas value
+ * @param val a schemas value
*
* Accessor for the type of a value
*
- * Returns the xmlSchemaValType of the value
+ * @returns the xmlSchemaValType of the value
*/
xmlSchemaValType
xmlSchemaGetValType(xmlSchemaValPtr val)
diff --git a/xmlstring.c b/xmlstring.c
index c8f7e3fd..9e05aeb2 100644
--- a/xmlstring.c
+++ b/xmlstring.c
@@ -40,13 +40,12 @@
************************************************************************/
/**
- * xmlStrndup:
- * @cur: the input xmlChar *
- * @len: the len of @cur
+ * @param cur the input xmlChar *
+ * @param len the len of `cur`
*
* a strndup for array of xmlChar's
*
- * Returns a new xmlChar * or NULL
+ * @returns a new xmlChar * or NULL
*/
xmlChar *
xmlStrndup(const xmlChar *cur, int len) {
@@ -63,14 +62,13 @@ xmlStrndup(const xmlChar *cur, int len) {
}
/**
- * xmlStrdup:
- * @cur: the input xmlChar *
+ * @param cur the input xmlChar *
*
* a strdup for array of xmlChar's. Since they are supposed to be
* encoded in UTF-8 or an encoding with 8bit based chars, we assume
* a termination mark of '0'.
*
- * Returns a new xmlChar * or NULL
+ * @returns a new xmlChar * or NULL
*/
xmlChar *
xmlStrdup(const xmlChar *cur) {
@@ -82,13 +80,12 @@ xmlStrdup(const xmlChar *cur) {
}
/**
- * xmlCharStrndup:
- * @cur: the input char *
- * @len: the len of @cur
+ * @param cur the input char *
+ * @param len the len of `cur`
*
* a strndup for char's to xmlChar's
*
- * Returns a new xmlChar * or NULL
+ * @returns a new xmlChar * or NULL
*/
xmlChar *
@@ -111,12 +108,11 @@ xmlCharStrndup(const char *cur, int len) {
}
/**
- * xmlCharStrdup:
- * @cur: the input char *
+ * @param cur the input char *
*
* a strdup for char's to xmlChar's
*
- * Returns a new xmlChar * or NULL
+ * @returns a new xmlChar * or NULL
*/
xmlChar *
@@ -129,13 +125,12 @@ xmlCharStrdup(const char *cur) {
}
/**
- * xmlStrcmp:
- * @str1: the first xmlChar *
- * @str2: the second xmlChar *
+ * @param str1 the first xmlChar *
+ * @param str2 the second xmlChar *
*
* a strcmp for xmlChar's
*
- * Returns the integer result of the comparison
+ * @returns the integer result of the comparison
*/
int
@@ -155,14 +150,13 @@ xmlStrcmp(const xmlChar *str1, const xmlChar *str2) {
}
/**
- * xmlStrEqual:
- * @str1: the first xmlChar *
- * @str2: the second xmlChar *
+ * @param str1 the first xmlChar *
+ * @param str2 the second xmlChar *
*
* Check if both strings are equal of have same content.
* Should be a bit more readable and faster than xmlStrcmp()
*
- * Returns 1 if they are equal, 0 if they are different
+ * @returns 1 if they are equal, 0 if they are different
*/
int
@@ -181,14 +175,13 @@ xmlStrEqual(const xmlChar *str1, const xmlChar *str2) {
}
/**
- * xmlStrQEqual:
- * @pref: the prefix of the QName
- * @name: the localname of the QName
- * @str: the second xmlChar *
+ * @param pref the prefix of the QName
+ * @param name the localname of the QName
+ * @param str the second xmlChar *
*
* Check if a QName is Equal to a given string
*
- * Returns 1 if they are equal, 0 if they are different
+ * @returns 1 if they are equal, 0 if they are different
*/
int
@@ -208,14 +201,13 @@ xmlStrQEqual(const xmlChar *pref, const xmlChar *name, const xmlChar *str) {
}
/**
- * xmlStrncmp:
- * @str1: the first xmlChar *
- * @str2: the second xmlChar *
- * @len: the max comparison length
+ * @param str1 the first xmlChar *
+ * @param str2 the second xmlChar *
+ * @param len the max comparison length
*
* a strncmp for xmlChar's
*
- * Returns the integer result of the comparison
+ * @returns the integer result of the comparison
*/
int
@@ -271,13 +263,12 @@ static const xmlChar casemap[256] = {
};
/**
- * xmlStrcasecmp:
- * @str1: the first xmlChar *
- * @str2: the second xmlChar *
+ * @param str1 the first xmlChar *
+ * @param str2 the second xmlChar *
*
* a strcasecmp for xmlChar's
*
- * Returns the integer result of the comparison
+ * @returns the integer result of the comparison
*/
int
@@ -295,14 +286,13 @@ xmlStrcasecmp(const xmlChar *str1, const xmlChar *str2) {
}
/**
- * xmlStrncasecmp:
- * @str1: the first xmlChar *
- * @str2: the second xmlChar *
- * @len: the max comparison length
+ * @param str1 the first xmlChar *
+ * @param str2 the second xmlChar *
+ * @param len the max comparison length
*
* a strncasecmp for xmlChar's
*
- * Returns the integer result of the comparison
+ * @returns the integer result of the comparison
*/
int
@@ -321,13 +311,12 @@ xmlStrncasecmp(const xmlChar *str1, const xmlChar *str2, int len) {
}
/**
- * xmlStrchr:
- * @str: the xmlChar * array
- * @val: the xmlChar to search
+ * @param str the xmlChar * array
+ * @param val the xmlChar to search
*
* a strchr for xmlChar's
*
- * Returns the xmlChar * for the first occurrence or NULL.
+ * @returns the xmlChar * for the first occurrence or NULL.
*/
const xmlChar *
@@ -341,13 +330,12 @@ xmlStrchr(const xmlChar *str, xmlChar val) {
}
/**
- * xmlStrstr:
- * @str: the xmlChar * array (haystack)
- * @val: the xmlChar to search (needle)
+ * @param str the xmlChar * array (haystack)
+ * @param val the xmlChar to search (needle)
*
* a strstr for xmlChar's
*
- * Returns the xmlChar * for the first occurrence or NULL.
+ * @returns the xmlChar * for the first occurrence or NULL.
*/
const xmlChar *
@@ -369,13 +357,12 @@ xmlStrstr(const xmlChar *str, const xmlChar *val) {
}
/**
- * xmlStrcasestr:
- * @str: the xmlChar * array (haystack)
- * @val: the xmlChar to search (needle)
+ * @param str the xmlChar * array (haystack)
+ * @param val the xmlChar to search (needle)
*
* a case-ignoring strstr for xmlChar's
*
- * Returns the xmlChar * for the first occurrence or NULL.
+ * @returns the xmlChar * for the first occurrence or NULL.
*/
const xmlChar *
@@ -396,14 +383,13 @@ xmlStrcasestr(const xmlChar *str, const xmlChar *val) {
}
/**
- * xmlStrsub:
- * @str: the xmlChar * array (haystack)
- * @start: the index of the first char (zero based)
- * @len: the length of the substring
+ * @param str the xmlChar * array (haystack)
+ * @param start the index of the first char (zero based)
+ * @param len the length of the substring
*
* Extract a substring of a given string
*
- * Returns the xmlChar * for the first occurrence or NULL.
+ * @returns the xmlChar * for the first occurrence or NULL.
*/
xmlChar *
@@ -423,12 +409,11 @@ xmlStrsub(const xmlChar *str, int start, int len) {
}
/**
- * xmlStrlen:
- * @str: the xmlChar * array
+ * @param str the xmlChar * array
*
* length of a xmlChar's string
*
- * Returns the number of xmlChar contained in the ARRAY.
+ * @returns the number of xmlChar contained in the ARRAY.
*/
int
@@ -438,16 +423,15 @@ xmlStrlen(const xmlChar *str) {
}
/**
- * xmlStrncat:
- * @cur: the original xmlChar * array
- * @add: the xmlChar * array added
- * @len: the length of @add
+ * @param cur the original xmlChar * array
+ * @param add the xmlChar * array added
+ * @param len the length of `add`
*
- * a strncat for array of xmlChar's, it will extend @cur with the len
- * first bytes of @add. Note that if @len < 0 then this is an API error
+ * a strncat for array of xmlChar's, it will extend `cur` with the len
+ * first bytes of `add`. Note that if `len` < 0 then this is an API error
* and NULL will be returned.
*
- * Returns a new xmlChar *, the original @cur is reallocated and should
+ * @returns a new xmlChar *, the original `cur` is reallocated and should
* not be freed.
*/
@@ -477,16 +461,15 @@ xmlStrncat(xmlChar *cur, const xmlChar *add, int len) {
}
/**
- * xmlStrncatNew:
- * @str1: first xmlChar string
- * @str2: second xmlChar string
- * @len: the len of @str2 or < 0
+ * @param str1 first xmlChar string
+ * @param str2 second xmlChar string
+ * @param len the len of `str2` or < 0
*
* same as xmlStrncat, but creates a new string. The original
- * two strings are not freed. If @len is < 0 then the length
+ * two strings are not freed. If `len` is < 0 then the length
* will be calculated automatically.
*
- * Returns a new xmlChar * or NULL
+ * @returns a new xmlChar * or NULL
*/
xmlChar *
xmlStrncatNew(const xmlChar *str1, const xmlChar *str2, int len) {
@@ -516,16 +499,15 @@ xmlStrncatNew(const xmlChar *str1, const xmlChar *str2, int len) {
}
/**
- * xmlStrcat:
- * @cur: the original xmlChar * array
- * @add: the xmlChar * array added
+ * @param cur the original xmlChar * array
+ * @param add the xmlChar * array added
*
* a strcat for array of xmlChar's. Since they are supposed to be
* encoded in UTF-8 or an encoding with 8bit based chars, we assume
* a termination mark of '0'.
*
- * Returns a new xmlChar * containing the concatenated string. The original
- * @cur is reallocated and should not be freed.
+ * @returns a new xmlChar * containing the concatenated string. The original
+ * `cur` is reallocated and should not be freed.
*/
xmlChar *
xmlStrcat(xmlChar *cur, const xmlChar *add) {
@@ -540,15 +522,14 @@ xmlStrcat(xmlChar *cur, const xmlChar *add) {
}
/**
- * xmlStrPrintf:
- * @buf: the result buffer.
- * @len: the result buffer length.
- * @msg: the message with printf formatting.
+ * @param buf the result buffer.
+ * @param len the result buffer length.
+ * @param msg the message with printf formatting.
* @...: extra parameters for the message.
*
- * Formats @msg and places result into @buf.
+ * Formats `msg` and places result into `buf`.
*
- * Returns the number of characters written to @buf or -1 if an error occurs.
+ * @returns the number of characters written to `buf` or -1 if an error occurs.
*/
int
xmlStrPrintf(xmlChar *buf, int len, const char *msg, ...) {
@@ -568,15 +549,14 @@ xmlStrPrintf(xmlChar *buf, int len, const char *msg, ...) {
}
/**
- * xmlStrVPrintf:
- * @buf: the result buffer.
- * @len: the result buffer length.
- * @msg: the message with printf formatting.
- * @ap: extra parameters for the message.
+ * @param buf the result buffer.
+ * @param len the result buffer length.
+ * @param msg the message with printf formatting.
+ * @param ap extra parameters for the message.
*
- * Formats @msg and places result into @buf.
+ * Formats `msg` and places result into `buf`.
*
- * Returns the number of characters written to @buf or -1 if an error occurs.
+ * @returns the number of characters written to `buf` or -1 if an error occurs.
*/
int
xmlStrVPrintf(xmlChar *buf, int len, const char *msg, va_list ap) {
@@ -593,15 +573,14 @@ xmlStrVPrintf(xmlChar *buf, int len, const char *msg, va_list ap) {
}
/**
- * xmlStrVASPrintf:
- * @out: pointer to the resulting string
- * @maxSize: maximum size of the output buffer
- * @msg: printf format string
- * @ap: arguments for format string
+ * @param out pointer to the resulting string
+ * @param maxSize maximum size of the output buffer
+ * @param msg printf format string
+ * @param ap arguments for format string
*
* Creates a newly allocated string according to format.
*
- * Returns 0 on success, 1 if the result was truncated or on other
+ * @returns 0 on success, 1 if the result was truncated or on other
* errors, -1 if a memory allocation failed.
*/
int
@@ -711,15 +690,14 @@ xmlStrVASPrintf(xmlChar **out, int maxSize, const char *msg, va_list ap) {
}
/**
- * xmlStrASPrintf:
- * @out: pointer to the resulting string
- * @maxSize: maximum size of the output buffer
- * @msg: printf format string
+ * @param out pointer to the resulting string
+ * @param maxSize maximum size of the output buffer
+ * @param msg printf format string
* @...: arguments for format string
*
* See xmlStrVASPrintf.
*
- * Returns 0 on success, 1 if the result was truncated or on other
+ * @returns 0 on success, 1 if the result was truncated or on other
* errors, -1 if a memory allocation failed.
*/
int
@@ -751,12 +729,11 @@ xmlStrASPrintf(xmlChar **out, int maxSize, const char *msg, ...) {
/**
- * xmlUTF8Size:
- * @utf: pointer to the UTF8 character
+ * @param utf pointer to the UTF8 character
*
* calculates the internal size of a UTF8 character
*
- * returns the numbers of bytes in the character, -1 on format error
+ * @returns the numbers of bytes in the character, -1 on format error
*/
int
xmlUTF8Size(const xmlChar *utf) {
@@ -781,13 +758,12 @@ xmlUTF8Size(const xmlChar *utf) {
}
/**
- * xmlUTF8Charcmp:
- * @utf1: pointer to first UTF8 char
- * @utf2: pointer to second UTF8 char
+ * @param utf1 pointer to first UTF8 char
+ * @param utf2 pointer to second UTF8 char
*
* compares the two UCS4 values
*
- * returns result of the compare as with xmlStrncmp
+ * @returns result of the compare as with xmlStrncmp
*/
int
xmlUTF8Charcmp(const xmlChar *utf1, const xmlChar *utf2) {
@@ -801,13 +777,12 @@ xmlUTF8Charcmp(const xmlChar *utf1, const xmlChar *utf2) {
}
/**
- * xmlUTF8Strlen:
- * @utf: a sequence of UTF-8 encoded bytes
+ * @param utf a sequence of UTF-8 encoded bytes
*
* compute the length of an UTF8 string, it doesn't do a full UTF8
* checking of the content of the string.
*
- * Returns the number of characters in the string or -1 in case of error
+ * @returns the number of characters in the string or -1 in case of error
*/
int
xmlUTF8Strlen(const xmlChar *utf) {
@@ -842,15 +817,14 @@ xmlUTF8Strlen(const xmlChar *utf) {
}
/**
- * xmlGetUTF8Char:
- * @utf: a sequence of UTF-8 encoded bytes
- * @len: a pointer to the minimum number of bytes present in
+ * @param utf a sequence of UTF-8 encoded bytes
+ * @param len a pointer to the minimum number of bytes present in
* the sequence. This is used to assure the next character
* is completely contained within the sequence.
*
- * Read the first UTF8 character from @utf
+ * Read the first UTF8 character from `utf`
*
- * Returns the char value or -1 in case of error, and sets *len to
+ * @returns the char value or -1 in case of error, and sets *len to
* the actual number of bytes consumed (0 in case of error)
*/
int
@@ -912,17 +886,16 @@ error:
}
/**
- * xmlCheckUTF8:
- * @utf: Pointer to putative UTF-8 encoded string.
+ * @param utf Pointer to putative UTF-8 encoded string.
*
- * Checks @utf for being valid UTF-8. @utf is assumed to be
+ * Checks `utf` for being valid UTF-8. `utf` is assumed to be
* null-terminated. This function is not super-strict, as it will
* allow longer UTF-8 sequences than necessary. Note that Java is
* capable of producing these sequences if provoked. Also note, this
* routine checks for the 4-byte maximum size, but does not check for
* 0x10ffff maximum value.
*
- * Return value: true if @utf is valid.
+ * @returns value: true if `utf` is valid.
**/
int
xmlCheckUTF8(const unsigned char *utf)
@@ -967,14 +940,13 @@ xmlCheckUTF8(const unsigned char *utf)
}
/**
- * xmlUTF8Strsize:
- * @utf: a sequence of UTF-8 encoded bytes
- * @len: the number of characters in the array
+ * @param utf a sequence of UTF-8 encoded bytes
+ * @param len the number of characters in the array
*
* storage size of an UTF8 string
* the behaviour is not guaranteed if the input string is not UTF-8
*
- * Returns the storage size of
+ * @returns the storage size of
* the first 'len' characters of ARRAY
*/
@@ -1006,13 +978,12 @@ xmlUTF8Strsize(const xmlChar *utf, int len) {
/**
- * xmlUTF8Strndup:
- * @utf: the input UTF8 *
- * @len: the len of @utf (in chars)
+ * @param utf the input UTF8 *
+ * @param len the len of `utf` (in chars)
*
* a strndup for array of UTF8's
*
- * Returns a new UTF8 * or NULL
+ * @returns a new UTF8 * or NULL
*/
xmlChar *
xmlUTF8Strndup(const xmlChar *utf, int len) {
@@ -1031,14 +1002,13 @@ xmlUTF8Strndup(const xmlChar *utf, int len) {
}
/**
- * xmlUTF8Strpos:
- * @utf: the input UTF8 *
- * @pos: the position of the desired UTF8 char (in chars)
+ * @param utf the input UTF8 *
+ * @param pos the position of the desired UTF8 char (in chars)
*
* a function to provide the equivalent of fetching a
* character from a string array
*
- * Returns a pointer to the UTF8 character or NULL
+ * @returns a pointer to the UTF8 character or NULL
*/
const xmlChar *
xmlUTF8Strpos(const xmlChar *utf, int pos) {
@@ -1065,13 +1035,12 @@ xmlUTF8Strpos(const xmlChar *utf, int pos) {
}
/**
- * xmlUTF8Strloc:
- * @utf: the input UTF8 *
- * @utfchar: the UTF8 character to be found
+ * @param utf the input UTF8 *
+ * @param utfchar the UTF8 character to be found
*
* a function to provide the relative location of a UTF8 char
*
- * Returns the relative character position of the desired char
+ * @returns the relative character position of the desired char
* or -1 if not found
*/
int
@@ -1100,15 +1069,14 @@ xmlUTF8Strloc(const xmlChar *utf, const xmlChar *utfchar) {
return(-1);
}
/**
- * xmlUTF8Strsub:
- * @utf: a sequence of UTF-8 encoded bytes
- * @start: relative pos of first char
- * @len: total number to copy
+ * @param utf a sequence of UTF-8 encoded bytes
+ * @param start relative pos of first char
+ * @param len total number to copy
*
* Create a substring from a given UTF-8 string
* Note: positions are given in units of UTF-8 chars
*
- * Returns a pointer to a newly created string or NULL if the
+ * @returns a pointer to a newly created string or NULL if the
* start index is out of bounds or a memory allocation failed.
* If len is too large, the result is truncated.
*/
@@ -1144,13 +1112,12 @@ xmlUTF8Strsub(const xmlChar *utf, int start, int len) {
}
/**
- * xmlEscapeFormatString:
- * @msg: a pointer to the string in which to escape '%' characters.
+ * @param msg a pointer to the string in which to escape '%' characters.
* Must be a heap-allocated buffer created by libxml2 that may be
* returned, or that may be freed and replaced.
*
* Replaces the string pointed to by 'msg' with an escaped string.
- * Returns the same string with all '%' characters escaped.
+ * @returns the same string with all '%' characters escaped.
*/
xmlChar *
xmlEscapeFormatString(xmlChar **msg)
diff --git a/xmlunicode.c b/xmlunicode.c
index 2f17f014..c1a408b8 100644
--- a/xmlunicode.c
+++ b/xmlunicode.c
@@ -763,13 +763,12 @@ static const xmlChSRange xmlZS[] = {{0x20, 0x20}, {0xa0, 0xa0},
static const xmlChRangeGroup xmlZG = {9,0,xmlZS,NULL};
/**
- * xmlUnicodeLookup:
- * @tptr: pointer to the name table
- * @tname: name to be found
+ * @param tptr pointer to the name table
+ * @param tname name to be found
*
* binary table lookup for user-supplied name
*
- * Returns pointer to range function if found, otherwise NULL
+ * @returns pointer to range function if found, otherwise NULL
*/
static xmlIntFunc
*xmlUnicodeLookup(const xmlUnicodeNameTable *tptr, const char *tname) {
@@ -795,12 +794,11 @@ static xmlIntFunc
}
/**
- * xmlUCSIsAegeanNumbers:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of AegeanNumbers UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsAegeanNumbers(int code) {
@@ -808,12 +806,11 @@ xmlUCSIsAegeanNumbers(int code) {
}
/**
- * xmlUCSIsAlphabeticPresentationForms:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of AlphabeticPresentationForms UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsAlphabeticPresentationForms(int code) {
@@ -821,12 +818,11 @@ xmlUCSIsAlphabeticPresentationForms(int code) {
}
/**
- * xmlUCSIsArabic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Arabic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsArabic(int code) {
@@ -834,12 +830,11 @@ xmlUCSIsArabic(int code) {
}
/**
- * xmlUCSIsArabicPresentationFormsA:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of ArabicPresentationForms-A UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsArabicPresentationFormsA(int code) {
@@ -847,12 +842,11 @@ xmlUCSIsArabicPresentationFormsA(int code) {
}
/**
- * xmlUCSIsArabicPresentationFormsB:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of ArabicPresentationForms-B UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsArabicPresentationFormsB(int code) {
@@ -860,12 +854,11 @@ xmlUCSIsArabicPresentationFormsB(int code) {
}
/**
- * xmlUCSIsArmenian:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Armenian UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsArmenian(int code) {
@@ -873,12 +866,11 @@ xmlUCSIsArmenian(int code) {
}
/**
- * xmlUCSIsArrows:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Arrows UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsArrows(int code) {
@@ -886,12 +878,11 @@ xmlUCSIsArrows(int code) {
}
/**
- * xmlUCSIsBasicLatin:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of BasicLatin UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBasicLatin(int code) {
@@ -899,12 +890,11 @@ xmlUCSIsBasicLatin(int code) {
}
/**
- * xmlUCSIsBengali:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Bengali UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBengali(int code) {
@@ -912,12 +902,11 @@ xmlUCSIsBengali(int code) {
}
/**
- * xmlUCSIsBlockElements:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of BlockElements UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBlockElements(int code) {
@@ -925,12 +914,11 @@ xmlUCSIsBlockElements(int code) {
}
/**
- * xmlUCSIsBopomofo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Bopomofo UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBopomofo(int code) {
@@ -938,12 +926,11 @@ xmlUCSIsBopomofo(int code) {
}
/**
- * xmlUCSIsBopomofoExtended:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of BopomofoExtended UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBopomofoExtended(int code) {
@@ -951,12 +938,11 @@ xmlUCSIsBopomofoExtended(int code) {
}
/**
- * xmlUCSIsBoxDrawing:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of BoxDrawing UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBoxDrawing(int code) {
@@ -964,12 +950,11 @@ xmlUCSIsBoxDrawing(int code) {
}
/**
- * xmlUCSIsBraillePatterns:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of BraillePatterns UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBraillePatterns(int code) {
@@ -977,12 +962,11 @@ xmlUCSIsBraillePatterns(int code) {
}
/**
- * xmlUCSIsBuhid:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Buhid UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsBuhid(int code) {
@@ -990,12 +974,11 @@ xmlUCSIsBuhid(int code) {
}
/**
- * xmlUCSIsByzantineMusicalSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of ByzantineMusicalSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsByzantineMusicalSymbols(int code) {
@@ -1003,12 +986,11 @@ xmlUCSIsByzantineMusicalSymbols(int code) {
}
/**
- * xmlUCSIsCJKCompatibility:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKCompatibility UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKCompatibility(int code) {
@@ -1016,12 +998,11 @@ xmlUCSIsCJKCompatibility(int code) {
}
/**
- * xmlUCSIsCJKCompatibilityForms:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKCompatibilityForms UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKCompatibilityForms(int code) {
@@ -1029,12 +1010,11 @@ xmlUCSIsCJKCompatibilityForms(int code) {
}
/**
- * xmlUCSIsCJKCompatibilityIdeographs:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKCompatibilityIdeographs UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKCompatibilityIdeographs(int code) {
@@ -1042,12 +1022,11 @@ xmlUCSIsCJKCompatibilityIdeographs(int code) {
}
/**
- * xmlUCSIsCJKCompatibilityIdeographsSupplement:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKCompatibilityIdeographsSupplement UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKCompatibilityIdeographsSupplement(int code) {
@@ -1055,12 +1034,11 @@ xmlUCSIsCJKCompatibilityIdeographsSupplement(int code) {
}
/**
- * xmlUCSIsCJKRadicalsSupplement:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKRadicalsSupplement UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKRadicalsSupplement(int code) {
@@ -1068,12 +1046,11 @@ xmlUCSIsCJKRadicalsSupplement(int code) {
}
/**
- * xmlUCSIsCJKSymbolsandPunctuation:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKSymbolsandPunctuation UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKSymbolsandPunctuation(int code) {
@@ -1081,12 +1058,11 @@ xmlUCSIsCJKSymbolsandPunctuation(int code) {
}
/**
- * xmlUCSIsCJKUnifiedIdeographs:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKUnifiedIdeographs UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKUnifiedIdeographs(int code) {
@@ -1094,12 +1070,11 @@ xmlUCSIsCJKUnifiedIdeographs(int code) {
}
/**
- * xmlUCSIsCJKUnifiedIdeographsExtensionA:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKUnifiedIdeographsExtensionA UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKUnifiedIdeographsExtensionA(int code) {
@@ -1107,12 +1082,11 @@ xmlUCSIsCJKUnifiedIdeographsExtensionA(int code) {
}
/**
- * xmlUCSIsCJKUnifiedIdeographsExtensionB:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CJKUnifiedIdeographsExtensionB UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCJKUnifiedIdeographsExtensionB(int code) {
@@ -1120,12 +1094,11 @@ xmlUCSIsCJKUnifiedIdeographsExtensionB(int code) {
}
/**
- * xmlUCSIsCherokee:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Cherokee UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCherokee(int code) {
@@ -1133,12 +1106,11 @@ xmlUCSIsCherokee(int code) {
}
/**
- * xmlUCSIsCombiningDiacriticalMarks:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CombiningDiacriticalMarks UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCombiningDiacriticalMarks(int code) {
@@ -1146,12 +1118,11 @@ xmlUCSIsCombiningDiacriticalMarks(int code) {
}
/**
- * xmlUCSIsCombiningDiacriticalMarksforSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CombiningDiacriticalMarksforSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCombiningDiacriticalMarksforSymbols(int code) {
@@ -1159,12 +1130,11 @@ xmlUCSIsCombiningDiacriticalMarksforSymbols(int code) {
}
/**
- * xmlUCSIsCombiningHalfMarks:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CombiningHalfMarks UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCombiningHalfMarks(int code) {
@@ -1172,12 +1142,11 @@ xmlUCSIsCombiningHalfMarks(int code) {
}
/**
- * xmlUCSIsCombiningMarksforSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CombiningMarksforSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCombiningMarksforSymbols(int code) {
@@ -1185,12 +1154,11 @@ xmlUCSIsCombiningMarksforSymbols(int code) {
}
/**
- * xmlUCSIsControlPictures:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of ControlPictures UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsControlPictures(int code) {
@@ -1198,12 +1166,11 @@ xmlUCSIsControlPictures(int code) {
}
/**
- * xmlUCSIsCurrencySymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CurrencySymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCurrencySymbols(int code) {
@@ -1211,12 +1178,11 @@ xmlUCSIsCurrencySymbols(int code) {
}
/**
- * xmlUCSIsCypriotSyllabary:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CypriotSyllabary UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCypriotSyllabary(int code) {
@@ -1224,12 +1190,11 @@ xmlUCSIsCypriotSyllabary(int code) {
}
/**
- * xmlUCSIsCyrillic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Cyrillic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCyrillic(int code) {
@@ -1237,12 +1202,11 @@ xmlUCSIsCyrillic(int code) {
}
/**
- * xmlUCSIsCyrillicSupplement:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of CyrillicSupplement UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsCyrillicSupplement(int code) {
@@ -1250,12 +1214,11 @@ xmlUCSIsCyrillicSupplement(int code) {
}
/**
- * xmlUCSIsDeseret:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Deseret UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsDeseret(int code) {
@@ -1263,12 +1226,11 @@ xmlUCSIsDeseret(int code) {
}
/**
- * xmlUCSIsDevanagari:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Devanagari UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsDevanagari(int code) {
@@ -1276,12 +1238,11 @@ xmlUCSIsDevanagari(int code) {
}
/**
- * xmlUCSIsDingbats:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Dingbats UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsDingbats(int code) {
@@ -1289,12 +1250,11 @@ xmlUCSIsDingbats(int code) {
}
/**
- * xmlUCSIsEnclosedAlphanumerics:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of EnclosedAlphanumerics UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsEnclosedAlphanumerics(int code) {
@@ -1302,12 +1262,11 @@ xmlUCSIsEnclosedAlphanumerics(int code) {
}
/**
- * xmlUCSIsEnclosedCJKLettersandMonths:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of EnclosedCJKLettersandMonths UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsEnclosedCJKLettersandMonths(int code) {
@@ -1315,12 +1274,11 @@ xmlUCSIsEnclosedCJKLettersandMonths(int code) {
}
/**
- * xmlUCSIsEthiopic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Ethiopic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsEthiopic(int code) {
@@ -1328,12 +1286,11 @@ xmlUCSIsEthiopic(int code) {
}
/**
- * xmlUCSIsGeneralPunctuation:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of GeneralPunctuation UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGeneralPunctuation(int code) {
@@ -1341,12 +1298,11 @@ xmlUCSIsGeneralPunctuation(int code) {
}
/**
- * xmlUCSIsGeometricShapes:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of GeometricShapes UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGeometricShapes(int code) {
@@ -1354,12 +1310,11 @@ xmlUCSIsGeometricShapes(int code) {
}
/**
- * xmlUCSIsGeorgian:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Georgian UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGeorgian(int code) {
@@ -1367,12 +1322,11 @@ xmlUCSIsGeorgian(int code) {
}
/**
- * xmlUCSIsGothic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Gothic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGothic(int code) {
@@ -1380,12 +1334,11 @@ xmlUCSIsGothic(int code) {
}
/**
- * xmlUCSIsGreek:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Greek UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGreek(int code) {
@@ -1393,12 +1346,11 @@ xmlUCSIsGreek(int code) {
}
/**
- * xmlUCSIsGreekExtended:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of GreekExtended UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGreekExtended(int code) {
@@ -1406,12 +1358,11 @@ xmlUCSIsGreekExtended(int code) {
}
/**
- * xmlUCSIsGreekandCoptic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of GreekandCoptic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGreekandCoptic(int code) {
@@ -1419,12 +1370,11 @@ xmlUCSIsGreekandCoptic(int code) {
}
/**
- * xmlUCSIsGujarati:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Gujarati UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGujarati(int code) {
@@ -1432,12 +1382,11 @@ xmlUCSIsGujarati(int code) {
}
/**
- * xmlUCSIsGurmukhi:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Gurmukhi UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsGurmukhi(int code) {
@@ -1445,12 +1394,11 @@ xmlUCSIsGurmukhi(int code) {
}
/**
- * xmlUCSIsHalfwidthandFullwidthForms:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of HalfwidthandFullwidthForms UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHalfwidthandFullwidthForms(int code) {
@@ -1458,12 +1406,11 @@ xmlUCSIsHalfwidthandFullwidthForms(int code) {
}
/**
- * xmlUCSIsHangulCompatibilityJamo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of HangulCompatibilityJamo UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHangulCompatibilityJamo(int code) {
@@ -1471,12 +1418,11 @@ xmlUCSIsHangulCompatibilityJamo(int code) {
}
/**
- * xmlUCSIsHangulJamo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of HangulJamo UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHangulJamo(int code) {
@@ -1484,12 +1430,11 @@ xmlUCSIsHangulJamo(int code) {
}
/**
- * xmlUCSIsHangulSyllables:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of HangulSyllables UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHangulSyllables(int code) {
@@ -1497,12 +1442,11 @@ xmlUCSIsHangulSyllables(int code) {
}
/**
- * xmlUCSIsHanunoo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Hanunoo UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHanunoo(int code) {
@@ -1510,12 +1454,11 @@ xmlUCSIsHanunoo(int code) {
}
/**
- * xmlUCSIsHebrew:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Hebrew UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHebrew(int code) {
@@ -1523,12 +1466,11 @@ xmlUCSIsHebrew(int code) {
}
/**
- * xmlUCSIsHighPrivateUseSurrogates:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of HighPrivateUseSurrogates UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHighPrivateUseSurrogates(int code) {
@@ -1536,12 +1478,11 @@ xmlUCSIsHighPrivateUseSurrogates(int code) {
}
/**
- * xmlUCSIsHighSurrogates:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of HighSurrogates UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHighSurrogates(int code) {
@@ -1549,12 +1490,11 @@ xmlUCSIsHighSurrogates(int code) {
}
/**
- * xmlUCSIsHiragana:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Hiragana UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsHiragana(int code) {
@@ -1562,12 +1502,11 @@ xmlUCSIsHiragana(int code) {
}
/**
- * xmlUCSIsIPAExtensions:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of IPAExtensions UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsIPAExtensions(int code) {
@@ -1575,12 +1514,11 @@ xmlUCSIsIPAExtensions(int code) {
}
/**
- * xmlUCSIsIdeographicDescriptionCharacters:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of IdeographicDescriptionCharacters UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsIdeographicDescriptionCharacters(int code) {
@@ -1588,12 +1526,11 @@ xmlUCSIsIdeographicDescriptionCharacters(int code) {
}
/**
- * xmlUCSIsKanbun:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Kanbun UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKanbun(int code) {
@@ -1601,12 +1538,11 @@ xmlUCSIsKanbun(int code) {
}
/**
- * xmlUCSIsKangxiRadicals:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of KangxiRadicals UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKangxiRadicals(int code) {
@@ -1614,12 +1550,11 @@ xmlUCSIsKangxiRadicals(int code) {
}
/**
- * xmlUCSIsKannada:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Kannada UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKannada(int code) {
@@ -1627,12 +1562,11 @@ xmlUCSIsKannada(int code) {
}
/**
- * xmlUCSIsKatakana:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Katakana UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKatakana(int code) {
@@ -1640,12 +1574,11 @@ xmlUCSIsKatakana(int code) {
}
/**
- * xmlUCSIsKatakanaPhoneticExtensions:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of KatakanaPhoneticExtensions UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKatakanaPhoneticExtensions(int code) {
@@ -1653,12 +1586,11 @@ xmlUCSIsKatakanaPhoneticExtensions(int code) {
}
/**
- * xmlUCSIsKhmer:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Khmer UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKhmer(int code) {
@@ -1666,12 +1598,11 @@ xmlUCSIsKhmer(int code) {
}
/**
- * xmlUCSIsKhmerSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of KhmerSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsKhmerSymbols(int code) {
@@ -1679,12 +1610,11 @@ xmlUCSIsKhmerSymbols(int code) {
}
/**
- * xmlUCSIsLao:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Lao UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLao(int code) {
@@ -1692,12 +1622,11 @@ xmlUCSIsLao(int code) {
}
/**
- * xmlUCSIsLatin1Supplement:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Latin-1Supplement UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLatin1Supplement(int code) {
@@ -1705,12 +1634,11 @@ xmlUCSIsLatin1Supplement(int code) {
}
/**
- * xmlUCSIsLatinExtendedA:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LatinExtended-A UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLatinExtendedA(int code) {
@@ -1718,12 +1646,11 @@ xmlUCSIsLatinExtendedA(int code) {
}
/**
- * xmlUCSIsLatinExtendedB:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LatinExtended-B UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLatinExtendedB(int code) {
@@ -1731,12 +1658,11 @@ xmlUCSIsLatinExtendedB(int code) {
}
/**
- * xmlUCSIsLatinExtendedAdditional:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LatinExtendedAdditional UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLatinExtendedAdditional(int code) {
@@ -1744,12 +1670,11 @@ xmlUCSIsLatinExtendedAdditional(int code) {
}
/**
- * xmlUCSIsLetterlikeSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LetterlikeSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLetterlikeSymbols(int code) {
@@ -1757,12 +1682,11 @@ xmlUCSIsLetterlikeSymbols(int code) {
}
/**
- * xmlUCSIsLimbu:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Limbu UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLimbu(int code) {
@@ -1770,12 +1694,11 @@ xmlUCSIsLimbu(int code) {
}
/**
- * xmlUCSIsLinearBIdeograms:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LinearBIdeograms UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLinearBIdeograms(int code) {
@@ -1783,12 +1706,11 @@ xmlUCSIsLinearBIdeograms(int code) {
}
/**
- * xmlUCSIsLinearBSyllabary:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LinearBSyllabary UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLinearBSyllabary(int code) {
@@ -1796,12 +1718,11 @@ xmlUCSIsLinearBSyllabary(int code) {
}
/**
- * xmlUCSIsLowSurrogates:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of LowSurrogates UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsLowSurrogates(int code) {
@@ -1809,12 +1730,11 @@ xmlUCSIsLowSurrogates(int code) {
}
/**
- * xmlUCSIsMalayalam:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Malayalam UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMalayalam(int code) {
@@ -1822,12 +1742,11 @@ xmlUCSIsMalayalam(int code) {
}
/**
- * xmlUCSIsMathematicalAlphanumericSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MathematicalAlphanumericSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMathematicalAlphanumericSymbols(int code) {
@@ -1835,12 +1754,11 @@ xmlUCSIsMathematicalAlphanumericSymbols(int code) {
}
/**
- * xmlUCSIsMathematicalOperators:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MathematicalOperators UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMathematicalOperators(int code) {
@@ -1848,12 +1766,11 @@ xmlUCSIsMathematicalOperators(int code) {
}
/**
- * xmlUCSIsMiscellaneousMathematicalSymbolsA:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MiscellaneousMathematicalSymbols-A UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMiscellaneousMathematicalSymbolsA(int code) {
@@ -1861,12 +1778,11 @@ xmlUCSIsMiscellaneousMathematicalSymbolsA(int code) {
}
/**
- * xmlUCSIsMiscellaneousMathematicalSymbolsB:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MiscellaneousMathematicalSymbols-B UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMiscellaneousMathematicalSymbolsB(int code) {
@@ -1874,12 +1790,11 @@ xmlUCSIsMiscellaneousMathematicalSymbolsB(int code) {
}
/**
- * xmlUCSIsMiscellaneousSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MiscellaneousSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMiscellaneousSymbols(int code) {
@@ -1887,12 +1802,11 @@ xmlUCSIsMiscellaneousSymbols(int code) {
}
/**
- * xmlUCSIsMiscellaneousSymbolsandArrows:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MiscellaneousSymbolsandArrows UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMiscellaneousSymbolsandArrows(int code) {
@@ -1900,12 +1814,11 @@ xmlUCSIsMiscellaneousSymbolsandArrows(int code) {
}
/**
- * xmlUCSIsMiscellaneousTechnical:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MiscellaneousTechnical UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMiscellaneousTechnical(int code) {
@@ -1913,12 +1826,11 @@ xmlUCSIsMiscellaneousTechnical(int code) {
}
/**
- * xmlUCSIsMongolian:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Mongolian UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMongolian(int code) {
@@ -1926,12 +1838,11 @@ xmlUCSIsMongolian(int code) {
}
/**
- * xmlUCSIsMusicalSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of MusicalSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMusicalSymbols(int code) {
@@ -1939,12 +1850,11 @@ xmlUCSIsMusicalSymbols(int code) {
}
/**
- * xmlUCSIsMyanmar:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Myanmar UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsMyanmar(int code) {
@@ -1952,12 +1862,11 @@ xmlUCSIsMyanmar(int code) {
}
/**
- * xmlUCSIsNumberForms:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of NumberForms UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsNumberForms(int code) {
@@ -1965,12 +1874,11 @@ xmlUCSIsNumberForms(int code) {
}
/**
- * xmlUCSIsOgham:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Ogham UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsOgham(int code) {
@@ -1978,12 +1886,11 @@ xmlUCSIsOgham(int code) {
}
/**
- * xmlUCSIsOldItalic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of OldItalic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsOldItalic(int code) {
@@ -1991,12 +1898,11 @@ xmlUCSIsOldItalic(int code) {
}
/**
- * xmlUCSIsOpticalCharacterRecognition:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of OpticalCharacterRecognition UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsOpticalCharacterRecognition(int code) {
@@ -2004,12 +1910,11 @@ xmlUCSIsOpticalCharacterRecognition(int code) {
}
/**
- * xmlUCSIsOriya:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Oriya UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsOriya(int code) {
@@ -2017,12 +1922,11 @@ xmlUCSIsOriya(int code) {
}
/**
- * xmlUCSIsOsmanya:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Osmanya UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsOsmanya(int code) {
@@ -2030,12 +1934,11 @@ xmlUCSIsOsmanya(int code) {
}
/**
- * xmlUCSIsPhoneticExtensions:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of PhoneticExtensions UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsPhoneticExtensions(int code) {
@@ -2043,12 +1946,11 @@ xmlUCSIsPhoneticExtensions(int code) {
}
/**
- * xmlUCSIsPrivateUse:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of PrivateUse UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsPrivateUse(int code) {
@@ -2058,12 +1960,11 @@ xmlUCSIsPrivateUse(int code) {
}
/**
- * xmlUCSIsPrivateUseArea:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of PrivateUseArea UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsPrivateUseArea(int code) {
@@ -2071,12 +1972,11 @@ xmlUCSIsPrivateUseArea(int code) {
}
/**
- * xmlUCSIsRunic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Runic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsRunic(int code) {
@@ -2084,12 +1984,11 @@ xmlUCSIsRunic(int code) {
}
/**
- * xmlUCSIsShavian:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Shavian UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsShavian(int code) {
@@ -2097,12 +1996,11 @@ xmlUCSIsShavian(int code) {
}
/**
- * xmlUCSIsSinhala:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Sinhala UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSinhala(int code) {
@@ -2110,12 +2008,11 @@ xmlUCSIsSinhala(int code) {
}
/**
- * xmlUCSIsSmallFormVariants:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SmallFormVariants UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSmallFormVariants(int code) {
@@ -2123,12 +2020,11 @@ xmlUCSIsSmallFormVariants(int code) {
}
/**
- * xmlUCSIsSpacingModifierLetters:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SpacingModifierLetters UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSpacingModifierLetters(int code) {
@@ -2136,12 +2032,11 @@ xmlUCSIsSpacingModifierLetters(int code) {
}
/**
- * xmlUCSIsSpecials:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Specials UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSpecials(int code) {
@@ -2149,12 +2044,11 @@ xmlUCSIsSpecials(int code) {
}
/**
- * xmlUCSIsSuperscriptsandSubscripts:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SuperscriptsandSubscripts UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSuperscriptsandSubscripts(int code) {
@@ -2162,12 +2056,11 @@ xmlUCSIsSuperscriptsandSubscripts(int code) {
}
/**
- * xmlUCSIsSupplementalArrowsA:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SupplementalArrows-A UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSupplementalArrowsA(int code) {
@@ -2175,12 +2068,11 @@ xmlUCSIsSupplementalArrowsA(int code) {
}
/**
- * xmlUCSIsSupplementalArrowsB:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SupplementalArrows-B UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSupplementalArrowsB(int code) {
@@ -2188,12 +2080,11 @@ xmlUCSIsSupplementalArrowsB(int code) {
}
/**
- * xmlUCSIsSupplementalMathematicalOperators:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SupplementalMathematicalOperators UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSupplementalMathematicalOperators(int code) {
@@ -2201,12 +2092,11 @@ xmlUCSIsSupplementalMathematicalOperators(int code) {
}
/**
- * xmlUCSIsSupplementaryPrivateUseAreaA:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SupplementaryPrivateUseArea-A UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSupplementaryPrivateUseAreaA(int code) {
@@ -2214,12 +2104,11 @@ xmlUCSIsSupplementaryPrivateUseAreaA(int code) {
}
/**
- * xmlUCSIsSupplementaryPrivateUseAreaB:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of SupplementaryPrivateUseArea-B UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSupplementaryPrivateUseAreaB(int code) {
@@ -2227,12 +2116,11 @@ xmlUCSIsSupplementaryPrivateUseAreaB(int code) {
}
/**
- * xmlUCSIsSyriac:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Syriac UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsSyriac(int code) {
@@ -2240,12 +2128,11 @@ xmlUCSIsSyriac(int code) {
}
/**
- * xmlUCSIsTagalog:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Tagalog UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTagalog(int code) {
@@ -2253,12 +2140,11 @@ xmlUCSIsTagalog(int code) {
}
/**
- * xmlUCSIsTagbanwa:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Tagbanwa UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTagbanwa(int code) {
@@ -2266,12 +2152,11 @@ xmlUCSIsTagbanwa(int code) {
}
/**
- * xmlUCSIsTags:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Tags UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTags(int code) {
@@ -2279,12 +2164,11 @@ xmlUCSIsTags(int code) {
}
/**
- * xmlUCSIsTaiLe:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of TaiLe UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTaiLe(int code) {
@@ -2292,12 +2176,11 @@ xmlUCSIsTaiLe(int code) {
}
/**
- * xmlUCSIsTaiXuanJingSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of TaiXuanJingSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTaiXuanJingSymbols(int code) {
@@ -2305,12 +2188,11 @@ xmlUCSIsTaiXuanJingSymbols(int code) {
}
/**
- * xmlUCSIsTamil:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Tamil UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTamil(int code) {
@@ -2318,12 +2200,11 @@ xmlUCSIsTamil(int code) {
}
/**
- * xmlUCSIsTelugu:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Telugu UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTelugu(int code) {
@@ -2331,12 +2212,11 @@ xmlUCSIsTelugu(int code) {
}
/**
- * xmlUCSIsThaana:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Thaana UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsThaana(int code) {
@@ -2344,12 +2224,11 @@ xmlUCSIsThaana(int code) {
}
/**
- * xmlUCSIsThai:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Thai UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsThai(int code) {
@@ -2357,12 +2236,11 @@ xmlUCSIsThai(int code) {
}
/**
- * xmlUCSIsTibetan:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Tibetan UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsTibetan(int code) {
@@ -2370,12 +2248,11 @@ xmlUCSIsTibetan(int code) {
}
/**
- * xmlUCSIsUgaritic:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Ugaritic UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsUgaritic(int code) {
@@ -2383,12 +2260,11 @@ xmlUCSIsUgaritic(int code) {
}
/**
- * xmlUCSIsUnifiedCanadianAboriginalSyllabics:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of UnifiedCanadianAboriginalSyllabics UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsUnifiedCanadianAboriginalSyllabics(int code) {
@@ -2396,12 +2272,11 @@ xmlUCSIsUnifiedCanadianAboriginalSyllabics(int code) {
}
/**
- * xmlUCSIsVariationSelectors:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of VariationSelectors UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsVariationSelectors(int code) {
@@ -2409,12 +2284,11 @@ xmlUCSIsVariationSelectors(int code) {
}
/**
- * xmlUCSIsVariationSelectorsSupplement:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of VariationSelectorsSupplement UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsVariationSelectorsSupplement(int code) {
@@ -2422,12 +2296,11 @@ xmlUCSIsVariationSelectorsSupplement(int code) {
}
/**
- * xmlUCSIsYiRadicals:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of YiRadicals UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsYiRadicals(int code) {
@@ -2435,12 +2308,11 @@ xmlUCSIsYiRadicals(int code) {
}
/**
- * xmlUCSIsYiSyllables:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of YiSyllables UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsYiSyllables(int code) {
@@ -2448,12 +2320,11 @@ xmlUCSIsYiSyllables(int code) {
}
/**
- * xmlUCSIsYijingHexagramSymbols:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of YijingHexagramSymbols UCS Block
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
static int
xmlUCSIsYijingHexagramSymbols(int code) {
@@ -2461,12 +2332,11 @@ xmlUCSIsYijingHexagramSymbols(int code) {
}
/**
- * xmlUCSIsCatC:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of C UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatC(int code) {
@@ -2474,12 +2344,11 @@ xmlUCSIsCatC(int code) {
}
/**
- * xmlUCSIsCatCc:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Cc UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatCc(int code) {
@@ -2488,12 +2357,11 @@ xmlUCSIsCatCc(int code) {
}
/**
- * xmlUCSIsCatCf:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Cf UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatCf(int code) {
@@ -2501,12 +2369,11 @@ xmlUCSIsCatCf(int code) {
}
/**
- * xmlUCSIsCatCo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Co UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatCo(int code) {
@@ -2519,12 +2386,11 @@ xmlUCSIsCatCo(int code) {
}
/**
- * xmlUCSIsCatCs:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Cs UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatCs(int code) {
@@ -2535,12 +2401,11 @@ xmlUCSIsCatCs(int code) {
}
/**
- * xmlUCSIsCatL:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of L UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatL(int code) {
@@ -2548,12 +2413,11 @@ xmlUCSIsCatL(int code) {
}
/**
- * xmlUCSIsCatLl:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Ll UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatLl(int code) {
@@ -2561,12 +2425,11 @@ xmlUCSIsCatLl(int code) {
}
/**
- * xmlUCSIsCatLm:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Lm UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatLm(int code) {
@@ -2574,12 +2437,11 @@ xmlUCSIsCatLm(int code) {
}
/**
- * xmlUCSIsCatLo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Lo UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatLo(int code) {
@@ -2587,12 +2449,11 @@ xmlUCSIsCatLo(int code) {
}
/**
- * xmlUCSIsCatLt:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Lt UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatLt(int code) {
@@ -2600,12 +2461,11 @@ xmlUCSIsCatLt(int code) {
}
/**
- * xmlUCSIsCatLu:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Lu UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatLu(int code) {
@@ -2613,12 +2473,11 @@ xmlUCSIsCatLu(int code) {
}
/**
- * xmlUCSIsCatM:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of M UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatM(int code) {
@@ -2626,12 +2485,11 @@ xmlUCSIsCatM(int code) {
}
/**
- * xmlUCSIsCatMc:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Mc UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatMc(int code) {
@@ -2639,12 +2497,11 @@ xmlUCSIsCatMc(int code) {
}
/**
- * xmlUCSIsCatMe:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Me UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatMe(int code) {
@@ -2655,12 +2512,11 @@ xmlUCSIsCatMe(int code) {
}
/**
- * xmlUCSIsCatMn:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Mn UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatMn(int code) {
@@ -2668,12 +2524,11 @@ xmlUCSIsCatMn(int code) {
}
/**
- * xmlUCSIsCatN:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of N UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatN(int code) {
@@ -2681,12 +2536,11 @@ xmlUCSIsCatN(int code) {
}
/**
- * xmlUCSIsCatNd:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Nd UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatNd(int code) {
@@ -2694,12 +2548,11 @@ xmlUCSIsCatNd(int code) {
}
/**
- * xmlUCSIsCatNl:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Nl UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatNl(int code) {
@@ -2712,12 +2565,11 @@ xmlUCSIsCatNl(int code) {
}
/**
- * xmlUCSIsCatNo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of No UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatNo(int code) {
@@ -2725,12 +2577,11 @@ xmlUCSIsCatNo(int code) {
}
/**
- * xmlUCSIsCatP:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of P UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatP(int code) {
@@ -2738,12 +2589,11 @@ xmlUCSIsCatP(int code) {
}
/**
- * xmlUCSIsCatPc:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Pc UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPc(int code) {
@@ -2758,12 +2608,11 @@ xmlUCSIsCatPc(int code) {
}
/**
- * xmlUCSIsCatPd:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Pd UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPd(int code) {
@@ -2771,12 +2620,11 @@ xmlUCSIsCatPd(int code) {
}
/**
- * xmlUCSIsCatPe:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Pe UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPe(int code) {
@@ -2784,12 +2632,11 @@ xmlUCSIsCatPe(int code) {
}
/**
- * xmlUCSIsCatPf:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Pf UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPf(int code) {
@@ -2800,12 +2647,11 @@ xmlUCSIsCatPf(int code) {
}
/**
- * xmlUCSIsCatPi:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Pi UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPi(int code) {
@@ -2817,12 +2663,11 @@ xmlUCSIsCatPi(int code) {
}
/**
- * xmlUCSIsCatPo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Po UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPo(int code) {
@@ -2830,12 +2675,11 @@ xmlUCSIsCatPo(int code) {
}
/**
- * xmlUCSIsCatPs:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Ps UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatPs(int code) {
@@ -2843,12 +2687,11 @@ xmlUCSIsCatPs(int code) {
}
/**
- * xmlUCSIsCatS:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of S UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatS(int code) {
@@ -2856,12 +2699,11 @@ xmlUCSIsCatS(int code) {
}
/**
- * xmlUCSIsCatSc:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Sc UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatSc(int code) {
@@ -2869,12 +2711,11 @@ xmlUCSIsCatSc(int code) {
}
/**
- * xmlUCSIsCatSk:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Sk UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatSk(int code) {
@@ -2882,12 +2723,11 @@ xmlUCSIsCatSk(int code) {
}
/**
- * xmlUCSIsCatSm:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Sm UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatSm(int code) {
@@ -2895,12 +2735,11 @@ xmlUCSIsCatSm(int code) {
}
/**
- * xmlUCSIsCatSo:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of So UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatSo(int code) {
@@ -2908,12 +2747,11 @@ xmlUCSIsCatSo(int code) {
}
/**
- * xmlUCSIsCatZ:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Z UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatZ(int code) {
@@ -2921,12 +2759,11 @@ xmlUCSIsCatZ(int code) {
}
/**
- * xmlUCSIsCatZl:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Zl UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatZl(int code) {
@@ -2934,12 +2771,11 @@ xmlUCSIsCatZl(int code) {
}
/**
- * xmlUCSIsCatZp:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Zp UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatZp(int code) {
@@ -2947,12 +2783,11 @@ xmlUCSIsCatZp(int code) {
}
/**
- * xmlUCSIsCatZs:
- * @code: UCS code point
+ * @param code UCS code point
*
* Check whether the character is part of Zs UCS Category
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlUCSIsCatZs(int code) {
@@ -3137,13 +2972,12 @@ static const xmlUnicodeNameTable xmlUnicodeBlockTbl = {xmlUnicodeBlocks, 128};
static const xmlUnicodeNameTable xmlUnicodeCatTbl = {xmlUnicodeCats, 36};
/**
- * xmlUCSIsBlock:
- * @code: UCS code point
- * @block: UCS block name
+ * @param code UCS code point
+ * @param block UCS block name
*
* Check whether the character is part of the UCS Block
*
- * Returns 1 if true, 0 if false and -1 on unknown block
+ * @returns 1 if true, 0 if false and -1 on unknown block
*/
int
xmlUCSIsBlock(int code, const char *block) {
@@ -3156,13 +2990,12 @@ xmlUCSIsBlock(int code, const char *block) {
}
/**
- * xmlUCSIsCat:
- * @code: UCS code point
- * @cat: UCS Category name
+ * @param code UCS code point
+ * @param cat UCS Category name
*
* Check whether the character is part of the UCS Category
*
- * Returns 1 if true, 0 if false and -1 on unknown category
+ * @returns 1 if true, 0 if false and -1 on unknown category
*/
int
xmlUCSIsCat(int code, const char *cat) {
diff --git a/xmlwriter.c b/xmlwriter.c
index 342f9502..a4f018bd 100644
--- a/xmlwriter.c
+++ b/xmlwriter.c
@@ -112,10 +112,9 @@ static int
xmlTextWriterStackEntry * p);
/**
- * xmlWriterErrMsg:
- * @ctxt: a writer context
- * @error: the error number
- * @msg: the error message
+ * @param ctxt a writer context
+ * @param error the error number
+ * @param msg the error message
*
* Handle a writer error
*/
@@ -134,11 +133,10 @@ xmlWriterErrMsg(xmlTextWriterPtr ctxt, xmlParserErrors error,
}
/**
- * xmlWriterErrMsgInt:
- * @ctxt: a writer context
- * @error: the error number
- * @msg: the error message
- * @val: an int
+ * @param ctxt a writer context
+ * @param error the error number
+ * @param msg the error message
+ * @param val an int
*
* Handle a writer error
*/
@@ -157,14 +155,13 @@ xmlWriterErrMsgInt(xmlTextWriterPtr ctxt, xmlParserErrors error,
}
/**
- * xmlNewTextWriter:
- * @out: an xmlOutputBufferPtr
+ * @param out an xmlOutputBufferPtr
*
* Create a new xmlNewTextWriter structure using an xmlOutputBufferPtr
- * NOTE: the @out parameter will be deallocated when the writer is closed
+ * NOTE: the `out` parameter will be deallocated when the writer is closed
* (if the call succeed.)
*
- * Returns the new xmlTextWriterPtr or NULL in case of error
+ * @returns the new xmlTextWriterPtr or NULL in case of error
*/
xmlTextWriterPtr
xmlNewTextWriter(xmlOutputBufferPtr out)
@@ -219,13 +216,12 @@ xmlNewTextWriter(xmlOutputBufferPtr out)
}
/**
- * xmlNewTextWriterFilename:
- * @uri: the URI of the resource for the output
- * @compression: compress the output?
+ * @param uri the URI of the resource for the output
+ * @param compression compress the output?
*
- * Create a new xmlNewTextWriter structure with @uri as output
+ * Create a new xmlNewTextWriter structure with `uri` as output
*
- * Returns the new xmlTextWriterPtr or NULL in case of error
+ * @returns the new xmlTextWriterPtr or NULL in case of error
*/
xmlTextWriterPtr
xmlNewTextWriterFilename(const char *uri, int compression)
@@ -254,14 +250,13 @@ xmlNewTextWriterFilename(const char *uri, int compression)
}
/**
- * xmlNewTextWriterMemory:
- * @buf: xmlBufferPtr
- * @compression: compress the output?
+ * @param buf xmlBufferPtr
+ * @param compression compress the output?
*
- * Create a new xmlNewTextWriter structure with @buf as output
+ * Create a new xmlNewTextWriter structure with `buf` as output
* TODO: handle compression
*
- * Returns the new xmlTextWriterPtr or NULL in case of error
+ * @returns the new xmlTextWriterPtr or NULL in case of error
*/
xmlTextWriterPtr
xmlNewTextWriterMemory(xmlBufferPtr buf, int compression ATTRIBUTE_UNUSED)
@@ -290,16 +285,15 @@ xmlNewTextWriterMemory(xmlBufferPtr buf, int compression ATTRIBUTE_UNUSED)
}
/**
- * xmlNewTextWriterPushParser:
- * @ctxt: xmlParserCtxtPtr to hold the new XML document tree
- * @compression: compress the output?
+ * @param ctxt xmlParserCtxtPtr to hold the new XML document tree
+ * @param compression compress the output?
*
- * Create a new xmlNewTextWriter structure with @ctxt as output
- * NOTE: the @ctxt context will be freed with the resulting writer
+ * Create a new xmlNewTextWriter structure with `ctxt` as output
+ * NOTE: the `ctxt` context will be freed with the resulting writer
* (if the call succeeds).
* TODO: handle compression
*
- * Returns the new xmlTextWriterPtr or NULL in case of error
+ * @returns the new xmlTextWriterPtr or NULL in case of error
*/
xmlTextWriterPtr
xmlNewTextWriterPushParser(xmlParserCtxtPtr ctxt,
@@ -337,13 +331,12 @@ xmlNewTextWriterPushParser(xmlParserCtxtPtr ctxt,
}
/**
- * xmlNewTextWriterDoc:
- * @doc: address of a xmlDocPtr to hold the new XML document tree
- * @compression: compress the output?
+ * @param doc address of a xmlDocPtr to hold the new XML document tree
+ * @param compression compress the output?
*
* Create a new xmlNewTextWriter structure with @*doc as output
*
- * Returns the new xmlTextWriterPtr or NULL in case of error
+ * @returns the new xmlTextWriterPtr or NULL in case of error
*/
xmlTextWriterPtr
xmlNewTextWriterDoc(xmlDocPtr * doc, int compression)
@@ -396,15 +389,14 @@ xmlNewTextWriterDoc(xmlDocPtr * doc, int compression)
}
/**
- * xmlNewTextWriterTree:
- * @doc: xmlDocPtr
- * @node: xmlNodePtr or NULL for doc->children
- * @compression: compress the output?
+ * @param doc xmlDocPtr
+ * @param node xmlNodePtr or NULL for doc->children
+ * @param compression compress the output?
*
- * Create a new xmlNewTextWriter structure with @doc as output
- * starting at @node
+ * Create a new xmlNewTextWriter structure with `doc` as output
+ * starting at `node`
*
- * Returns the new xmlTextWriterPtr or NULL in case of error
+ * @returns the new xmlTextWriterPtr or NULL in case of error
*/
xmlTextWriterPtr
xmlNewTextWriterTree(xmlDocPtr doc, xmlNodePtr node, int compression)
@@ -453,8 +445,7 @@ xmlNewTextWriterTree(xmlDocPtr doc, xmlNodePtr node, int compression)
}
/**
- * xmlFreeTextWriter:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Deallocate all the resources associated to the writer
*/
@@ -490,15 +481,14 @@ xmlFreeTextWriter(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterStartDocument:
- * @writer: the xmlTextWriterPtr
- * @version: the xml version ("1.0") or NULL for default ("1.0")
- * @encoding: the encoding or NULL for default
- * @standalone: "yes" or "no" or NULL for default
+ * @param writer the xmlTextWriterPtr
+ * @param version the xml version ("1.0") or NULL for default ("1.0")
+ * @param encoding the encoding or NULL for default
+ * @param standalone "yes" or "no" or NULL for default
*
* Start a new xml document
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartDocument(xmlTextWriterPtr writer, const char *version,
@@ -612,13 +602,12 @@ xmlTextWriterStartDocument(xmlTextWriterPtr writer, const char *version,
}
/**
- * xmlTextWriterEndDocument:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End an xml document. All open elements are closed, and
* the content is flushed to the output.
*
- * Returns the bytes written or -1 in case of error
+ * @returns the bytes written or -1 in case of error
*/
int
xmlTextWriterEndDocument(xmlTextWriterPtr writer)
@@ -703,12 +692,11 @@ xmlTextWriterEndDocument(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterStartComment:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Start an xml comment.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartComment(xmlTextWriterPtr writer)
@@ -787,12 +775,11 @@ xmlTextWriterStartComment(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterEndComment:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End the current xml comment.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndComment(xmlTextWriterPtr writer)
@@ -843,14 +830,13 @@ xmlTextWriterEndComment(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatComment:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write an xml comment.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatComment(xmlTextWriterPtr writer,
@@ -868,14 +854,13 @@ xmlTextWriterWriteFormatComment(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatComment:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write an xml comment.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatComment(xmlTextWriterPtr writer,
@@ -901,13 +886,12 @@ xmlTextWriterWriteVFormatComment(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteComment:
- * @writer: the xmlTextWriterPtr
- * @content: comment string
+ * @param writer the xmlTextWriterPtr
+ * @param content comment string
*
* Write an xml comment.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteComment(xmlTextWriterPtr writer, const xmlChar * content)
@@ -933,13 +917,12 @@ xmlTextWriterWriteComment(xmlTextWriterPtr writer, const xmlChar * content)
}
/**
- * xmlTextWriterStartElement:
- * @writer: the xmlTextWriterPtr
- * @name: element name
+ * @param writer the xmlTextWriterPtr
+ * @param name element name
*
* Start an xml element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartElement(xmlTextWriterPtr writer, const xmlChar * name)
@@ -1028,15 +1011,14 @@ xmlTextWriterStartElement(xmlTextWriterPtr writer, const xmlChar * name)
}
/**
- * xmlTextWriterStartElementNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix or NULL
- * @name: element local name
- * @namespaceURI: namespace URI or NULL
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix or NULL
+ * @param name element local name
+ * @param namespaceURI namespace URI or NULL
*
* Start an xml element with namespace support.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartElementNS(xmlTextWriterPtr writer,
@@ -1096,12 +1078,11 @@ xmlTextWriterStartElementNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterEndElement:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End the current xml element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndElement(xmlTextWriterPtr writer)
@@ -1188,12 +1169,11 @@ xmlTextWriterEndElement(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterFullEndElement:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End the current xml element. Writes an end tag even if the element is empty
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterFullEndElement(xmlTextWriterPtr writer)
@@ -1271,14 +1251,13 @@ xmlTextWriterFullEndElement(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatRaw:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted raw xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatRaw(xmlTextWriterPtr writer, const char *format,
@@ -1296,14 +1275,13 @@ xmlTextWriterWriteFormatRaw(xmlTextWriterPtr writer, const char *format,
}
/**
- * xmlTextWriterWriteVFormatRaw:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted raw xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatRaw(xmlTextWriterPtr writer, const char *format,
@@ -1326,15 +1304,14 @@ xmlTextWriterWriteVFormatRaw(xmlTextWriterPtr writer, const char *format,
}
/**
- * xmlTextWriterWriteRawLen:
- * @writer: the xmlTextWriterPtr
- * @content: text string
- * @len: length of the text string
+ * @param writer the xmlTextWriterPtr
+ * @param content text string
+ * @param len length of the text string
*
* Write an xml text.
* TODO: what about entities and special chars??
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteRawLen(xmlTextWriterPtr writer, const xmlChar * content,
@@ -1382,13 +1359,12 @@ xmlTextWriterWriteRawLen(xmlTextWriterPtr writer, const xmlChar * content,
}
/**
- * xmlTextWriterWriteRaw:
- * @writer: the xmlTextWriterPtr
- * @content: text string
+ * @param writer the xmlTextWriterPtr
+ * @param content text string
*
* Write a raw xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteRaw(xmlTextWriterPtr writer, const xmlChar * content)
@@ -1397,14 +1373,13 @@ xmlTextWriterWriteRaw(xmlTextWriterPtr writer, const xmlChar * content)
}
/**
- * xmlTextWriterWriteFormatString:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatString(xmlTextWriterPtr writer, const char *format,
@@ -1425,14 +1400,13 @@ xmlTextWriterWriteFormatString(xmlTextWriterPtr writer, const char *format,
}
/**
- * xmlTextWriterWriteVFormatString:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatString(xmlTextWriterPtr writer,
@@ -1455,13 +1429,12 @@ xmlTextWriterWriteVFormatString(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteString:
- * @writer: the xmlTextWriterPtr
- * @content: text string
+ * @param writer the xmlTextWriterPtr
+ * @param content text string
*
* Write an xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteString(xmlTextWriterPtr writer, const xmlChar * content)
@@ -1515,15 +1488,14 @@ xmlTextWriterWriteString(xmlTextWriterPtr writer, const xmlChar * content)
}
/**
- * xmlOutputBufferWriteBase64:
- * @out: the xmlOutputBufferPtr
- * @data: binary data
- * @len: the number of bytes to encode
+ * @param out the xmlOutputBufferPtr
+ * @param data binary data
+ * @param len the number of bytes to encode
*
* Write base64 encoded data to an xmlOutputBuffer.
* Adapted from John Walker's base64.c (http://www.fourmilab.ch/).
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
static int
xmlOutputBufferWriteBase64(xmlOutputBufferPtr out, int len,
@@ -1597,15 +1569,14 @@ xmlOutputBufferWriteBase64(xmlOutputBufferPtr out, int len,
}
/**
- * xmlTextWriterWriteBase64:
- * @writer: the xmlTextWriterPtr
- * @data: binary data
- * @start: the position within the data of the first byte to encode
- * @len: the number of bytes to encode
+ * @param writer the xmlTextWriterPtr
+ * @param data binary data
+ * @param start the position within the data of the first byte to encode
+ * @param len the number of bytes to encode
*
* Write an base64 encoded xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteBase64(xmlTextWriterPtr writer, const char *data,
@@ -1645,14 +1616,13 @@ xmlTextWriterWriteBase64(xmlTextWriterPtr writer, const char *data,
}
/**
- * xmlOutputBufferWriteBinHex:
- * @out: the xmlOutputBufferPtr
- * @data: binary data
- * @len: the number of bytes to encode
+ * @param out the xmlOutputBufferPtr
+ * @param data binary data
+ * @param len the number of bytes to encode
*
* Write hqx encoded data to an xmlOutputBuffer.
*
- * Returns the bytes written (may be 0 because of buffering)
+ * @returns the bytes written (may be 0 because of buffering)
* or -1 in case of error
*/
static int
@@ -1689,15 +1659,14 @@ xmlOutputBufferWriteBinHex(xmlOutputBufferPtr out,
}
/**
- * xmlTextWriterWriteBinHex:
- * @writer: the xmlTextWriterPtr
- * @data: binary data
- * @start: the position within the data of the first byte to encode
- * @len: the number of bytes to encode
+ * @param writer the xmlTextWriterPtr
+ * @param data binary data
+ * @param start the position within the data of the first byte to encode
+ * @param len the number of bytes to encode
*
* Write a BinHex encoded xml text.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteBinHex(xmlTextWriterPtr writer, const char *data,
@@ -1737,13 +1706,12 @@ xmlTextWriterWriteBinHex(xmlTextWriterPtr writer, const char *data,
}
/**
- * xmlTextWriterStartAttribute:
- * @writer: the xmlTextWriterPtr
- * @name: element name
+ * @param writer the xmlTextWriterPtr
+ * @param name element name
*
* Start an xml attribute.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartAttribute(xmlTextWriterPtr writer, const xmlChar * name)
@@ -1801,15 +1769,14 @@ xmlTextWriterStartAttribute(xmlTextWriterPtr writer, const xmlChar * name)
}
/**
- * xmlTextWriterStartAttributeNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix or NULL
- * @name: element local name
- * @namespaceURI: namespace URI or NULL
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix or NULL
+ * @param name element local name
+ * @param namespaceURI namespace URI or NULL
*
* Start an xml attribute with namespace support.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartAttributeNS(xmlTextWriterPtr writer,
@@ -1893,12 +1860,11 @@ xmlTextWriterStartAttributeNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterEndAttribute:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End the current xml element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndAttribute(xmlTextWriterPtr writer)
@@ -1940,15 +1906,14 @@ xmlTextWriterEndAttribute(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatAttribute:
- * @writer: the xmlTextWriterPtr
- * @name: attribute name
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param name attribute name
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted xml attribute.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatAttribute(xmlTextWriterPtr writer,
@@ -1967,15 +1932,14 @@ xmlTextWriterWriteFormatAttribute(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatAttribute:
- * @writer: the xmlTextWriterPtr
- * @name: attribute name
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param name attribute name
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml attribute.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatAttribute(xmlTextWriterPtr writer,
@@ -1999,14 +1963,13 @@ xmlTextWriterWriteVFormatAttribute(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteAttribute:
- * @writer: the xmlTextWriterPtr
- * @name: attribute name
- * @content: attribute content
+ * @param writer the xmlTextWriterPtr
+ * @param name attribute name
+ * @param content attribute content
*
* Write an xml attribute.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteAttribute(xmlTextWriterPtr writer, const xmlChar * name,
@@ -2033,17 +1996,16 @@ xmlTextWriterWriteAttribute(xmlTextWriterPtr writer, const xmlChar * name,
}
/**
- * xmlTextWriterWriteFormatAttributeNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix
- * @name: attribute local name
- * @namespaceURI: namespace URI
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix
+ * @param name attribute local name
+ * @param namespaceURI namespace URI
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted xml attribute.with namespace support
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatAttributeNS(xmlTextWriterPtr writer,
@@ -2065,17 +2027,16 @@ xmlTextWriterWriteFormatAttributeNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatAttributeNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix
- * @name: attribute local name
- * @namespaceURI: namespace URI
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix
+ * @param name attribute local name
+ * @param namespaceURI namespace URI
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml attribute.with namespace support
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatAttributeNS(xmlTextWriterPtr writer,
@@ -2102,16 +2063,15 @@ xmlTextWriterWriteVFormatAttributeNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteAttributeNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix
- * @name: attribute local name
- * @namespaceURI: namespace URI
- * @content: attribute content
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix
+ * @param name attribute local name
+ * @param namespaceURI namespace URI
+ * @param content attribute content
*
* Write an xml attribute.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteAttributeNS(xmlTextWriterPtr writer,
@@ -2143,15 +2103,14 @@ xmlTextWriterWriteAttributeNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteFormatElement:
- * @writer: the xmlTextWriterPtr
- * @name: element name
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param name element name
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted xml element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatElement(xmlTextWriterPtr writer,
@@ -2170,15 +2129,14 @@ xmlTextWriterWriteFormatElement(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatElement:
- * @writer: the xmlTextWriterPtr
- * @name: element name
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param name element name
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatElement(xmlTextWriterPtr writer,
@@ -2202,14 +2160,13 @@ xmlTextWriterWriteVFormatElement(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteElement:
- * @writer: the xmlTextWriterPtr
- * @name: element name
- * @content: element content
+ * @param writer the xmlTextWriterPtr
+ * @param name element name
+ * @param content element content
*
* Write an xml element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteElement(xmlTextWriterPtr writer, const xmlChar * name,
@@ -2238,17 +2195,16 @@ xmlTextWriterWriteElement(xmlTextWriterPtr writer, const xmlChar * name,
}
/**
- * xmlTextWriterWriteFormatElementNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix
- * @name: element local name
- * @namespaceURI: namespace URI
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix
+ * @param name element local name
+ * @param namespaceURI namespace URI
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted xml element with namespace support.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatElementNS(xmlTextWriterPtr writer,
@@ -2270,17 +2226,16 @@ xmlTextWriterWriteFormatElementNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatElementNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix
- * @name: element local name
- * @namespaceURI: namespace URI
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix
+ * @param name element local name
+ * @param namespaceURI namespace URI
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml element with namespace support.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatElementNS(xmlTextWriterPtr writer,
@@ -2307,16 +2262,15 @@ xmlTextWriterWriteVFormatElementNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteElementNS:
- * @writer: the xmlTextWriterPtr
- * @prefix: namespace prefix
- * @name: element local name
- * @namespaceURI: namespace URI
- * @content: element content
+ * @param writer the xmlTextWriterPtr
+ * @param prefix namespace prefix
+ * @param name element local name
+ * @param namespaceURI namespace URI
+ * @param content element content
*
* Write an xml element with namespace support.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteElementNS(xmlTextWriterPtr writer,
@@ -2349,13 +2303,12 @@ xmlTextWriterWriteElementNS(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterStartPI:
- * @writer: the xmlTextWriterPtr
- * @target: PI target
+ * @param writer the xmlTextWriterPtr
+ * @param target PI target
*
* Start an xml PI.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartPI(xmlTextWriterPtr writer, const xmlChar * target)
@@ -2446,12 +2399,11 @@ xmlTextWriterStartPI(xmlTextWriterPtr writer, const xmlChar * target)
}
/**
- * xmlTextWriterEndPI:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End the current xml PI.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndPI(xmlTextWriterPtr writer)
@@ -2497,15 +2449,14 @@ xmlTextWriterEndPI(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatPI:
- * @writer: the xmlTextWriterPtr
- * @target: PI target
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param target PI target
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted PI.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatPI(xmlTextWriterPtr writer, const xmlChar * target,
@@ -2523,15 +2474,14 @@ xmlTextWriterWriteFormatPI(xmlTextWriterPtr writer, const xmlChar * target,
}
/**
- * xmlTextWriterWriteVFormatPI:
- * @writer: the xmlTextWriterPtr
- * @target: PI target
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param target PI target
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml PI.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatPI(xmlTextWriterPtr writer,
@@ -2555,14 +2505,13 @@ xmlTextWriterWriteVFormatPI(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWritePI:
- * @writer: the xmlTextWriterPtr
- * @target: PI target
- * @content: PI content
+ * @param writer the xmlTextWriterPtr
+ * @param target PI target
+ * @param content PI content
*
* Write an xml PI.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWritePI(xmlTextWriterPtr writer, const xmlChar * target,
@@ -2591,12 +2540,11 @@ xmlTextWriterWritePI(xmlTextWriterPtr writer, const xmlChar * target,
}
/**
- * xmlTextWriterStartCDATA:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Start an xml CDATA section.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartCDATA(xmlTextWriterPtr writer)
@@ -2670,12 +2618,11 @@ xmlTextWriterStartCDATA(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterEndCDATA:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End an xml CDATA section.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndCDATA(xmlTextWriterPtr writer)
@@ -2713,14 +2660,13 @@ xmlTextWriterEndCDATA(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatCDATA:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted xml CDATA.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatCDATA(xmlTextWriterPtr writer, const char *format,
@@ -2738,14 +2684,13 @@ xmlTextWriterWriteFormatCDATA(xmlTextWriterPtr writer, const char *format,
}
/**
- * xmlTextWriterWriteVFormatCDATA:
- * @writer: the xmlTextWriterPtr
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted xml CDATA.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatCDATA(xmlTextWriterPtr writer, const char *format,
@@ -2768,13 +2713,12 @@ xmlTextWriterWriteVFormatCDATA(xmlTextWriterPtr writer, const char *format,
}
/**
- * xmlTextWriterWriteCDATA:
- * @writer: the xmlTextWriterPtr
- * @content: CDATA content
+ * @param writer the xmlTextWriterPtr
+ * @param content CDATA content
*
* Write an xml CDATA.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteCDATA(xmlTextWriterPtr writer, const xmlChar * content)
@@ -2802,15 +2746,14 @@ xmlTextWriterWriteCDATA(xmlTextWriterPtr writer, const xmlChar * content)
}
/**
- * xmlTextWriterStartDTD:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
*
* Start an xml DTD.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartDTD(xmlTextWriterPtr writer,
@@ -2942,12 +2885,11 @@ xmlTextWriterStartDTD(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterEndDTD:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End an xml DTD.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndDTD(xmlTextWriterPtr writer)
@@ -3019,17 +2961,16 @@ xmlTextWriterEndDTD(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatDTD:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a DTD with a formatted markup declarations part.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatDTD(xmlTextWriterPtr writer,
@@ -3050,17 +2991,16 @@ xmlTextWriterWriteFormatDTD(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatDTD:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a DTD with a formatted markup declarations part.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatDTD(xmlTextWriterPtr writer,
@@ -3086,16 +3026,15 @@ xmlTextWriterWriteVFormatDTD(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTD:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
- * @subset: string content of the DTD
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
+ * @param subset string content of the DTD
*
* Write a DTD.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTD(xmlTextWriterPtr writer,
@@ -3126,13 +3065,12 @@ xmlTextWriterWriteDTD(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterStartDTDElement:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD element
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD element
*
* Start an xml DTD element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartDTDElement(xmlTextWriterPtr writer, const xmlChar * name)
@@ -3214,12 +3152,11 @@ xmlTextWriterStartDTDElement(xmlTextWriterPtr writer, const xmlChar * name)
}
/**
- * xmlTextWriterEndDTDElement:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End an xml DTD element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndDTDElement(xmlTextWriterPtr writer)
@@ -3265,15 +3202,14 @@ xmlTextWriterEndDTDElement(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatDTDElement:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD element
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD element
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted DTD element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatDTDElement(xmlTextWriterPtr writer,
@@ -3292,15 +3228,14 @@ xmlTextWriterWriteFormatDTDElement(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatDTDElement:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD element
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD element
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted DTD element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatDTDElement(xmlTextWriterPtr writer,
@@ -3324,14 +3259,13 @@ xmlTextWriterWriteVFormatDTDElement(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDElement:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD element
- * @content: content of the element
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD element
+ * @param content content of the element
*
* Write a DTD element.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDElement(xmlTextWriterPtr writer,
@@ -3363,13 +3297,12 @@ xmlTextWriterWriteDTDElement(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterStartDTDAttlist:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD ATTLIST
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD ATTLIST
*
* Start an xml DTD ATTLIST.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartDTDAttlist(xmlTextWriterPtr writer, const xmlChar * name)
@@ -3451,12 +3384,11 @@ xmlTextWriterStartDTDAttlist(xmlTextWriterPtr writer, const xmlChar * name)
}
/**
- * xmlTextWriterEndDTDAttlist:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End an xml DTD attribute list.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndDTDAttlist(xmlTextWriterPtr writer)
@@ -3502,15 +3434,14 @@ xmlTextWriterEndDTDAttlist(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatDTDAttlist:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD ATTLIST
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD ATTLIST
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted DTD ATTLIST.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatDTDAttlist(xmlTextWriterPtr writer,
@@ -3529,15 +3460,14 @@ xmlTextWriterWriteFormatDTDAttlist(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatDTDAttlist:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD ATTLIST
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD ATTLIST
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted DTD ATTLIST.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatDTDAttlist(xmlTextWriterPtr writer,
@@ -3561,14 +3491,13 @@ xmlTextWriterWriteVFormatDTDAttlist(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDAttlist:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the DTD ATTLIST
- * @content: content of the ATTLIST
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the DTD ATTLIST
+ * @param content content of the ATTLIST
*
* Write a DTD ATTLIST.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDAttlist(xmlTextWriterPtr writer,
@@ -3600,14 +3529,13 @@ xmlTextWriterWriteDTDAttlist(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterStartDTDEntity:
- * @writer: the xmlTextWriterPtr
- * @pe: TRUE if this is a parameter entity, FALSE if not
- * @name: the name of the DTD ATTLIST
+ * @param writer the xmlTextWriterPtr
+ * @param pe TRUE if this is a parameter entity, FALSE if not
+ * @param name the name of the DTD ATTLIST
*
* Start an xml DTD ATTLIST.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterStartDTDEntity(xmlTextWriterPtr writer,
@@ -3702,12 +3630,11 @@ xmlTextWriterStartDTDEntity(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterEndDTDEntity:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* End an xml DTD entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterEndDTDEntity(xmlTextWriterPtr writer)
@@ -3759,16 +3686,15 @@ xmlTextWriterEndDTDEntity(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterWriteFormatDTDInternalEntity:
- * @writer: the xmlTextWriterPtr
- * @pe: TRUE if this is a parameter entity, FALSE if not
- * @name: the name of the DTD entity
- * @format: format string (see printf)
+ * @param writer the xmlTextWriterPtr
+ * @param pe TRUE if this is a parameter entity, FALSE if not
+ * @param name the name of the DTD entity
+ * @param format format string (see printf)
* @...: extra parameters for the format
*
* Write a formatted DTD internal entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteFormatDTDInternalEntity(xmlTextWriterPtr writer,
@@ -3789,16 +3715,15 @@ xmlTextWriterWriteFormatDTDInternalEntity(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteVFormatDTDInternalEntity:
- * @writer: the xmlTextWriterPtr
- * @pe: TRUE if this is a parameter entity, FALSE if not
- * @name: the name of the DTD entity
- * @format: format string (see printf)
- * @argptr: pointer to the first member of the variable argument list.
+ * @param writer the xmlTextWriterPtr
+ * @param pe TRUE if this is a parameter entity, FALSE if not
+ * @param name the name of the DTD entity
+ * @param format format string (see printf)
+ * @param argptr pointer to the first member of the variable argument list.
*
* Write a formatted DTD internal entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteVFormatDTDInternalEntity(xmlTextWriterPtr writer,
@@ -3824,18 +3749,17 @@ xmlTextWriterWriteVFormatDTDInternalEntity(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDEntity:
- * @writer: the xmlTextWriterPtr
- * @pe: TRUE if this is a parameter entity, FALSE if not
- * @name: the name of the DTD entity
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
- * @ndataid: the xml notation name.
- * @content: content of the entity
+ * @param writer the xmlTextWriterPtr
+ * @param pe TRUE if this is a parameter entity, FALSE if not
+ * @param name the name of the DTD entity
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
+ * @param ndataid the xml notation name.
+ * @param content content of the entity
*
* Write a DTD entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDEntity(xmlTextWriterPtr writer,
@@ -3860,15 +3784,14 @@ xmlTextWriterWriteDTDEntity(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDInternalEntity:
- * @writer: the xmlTextWriterPtr
- * @pe: TRUE if this is a parameter entity, FALSE if not
- * @name: the name of the DTD entity
- * @content: content of the entity
+ * @param writer the xmlTextWriterPtr
+ * @param pe TRUE if this is a parameter entity, FALSE if not
+ * @param name the name of the DTD entity
+ * @param content content of the entity
*
* Write a DTD internal entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDInternalEntity(xmlTextWriterPtr writer,
@@ -3902,17 +3825,16 @@ xmlTextWriterWriteDTDInternalEntity(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDExternalEntity:
- * @writer: the xmlTextWriterPtr
- * @pe: TRUE if this is a parameter entity, FALSE if not
- * @name: the name of the DTD entity
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
- * @ndataid: the xml notation name.
+ * @param writer the xmlTextWriterPtr
+ * @param pe TRUE if this is a parameter entity, FALSE if not
+ * @param name the name of the DTD entity
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
+ * @param ndataid the xml notation name.
*
* Write a DTD external entity. The entity must have been started with xmlTextWriterStartDTDEntity
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDExternalEntity(xmlTextWriterPtr writer,
@@ -3952,15 +3874,14 @@ xmlTextWriterWriteDTDExternalEntity(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDExternalEntityContents:
- * @writer: the xmlTextWriterPtr
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
- * @ndataid: the xml notation name.
+ * @param writer the xmlTextWriterPtr
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
+ * @param ndataid the xml notation name.
*
* Write the contents of a DTD external entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDExternalEntityContents(xmlTextWriterPtr writer,
@@ -4084,15 +4005,14 @@ xmlTextWriterWriteDTDExternalEntityContents(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterWriteDTDNotation:
- * @writer: the xmlTextWriterPtr
- * @name: the name of the xml notation
- * @pubid: the public identifier, which is an alternative to the system identifier
- * @sysid: the system identifier, which is the URI of the DTD
+ * @param writer the xmlTextWriterPtr
+ * @param name the name of the xml notation
+ * @param pubid the public identifier, which is an alternative to the system identifier
+ * @param sysid the system identifier, which is the URI of the DTD
*
* Write a DTD entity.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterWriteDTDNotation(xmlTextWriterPtr writer,
@@ -4207,12 +4127,11 @@ xmlTextWriterWriteDTDNotation(xmlTextWriterPtr writer,
}
/**
- * xmlTextWriterFlush:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Flush the output buffer.
*
- * Returns the bytes written (may be 0 because of buffering) or -1 in case of error
+ * @returns the bytes written (may be 0 because of buffering) or -1 in case of error
*/
int
xmlTextWriterFlush(xmlTextWriterPtr writer)
@@ -4231,14 +4150,13 @@ xmlTextWriterFlush(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterClose:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Flushes and closes the output buffer.
*
* Available since 2.13.0.
*
- * Returns an xmlParserErrors code.
+ * @returns an xmlParserErrors code.
*/
int
xmlTextWriterClose(xmlTextWriterPtr writer)
@@ -4264,8 +4182,7 @@ xmlTextWriterClose(xmlTextWriterPtr writer)
*/
/**
- * xmlFreeTextWriterStackEntry:
- * @lk: the xmlLinkPtr
+ * @param lk the xmlLinkPtr
*
* Free callback for the xmlList.
*/
@@ -4284,13 +4201,12 @@ xmlFreeTextWriterStackEntry(xmlLinkPtr lk)
}
/**
- * xmlCmpTextWriterStackEntry:
- * @data0: the first data
- * @data1: the second data
+ * @param data0 the first data
+ * @param data1 the second data
*
* Compare callback for the xmlList.
*
- * Returns -1, 0, 1
+ * @returns -1, 0, 1
*/
static int
xmlCmpTextWriterStackEntry(const void *data0, const void *data1)
@@ -4318,8 +4234,7 @@ xmlCmpTextWriterStackEntry(const void *data0, const void *data1)
*/
/**
- * xmlTextWriterOutputNSDecl:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Output the current namespace declarations.
*/
@@ -4363,8 +4278,7 @@ xmlTextWriterOutputNSDecl(xmlTextWriterPtr writer)
}
/**
- * xmlFreeTextWriterNsStackEntry:
- * @lk: the xmlLinkPtr
+ * @param lk the xmlLinkPtr
*
* Free callback for the xmlList.
*/
@@ -4386,13 +4300,12 @@ xmlFreeTextWriterNsStackEntry(xmlLinkPtr lk)
}
/**
- * xmlCmpTextWriterNsStackEntry:
- * @data0: the first data
- * @data1: the second data
+ * @param data0 the first data
+ * @param data1 the second data
*
* Compare callback for the xmlList.
*
- * Returns -1, 0, 1
+ * @returns -1, 0, 1
*/
static int
xmlCmpTextWriterNsStackEntry(const void *data0, const void *data1)
@@ -4422,14 +4335,13 @@ xmlCmpTextWriterNsStackEntry(const void *data0, const void *data1)
}
/**
- * xmlTextWriterWriteDocCallback:
- * @context: the xmlBufferPtr
- * @str: the data to write
- * @len: the length of the data
+ * @param context the xmlBufferPtr
+ * @param str the data to write
+ * @param len the length of the data
*
* Write callback for the xmlOutputBuffer with target xmlBuffer
*
- * Returns -1, 0, 1
+ * @returns -1, 0, 1
*/
static int
xmlTextWriterWriteDocCallback(void *context, const char *str, int len)
@@ -4449,12 +4361,11 @@ xmlTextWriterWriteDocCallback(void *context, const char *str, int len)
}
/**
- * xmlTextWriterCloseDocCallback:
- * @context: the xmlBufferPtr
+ * @param context the xmlBufferPtr
*
* Close callback for the xmlOutputBuffer with target xmlBuffer
*
- * Returns -1, 0, 1
+ * @returns -1, 0, 1
*/
static int
xmlTextWriterCloseDocCallback(void *context)
@@ -4474,13 +4385,12 @@ xmlTextWriterCloseDocCallback(void *context)
}
/**
- * xmlTextWriterVSprintf:
- * @format: see printf
- * @argptr: pointer to the first member of the variable argument list.
+ * @param format see printf
+ * @param argptr pointer to the first member of the variable argument list.
*
* Utility function for formatted output
*
- * Returns a new xmlChar buffer with the data or NULL on error. This buffer must be freed.
+ * @returns a new xmlChar buffer with the data or NULL on error. This buffer must be freed.
*/
static xmlChar *
xmlTextWriterVSprintf(const char *format, va_list argptr)
@@ -4518,8 +4428,7 @@ xmlTextWriterVSprintf(const char *format, va_list argptr)
}
/**
- * xmlTextWriterStartDocumentCallback:
- * @ctx: the user data (XML parser context)
+ * @param ctx the user data (XML parser context)
*
* called at the start of document processing.
*/
@@ -4567,13 +4476,12 @@ xmlTextWriterStartDocumentCallback(void *ctx)
}
/**
- * xmlTextWriterSetIndent:
- * @writer: the xmlTextWriterPtr
- * @indent: do indentation?
+ * @param writer the xmlTextWriterPtr
+ * @param indent do indentation?
*
* Set indentation output. indent = 0 do not indentation. indent > 0 do indentation.
*
- * Returns -1 on error or 0 otherwise.
+ * @returns -1 on error or 0 otherwise.
*/
int
xmlTextWriterSetIndent(xmlTextWriterPtr writer, int indent)
@@ -4588,13 +4496,12 @@ xmlTextWriterSetIndent(xmlTextWriterPtr writer, int indent)
}
/**
- * xmlTextWriterSetIndentString:
- * @writer: the xmlTextWriterPtr
- * @str: the xmlChar string
+ * @param writer the xmlTextWriterPtr
+ * @param str the xmlChar string
*
* Set string indentation.
*
- * Returns -1 on error or 0 otherwise.
+ * @returns -1 on error or 0 otherwise.
*/
int
xmlTextWriterSetIndentString(xmlTextWriterPtr writer, const xmlChar * str)
@@ -4613,13 +4520,12 @@ xmlTextWriterSetIndentString(xmlTextWriterPtr writer, const xmlChar * str)
}
/**
- * xmlTextWriterSetQuoteChar:
- * @writer: the xmlTextWriterPtr
- * @quotechar: the quote character
+ * @param writer the xmlTextWriterPtr
+ * @param quotechar the quote character
*
* Set the character used for quoting attributes.
*
- * Returns -1 on error or 0 otherwise.
+ * @returns -1 on error or 0 otherwise.
*/
int
xmlTextWriterSetQuoteChar(xmlTextWriterPtr writer, xmlChar quotechar)
@@ -4633,12 +4539,11 @@ xmlTextWriterSetQuoteChar(xmlTextWriterPtr writer, xmlChar quotechar)
}
/**
- * xmlTextWriterWriteIndent:
- * @writer: the xmlTextWriterPtr
+ * @param writer the xmlTextWriterPtr
*
* Write indent string.
*
- * Returns -1 on error or the number of strings written.
+ * @returns -1 on error or the number of strings written.
*/
static int
xmlTextWriterWriteIndent(xmlTextWriterPtr writer)
@@ -4661,13 +4566,12 @@ xmlTextWriterWriteIndent(xmlTextWriterPtr writer)
}
/**
- * xmlTextWriterHandleStateDependencies:
- * @writer: the xmlTextWriterPtr
- * @p: the xmlTextWriterStackEntry
+ * @param writer the xmlTextWriterPtr
+ * @param p the xmlTextWriterStackEntry
*
* Write state dependent strings.
*
- * Returns -1 on error or the number of characters written.
+ * @returns -1 on error or the number of characters written.
*/
static int
xmlTextWriterHandleStateDependencies(xmlTextWriterPtr writer,
diff --git a/xpath.c b/xpath.c
index e944cdf1..06295567 100644
--- a/xpath.c
+++ b/xpath.c
@@ -181,9 +181,8 @@ double xmlXPathPINF = 0.0;
double xmlXPathNINF = 0.0;
/**
- * xmlXPathInit:
*
- * DEPRECATED: Alias for xmlInitParser.
+ * @deprecated Alias for xmlInitParser.
*/
void
xmlXPathInit(void) {
@@ -203,7 +202,6 @@ xmlXPathSFComputeHash(const xmlChar *name) {
}
/**
- * xmlInitXPathInternal:
*
* Initialize the XPath environment
*/
@@ -252,12 +250,11 @@ xmlInitXPathInternal(void) {
************************************************************************/
/**
- * xmlXPathIsNaN:
- * @val: a double value
+ * @param val a double value
*
* Checks whether a double is a NaN.
*
- * Returns 1 if the value is a NaN, 0 otherwise
+ * @returns 1 if the value is a NaN, 0 otherwise
*/
int
xmlXPathIsNaN(double val) {
@@ -269,12 +266,11 @@ xmlXPathIsNaN(double val) {
}
/**
- * xmlXPathIsInf:
- * @val: a double value
+ * @param val a double value
*
* Checks whether a double is an infinity.
*
- * Returns 1 if the value is +Infinite, -1 if -Infinite, 0 otherwise
+ * @returns 1 if the value is +Infinite, -1 if -Infinite, 0 otherwise
*/
int
xmlXPathIsInf(double val) {
@@ -312,14 +308,13 @@ xmlXPathNodeSetClear(xmlNodeSetPtr set, int hasNsNodes);
#ifdef XP_OPTIMIZED_NON_ELEM_COMPARISON
/**
- * xmlXPathCmpNodesExt:
- * @node1: the first node
- * @node2: the second node
+ * @param node1 the first node
+ * @param node2 the second node
*
* Compare two nodes w.r.t document order.
* This one is optimized for handling of non-element nodes.
*
- * Returns -2 in case of error 1 if first point < second point, 0 if
+ * @returns -2 in case of error 1 if first point < second point, 0 if
* it's the same node, -1 otherwise
*/
static int
@@ -610,12 +605,12 @@ turtle_comparison:
#define SORT_TYPE xmlNodePtr
/**
* wrap_cmp:
- * @x: a node
- * @y: another node
+ * @param x a node
+ * @param y another node
*
* Comparison function for the Timsort implementation
*
- * Returns -2 in case of error -1 if first point < second point, 0 if
+ * @returns -2 in case of error -1 if first point < second point, 0 if
* it's the same node, +1 otherwise
*/
static
@@ -645,7 +640,7 @@ int wrap_cmp( xmlNodePtr x, xmlNodePtr y );
/**
* XP_ERRORNULL:
- * @X: the error code
+ * @param X the error code
*
* Macro to raise an XPath error and return NULL.
*/
@@ -688,8 +683,7 @@ static const char* const xmlXPathErrorMessages[] = {
#define MAXERRNO ((int)(sizeof(xmlXPathErrorMessages) / \
sizeof(xmlXPathErrorMessages[0])) - 1)
/**
- * xmlXPathErrMemory:
- * @ctxt: an XPath context
+ * @param ctxt an XPath context
*
* Handle a memory allocation failure.
*/
@@ -703,8 +697,7 @@ xmlXPathErrMemory(xmlXPathContextPtr ctxt)
}
/**
- * xmlXPathPErrMemory:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Handle a memory allocation failure.
*/
@@ -718,9 +711,8 @@ xmlXPathPErrMemory(xmlXPathParserContextPtr ctxt)
}
/**
- * xmlXPathErr:
- * @ctxt: a XPath parser context
- * @code: the error code
+ * @param ctxt a XPath parser context
+ * @param code the error code
*
* Handle an XPath error
*/
@@ -787,11 +779,10 @@ xmlXPathErr(xmlXPathParserContextPtr ctxt, int code)
}
/**
- * xmlXPatherror:
- * @ctxt: the XPath Parser context
- * @file: the file name
- * @line: the line number
- * @no: the error number
+ * @param ctxt the XPath Parser context
+ * @param file the file name
+ * @param line the line number
+ * @param no the error number
*
* Formats an error message.
*/
@@ -802,9 +793,8 @@ xmlXPatherror(xmlXPathParserContextPtr ctxt, const char *file ATTRIBUTE_UNUSED,
}
/**
- * xmlXPathCheckOpLimit:
- * @ctxt: the XPath Parser context
- * @opCount: the number of operations to be added
+ * @param ctxt the XPath Parser context
+ * @param opCount the number of operations to be added
*
* Adds opCount to the running total of operations and returns -1 if the
* operation limit is exceeded. Returns 0 otherwise.
@@ -942,11 +932,10 @@ xmlXPathFreeObjectEntry(void *obj, const xmlChar *name);
************************************************************************/
/**
- * xmlXPathNewCompExpr:
*
* Create a new Xpath component
*
- * Returns the newly allocated xmlXPathCompExprPtr or NULL in case of error
+ * @returns the newly allocated xmlXPathCompExprPtr or NULL in case of error
*/
static xmlXPathCompExprPtr
xmlXPathNewCompExpr(void) {
@@ -974,10 +963,9 @@ xmlXPathNewCompExpr(void) {
}
/**
- * xmlXPathFreeCompExpr:
- * @comp: an XPATH comp
+ * @param comp an XPATH comp
*
- * Free up the memory allocated by @comp
+ * Free up the memory allocated by `comp`
*/
void
xmlXPathFreeCompExpr(xmlXPathCompExprPtr comp)
@@ -1025,20 +1013,19 @@ xmlXPathFreeCompExpr(xmlXPathCompExprPtr comp)
}
/**
- * xmlXPathCompExprAdd:
- * @ctxt: XPath parser context
- * @ch1: first child index
- * @ch2: second child index
- * @op: an op
- * @value: the first int value
- * @value2: the second int value
- * @value3: the third int value
- * @value4: the first string value
- * @value5: the second string value
+ * @param ctxt XPath parser context
+ * @param ch1 first child index
+ * @param ch2 second child index
+ * @param op an op
+ * @param value the first int value
+ * @param value2 the second int value
+ * @param value3 the third int value
+ * @param value4 the first string value
+ * @param value5 the second string value
*
* Add a step to an XPath Compiled Expression
*
- * Returns -1 in case of failure, the index otherwise
+ * @returns -1 in case of failure, the index otherwise
*/
static int
xmlXPathCompExprAdd(xmlXPathParserContextPtr ctxt, int ch1, int ch2,
@@ -1231,10 +1218,9 @@ xmlXPathDebugDumpValueTree(FILE *output, xmlNodeSetPtr cur, int depth) {
}
/**
- * xmlXPathDebugDumpObject:
- * @output: the FILE * to dump the output
- * @cur: the object to inspect
- * @depth: indentation level
+ * @param output the FILE * to dump the output
+ * @param cur the object to inspect
+ * @param depth indentation level
*
* Dump the content of the object for debugging purposes
*/
@@ -1480,10 +1466,9 @@ finish:
}
/**
- * xmlXPathDebugDumpCompExpr:
- * @output: the FILE * for the output
- * @comp: the precompiled XPath expression
- * @depth: the indentation level.
+ * @param output the FILE * for the output
+ * @param comp the precompiled XPath expression
+ * @param depth the indentation level.
*
* Dumps the tree of the compiled XPath expression.
*/
@@ -1523,11 +1508,10 @@ xmlXPathDebugDumpCompExpr(FILE *output, xmlXPathCompExprPtr comp,
************************************************************************/
/**
- * xmlXPathNewCache:
*
* Create a new object cache
*
- * Returns the xmlXPathCache just allocated.
+ * @returns the xmlXPathCache just allocated.
*/
static xmlXPathContextCachePtr
xmlXPathNewCache(void)
@@ -1575,25 +1559,24 @@ xmlXPathFreeCache(xmlXPathContextCachePtr cache)
}
/**
- * xmlXPathContextSetCache:
*
- * @ctxt: the XPath context
- * @active: enables/disables (creates/frees) the cache
- * @value: a value with semantics dependent on @options
- * @options: options (currently only the value 0 is used)
+ * @param ctxt the XPath context
+ * @param active enables/disables (creates/frees) the cache
+ * @param value a value with semantics dependent on `options`
+ * @param options options (currently only the value 0 is used)
*
* Creates/frees an object cache on the XPath context.
* If activates XPath objects (xmlXPathObject) will be cached internally
* to be reused.
*
- * @options must be set to 0 to enable XPath object caching.
- * Other values for @options have currently no effect.
+ * `options` must be set to 0 to enable XPath object caching.
+ * Other values for `options` have currently no effect.
*
- * @value sets the maximum number of XPath objects to be cached per slot.
+ * `value` sets the maximum number of XPath objects to be cached per slot.
* There are two slots for node-set and misc objects.
* Use <0 for the default number (100).
*
- * Returns 0 if the setting succeeded, and -1 on API or internal errors.
+ * @returns 0 if the setting succeeded, and -1 on API or internal errors.
*/
int
xmlXPathContextSetCache(xmlXPathContextPtr ctxt,
@@ -1628,14 +1611,13 @@ xmlXPathContextSetCache(xmlXPathContextPtr ctxt,
}
/**
- * xmlXPathCacheWrapNodeSet:
- * @pctxt: the XPath context
- * @val: the NodePtr value
+ * @param pctxt the XPath context
+ * @param val the NodePtr value
*
* This is the cached version of xmlXPathWrapNodeSet().
- * Wrap the Nodeset @val in a new xmlXPathObjectPtr
+ * Wrap the Nodeset `val` in a new xmlXPathObjectPtr
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*
* In case of error the node set is destroyed and NULL is returned.
*/
@@ -1667,14 +1649,13 @@ xmlXPathCacheWrapNodeSet(xmlXPathParserContextPtr pctxt, xmlNodeSetPtr val)
}
/**
- * xmlXPathCacheWrapString:
- * @pctxt: the XPath context
- * @val: the xmlChar * value
+ * @param pctxt the XPath context
+ * @param val the xmlChar * value
*
* This is the cached version of xmlXPathWrapString().
- * Wraps the @val string into an XPath object.
+ * Wraps the `val` string into an XPath object.
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*/
static xmlXPathObjectPtr
xmlXPathCacheWrapString(xmlXPathParserContextPtr pctxt, xmlChar *val)
@@ -1702,15 +1683,14 @@ xmlXPathCacheWrapString(xmlXPathParserContextPtr pctxt, xmlChar *val)
}
/**
- * xmlXPathCacheNewNodeSet:
- * @pctxt: the XPath context
- * @val: the NodePtr value
+ * @param pctxt the XPath context
+ * @param val the NodePtr value
*
* This is the cached version of xmlXPathNewNodeSet().
* Acquire an xmlXPathObjectPtr of type NodeSet and initialize
- * it with the single Node @val
+ * it with the single Node `val`
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*/
static xmlXPathObjectPtr
xmlXPathCacheNewNodeSet(xmlXPathParserContextPtr pctxt, xmlNodePtr val)
@@ -1772,14 +1752,13 @@ xmlXPathCacheNewNodeSet(xmlXPathParserContextPtr pctxt, xmlNodePtr val)
}
/**
- * xmlXPathCacheNewString:
- * @pctxt: the XPath context
- * @val: the xmlChar * value
+ * @param pctxt the XPath context
+ * @param val the xmlChar * value
*
* This is the cached version of xmlXPathNewString().
- * Acquire an xmlXPathObjectPtr of type string and of value @val
+ * Acquire an xmlXPathObjectPtr of type string and of value `val`
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*/
static xmlXPathObjectPtr
xmlXPathCacheNewString(xmlXPathParserContextPtr pctxt, const xmlChar *val)
@@ -1817,14 +1796,13 @@ xmlXPathCacheNewString(xmlXPathParserContextPtr pctxt, const xmlChar *val)
}
/**
- * xmlXPathCacheNewCString:
- * @pctxt: the XPath context
- * @val: the char * value
+ * @param pctxt the XPath context
+ * @param val the char * value
*
* This is the cached version of xmlXPathNewCString().
- * Acquire an xmlXPathObjectPtr of type string and of value @val
+ * Acquire an xmlXPathObjectPtr of type string and of value `val`
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*/
static xmlXPathObjectPtr
xmlXPathCacheNewCString(xmlXPathParserContextPtr pctxt, const char *val)
@@ -1833,14 +1811,13 @@ xmlXPathCacheNewCString(xmlXPathParserContextPtr pctxt, const char *val)
}
/**
- * xmlXPathCacheNewBoolean:
- * @pctxt: the XPath context
- * @val: the boolean value
+ * @param pctxt the XPath context
+ * @param val the boolean value
*
* This is the cached version of xmlXPathNewBoolean().
- * Acquires an xmlXPathObjectPtr of type boolean and of value @val
+ * Acquires an xmlXPathObjectPtr of type boolean and of value `val`
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*/
static xmlXPathObjectPtr
xmlXPathCacheNewBoolean(xmlXPathParserContextPtr pctxt, int val)
@@ -1869,14 +1846,13 @@ xmlXPathCacheNewBoolean(xmlXPathParserContextPtr pctxt, int val)
}
/**
- * xmlXPathCacheNewFloat:
- * @pctxt: the XPath context
- * @val: the double value
+ * @param pctxt the XPath context
+ * @param val the double value
*
* This is the cached version of xmlXPathNewFloat().
- * Acquires an xmlXPathObjectPtr of type double and of value @val
+ * Acquires an xmlXPathObjectPtr of type double and of value `val`
*
- * Returns the created or reused object.
+ * @returns the created or reused object.
*/
static xmlXPathObjectPtr
xmlXPathCacheNewFloat(xmlXPathParserContextPtr pctxt, double val)
@@ -1905,14 +1881,13 @@ xmlXPathCacheNewFloat(xmlXPathParserContextPtr pctxt, double val)
}
/**
- * xmlXPathCacheObjectCopy:
- * @pctxt: the XPath context
- * @val: the original object
+ * @param pctxt the XPath context
+ * @param val the original object
*
* This is the cached version of xmlXPathObjectCopy().
* Acquire a copy of a given object
*
- * Returns a created or reused created object.
+ * @returns a created or reused created object.
*/
static xmlXPathObjectPtr
xmlXPathCacheObjectCopy(xmlXPathParserContextPtr pctxt, xmlXPathObjectPtr val)
@@ -1958,13 +1933,12 @@ xmlXPathCacheObjectCopy(xmlXPathParserContextPtr pctxt, xmlXPathObjectPtr val)
************************************************************************/
/**
- * xmlXPathCastToNumberInternal:
- * @ctxt: parser context
- * @val: an XPath object
+ * @param ctxt parser context
+ * @param val an XPath object
*
* Converts an XPath object to its number value
*
- * Returns the number value
+ * @returns the number value
*/
static double
xmlXPathCastToNumberInternal(xmlXPathParserContextPtr ctxt,
@@ -2009,12 +1983,11 @@ xmlXPathCastToNumberInternal(xmlXPathParserContextPtr ctxt,
}
/**
- * xmlXPathValuePop:
- * @ctxt: an XPath evaluation context
+ * @param ctxt an XPath evaluation context
*
* Pops the top XPath object from the value stack
*
- * Returns the XPath object just removed
+ * @returns the XPath object just removed
*/
xmlXPathObjectPtr
xmlXPathValuePop(xmlXPathParserContextPtr ctxt)
@@ -2035,14 +2008,13 @@ xmlXPathValuePop(xmlXPathParserContextPtr ctxt)
}
/**
- * xmlXPathValuePush:
- * @ctxt: an XPath evaluation context
- * @value: the XPath object
+ * @param ctxt an XPath evaluation context
+ * @param value the XPath object
*
* Pushes a new XPath object on top of the value stack. If value is NULL,
* a memory error is recorded in the parser context.
*
- * Returns the number of items on the value stack, or -1 in case of error.
+ * @returns the number of items on the value stack, or -1 in case of error.
*
* The object is destroyed in case of error.
*/
@@ -2083,13 +2055,12 @@ xmlXPathValuePush(xmlXPathParserContextPtr ctxt, xmlXPathObjectPtr value)
}
/**
- * xmlXPathPopBoolean:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pops a boolean from the stack, handling conversion if needed.
- * Check error with #xmlXPathCheckError.
+ * Check error with \#xmlXPathCheckError.
*
- * Returns the boolean
+ * @returns the boolean
*/
int
xmlXPathPopBoolean (xmlXPathParserContextPtr ctxt) {
@@ -2110,13 +2081,12 @@ xmlXPathPopBoolean (xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathPopNumber:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pops a number from the stack, handling conversion if needed.
- * Check error with #xmlXPathCheckError.
+ * Check error with \#xmlXPathCheckError.
*
- * Returns the number
+ * @returns the number
*/
double
xmlXPathPopNumber (xmlXPathParserContextPtr ctxt) {
@@ -2137,13 +2107,12 @@ xmlXPathPopNumber (xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathPopString:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pops a string from the stack, handling conversion if needed.
- * Check error with #xmlXPathCheckError.
+ * Check error with \#xmlXPathCheckError.
*
- * Returns the string
+ * @returns the string
*/
xmlChar *
xmlXPathPopString (xmlXPathParserContextPtr ctxt) {
@@ -2163,13 +2132,12 @@ xmlXPathPopString (xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathPopNodeSet:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pops a node-set from the stack, handling conversion if needed.
- * Check error with #xmlXPathCheckError.
+ * Check error with \#xmlXPathCheckError.
*
- * Returns the node-set
+ * @returns the node-set
*/
xmlNodeSetPtr
xmlXPathPopNodeSet (xmlXPathParserContextPtr ctxt) {
@@ -2193,13 +2161,12 @@ xmlXPathPopNodeSet (xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathPopExternal:
- * @ctxt: an XPath parser context
+ * @param ctxt an XPath parser context
*
* Pops an external object from the stack, handling conversion if needed.
- * Check error with #xmlXPathCheckError.
+ * Check error with \#xmlXPathCheckError.
*
- * Returns the object
+ * @returns the object
*/
void *
xmlXPathPopExternal (xmlXPathParserContextPtr ctxt) {
@@ -2279,10 +2246,9 @@ xmlXPathPopExternal (xmlXPathParserContextPtr ctxt) {
#define EXPONENT_DIGITS (3 + 2)
/**
- * xmlXPathFormatNumber:
- * @number: number to format
- * @buffer: output buffer
- * @buffersize: size of output buffer
+ * @param number number to format
+ * @param buffer output buffer
+ * @param buffersize size of output buffer
*
* Convert the number into a string representation.
*/
@@ -2412,8 +2378,7 @@ xmlXPathFormatNumber(double number, char buffer[], int buffersize)
************************************************************************/
/**
- * xmlXPathOrderDocElems:
- * @doc: an input document
+ * @param doc an input document
*
* Call this routine to speed up XPath computation on static documents.
* This stamps all the element nodes with the document order
@@ -2421,7 +2386,7 @@ xmlXPathFormatNumber(double number, char buffer[], int buffersize)
* field, the value stored is actually - the node number (starting at -1)
* to be able to differentiate from line numbers.
*
- * Returns the number of elements found in the document or -1 in case
+ * @returns the number of elements found in the document or -1 in case
* of error.
*/
long
@@ -2463,13 +2428,12 @@ xmlXPathOrderDocElems(xmlDocPtr doc) {
}
/**
- * xmlXPathCmpNodes:
- * @node1: the first node
- * @node2: the second node
+ * @param node1 the first node
+ * @param node2 the second node
*
* Compare two nodes w.r.t document order
*
- * Returns -2 in case of error 1 if first point < second point, 0 if
+ * @returns -2 in case of error 1 if first point < second point, 0 if
* it's the same node, -1 otherwise
*/
int
@@ -2610,8 +2574,7 @@ xmlXPathCmpNodes(xmlNodePtr node1, xmlNodePtr node2) {
}
/**
- * xmlXPathNodeSetSort:
- * @set: the node set
+ * @param set the node set
*
* Sort the node set in document order
*/
@@ -2659,15 +2622,14 @@ xmlXPathNodeSetSort(xmlNodeSetPtr set) {
#define XML_NODESET_DEFAULT 10
/**
- * xmlXPathNodeSetDupNs:
- * @node: the parent node of the namespace XPath node
- * @ns: the libxml namespace declaration node.
+ * @param node the parent node of the namespace XPath node
+ * @param ns the libxml namespace declaration node.
*
* Namespace node in libxml don't match the XPath semantic. In a node set
* the namespace nodes are duplicated and the next pointer is set to the
* parent node in the XPath semantic.
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
static xmlNodePtr
xmlXPathNodeSetDupNs(xmlNodePtr node, xmlNsPtr ns) {
@@ -2706,8 +2668,7 @@ xmlXPathNodeSetDupNs(xmlNodePtr node, xmlNsPtr ns) {
}
/**
- * xmlXPathNodeSetFreeNs:
- * @ns: the XPath namespace node found in a nodeset.
+ * @param ns the XPath namespace node found in a nodeset.
*
* Namespace nodes in libxml don't match the XPath semantic. In a node set
* the namespace nodes are duplicated and the next pointer is set to the
@@ -2728,12 +2689,11 @@ xmlXPathNodeSetFreeNs(xmlNsPtr ns) {
}
/**
- * xmlXPathNodeSetCreate:
- * @val: an initial xmlNodePtr, or NULL
+ * @param val an initial xmlNodePtr, or NULL
*
- * Create a new xmlNodeSetPtr of type double and of value @val
+ * Create a new xmlNodeSetPtr of type double and of value `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlNodeSetPtr
xmlXPathNodeSetCreate(xmlNodePtr val) {
@@ -2769,13 +2729,12 @@ xmlXPathNodeSetCreate(xmlNodePtr val) {
}
/**
- * xmlXPathNodeSetContains:
- * @cur: the node-set
- * @val: the node
+ * @param cur the node-set
+ * @param val the node
*
- * checks whether @cur contains @val
+ * checks whether `cur` contains `val`
*
- * Returns true (1) if @cur contains @val, false (0) otherwise
+ * @returns true (1) if `cur` contains `val`, false (0) otherwise
*/
int
xmlXPathNodeSetContains (xmlNodeSetPtr cur, xmlNodePtr val) {
@@ -2824,14 +2783,13 @@ xmlXPathNodeSetGrow(xmlNodeSetPtr cur) {
}
/**
- * xmlXPathNodeSetAddNs:
- * @cur: the initial node set
- * @node: the hosting node
- * @ns: a the namespace node
+ * @param cur the initial node set
+ * @param node the hosting node
+ * @param ns a the namespace node
*
* add a new namespace node to an existing NodeSet
*
- * Returns 0 in case of success and -1 in case of error
+ * @returns 0 in case of success and -1 in case of error
*/
int
xmlXPathNodeSetAddNs(xmlNodeSetPtr cur, xmlNodePtr node, xmlNsPtr ns) {
@@ -2870,13 +2828,12 @@ xmlXPathNodeSetAddNs(xmlNodeSetPtr cur, xmlNodePtr node, xmlNsPtr ns) {
}
/**
- * xmlXPathNodeSetAdd:
- * @cur: the initial node set
- * @val: a new xmlNodePtr
+ * @param cur the initial node set
+ * @param val a new xmlNodePtr
*
* add a new xmlNodePtr to an existing NodeSet
*
- * Returns 0 in case of success, and -1 in case of error
+ * @returns 0 in case of success, and -1 in case of error
*/
int
xmlXPathNodeSetAdd(xmlNodeSetPtr cur, xmlNodePtr val) {
@@ -2912,14 +2869,13 @@ xmlXPathNodeSetAdd(xmlNodeSetPtr cur, xmlNodePtr val) {
}
/**
- * xmlXPathNodeSetAddUnique:
- * @cur: the initial node set
- * @val: a new xmlNodePtr
+ * @param cur the initial node set
+ * @param val a new xmlNodePtr
*
* add a new xmlNodePtr to an existing NodeSet, optimized version
* when we are sure the node is not already in the set.
*
- * Returns 0 in case of success and -1 in case of failure
+ * @returns 0 in case of success and -1 in case of failure
*/
int
xmlXPathNodeSetAddUnique(xmlNodeSetPtr cur, xmlNodePtr val) {
@@ -2947,16 +2903,15 @@ xmlXPathNodeSetAddUnique(xmlNodeSetPtr cur, xmlNodePtr val) {
}
/**
- * xmlXPathNodeSetMerge:
- * @val1: the first NodeSet or NULL
- * @val2: the second NodeSet
+ * @param val1 the first NodeSet or NULL
+ * @param val2 the second NodeSet
*
- * Merges two nodesets, all nodes from @val2 are added to @val1
- * if @val1 is NULL, a new set is created and copied from @val2
+ * Merges two nodesets, all nodes from `val2` are added to `val1`
+ * if `val1` is NULL, a new set is created and copied from `val2`
*
- * Returns @val1 once extended or NULL in case of error.
+ * @returns `val1` once extended or NULL in case of error.
*
- * Frees @val1 in case of error.
+ * Frees `val1` in case of error.
*/
xmlNodeSetPtr
xmlXPathNodeSetMerge(xmlNodeSetPtr val1, xmlNodeSetPtr val2) {
@@ -3026,16 +2981,15 @@ error:
/**
- * xmlXPathNodeSetMergeAndClear:
- * @set1: the first NodeSet or NULL
- * @set2: the second NodeSet
+ * @param set1 the first NodeSet or NULL
+ * @param set2 the second NodeSet
*
- * Merges two nodesets, all nodes from @set2 are added to @set1.
+ * Merges two nodesets, all nodes from `set2` are added to `set1`.
* Checks for duplicate nodes. Clears set2.
*
- * Returns @set1 once extended or NULL in case of error.
+ * @returns `set1` once extended or NULL in case of error.
*
- * Frees @set1 in case of error.
+ * Frees `set1` in case of error.
*/
static xmlNodeSetPtr
xmlXPathNodeSetMergeAndClear(xmlNodeSetPtr set1, xmlNodeSetPtr set2)
@@ -3091,16 +3045,15 @@ error:
}
/**
- * xmlXPathNodeSetMergeAndClearNoDupls:
- * @set1: the first NodeSet or NULL
- * @set2: the second NodeSet
+ * @param set1 the first NodeSet or NULL
+ * @param set2 the second NodeSet
*
- * Merges two nodesets, all nodes from @set2 are added to @set1.
+ * Merges two nodesets, all nodes from `set2` are added to `set1`.
* Doesn't check for duplicate nodes. Clears set2.
*
- * Returns @set1 once extended or NULL in case of error.
+ * @returns `set1` once extended or NULL in case of error.
*
- * Frees @set1 in case of error.
+ * Frees `set1` in case of error.
*/
static xmlNodeSetPtr
xmlXPathNodeSetMergeAndClearNoDupls(xmlNodeSetPtr set1, xmlNodeSetPtr set2)
@@ -3129,9 +3082,8 @@ error:
}
/**
- * xmlXPathNodeSetDel:
- * @cur: the initial node set
- * @val: an xmlNodePtr
+ * @param cur the initial node set
+ * @param val an xmlNodePtr
*
* Removes an xmlNodePtr from an existing NodeSet
*/
@@ -3161,9 +3113,8 @@ xmlXPathNodeSetDel(xmlNodeSetPtr cur, xmlNodePtr val) {
}
/**
- * xmlXPathNodeSetRemove:
- * @cur: the initial node set
- * @val: the index to remove
+ * @param cur the initial node set
+ * @param val the index to remove
*
* Removes an entry from an existing NodeSet list.
*/
@@ -3181,8 +3132,7 @@ xmlXPathNodeSetRemove(xmlNodeSetPtr cur, int val) {
}
/**
- * xmlXPathFreeNodeSet:
- * @obj: the xmlNodeSetPtr to free
+ * @param obj the xmlNodeSetPtr to free
*
* Free the NodeSet compound (not the actual nodes !).
*/
@@ -3203,14 +3153,13 @@ xmlXPathFreeNodeSet(xmlNodeSetPtr obj) {
}
/**
- * xmlXPathNodeSetClearFromPos:
- * @set: the node set to be cleared
- * @pos: the start position to clear from
- * @hasNsNodes: the node set might contain namespace nodes
+ * @param set the node set to be cleared
+ * @param pos the start position to clear from
+ * @param hasNsNodes the node set might contain namespace nodes
*
* Clears the list from temporary XPath objects (e.g. namespace nodes
- * are feed) starting with the entry at @pos, but does *not* free the list
- * itself. Sets the length of the list to @pos.
+ * are feed) starting with the entry at `pos`, but does *not* free the list
+ * itself. Sets the length of the list to `pos`.
*/
static void
xmlXPathNodeSetClearFromPos(xmlNodeSetPtr set, int pos, int hasNsNodes)
@@ -3232,9 +3181,8 @@ xmlXPathNodeSetClearFromPos(xmlNodeSetPtr set, int pos, int hasNsNodes)
}
/**
- * xmlXPathNodeSetClear:
- * @set: the node set to clear
- * @hasNsNodes: the node set might contain namespace nodes
+ * @param set the node set to clear
+ * @param hasNsNodes the node set might contain namespace nodes
*
* Clears the list from all temporary XPath objects (e.g. namespace nodes
* are feed), but does *not* free the list itself. Sets the length of the
@@ -3247,8 +3195,7 @@ xmlXPathNodeSetClear(xmlNodeSetPtr set, int hasNsNodes)
}
/**
- * xmlXPathNodeSetKeepLast:
- * @set: the node set to be cleared
+ * @param set the node set to be cleared
*
* Move the last node to the first position and clear temporary XPath objects
* (e.g. namespace nodes) from all other nodes. Sets the length of the list
@@ -3273,13 +3220,12 @@ xmlXPathNodeSetKeepLast(xmlNodeSetPtr set)
}
/**
- * xmlXPathNewNodeSet:
- * @val: the NodePtr value
+ * @param val the NodePtr value
*
* Create a new xmlXPathObjectPtr of type NodeSet and initialize
- * it with the single Node @val
+ * it with the single Node `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewNodeSet(xmlNodePtr val) {
@@ -3301,13 +3247,12 @@ xmlXPathNewNodeSet(xmlNodePtr val) {
}
/**
- * xmlXPathNewValueTree:
- * @val: the NodePtr value
+ * @param val the NodePtr value
*
* Create a new xmlXPathObjectPtr of type Value Tree (XSLT) and initialize
- * it with the tree root @val
+ * it with the tree root `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewValueTree(xmlNodePtr val) {
@@ -3322,13 +3267,12 @@ xmlXPathNewValueTree(xmlNodePtr val) {
}
/**
- * xmlXPathNewNodeSetList:
- * @val: an existing NodeSet
+ * @param val an existing NodeSet
*
* Create a new xmlXPathObjectPtr of type NodeSet and initialize
- * it with the Nodeset @val
+ * it with the Nodeset `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewNodeSetList(xmlNodeSetPtr val)
@@ -3354,12 +3298,11 @@ xmlXPathNewNodeSetList(xmlNodeSetPtr val)
}
/**
- * xmlXPathWrapNodeSet:
- * @val: the NodePtr value
+ * @param val the NodePtr value
*
- * Wrap the Nodeset @val in a new xmlXPathObjectPtr
+ * Wrap the Nodeset `val` in a new xmlXPathObjectPtr
*
- * Returns the newly created object.
+ * @returns the newly created object.
*
* In case of error the node set is destroyed and NULL is returned.
*/
@@ -3379,10 +3322,9 @@ xmlXPathWrapNodeSet(xmlNodeSetPtr val) {
}
/**
- * xmlXPathFreeNodeSetList:
- * @obj: an existing NodeSetList object
+ * @param obj an existing NodeSetList object
*
- * Free up the xmlXPathObjectPtr @obj but don't deallocate the objects in
+ * Free up the xmlXPathObjectPtr `obj` but don't deallocate the objects in
* the list contrary to xmlXPathFreeObject().
*/
void
@@ -3392,14 +3334,13 @@ xmlXPathFreeNodeSetList(xmlXPathObjectPtr obj) {
}
/**
- * xmlXPathDifference:
- * @nodes1: a node-set
- * @nodes2: a node-set
+ * @param nodes1 a node-set
+ * @param nodes2 a node-set
*
* Implements the EXSLT - Sets difference() function:
* node-set set:difference (node-set, node-set)
*
- * Returns the difference between the two node sets, or nodes1 if
+ * @returns the difference between the two node sets, or nodes1 if
* nodes2 is empty
*/
xmlNodeSetPtr
@@ -3432,14 +3373,13 @@ xmlXPathDifference (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
}
/**
- * xmlXPathIntersection:
- * @nodes1: a node-set
- * @nodes2: a node-set
+ * @param nodes1 a node-set
+ * @param nodes2 a node-set
*
* Implements the EXSLT - Sets intersection() function:
* node-set set:intersection (node-set, node-set)
*
- * Returns a node set comprising the nodes that are within both the
+ * @returns a node set comprising the nodes that are within both the
* node sets passed as arguments
*/
xmlNodeSetPtr
@@ -3470,13 +3410,12 @@ xmlXPathIntersection (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
}
/**
- * xmlXPathDistinctSorted:
- * @nodes: a node-set, sorted by document order
+ * @param nodes a node-set, sorted by document order
*
* Implements the EXSLT - Sets distinct() function:
* node-set set:distinct (node-set)
*
- * Returns a subset of the nodes contained in @nodes, or @nodes if
+ * @returns a subset of the nodes contained in `nodes`, or `nodes` if
* it is empty
*/
xmlNodeSetPtr
@@ -3519,15 +3458,14 @@ error:
}
/**
- * xmlXPathDistinct:
- * @nodes: a node-set
+ * @param nodes a node-set
*
* Implements the EXSLT - Sets distinct() function:
* node-set set:distinct (node-set)
- * @nodes is sorted by document order, then #exslSetsDistinctSorted
+ * `nodes` is sorted by document order, then \#exslSetsDistinctSorted
* is called with the sorted node-set
*
- * Returns a subset of the nodes contained in @nodes, or @nodes if
+ * @returns a subset of the nodes contained in `nodes`, or `nodes` if
* it is empty
*/
xmlNodeSetPtr
@@ -3540,14 +3478,13 @@ xmlXPathDistinct (xmlNodeSetPtr nodes) {
}
/**
- * xmlXPathHasSameNodes:
- * @nodes1: a node-set
- * @nodes2: a node-set
+ * @param nodes1 a node-set
+ * @param nodes2 a node-set
*
* Implements the EXSLT - Sets has-same-nodes function:
* boolean set:has-same-node(node-set, node-set)
*
- * Returns true (1) if @nodes1 shares any node with @nodes2, false (0)
+ * @returns true (1) if `nodes1` shares any node with `nodes2`, false (0)
* otherwise
*/
int
@@ -3569,16 +3506,15 @@ xmlXPathHasSameNodes (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
}
/**
- * xmlXPathNodeLeadingSorted:
- * @nodes: a node-set, sorted by document order
- * @node: a node
+ * @param nodes a node-set, sorted by document order
+ * @param node a node
*
* Implements the EXSLT - Sets leading() function:
* node-set set:leading (node-set, node-set)
*
- * Returns the nodes in @nodes that precede @node in document order,
- * @nodes if @node is NULL or an empty node-set if @nodes
- * doesn't contain @node
+ * @returns the nodes in `nodes` that precede `node` in document order,
+ * `nodes` if `node` is NULL or an empty node-set if `nodes`
+ * doesn't contain `node`
*/
xmlNodeSetPtr
xmlXPathNodeLeadingSorted (xmlNodeSetPtr nodes, xmlNodePtr node) {
@@ -3610,18 +3546,17 @@ xmlXPathNodeLeadingSorted (xmlNodeSetPtr nodes, xmlNodePtr node) {
}
/**
- * xmlXPathNodeLeading:
- * @nodes: a node-set
- * @node: a node
+ * @param nodes a node-set
+ * @param node a node
*
* Implements the EXSLT - Sets leading() function:
* node-set set:leading (node-set, node-set)
- * @nodes is sorted by document order, then #exslSetsNodeLeadingSorted
+ * `nodes` is sorted by document order, then \#exslSetsNodeLeadingSorted
* is called.
*
- * Returns the nodes in @nodes that precede @node in document order,
- * @nodes if @node is NULL or an empty node-set if @nodes
- * doesn't contain @node
+ * @returns the nodes in `nodes` that precede `node` in document order,
+ * `nodes` if `node` is NULL or an empty node-set if `nodes`
+ * doesn't contain `node`
*/
xmlNodeSetPtr
xmlXPathNodeLeading (xmlNodeSetPtr nodes, xmlNodePtr node) {
@@ -3630,16 +3565,15 @@ xmlXPathNodeLeading (xmlNodeSetPtr nodes, xmlNodePtr node) {
}
/**
- * xmlXPathLeadingSorted:
- * @nodes1: a node-set, sorted by document order
- * @nodes2: a node-set, sorted by document order
+ * @param nodes1 a node-set, sorted by document order
+ * @param nodes2 a node-set, sorted by document order
*
* Implements the EXSLT - Sets leading() function:
* node-set set:leading (node-set, node-set)
*
- * Returns the nodes in @nodes1 that precede the first node in @nodes2
- * in document order, @nodes1 if @nodes2 is NULL or empty or
- * an empty node-set if @nodes1 doesn't contain @nodes2
+ * @returns the nodes in `nodes1` that precede the first node in `nodes2`
+ * in document order, `nodes1` if `nodes2` is NULL or empty or
+ * an empty node-set if `nodes1` doesn't contain `nodes2`
*/
xmlNodeSetPtr
xmlXPathLeadingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
@@ -3650,18 +3584,17 @@ xmlXPathLeadingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
}
/**
- * xmlXPathLeading:
- * @nodes1: a node-set
- * @nodes2: a node-set
+ * @param nodes1 a node-set
+ * @param nodes2 a node-set
*
* Implements the EXSLT - Sets leading() function:
* node-set set:leading (node-set, node-set)
- * @nodes1 and @nodes2 are sorted by document order, then
- * #exslSetsLeadingSorted is called.
+ * `nodes1` and `nodes2` are sorted by document order, then
+ * \#exslSetsLeadingSorted is called.
*
- * Returns the nodes in @nodes1 that precede the first node in @nodes2
- * in document order, @nodes1 if @nodes2 is NULL or empty or
- * an empty node-set if @nodes1 doesn't contain @nodes2
+ * @returns the nodes in `nodes1` that precede the first node in `nodes2`
+ * in document order, `nodes1` if `nodes2` is NULL or empty or
+ * an empty node-set if `nodes1` doesn't contain `nodes2`
*/
xmlNodeSetPtr
xmlXPathLeading (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
@@ -3676,16 +3609,15 @@ xmlXPathLeading (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
}
/**
- * xmlXPathNodeTrailingSorted:
- * @nodes: a node-set, sorted by document order
- * @node: a node
+ * @param nodes a node-set, sorted by document order
+ * @param node a node
*
* Implements the EXSLT - Sets trailing() function:
* node-set set:trailing (node-set, node-set)
*
- * Returns the nodes in @nodes that follow @node in document order,
- * @nodes if @node is NULL or an empty node-set if @nodes
- * doesn't contain @node
+ * @returns the nodes in `nodes` that follow `node` in document order,
+ * `nodes` if `node` is NULL or an empty node-set if `nodes`
+ * doesn't contain `node`
*/
xmlNodeSetPtr
xmlXPathNodeTrailingSorted (xmlNodeSetPtr nodes, xmlNodePtr node) {
@@ -3718,18 +3650,17 @@ xmlXPathNodeTrailingSorted (xmlNodeSetPtr nodes, xmlNodePtr node) {
}
/**
- * xmlXPathNodeTrailing:
- * @nodes: a node-set
- * @node: a node
+ * @param nodes a node-set
+ * @param node a node
*
* Implements the EXSLT - Sets trailing() function:
* node-set set:trailing (node-set, node-set)
- * @nodes is sorted by document order, then #xmlXPathNodeTrailingSorted
+ * `nodes` is sorted by document order, then \#xmlXPathNodeTrailingSorted
* is called.
*
- * Returns the nodes in @nodes that follow @node in document order,
- * @nodes if @node is NULL or an empty node-set if @nodes
- * doesn't contain @node
+ * @returns the nodes in `nodes` that follow `node` in document order,
+ * `nodes` if `node` is NULL or an empty node-set if `nodes`
+ * doesn't contain `node`
*/
xmlNodeSetPtr
xmlXPathNodeTrailing (xmlNodeSetPtr nodes, xmlNodePtr node) {
@@ -3738,16 +3669,15 @@ xmlXPathNodeTrailing (xmlNodeSetPtr nodes, xmlNodePtr node) {
}
/**
- * xmlXPathTrailingSorted:
- * @nodes1: a node-set, sorted by document order
- * @nodes2: a node-set, sorted by document order
+ * @param nodes1 a node-set, sorted by document order
+ * @param nodes2 a node-set, sorted by document order
*
* Implements the EXSLT - Sets trailing() function:
* node-set set:trailing (node-set, node-set)
*
- * Returns the nodes in @nodes1 that follow the first node in @nodes2
- * in document order, @nodes1 if @nodes2 is NULL or empty or
- * an empty node-set if @nodes1 doesn't contain @nodes2
+ * @returns the nodes in `nodes1` that follow the first node in `nodes2`
+ * in document order, `nodes1` if `nodes2` is NULL or empty or
+ * an empty node-set if `nodes1` doesn't contain `nodes2`
*/
xmlNodeSetPtr
xmlXPathTrailingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
@@ -3758,18 +3688,17 @@ xmlXPathTrailingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
}
/**
- * xmlXPathTrailing:
- * @nodes1: a node-set
- * @nodes2: a node-set
+ * @param nodes1 a node-set
+ * @param nodes2 a node-set
*
* Implements the EXSLT - Sets trailing() function:
* node-set set:trailing (node-set, node-set)
- * @nodes1 and @nodes2 are sorted by document order, then
- * #xmlXPathTrailingSorted is called.
+ * `nodes1` and `nodes2` are sorted by document order, then
+ * \#xmlXPathTrailingSorted is called.
*
- * Returns the nodes in @nodes1 that follow the first node in @nodes2
- * in document order, @nodes1 if @nodes2 is NULL or empty or
- * an empty node-set if @nodes1 doesn't contain @nodes2
+ * @returns the nodes in `nodes1` that follow the first node in `nodes2`
+ * in document order, `nodes1` if `nodes2` is NULL or empty or
+ * an empty node-set if `nodes1` doesn't contain `nodes2`
*/
xmlNodeSetPtr
xmlXPathTrailing (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
@@ -3790,14 +3719,13 @@ xmlXPathTrailing (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) {
************************************************************************/
/**
- * xmlXPathRegisterFunc:
- * @ctxt: the XPath context
- * @name: the function name
- * @f: the function implementation or NULL
+ * @param ctxt the XPath context
+ * @param name the function name
+ * @param f the function implementation or NULL
*
- * Register a new function. If @f is NULL it unregisters the function
+ * Register a new function. If `f` is NULL it unregisters the function
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlXPathRegisterFunc(xmlXPathContextPtr ctxt, const xmlChar *name,
@@ -3806,15 +3734,14 @@ xmlXPathRegisterFunc(xmlXPathContextPtr ctxt, const xmlChar *name,
}
/**
- * xmlXPathRegisterFuncNS:
- * @ctxt: the XPath context
- * @name: the function name
- * @ns_uri: the function namespace URI
- * @f: the function implementation or NULL
+ * @param ctxt the XPath context
+ * @param name the function name
+ * @param ns_uri the function namespace URI
+ * @param f the function implementation or NULL
*
- * Register a new function. If @f is NULL it unregisters the function
+ * Register a new function. If `f` is NULL it unregisters the function
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlXPathRegisterFuncNS(xmlXPathContextPtr ctxt, const xmlChar *name,
@@ -3846,10 +3773,9 @@ xmlXPathRegisterFuncNS(xmlXPathContextPtr ctxt, const xmlChar *name,
}
/**
- * xmlXPathRegisterFuncLookup:
- * @ctxt: the XPath context
- * @f: the lookup function
- * @funcCtxt: the lookup data
+ * @param ctxt the XPath context
+ * @param f the lookup function
+ * @param funcCtxt the lookup data
*
* Registers an external mechanism to do function lookup.
*/
@@ -3864,14 +3790,13 @@ xmlXPathRegisterFuncLookup (xmlXPathContextPtr ctxt,
}
/**
- * xmlXPathFunctionLookup:
- * @ctxt: the XPath context
- * @name: the function name
+ * @param ctxt the XPath context
+ * @param name the function name
*
* Search in the Function array of the context for the given
* function.
*
- * Returns the xmlXPathFunction or NULL if not found
+ * @returns the xmlXPathFunction or NULL if not found
*/
xmlXPathFunction
xmlXPathFunctionLookup(xmlXPathContextPtr ctxt, const xmlChar *name) {
@@ -3879,15 +3804,14 @@ xmlXPathFunctionLookup(xmlXPathContextPtr ctxt, const xmlChar *name) {
}
/**
- * xmlXPathFunctionLookupNS:
- * @ctxt: the XPath context
- * @name: the function name
- * @ns_uri: the function namespace URI
+ * @param ctxt the XPath context
+ * @param name the function name
+ * @param ns_uri the function namespace URI
*
* Search in the Function array of the context for the given
* function.
*
- * Returns the xmlXPathFunction or NULL if not found
+ * @returns the xmlXPathFunction or NULL if not found
*/
xmlXPathFunction
xmlXPathFunctionLookupNS(xmlXPathContextPtr ctxt, const xmlChar *name,
@@ -3935,8 +3859,7 @@ xmlXPathFunctionLookupNS(xmlXPathContextPtr ctxt, const xmlChar *name,
}
/**
- * xmlXPathRegisteredFuncsCleanup:
- * @ctxt: the XPath context
+ * @param ctxt the XPath context
*
* Cleanup the XPath context data associated to registered functions
*/
@@ -3956,15 +3879,14 @@ xmlXPathRegisteredFuncsCleanup(xmlXPathContextPtr ctxt) {
************************************************************************/
/**
- * xmlXPathRegisterVariable:
- * @ctxt: the XPath context
- * @name: the variable name
- * @value: the variable value or NULL
+ * @param ctxt the XPath context
+ * @param name the variable name
+ * @param value the variable value or NULL
*
- * Register a new variable value. If @value is NULL it unregisters
+ * Register a new variable value. If `value` is NULL it unregisters
* the variable
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlXPathRegisterVariable(xmlXPathContextPtr ctxt, const xmlChar *name,
@@ -3973,16 +3895,15 @@ xmlXPathRegisterVariable(xmlXPathContextPtr ctxt, const xmlChar *name,
}
/**
- * xmlXPathRegisterVariableNS:
- * @ctxt: the XPath context
- * @name: the variable name
- * @ns_uri: the variable namespace URI
- * @value: the variable value or NULL
+ * @param ctxt the XPath context
+ * @param name the variable name
+ * @param ns_uri the variable namespace URI
+ * @param value the variable value or NULL
*
- * Register a new variable value. If @value is NULL it unregisters
+ * Register a new variable value. If `value` is NULL it unregisters
* the variable
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlXPathRegisterVariableNS(xmlXPathContextPtr ctxt, const xmlChar *name,
@@ -4005,10 +3926,9 @@ xmlXPathRegisterVariableNS(xmlXPathContextPtr ctxt, const xmlChar *name,
}
/**
- * xmlXPathRegisterVariableLookup:
- * @ctxt: the XPath context
- * @f: the lookup function
- * @data: the lookup data
+ * @param ctxt the XPath context
+ * @param f the lookup function
+ * @param data the lookup data
*
* register an external mechanism to do variable lookup
*/
@@ -4022,14 +3942,13 @@ xmlXPathRegisterVariableLookup(xmlXPathContextPtr ctxt,
}
/**
- * xmlXPathVariableLookup:
- * @ctxt: the XPath context
- * @name: the variable name
+ * @param ctxt the XPath context
+ * @param name the variable name
*
* Search in the Variable array of the context for the given
* variable value.
*
- * Returns a copy of the value or NULL if not found
+ * @returns a copy of the value or NULL if not found
*/
xmlXPathObjectPtr
xmlXPathVariableLookup(xmlXPathContextPtr ctxt, const xmlChar *name) {
@@ -4047,15 +3966,14 @@ xmlXPathVariableLookup(xmlXPathContextPtr ctxt, const xmlChar *name) {
}
/**
- * xmlXPathVariableLookupNS:
- * @ctxt: the XPath context
- * @name: the variable name
- * @ns_uri: the variable namespace URI
+ * @param ctxt the XPath context
+ * @param name the variable name
+ * @param ns_uri the variable namespace URI
*
* Search in the Variable array of the context for the given
* variable value.
*
- * Returns the a copy of the value or NULL if not found
+ * @returns the a copy of the value or NULL if not found
*/
xmlXPathObjectPtr
xmlXPathVariableLookupNS(xmlXPathContextPtr ctxt, const xmlChar *name,
@@ -4080,8 +3998,7 @@ xmlXPathVariableLookupNS(xmlXPathContextPtr ctxt, const xmlChar *name,
}
/**
- * xmlXPathRegisteredVariablesCleanup:
- * @ctxt: the XPath context
+ * @param ctxt the XPath context
*
* Cleanup the XPath context data associated to registered variables
*/
@@ -4095,15 +4012,14 @@ xmlXPathRegisteredVariablesCleanup(xmlXPathContextPtr ctxt) {
}
/**
- * xmlXPathRegisterNs:
- * @ctxt: the XPath context
- * @prefix: the namespace prefix cannot be NULL or empty string
- * @ns_uri: the namespace name
+ * @param ctxt the XPath context
+ * @param prefix the namespace prefix cannot be NULL or empty string
+ * @param ns_uri the namespace name
*
- * Register a new namespace. If @ns_uri is NULL it unregisters
+ * Register a new namespace. If `ns_uri` is NULL it unregisters
* the namespace
*
- * Returns 0 in case of success, -1 in case of error
+ * @returns 0 in case of success, -1 in case of error
*/
int
xmlXPathRegisterNs(xmlXPathContextPtr ctxt, const xmlChar *prefix,
@@ -4143,14 +4059,13 @@ xmlXPathRegisterNs(xmlXPathContextPtr ctxt, const xmlChar *prefix,
}
/**
- * xmlXPathNsLookup:
- * @ctxt: the XPath context
- * @prefix: the namespace prefix value
+ * @param ctxt the XPath context
+ * @param prefix the namespace prefix value
*
* Search in the namespace declaration array of the context for the given
* namespace name associated to the given prefix
*
- * Returns the value or NULL if not found
+ * @returns the value or NULL if not found
*/
const xmlChar *
xmlXPathNsLookup(xmlXPathContextPtr ctxt, const xmlChar *prefix) {
@@ -4176,8 +4091,7 @@ xmlXPathNsLookup(xmlXPathContextPtr ctxt, const xmlChar *prefix) {
}
/**
- * xmlXPathRegisteredNsCleanup:
- * @ctxt: the XPath context
+ * @param ctxt the XPath context
*
* Cleanup the XPath context data associated to registered variables
*/
@@ -4199,12 +4113,11 @@ xmlXPathRegisteredNsCleanup(xmlXPathContextPtr ctxt) {
/* Allocations are terrible, one needs to optimize all this !!! */
/**
- * xmlXPathNewFloat:
- * @val: the double value
+ * @param val the double value
*
- * Create a new xmlXPathObjectPtr of type double and of value @val
+ * Create a new xmlXPathObjectPtr of type double and of value `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewFloat(double val) {
@@ -4220,12 +4133,11 @@ xmlXPathNewFloat(double val) {
}
/**
- * xmlXPathNewBoolean:
- * @val: the boolean value
+ * @param val the boolean value
*
- * Create a new xmlXPathObjectPtr of type boolean and of value @val
+ * Create a new xmlXPathObjectPtr of type boolean and of value `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewBoolean(int val) {
@@ -4241,12 +4153,11 @@ xmlXPathNewBoolean(int val) {
}
/**
- * xmlXPathNewString:
- * @val: the xmlChar * value
+ * @param val the xmlChar * value
*
- * Create a new xmlXPathObjectPtr of type string and of value @val
+ * Create a new xmlXPathObjectPtr of type string and of value `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewString(const xmlChar *val) {
@@ -4268,14 +4179,13 @@ xmlXPathNewString(const xmlChar *val) {
}
/**
- * xmlXPathWrapString:
- * @val: the xmlChar * value
+ * @param val the xmlChar * value
*
- * Wraps the @val string into an XPath object.
+ * Wraps the `val` string into an XPath object.
*
- * Returns the newly created object.
+ * @returns the newly created object.
*
- * Frees @val in case of error.
+ * Frees `val` in case of error.
*/
xmlXPathObjectPtr
xmlXPathWrapString (xmlChar *val) {
@@ -4293,12 +4203,11 @@ xmlXPathWrapString (xmlChar *val) {
}
/**
- * xmlXPathNewCString:
- * @val: the char * value
+ * @param val the char * value
*
- * Create a new xmlXPathObjectPtr of type string and of value @val
+ * Create a new xmlXPathObjectPtr of type string and of value `val`
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathNewCString(const char *val) {
@@ -4306,12 +4215,11 @@ xmlXPathNewCString(const char *val) {
}
/**
- * xmlXPathWrapCString:
- * @val: the char * value
+ * @param val the char * value
*
* Wraps a string into an XPath object.
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathWrapCString (char * val) {
@@ -4319,12 +4227,11 @@ xmlXPathWrapCString (char * val) {
}
/**
- * xmlXPathWrapExternal:
- * @val: the user data
+ * @param val the user data
*
- * Wraps the @val data into an XPath object.
+ * Wraps the `val` data into an XPath object.
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathWrapExternal (void *val) {
@@ -4340,12 +4247,11 @@ xmlXPathWrapExternal (void *val) {
}
/**
- * xmlXPathObjectCopy:
- * @val: the original object
+ * @param val the original object
*
* allocate a new copy of a given object
*
- * Returns the newly created object.
+ * @returns the newly created object.
*/
xmlXPathObjectPtr
xmlXPathObjectCopy(xmlXPathObjectPtr val) {
@@ -4391,8 +4297,7 @@ xmlXPathObjectCopy(xmlXPathObjectPtr val) {
}
/**
- * xmlXPathFreeObject:
- * @obj: the object to free
+ * @param obj the object to free
*
* Free up an xmlXPathObjectPtr object.
*/
@@ -4415,9 +4320,8 @@ xmlXPathFreeObjectEntry(void *obj, const xmlChar *name ATTRIBUTE_UNUSED) {
}
/**
- * xmlXPathReleaseObject:
- * @ctxt: XPath context
- * @obj: the xmlXPathObjectPtr to free or to cache
+ * @param ctxt XPath context
+ * @param obj the xmlXPathObjectPtr to free or to cache
*
* Depending on the state of the cache this frees the given
* XPath object or stores it in the cache.
@@ -4515,12 +4419,11 @@ free_obj:
************************************************************************/
/**
- * xmlXPathCastBooleanToString:
- * @val: a boolean
+ * @param val a boolean
*
* Converts a boolean to its string value.
*
- * Returns a newly allocated string.
+ * @returns a newly allocated string.
*/
xmlChar *
xmlXPathCastBooleanToString (int val) {
@@ -4533,12 +4436,11 @@ xmlXPathCastBooleanToString (int val) {
}
/**
- * xmlXPathCastNumberToString:
- * @val: a number
+ * @param val a number
*
* Converts a number to its string value.
*
- * Returns a newly allocated string.
+ * @returns a newly allocated string.
*/
xmlChar *
xmlXPathCastNumberToString (double val) {
@@ -4568,12 +4470,11 @@ xmlXPathCastNumberToString (double val) {
}
/**
- * xmlXPathCastNodeToString:
- * @node: a node
+ * @param node a node
*
* Converts a node to its string value.
*
- * Returns a newly allocated string.
+ * @returns a newly allocated string.
*/
xmlChar *
xmlXPathCastNodeToString (xmlNodePtr node) {
@@ -4581,12 +4482,11 @@ xmlXPathCastNodeToString (xmlNodePtr node) {
}
/**
- * xmlXPathCastNodeSetToString:
- * @ns: a node-set
+ * @param ns a node-set
*
* Converts a node-set to its string value.
*
- * Returns a newly allocated string.
+ * @returns a newly allocated string.
*/
xmlChar *
xmlXPathCastNodeSetToString (xmlNodeSetPtr ns) {
@@ -4599,12 +4499,11 @@ xmlXPathCastNodeSetToString (xmlNodeSetPtr ns) {
}
/**
- * xmlXPathCastToString:
- * @val: an XPath object
+ * @param val an XPath object
*
* Converts an existing object to its string() equivalent
*
- * Returns the allocated string value of the object, NULL in case of error.
+ * @returns the allocated string value of the object, NULL in case of error.
* It's up to the caller to free the string memory with xmlFree().
*/
xmlChar *
@@ -4639,13 +4538,12 @@ xmlXPathCastToString(xmlXPathObjectPtr val) {
}
/**
- * xmlXPathConvertString:
- * @val: an XPath object
+ * @param val an XPath object
*
* Converts an existing object to its string() equivalent
*
- * Returns the new object, the old one is freed (or the operation
- * is done directly on @val)
+ * @returns the new object, the old one is freed (or the operation
+ * is done directly on `val`)
*/
xmlXPathObjectPtr
xmlXPathConvertString(xmlXPathObjectPtr val) {
@@ -4680,12 +4578,11 @@ xmlXPathConvertString(xmlXPathObjectPtr val) {
}
/**
- * xmlXPathCastBooleanToNumber:
- * @val: a boolean
+ * @param val a boolean
*
* Converts a boolean to its number value
*
- * Returns the number value
+ * @returns the number value
*/
double
xmlXPathCastBooleanToNumber(int val) {
@@ -4695,12 +4592,11 @@ xmlXPathCastBooleanToNumber(int val) {
}
/**
- * xmlXPathCastStringToNumber:
- * @val: a string
+ * @param val a string
*
* Converts a string to its number value
*
- * Returns the number value
+ * @returns the number value
*/
double
xmlXPathCastStringToNumber(const xmlChar * val) {
@@ -4708,13 +4604,12 @@ xmlXPathCastStringToNumber(const xmlChar * val) {
}
/**
- * xmlXPathNodeToNumberInternal:
- * @ctxt: XPath parser context
- * @node: a node
+ * @param ctxt XPath parser context
+ * @param node a node
*
* Converts a node to its number value
*
- * Returns the number value
+ * @returns the number value
*/
static double
xmlXPathNodeToNumberInternal(xmlXPathParserContextPtr ctxt, xmlNodePtr node) {
@@ -4735,12 +4630,11 @@ xmlXPathNodeToNumberInternal(xmlXPathParserContextPtr ctxt, xmlNodePtr node) {
}
/**
- * xmlXPathCastNodeToNumber:
- * @node: a node
+ * @param node a node
*
* Converts a node to its number value
*
- * Returns the number value
+ * @returns the number value
*/
double
xmlXPathCastNodeToNumber (xmlNodePtr node) {
@@ -4748,12 +4642,11 @@ xmlXPathCastNodeToNumber (xmlNodePtr node) {
}
/**
- * xmlXPathCastNodeSetToNumber:
- * @ns: a node-set
+ * @param ns a node-set
*
* Converts a node-set to its number value
*
- * Returns the number value
+ * @returns the number value
*/
double
xmlXPathCastNodeSetToNumber (xmlNodeSetPtr ns) {
@@ -4769,12 +4662,11 @@ xmlXPathCastNodeSetToNumber (xmlNodeSetPtr ns) {
}
/**
- * xmlXPathCastToNumber:
- * @val: an XPath object
+ * @param val an XPath object
*
* Converts an XPath object to its number value
*
- * Returns the number value
+ * @returns the number value
*/
double
xmlXPathCastToNumber(xmlXPathObjectPtr val) {
@@ -4782,13 +4674,12 @@ xmlXPathCastToNumber(xmlXPathObjectPtr val) {
}
/**
- * xmlXPathConvertNumber:
- * @val: an XPath object
+ * @param val an XPath object
*
* Converts an existing object to its number() equivalent
*
- * Returns the new object, the old one is freed (or the operation
- * is done directly on @val)
+ * @returns the new object, the old one is freed (or the operation
+ * is done directly on `val`)
*/
xmlXPathObjectPtr
xmlXPathConvertNumber(xmlXPathObjectPtr val) {
@@ -4804,12 +4695,11 @@ xmlXPathConvertNumber(xmlXPathObjectPtr val) {
}
/**
- * xmlXPathCastNumberToBoolean:
- * @val: a number
+ * @param val a number
*
* Converts a number to its boolean value
*
- * Returns the boolean value
+ * @returns the boolean value
*/
int
xmlXPathCastNumberToBoolean (double val) {
@@ -4819,12 +4709,11 @@ xmlXPathCastNumberToBoolean (double val) {
}
/**
- * xmlXPathCastStringToBoolean:
- * @val: a string
+ * @param val a string
*
* Converts a string to its boolean value
*
- * Returns the boolean value
+ * @returns the boolean value
*/
int
xmlXPathCastStringToBoolean (const xmlChar *val) {
@@ -4834,12 +4723,11 @@ xmlXPathCastStringToBoolean (const xmlChar *val) {
}
/**
- * xmlXPathCastNodeSetToBoolean:
- * @ns: a node-set
+ * @param ns a node-set
*
* Converts a node-set to its boolean value
*
- * Returns the boolean value
+ * @returns the boolean value
*/
int
xmlXPathCastNodeSetToBoolean (xmlNodeSetPtr ns) {
@@ -4849,12 +4737,11 @@ xmlXPathCastNodeSetToBoolean (xmlNodeSetPtr ns) {
}
/**
- * xmlXPathCastToBoolean:
- * @val: an XPath object
+ * @param val an XPath object
*
* Converts an XPath object to its boolean value
*
- * Returns the boolean value
+ * @returns the boolean value
*/
int
xmlXPathCastToBoolean (xmlXPathObjectPtr val) {
@@ -4889,13 +4776,12 @@ xmlXPathCastToBoolean (xmlXPathObjectPtr val) {
/**
- * xmlXPathConvertBoolean:
- * @val: an XPath object
+ * @param val an XPath object
*
* Converts an existing object to its boolean() equivalent
*
- * Returns the new object, the old one is freed (or the operation
- * is done directly on @val)
+ * @returns the new object, the old one is freed (or the operation
+ * is done directly on `val`)
*/
xmlXPathObjectPtr
xmlXPathConvertBoolean(xmlXPathObjectPtr val) {
@@ -4917,12 +4803,11 @@ xmlXPathConvertBoolean(xmlXPathObjectPtr val) {
************************************************************************/
/**
- * xmlXPathNewContext:
- * @doc: the XML document
+ * @param doc the XML document
*
* Create a new xmlXPathContext
*
- * Returns the xmlXPathContext just allocated. The caller will need to free it.
+ * @returns the xmlXPathContext just allocated. The caller will need to free it.
*/
xmlXPathContextPtr
xmlXPathNewContext(xmlDocPtr doc) {
@@ -4962,8 +4847,7 @@ xmlXPathNewContext(xmlDocPtr doc) {
}
/**
- * xmlXPathFreeContext:
- * @ctxt: the context to free
+ * @param ctxt the context to free
*
* Free up an xmlXPathContext
*/
@@ -4981,10 +4865,9 @@ xmlXPathFreeContext(xmlXPathContextPtr ctxt) {
}
/**
- * xmlXPathSetErrorHandler:
- * @ctxt: the XPath context
- * @handler: error handler
- * @data: user data which will be passed to the handler
+ * @param ctxt the XPath context
+ * @param handler error handler
+ * @param data user data which will be passed to the handler
*
* Register a callback function that will be called on errors and
* warnings. If handler is NULL, the error handler will be deactivated.
@@ -5008,13 +4891,12 @@ xmlXPathSetErrorHandler(xmlXPathContextPtr ctxt,
************************************************************************/
/**
- * xmlXPathNewParserContext:
- * @str: the XPath expression
- * @ctxt: the XPath context
+ * @param str the XPath expression
+ * @param ctxt the XPath context
*
* Create a new xmlXPathParserContext
*
- * Returns the xmlXPathParserContext just allocated.
+ * @returns the xmlXPathParserContext just allocated.
*/
xmlXPathParserContextPtr
xmlXPathNewParserContext(const xmlChar *str, xmlXPathContextPtr ctxt) {
@@ -5045,13 +4927,12 @@ xmlXPathNewParserContext(const xmlChar *str, xmlXPathContextPtr ctxt) {
}
/**
- * xmlXPathCompParserContext:
- * @comp: the XPath compiled expression
- * @ctxt: the XPath context
+ * @param comp the XPath compiled expression
+ * @param ctxt the XPath context
*
* Create a new xmlXPathParserContext when processing a compiled expression
*
- * Returns the xmlXPathParserContext just allocated.
+ * @returns the xmlXPathParserContext just allocated.
*/
static xmlXPathParserContextPtr
xmlXPathCompParserContext(xmlXPathCompExprPtr comp, xmlXPathContextPtr ctxt) {
@@ -5086,8 +4967,7 @@ xmlXPathCompParserContext(xmlXPathCompExprPtr comp, xmlXPathContextPtr ctxt) {
}
/**
- * xmlXPathFreeParserContext:
- * @ctxt: the context to free
+ * @param ctxt the context to free
*
* Free up an xmlXPathParserContext
*/
@@ -5126,13 +5006,12 @@ xmlXPathFreeParserContext(xmlXPathParserContextPtr ctxt) {
************************************************************************/
/**
- * xmlXPathNodeValHash:
- * @node: a node pointer
+ * @param node a node pointer
*
* Function computing the beginning of the string value of the node,
* used to speed up comparisons
*
- * Returns an int usable as a hash
+ * @returns an int usable as a hash
*/
static unsigned int
xmlXPathNodeValHash(xmlNodePtr node) {
@@ -5239,13 +5118,12 @@ xmlXPathNodeValHash(xmlNodePtr node) {
}
/**
- * xmlXPathStringHash:
- * @string: a string
+ * @param string a string
*
* Function computing the beginning of the string value of the node,
* used to speed up comparisons
*
- * Returns an int usable as a hash
+ * @returns an int usable as a hash
*/
static unsigned int
xmlXPathStringHash(const xmlChar * string) {
@@ -5257,18 +5135,17 @@ xmlXPathStringHash(const xmlChar * string) {
}
/**
- * xmlXPathCompareNodeSetFloat:
- * @ctxt: the XPath Parser context
- * @inf: less than (1) or greater than (0)
- * @strict: is the comparison strict
- * @arg: the node set
- * @f: the value
+ * @param ctxt the XPath Parser context
+ * @param inf less than (1) or greater than (0)
+ * @param strict is the comparison strict
+ * @param arg the node set
+ * @param f the value
*
* Implement the compare operation between a nodeset and a number
- * @ns < @val (1, 1, ...
- * @ns <= @val (1, 0, ...
- * @ns > @val (0, 1, ...
- * @ns >= @val (0, 0, ...
+ * `ns` < `val` (1, 1, ...
+ * `ns` <= `val` (1, 0, ...
+ * `ns` > `val` (0, 1, ...
+ * `ns` >= `val` (0, 0, ...
*
* If one object to be compared is a node-set and the other is a number,
* then the comparison will be true if and only if there is a node in the
@@ -5276,7 +5153,7 @@ xmlXPathStringHash(const xmlChar * string) {
* to be compared and on the result of converting the string-value of that
* node to a number using the number function is true.
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
static int
xmlXPathCompareNodeSetFloat(xmlXPathParserContextPtr ctxt, int inf, int strict,
@@ -5314,25 +5191,24 @@ xmlXPathCompareNodeSetFloat(xmlXPathParserContextPtr ctxt, int inf, int strict,
}
/**
- * xmlXPathCompareNodeSetString:
- * @ctxt: the XPath Parser context
- * @inf: less than (1) or greater than (0)
- * @strict: is the comparison strict
- * @arg: the node set
- * @s: the value
+ * @param ctxt the XPath Parser context
+ * @param inf less than (1) or greater than (0)
+ * @param strict is the comparison strict
+ * @param arg the node set
+ * @param s the value
*
* Implement the compare operation between a nodeset and a string
- * @ns < @val (1, 1, ...
- * @ns <= @val (1, 0, ...
- * @ns > @val (0, 1, ...
- * @ns >= @val (0, 0, ...
+ * `ns` < `val` (1, 1, ...
+ * `ns` <= `val` (1, 0, ...
+ * `ns` > `val` (0, 1, ...
+ * `ns` >= `val` (0, 0, ...
*
* If one object to be compared is a node-set and the other is a string,
* then the comparison will be true if and only if there is a node in
* the node-set such that the result of performing the comparison on the
* string-value of the node and the other string is true.
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
static int
xmlXPathCompareNodeSetString(xmlXPathParserContextPtr ctxt, int inf, int strict,
@@ -5370,12 +5246,11 @@ xmlXPathCompareNodeSetString(xmlXPathParserContextPtr ctxt, int inf, int strict,
}
/**
- * xmlXPathCompareNodeSets:
- * @ctxt: XPath parser context
- * @inf: less than (1) or greater than (0)
- * @strict: is the comparison strict
- * @arg1: the first node set object
- * @arg2: the second node set object
+ * @param ctxt XPath parser context
+ * @param inf less than (1) or greater than (0)
+ * @param strict is the comparison strict
+ * @param arg1 the first node set object
+ * @param arg2 the second node set object
*
* Implement the compare operation on nodesets:
*
@@ -5474,25 +5349,24 @@ xmlXPathCompareNodeSets(xmlXPathParserContextPtr ctxt, int inf, int strict,
}
/**
- * xmlXPathCompareNodeSetValue:
- * @ctxt: the XPath Parser context
- * @inf: less than (1) or greater than (0)
- * @strict: is the comparison strict
- * @arg: the node set
- * @val: the value
+ * @param ctxt the XPath Parser context
+ * @param inf less than (1) or greater than (0)
+ * @param strict is the comparison strict
+ * @param arg the node set
+ * @param val the value
*
* Implement the compare operation between a nodeset and a value
- * @ns < @val (1, 1, ...
- * @ns <= @val (1, 0, ...
- * @ns > @val (0, 1, ...
- * @ns >= @val (0, 0, ...
+ * `ns` < `val` (1, 1, ...
+ * `ns` <= `val` (1, 0, ...
+ * `ns` > `val` (0, 1, ...
+ * `ns` >= `val` (0, 0, ...
*
* If one object to be compared is a node-set and the other is a boolean,
* then the comparison will be true if and only if the result of performing
* the comparison on the boolean and on the result of converting
* the node-set to a boolean using the boolean function is true.
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
static int
xmlXPathCompareNodeSetValue(xmlXPathParserContextPtr ctxt, int inf, int strict,
@@ -5523,19 +5397,18 @@ xmlXPathCompareNodeSetValue(xmlXPathParserContextPtr ctxt, int inf, int strict,
}
/**
- * xmlXPathEqualNodeSetString:
- * @ctxt: XPath parser context
- * @arg: the nodeset object argument
- * @str: the string to compare to.
- * @neq: flag to show whether for '=' (0) or '!=' (1)
+ * @param ctxt XPath parser context
+ * @param arg the nodeset object argument
+ * @param str the string to compare to.
+ * @param neq flag to show whether for '=' (0) or '!=' (1)
*
- * Implement the equal operation on XPath objects content: @arg1 == @arg2
+ * Implement the equal operation on XPath objects content: `arg1` == `arg2`
* If one object to be compared is a node-set and the other is a string,
* then the comparison will be true if and only if there is a node in
* the node-set such that the result of performing the comparison on the
* string-value of the node and the other string is true.
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
static int
xmlXPathEqualNodeSetString(xmlXPathParserContextPtr ctxt,
@@ -5581,20 +5454,19 @@ xmlXPathEqualNodeSetString(xmlXPathParserContextPtr ctxt,
}
/**
- * xmlXPathEqualNodeSetFloat:
- * @ctxt: XPath parser context
- * @arg: the nodeset object argument
- * @f: the float to compare to
- * @neq: flag to show whether to compare '=' (0) or '!=' (1)
+ * @param ctxt XPath parser context
+ * @param arg the nodeset object argument
+ * @param f the float to compare to
+ * @param neq flag to show whether to compare '=' (0) or '!=' (1)
*
- * Implement the equal operation on XPath objects content: @arg1 == @arg2
+ * Implement the equal operation on XPath objects content: `arg1` == `arg2`
* If one object to be compared is a node-set and the other is a number,
* then the comparison will be true if and only if there is a node in
* the node-set such that the result of performing the comparison on the
* number to be compared and on the result of converting the string-value
* of that node to a number using the number function is true.
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
static int
xmlXPathEqualNodeSetFloat(xmlXPathParserContextPtr ctxt,
@@ -5644,14 +5516,13 @@ xmlXPathEqualNodeSetFloat(xmlXPathParserContextPtr ctxt,
/**
- * xmlXPathEqualNodeSets:
- * @ctxt: XPath parser context
- * @arg1: first nodeset object argument
- * @arg2: second nodeset object argument
- * @neq: flag to show whether to test '=' (0) or '!=' (1)
+ * @param ctxt XPath parser context
+ * @param arg1 first nodeset object argument
+ * @param arg2 second nodeset object argument
+ * @param neq flag to show whether to test '=' (0) or '!=' (1)
*
* Implement the equal / not equal operation on XPath nodesets:
- * @arg1 == @arg2 or @arg1 != @arg2
+ * `arg1` == `arg2` or `arg1` != `arg2`
* If both objects to be compared are node-sets, then the comparison
* will be true if and only if there is a node in the first node-set and
* a node in the second node-set such that the result of performing the
@@ -5659,7 +5530,7 @@ xmlXPathEqualNodeSetFloat(xmlXPathParserContextPtr ctxt,
*
* (needless to say, this is a costly operation)
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
static int
xmlXPathEqualNodeSets(xmlXPathParserContextPtr ctxt, xmlXPathObjectPtr arg1,
@@ -5926,12 +5797,11 @@ xmlXPathEqualValuesCommon(xmlXPathParserContextPtr ctxt,
}
/**
- * xmlXPathEqualValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
- * Implement the equal operation on XPath objects content: @arg1 == @arg2
+ * Implement the equal operation on XPath objects content: `arg1` == `arg2`
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
int
xmlXPathEqualValues(xmlXPathParserContextPtr ctxt) {
@@ -6001,12 +5871,11 @@ xmlXPathEqualValues(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathNotEqualValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
- * Implement the equal operation on XPath objects content: @arg1 == @arg2
+ * Implement the equal operation on XPath objects content: `arg1` == `arg2`
*
- * Returns 0 or 1 depending on the results of the test.
+ * @returns 0 or 1 depending on the results of the test.
*/
int
xmlXPathNotEqualValues(xmlXPathParserContextPtr ctxt) {
@@ -6076,16 +5945,15 @@ xmlXPathNotEqualValues(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompareValues:
- * @ctxt: the XPath Parser context
- * @inf: less than (1) or greater than (0)
- * @strict: is the comparison strict
+ * @param ctxt the XPath Parser context
+ * @param inf less than (1) or greater than (0)
+ * @param strict is the comparison strict
*
* Implement the compare operation on XPath objects:
- * @arg1 < @arg2 (1, 1, ...
- * @arg1 <= @arg2 (1, 0, ...
- * @arg1 > @arg2 (0, 1, ...
- * @arg1 >= @arg2 (0, 0, ...
+ * `arg1` < `arg2` (1, 1, ...
+ * `arg1` <= `arg2` (1, 0, ...
+ * `arg1` > `arg2` (0, 1, ...
+ * `arg1` >= `arg2` (0, 0, ...
*
* When neither object to be compared is a node-set and the operator is
* <=, <, >=, >, then the objects are compared by converted both objects
@@ -6097,7 +5965,7 @@ xmlXPathNotEqualValues(xmlXPathParserContextPtr ctxt) {
* number. The >= comparison will be true if and only if the first number
* is greater than or equal to the second number.
*
- * Returns 1 if the comparison succeeded, 0 if it failed
+ * @returns 1 if the comparison succeeded, 0 if it failed
*/
int
xmlXPathCompareValues(xmlXPathParserContextPtr ctxt, int inf, int strict) {
@@ -6205,8 +6073,7 @@ error:
}
/**
- * xmlXPathValueFlipSign:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Implement the unary - operation on an XPath object
* The numeric operators convert their operands to numbers as if
@@ -6221,8 +6088,7 @@ xmlXPathValueFlipSign(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathAddValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Implement the add operation on XPath objects:
* The numeric operators convert their operands to numbers as if
@@ -6244,8 +6110,7 @@ xmlXPathAddValues(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathSubValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Implement the subtraction operation on XPath objects:
* The numeric operators convert their operands to numbers as if
@@ -6267,8 +6132,7 @@ xmlXPathSubValues(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathMultValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Implement the multiply operation on XPath objects:
* The numeric operators convert their operands to numbers as if
@@ -6290,10 +6154,9 @@ xmlXPathMultValues(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathDivValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
- * Implement the div operation on XPath objects @arg1 / @arg2.
+ * Implement the div operation on XPath objects `arg1` / `arg2`.
* The numeric operators convert their operands to numbers as if
* by calling the number function.
*/
@@ -6314,10 +6177,9 @@ xmlXPathDivValues(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathModValues:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
- * Implement the mod operation on XPath objects: @arg1 / @arg2
+ * Implement the mod operation on XPath objects: `arg1` / `arg2`
* The numeric operators convert their operands to numbers as if
* by calling the number function.
*/
@@ -6356,17 +6218,15 @@ typedef xmlNodePtr (*xmlXPathTraversalFunction)
(xmlXPathParserContextPtr ctxt, xmlNodePtr cur);
/*
- * xmlXPathTraversalFunctionExt:
* A traversal function enumerates nodes along an axis.
* Initially it must be called with NULL, and it indicates
* termination on the axis by returning NULL.
- * The context node of the traversal is specified via @contextNode.
+ * The context node of the traversal is specified via `contextNode`.
*/
typedef xmlNodePtr (*xmlXPathTraversalFunctionExt)
(xmlNodePtr cur, xmlNodePtr contextNode);
/*
- * xmlXPathNodeSetMergeFunction:
* Used for merging node sets in xmlXPathCollectAndTest().
*/
typedef xmlNodeSetPtr (*xmlXPathNodeSetMergeFunction)
@@ -6374,14 +6234,13 @@ typedef xmlNodeSetPtr (*xmlXPathNodeSetMergeFunction)
/**
- * xmlXPathNextSelf:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "self" direction
* The self axis contains just the context node itself
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6392,14 +6251,13 @@ xmlXPathNextSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextChild:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "child" direction
* The child axis contains the children of the context node in document order.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextChild(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6440,14 +6298,13 @@ xmlXPathNextChild(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextChildElement:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "child" direction and nodes of type element.
* The child axis contains the children of the context node in document order.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
static xmlNodePtr
xmlXPathNextChildElement(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6512,15 +6369,14 @@ xmlXPathNextChildElement(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextDescendant:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "descendant" direction
* the descendant axis contains the descendants of the context node in document
* order; a descendant is a child or a child of a child and so on.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextDescendant(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6575,9 +6431,8 @@ xmlXPathNextDescendant(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextDescendantOrSelf:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "descendant-or-self" direction
* the descendant-or-self axis contains the context node and the descendants
@@ -6585,7 +6440,7 @@ xmlXPathNextDescendant(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
* node on the axis, and the first child of the context node is the second node
* on the axis
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextDescendantOrSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6603,14 +6458,13 @@ xmlXPathNextDescendantOrSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextParent:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "parent" direction
* The parent axis contains the parent of the context node, if there is one.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextParent(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6669,9 +6523,8 @@ xmlXPathNextParent(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextAncestor:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "ancestor" direction
* the ancestor axis contains the ancestors of the context node; the ancestors
@@ -6680,7 +6533,7 @@ xmlXPathNextParent(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
* parent is the first node on the axis, and the parent's parent is the second
* node on the axis
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextAncestor(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6788,9 +6641,8 @@ xmlXPathNextAncestor(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextAncestorOrSelf:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "ancestor-or-self" direction
* he ancestor-or-self axis contains the context node and ancestors of
@@ -6798,7 +6650,7 @@ xmlXPathNextAncestor(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
* the first node on the axis, and the context node's parent the second;
* parent here is defined the same as with the parent axis.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextAncestorOrSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6809,15 +6661,14 @@ xmlXPathNextAncestorOrSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextFollowingSibling:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "following-sibling" direction
* The following-sibling axis contains the following siblings of the context
* node in document order.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextFollowingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6833,16 +6684,15 @@ xmlXPathNextFollowingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextPrecedingSibling:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "preceding-sibling" direction
* The preceding-sibling axis contains the preceding siblings of the context
* node in reverse document order; the first preceding sibling is first on the
* axis; the sibling preceding that node is the second on the axis and so on.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextPrecedingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6863,9 +6713,8 @@ xmlXPathNextPrecedingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextFollowing:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "following" direction
* The following axis contains all nodes in the same document as the context
@@ -6873,7 +6722,7 @@ xmlXPathNextPrecedingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
* descendants and excluding attribute nodes and namespace nodes; the nodes
* are ordered in document order
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextFollowing(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -6907,13 +6756,12 @@ xmlXPathNextFollowing(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/*
- * xmlXPathIsAncestor:
- * @ancestor: the ancestor node
- * @node: the current node
+ * @param ancestor the ancestor node
+ * @param node the current node
*
- * Check that @ancestor is a @node's ancestor
+ * Check that `ancestor` is a `node`'s ancestor
*
- * returns 1 if @ancestor is a @node's ancestor, 0 otherwise.
+ * @returns 1 if `ancestor` is a `node`'s ancestor, 0 otherwise.
*/
static int
xmlXPathIsAncestor(xmlNodePtr ancestor, xmlNodePtr node) {
@@ -6936,9 +6784,8 @@ xmlXPathIsAncestor(xmlNodePtr ancestor, xmlNodePtr node) {
}
/**
- * xmlXPathNextPreceding:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "preceding" direction
* the preceding axis contains all nodes in the same document as the context
@@ -6946,7 +6793,7 @@ xmlXPathIsAncestor(xmlNodePtr ancestor, xmlNodePtr node) {
* ancestors and excluding attribute nodes and namespace nodes; the nodes are
* ordered in reverse document order
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextPreceding(xmlXPathParserContextPtr ctxt, xmlNodePtr cur)
@@ -6985,9 +6832,8 @@ xmlXPathNextPreceding(xmlXPathParserContextPtr ctxt, xmlNodePtr cur)
}
/**
- * xmlXPathNextPrecedingInternal:
- * @ctxt: the XPath Parser context
- * @cur: the current node in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current node in the traversal
*
* Traversal function for the "preceding" direction
* the preceding axis contains all nodes in the same document as the context
@@ -6997,7 +6843,7 @@ xmlXPathNextPreceding(xmlXPathParserContextPtr ctxt, xmlNodePtr cur)
* This is a faster implementation but internal only since it requires a
* state kept in the parser context: ctxt->ancestor.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
static xmlNodePtr
xmlXPathNextPrecedingInternal(xmlXPathParserContextPtr ctxt,
@@ -7041,9 +6887,8 @@ xmlXPathNextPrecedingInternal(xmlXPathParserContextPtr ctxt,
}
/**
- * xmlXPathNextNamespace:
- * @ctxt: the XPath Parser context
- * @cur: the current attribute in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current attribute in the traversal
*
* Traversal function for the "namespace" direction
* the namespace axis contains the namespace nodes of the context node;
@@ -7052,7 +6897,7 @@ xmlXPathNextPrecedingInternal(xmlXPathParserContextPtr ctxt,
*
* We keep the XML namespace node at the end of the list.
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextNamespace(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -7085,14 +6930,13 @@ xmlXPathNextNamespace(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
}
/**
- * xmlXPathNextAttribute:
- * @ctxt: the XPath Parser context
- * @cur: the current attribute in the traversal
+ * @param ctxt the XPath Parser context
+ * @param cur the current attribute in the traversal
*
* Traversal function for the "attribute" direction
* TODO: support DTD inherited default attributes
*
- * Returns the next element following that axis
+ * @returns the next element following that axis
*/
xmlNodePtr
xmlXPathNextAttribute(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
@@ -7125,8 +6969,7 @@ xmlXPathNextAttribute(xmlXPathParserContextPtr ctxt, xmlNodePtr cur) {
************************************************************************/
/**
- * xmlXPathRoot:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Initialize the context to the root of the document
*/
@@ -7147,9 +6990,8 @@ xmlXPathRoot(xmlXPathParserContextPtr ctxt) {
/**
- * xmlXPathLastFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the last() XPath function
* number last()
@@ -7167,9 +7009,8 @@ xmlXPathLastFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathPositionFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the position() XPath function
* number position()
@@ -7189,9 +7030,8 @@ xmlXPathPositionFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathCountFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the count() XPath function
* number count(node-set)
@@ -7216,13 +7056,12 @@ xmlXPathCountFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathGetElementsByIds:
- * @doc: the document
- * @ids: a whitespace separated list of IDs
+ * @param doc the document
+ * @param ids a whitespace separated list of IDs
*
* Selects elements by their unique ID.
*
- * Returns a node-set of selected elements.
+ * @returns a node-set of selected elements.
*/
static xmlNodeSetPtr
xmlXPathGetElementsByIds (xmlDocPtr doc, const xmlChar *ids) {
@@ -7279,9 +7118,8 @@ xmlXPathGetElementsByIds (xmlDocPtr doc, const xmlChar *ids) {
}
/**
- * xmlXPathIdFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the id() XPath function
* node-set id(object)
@@ -7346,9 +7184,8 @@ xmlXPathIdFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathLocalNameFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the local-name() XPath function
* string local-name(node-set?)
@@ -7402,9 +7239,8 @@ xmlXPathLocalNameFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathNamespaceURIFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the namespace-uri() XPath function
* string namespace-uri(node-set?)
@@ -7453,9 +7289,8 @@ xmlXPathNamespaceURIFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathNameFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the name() XPath function
* string name(node-set?)
@@ -7530,9 +7365,8 @@ xmlXPathNameFunction(xmlXPathParserContextPtr ctxt, int nargs)
/**
- * xmlXPathStringFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the string() XPath function
* string string(object?)
@@ -7593,9 +7427,8 @@ xmlXPathStringFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathStringLengthFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the string-length() XPath function
* number string-length(string?)
@@ -7635,9 +7468,8 @@ xmlXPathStringLengthFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathConcatFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the concat() XPath function
* string concat(string, string, string*)
@@ -7681,9 +7513,8 @@ xmlXPathConcatFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathContainsFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the contains() XPath function
* boolean contains(string, string)
@@ -7715,9 +7546,8 @@ xmlXPathContainsFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathStartsWithFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the starts-with() XPath function
* boolean starts-with(string, string)
@@ -7751,9 +7581,8 @@ xmlXPathStartsWithFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathSubstringFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the substring() XPath function
* string substring(string, number, number?)
@@ -7854,9 +7683,8 @@ xmlXPathSubstringFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathSubstringBeforeFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the substring-before() XPath function
* string substring-before(string, string)
@@ -7899,9 +7727,8 @@ error:
}
/**
- * xmlXPathSubstringAfterFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the substring-after() XPath function
* string substring-after(string, string)
@@ -7945,9 +7772,8 @@ error:
}
/**
- * xmlXPathNormalizeFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the normalize-space() XPath function
* string normalize-space(string?)
@@ -8003,9 +7829,8 @@ xmlXPathNormalizeFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathTranslateFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the translate() XPath function
* string translate(string, string, string)
@@ -8114,9 +7939,8 @@ error:
}
/**
- * xmlXPathBooleanFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the boolean() XPath function
* boolean boolean(object)
@@ -8143,9 +7967,8 @@ xmlXPathBooleanFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathNotFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the not() XPath function
* boolean not(boolean)
@@ -8161,9 +7984,8 @@ xmlXPathNotFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathTrueFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the true() XPath function
* boolean true()
@@ -8175,9 +7997,8 @@ xmlXPathTrueFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathFalseFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the false() XPath function
* boolean false()
@@ -8189,9 +8010,8 @@ xmlXPathFalseFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathLangFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the lang() XPath function
* boolean lang(string)
@@ -8248,9 +8068,8 @@ not_equal:
}
/**
- * xmlXPathNumberFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the number() XPath function
* number number(object?)
@@ -8289,9 +8108,8 @@ xmlXPathNumberFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathSumFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the sum() XPath function
* number sum(node-set)
@@ -8322,9 +8140,8 @@ xmlXPathSumFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathFloorFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the floor() XPath function
* number floor(number)
@@ -8341,9 +8158,8 @@ xmlXPathFloorFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathCeilingFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the ceiling() XPath function
* number ceiling(number)
@@ -8365,9 +8181,8 @@ xmlXPathCeilingFunction(xmlXPathParserContextPtr ctxt, int nargs) {
}
/**
- * xmlXPathRoundFunction:
- * @ctxt: the XPath Parser context
- * @nargs: the number of arguments
+ * @param ctxt the XPath Parser context
+ * @param nargs the number of arguments
*
* Implement the round() XPath function
* number round(number)
@@ -8415,14 +8230,13 @@ static xmlChar * xmlXPathParseNameComplex(xmlXPathParserContextPtr ctxt,
int qualified);
/**
- * xmlXPathCurrentChar:
- * @ctxt: the XPath parser context
- * @len: pointer to the length of the char read
+ * @param ctxt the XPath parser context
+ * @param len pointer to the length of the char read
*
* The current char value, if using UTF-8 this may actually span multiple
* bytes in the input buffer.
*
- * Returns the current char value and its length
+ * @returns the current char value and its length
*/
static int
@@ -8499,8 +8313,7 @@ encoding_error:
}
/**
- * xmlXPathParseNCName:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* parse an XML namespace non qualified name.
*
@@ -8509,7 +8322,7 @@ encoding_error:
* [NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
* CombiningChar | Extender
*
- * Returns the namespace name or NULL
+ * @returns the namespace name or NULL
*/
xmlChar *
@@ -8551,9 +8364,8 @@ xmlXPathParseNCName(xmlXPathParserContextPtr ctxt) {
/**
- * xmlXPathParseQName:
- * @ctxt: the XPath Parser context
- * @prefix: a xmlChar **
+ * @param ctxt the XPath Parser context
+ * @param prefix a xmlChar **
*
* parse an XML qualified name
*
@@ -8563,7 +8375,7 @@ xmlXPathParseNCName(xmlXPathParserContextPtr ctxt) {
*
* [NS 7] LocalPart ::= NCName
*
- * Returns the function returns the local part, and prefix is updated
+ * @returns the function returns the local part, and prefix is updated
* to get the Prefix if any.
*/
@@ -8582,8 +8394,7 @@ xmlXPathParseQName(xmlXPathParserContextPtr ctxt, xmlChar **prefix) {
}
/**
- * xmlXPathParseName:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* parse an XML name
*
@@ -8592,7 +8403,7 @@ xmlXPathParseQName(xmlXPathParserContextPtr ctxt, xmlChar **prefix) {
*
* [5] Name ::= (Letter | '_' | ':') (NameChar)*
*
- * Returns the namespace name or NULL
+ * @returns the namespace name or NULL
*/
xmlChar *
@@ -8720,8 +8531,7 @@ xmlXPathParseNameComplex(xmlXPathParserContextPtr ctxt, int qualified) {
#define MAX_FRAC 20
/**
- * xmlXPathStringEvalNumber:
- * @str: A string to scan
+ * @param str A string to scan
*
* [30a] Float ::= Number ('e' Digits?)?
*
@@ -8733,7 +8543,7 @@ xmlXPathParseNameComplex(xmlXPathParserContextPtr ctxt, int qualified) {
* In complement of the Number expression, this function also handles
* negative values : '-' Number.
*
- * Returns the double value.
+ * @returns the double value.
*/
double
xmlXPathStringEvalNumber(const xmlChar *str) {
@@ -8827,8 +8637,7 @@ xmlXPathStringEvalNumber(const xmlChar *str) {
}
/**
- * xmlXPathCompNumber:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [30] Number ::= Digits ('.' Digits?)?
* | '.' Digits
@@ -8927,15 +8736,14 @@ xmlXPathCompNumber(xmlXPathParserContextPtr ctxt)
}
/**
- * xmlXPathParseLiteral:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Parse a Literal
*
* [29] Literal ::= '"' [^"]* '"'
* | "'" [^']* "'"
*
- * Returns the value found or NULL in case of error
+ * @returns the value found or NULL in case of error
*/
static xmlChar *
xmlXPathParseLiteral(xmlXPathParserContextPtr ctxt) {
@@ -8972,8 +8780,7 @@ xmlXPathParseLiteral(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompLiteral:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Parse a Literal and push it on the stack.
*
@@ -9001,8 +8808,7 @@ xmlXPathCompLiteral(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompVariableReference:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Parse a VariableReference, evaluate it and push it on the stack.
*
@@ -9044,8 +8850,7 @@ xmlXPathCompVariableReference(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathIsNodeType:
- * @name: a name string
+ * @param name a name string
*
* Is the name given a NodeType one.
*
@@ -9054,7 +8859,7 @@ xmlXPathCompVariableReference(xmlXPathParserContextPtr ctxt) {
* | 'processing-instruction'
* | 'node'
*
- * Returns 1 if true 0 otherwise
+ * @returns 1 if true 0 otherwise
*/
int
xmlXPathIsNodeType(const xmlChar *name) {
@@ -9073,8 +8878,7 @@ xmlXPathIsNodeType(const xmlChar *name) {
}
/**
- * xmlXPathCompFunctionCall:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [16] FunctionCall ::= FunctionName '(' ( Argument ( ',' Argument)*)? ')'
* [17] Argument ::= Expr
@@ -9144,8 +8948,7 @@ xmlXPathCompFunctionCall(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompPrimaryExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [15] PrimaryExpr ::= VariableReference
* | '(' Expr ')'
@@ -9180,8 +8983,7 @@ xmlXPathCompPrimaryExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompFilterExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [20] FilterExpr ::= PrimaryExpr
* | FilterExpr Predicate
@@ -9209,8 +9011,7 @@ xmlXPathCompFilterExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathScanName:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* Trickery: parse an XML name but without consuming the input flow
* Needed to avoid insanity in the parser state.
@@ -9222,7 +9023,7 @@ xmlXPathCompFilterExpr(xmlXPathParserContextPtr ctxt) {
*
* [6] Names ::= Name (S Name)*
*
- * Returns the Name parsed or NULL
+ * @returns the Name parsed or NULL
*/
static xmlChar *
@@ -9258,8 +9059,7 @@ xmlXPathScanName(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompPathExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [19] PathExpr ::= LocationPath
* | FilterExpr
@@ -9383,8 +9183,7 @@ xmlXPathCompPathExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompUnionExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [18] UnionExpr ::= PathExpr
* | UnionExpr '|' PathExpr
@@ -9412,8 +9211,7 @@ xmlXPathCompUnionExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompUnaryExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [27] UnaryExpr ::= UnionExpr
* | '-' UnaryExpr
@@ -9445,8 +9243,7 @@ xmlXPathCompUnaryExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompMultiplicativeExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [26] MultiplicativeExpr ::= UnaryExpr
* | MultiplicativeExpr MultiplyOperator UnaryExpr
@@ -9487,8 +9284,7 @@ xmlXPathCompMultiplicativeExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompAdditiveExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [25] AdditiveExpr ::= MultiplicativeExpr
* | AdditiveExpr '+' MultiplicativeExpr
@@ -9519,8 +9315,7 @@ xmlXPathCompAdditiveExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompRelationalExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [24] RelationalExpr ::= AdditiveExpr
* | RelationalExpr '<' AdditiveExpr
@@ -9560,8 +9355,7 @@ xmlXPathCompRelationalExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompEqualityExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [23] EqualityExpr ::= RelationalExpr
* | EqualityExpr '=' RelationalExpr
@@ -9597,8 +9391,7 @@ xmlXPathCompEqualityExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompAndExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [22] AndExpr ::= EqualityExpr
* | AndExpr 'and' EqualityExpr
@@ -9623,9 +9416,8 @@ xmlXPathCompAndExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompileExpr:
- * @ctxt: the XPath Parser context
- * @sort: whether to sort the resulting node set
+ * @param ctxt the XPath Parser context
+ * @param sort whether to sort the resulting node set
*
* [14] Expr ::= OrExpr
* [21] OrExpr ::= AndExpr
@@ -9674,9 +9466,8 @@ xmlXPathCompileExpr(xmlXPathParserContextPtr ctxt, int sort) {
}
/**
- * xmlXPathCompPredicate:
- * @ctxt: the XPath Parser context
- * @filter: act as a filter
+ * @param ctxt the XPath Parser context
+ * @param filter act as a filter
*
* [8] Predicate ::= '[' PredicateExpr ']'
* [9] PredicateExpr ::= Expr
@@ -9724,12 +9515,11 @@ xmlXPathCompPredicate(xmlXPathParserContextPtr ctxt, int filter) {
}
/**
- * xmlXPathCompNodeTest:
- * @ctxt: the XPath Parser context
- * @test: pointer to a xmlXPathTestVal
- * @type: pointer to a xmlXPathTypeVal
- * @prefix: placeholder for a possible name prefix
- * @name: current name token (optional)
+ * @param ctxt the XPath Parser context
+ * @param test pointer to a xmlXPathTestVal
+ * @param type pointer to a xmlXPathTypeVal
+ * @param prefix placeholder for a possible name prefix
+ * @param name current name token (optional)
*
* ```
* [7] NodeTest ::= NameTest
@@ -9745,7 +9535,7 @@ xmlXPathCompPredicate(xmlXPathParserContextPtr ctxt, int filter) {
* | 'node'
* ```
*
- * Returns the name found and updates @test, @type and @prefix appropriately
+ * @returns the name found and updates `test`, `type` and `prefix` appropriately
*/
static xmlChar *
xmlXPathCompNodeTest(xmlXPathParserContextPtr ctxt, xmlXPathTestVal *test,
@@ -9852,8 +9642,7 @@ xmlXPathCompNodeTest(xmlXPathParserContextPtr ctxt, xmlXPathTestVal *test,
}
/**
- * xmlXPathIsAxisName:
- * @name: a preparsed name token
+ * @param name a preparsed name token
*
* [6] AxisName ::= 'ancestor'
* | 'ancestor-or-self'
@@ -9869,7 +9658,7 @@ xmlXPathCompNodeTest(xmlXPathParserContextPtr ctxt, xmlXPathTestVal *test,
* | 'preceding-sibling'
* | 'self'
*
- * Returns the axis or 0
+ * @returns the axis or 0
*/
static xmlXPathAxisVal
xmlXPathIsAxisName(const xmlChar *name) {
@@ -9920,8 +9709,7 @@ xmlXPathIsAxisName(const xmlChar *name) {
}
/**
- * xmlXPathCompStep:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [4] Step ::= AxisSpecifier NodeTest Predicate*
* | AbbreviatedStep
@@ -10021,8 +9809,7 @@ xmlXPathCompStep(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathCompRelativeLocationPath:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [3] RelativeLocationPath ::= Step
* | RelativeLocationPath '/' Step
@@ -10064,8 +9851,7 @@ xmlXPathCompRelativeLocationPath
}
/**
- * xmlXPathCompLocationPath:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
* [1] LocationPath ::= RelativeLocationPath
* | AbsoluteLocationPath
@@ -10113,13 +9899,12 @@ static int
xmlXPathCompOpEval(xmlXPathParserContextPtr ctxt, xmlXPathStepOpPtr op);
/**
- * xmlXPathNodeSetFilter:
- * @ctxt: the XPath Parser context
- * @set: the node set to filter
- * @filterOpIndex: the index of the predicate/filter op
- * @minPos: minimum position in the filtered set (1-based)
- * @maxPos: maximum position in the filtered set (1-based)
- * @hasNsNodes: true if the node set may contain namespace nodes
+ * @param ctxt the XPath Parser context
+ * @param set the node set to filter
+ * @param filterOpIndex the index of the predicate/filter op
+ * @param minPos minimum position in the filtered set (1-based)
+ * @param maxPos maximum position in the filtered set (1-based)
+ * @param hasNsNodes true if the node set may contain namespace nodes
*
* Filter a node set, keeping only nodes for which the predicate expression
* matches. Afterwards, keep only nodes between minPos and maxPos in the
@@ -10247,13 +10032,12 @@ xmlXPathNodeSetFilter(xmlXPathParserContextPtr ctxt,
}
/**
- * xmlXPathCompOpEvalPredicate:
- * @ctxt: the XPath Parser context
- * @op: the predicate op
- * @set: the node set to filter
- * @minPos: minimum position in the filtered set (1-based)
- * @maxPos: maximum position in the filtered set (1-based)
- * @hasNsNodes: true if the node set may contain namespace nodes
+ * @param ctxt the XPath Parser context
+ * @param op the predicate op
+ * @param set the node set to filter
+ * @param minPos minimum position in the filtered set (1-based)
+ * @param maxPos maximum position in the filtered set (1-based)
+ * @param hasNsNodes true if the node set may contain namespace nodes
*
* Filter a node set, keeping only nodes for which the sequence of predicate
* expressions matches. Afterwards, keep only nodes between minPos and maxPos
@@ -10948,15 +10732,14 @@ xmlXPathCompOpEvalFilterFirst(xmlXPathParserContextPtr ctxt,
xmlXPathStepOpPtr op, xmlNodePtr * first);
/**
- * xmlXPathCompOpEvalFirst:
- * @ctxt: the XPath parser context with the compiled expression
- * @op: an XPath compiled operation
- * @first: the first elem found so far
+ * @param ctxt the XPath parser context with the compiled expression
+ * @param op an XPath compiled operation
+ * @param first the first elem found so far
*
* Evaluate the Precompiled XPath operation searching only the first
* element in document order
*
- * Returns the number of examined objects.
+ * @returns the number of examined objects.
*/
static int
xmlXPathCompOpEvalFirst(xmlXPathParserContextPtr ctxt,
@@ -11088,15 +10871,14 @@ xmlXPathCompOpEvalFirst(xmlXPathParserContextPtr ctxt,
}
/**
- * xmlXPathCompOpEvalLast:
- * @ctxt: the XPath parser context with the compiled expression
- * @op: an XPath compiled operation
- * @last: the last elem found so far
+ * @param ctxt the XPath parser context with the compiled expression
+ * @param op an XPath compiled operation
+ * @param last the last elem found so far
*
* Evaluate the Precompiled XPath operation searching only the last
* element in document order
*
- * Returns the number of nodes traversed
+ * @returns the number of nodes traversed
*/
static int
xmlXPathCompOpEvalLast(xmlXPathParserContextPtr ctxt, xmlXPathStepOpPtr op,
@@ -11299,12 +11081,11 @@ xmlXPathCompOpEvalFilterFirst(xmlXPathParserContextPtr ctxt,
#endif /* XP_OPTIMIZED_FILTER_FIRST */
/**
- * xmlXPathCompOpEval:
- * @ctxt: the XPath parser context with the compiled expression
- * @op: an XPath compiled operation
+ * @param ctxt the XPath parser context with the compiled expression
+ * @param op an XPath compiled operation
*
* Evaluate the Precompiled XPath operation
- * Returns the number of nodes traversed
+ * @returns the number of nodes traversed
*/
static int
xmlXPathCompOpEval(xmlXPathParserContextPtr ctxt, xmlXPathStepOpPtr op)
@@ -11702,14 +11483,13 @@ xmlXPathCompOpEval(xmlXPathParserContextPtr ctxt, xmlXPathStepOpPtr op)
}
/**
- * xmlXPathCompOpEvalToBoolean:
- * @ctxt: the XPath parser context
- * @op: the step operation
- * @isPredicate: whether a predicate is evaluated
+ * @param ctxt the XPath parser context
+ * @param op the step operation
+ * @param isPredicate whether a predicate is evaluated
*
* Evaluates if the expression evaluates to true.
*
- * Returns 1 if true, 0 if false and -1 on API or internal errors.
+ * @returns 1 if true, 0 if false and -1 on API or internal errors.
*/
static int
xmlXPathCompOpEvalToBoolean(xmlXPathParserContextPtr ctxt,
@@ -11796,8 +11576,7 @@ start:
#ifdef XPATH_STREAMING
/**
- * xmlXPathRunStreamEval:
- * @pctxt: the XPath parser context with the compiled expression
+ * @param pctxt the XPath parser context with the compiled expression
*
* Evaluate the Precompiled Streamable XPath expression in the given context.
*/
@@ -12028,9 +11807,8 @@ return_1:
#endif /* XPATH_STREAMING */
/**
- * xmlXPathRunEval:
- * @ctxt: the XPath parser context with the compiled expression
- * @toBool: evaluate to a boolean result
+ * @param ctxt the XPath parser context with the compiled expression
+ * @param toBool evaluate to a boolean result
*
* Evaluate the Precompiled XPath expression in the given context.
*/
@@ -12115,9 +11893,8 @@ xmlXPathRunEval(xmlXPathParserContextPtr ctxt, int toBool)
************************************************************************/
/**
- * xmlXPathEvalPredicate:
- * @ctxt: the XPath context
- * @res: the Predicate Expression evaluation result
+ * @param ctxt the XPath context
+ * @param res the Predicate Expression evaluation result
*
* Evaluate a predicate result for the current node.
* A PredicateExpr is evaluated by evaluating the Expr and converting
@@ -12128,7 +11905,7 @@ xmlXPathRunEval(xmlXPathParserContextPtr ctxt, int toBool)
* is not a number, then the result will be converted as if by a call
* to the boolean function.
*
- * Returns 1 if predicate is true, 0 otherwise
+ * @returns 1 if predicate is true, 0 otherwise
*/
int
xmlXPathEvalPredicate(xmlXPathContextPtr ctxt, xmlXPathObjectPtr res) {
@@ -12153,9 +11930,8 @@ xmlXPathEvalPredicate(xmlXPathContextPtr ctxt, xmlXPathObjectPtr res) {
}
/**
- * xmlXPathEvaluatePredicateResult:
- * @ctxt: the XPath Parser context
- * @res: the Predicate Expression evaluation result
+ * @param ctxt the XPath Parser context
+ * @param res the Predicate Expression evaluation result
*
* Evaluate a predicate result for the current node.
* A PredicateExpr is evaluated by evaluating the Expr and converting
@@ -12166,7 +11942,7 @@ xmlXPathEvalPredicate(xmlXPathContextPtr ctxt, xmlXPathObjectPtr res) {
* is not a number, then the result will be converted as if by a call
* to the boolean function.
*
- * Returns 1 if predicate is true, 0 otherwise
+ * @returns 1 if predicate is true, 0 otherwise
*/
int
xmlXPathEvaluatePredicateResult(xmlXPathParserContextPtr ctxt,
@@ -12197,13 +11973,12 @@ xmlXPathEvaluatePredicateResult(xmlXPathParserContextPtr ctxt,
#ifdef XPATH_STREAMING
/**
- * xmlXPathTryStreamCompile:
- * @ctxt: an XPath context
- * @str: the XPath expression
+ * @param ctxt an XPath context
+ * @param str the XPath expression
*
* Try to compile the XPath expression as a streamable subset.
*
- * Returns the compiled expression or NULL if failed to compile.
+ * @returns the compiled expression or NULL if failed to compile.
*/
static xmlXPathCompExprPtr
xmlXPathTryStreamCompile(xmlXPathContextPtr ctxt, const xmlChar *str) {
@@ -12360,13 +12135,12 @@ xmlXPathOptimizeExpression(xmlXPathParserContextPtr pctxt,
}
/**
- * xmlXPathCtxtCompile:
- * @ctxt: an XPath context
- * @str: the XPath expression
+ * @param ctxt an XPath context
+ * @param str the XPath expression
*
* Compile an XPath expression
*
- * Returns the xmlXPathCompExprPtr resulting from the compilation or NULL.
+ * @returns the xmlXPathCompExprPtr resulting from the compilation or NULL.
* the caller has to free the object.
*/
xmlXPathCompExprPtr
@@ -12447,12 +12221,11 @@ xmlXPathCtxtCompile(xmlXPathContextPtr ctxt, const xmlChar *str) {
}
/**
- * xmlXPathCompile:
- * @str: the XPath expression
+ * @param str the XPath expression
*
* Compile an XPath expression
*
- * Returns the xmlXPathCompExprPtr resulting from the compilation or NULL.
+ * @returns the xmlXPathCompExprPtr resulting from the compilation or NULL.
* the caller has to free the object.
*/
xmlXPathCompExprPtr
@@ -12461,16 +12234,15 @@ xmlXPathCompile(const xmlChar *str) {
}
/**
- * xmlXPathCompiledEvalInternal:
- * @comp: the compiled XPath expression
- * @ctxt: the XPath context
- * @resObjPtr: the resulting XPath object or NULL
- * @toBool: 1 if only a boolean result is requested
+ * @param comp the compiled XPath expression
+ * @param ctxt the XPath context
+ * @param resObjPtr the resulting XPath object or NULL
+ * @param toBool 1 if only a boolean result is requested
*
* Evaluate the Precompiled XPath expression in the given context.
- * The caller has to free @resObj.
+ * The caller has to free `resObj`.
*
- * Returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
+ * @returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
* the caller has to free the object.
*/
static int
@@ -12513,13 +12285,12 @@ xmlXPathCompiledEvalInternal(xmlXPathCompExprPtr comp,
}
/**
- * xmlXPathCompiledEval:
- * @comp: the compiled XPath expression
- * @ctx: the XPath context
+ * @param comp the compiled XPath expression
+ * @param ctx the XPath context
*
* Evaluate the Precompiled XPath expression in the given context.
*
- * Returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
+ * @returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
* the caller has to free the object.
*/
xmlXPathObjectPtr
@@ -12532,14 +12303,13 @@ xmlXPathCompiledEval(xmlXPathCompExprPtr comp, xmlXPathContextPtr ctx)
}
/**
- * xmlXPathCompiledEvalToBoolean:
- * @comp: the compiled XPath expression
- * @ctxt: the XPath context
+ * @param comp the compiled XPath expression
+ * @param ctxt the XPath context
*
* Applies the XPath boolean() function on the result of the given
* compiled expression.
*
- * Returns 1 if the expression evaluated to true, 0 if to false and
+ * @returns 1 if the expression evaluated to true, 0 if to false and
* -1 in API and internal errors.
*/
int
@@ -12550,10 +12320,9 @@ xmlXPathCompiledEvalToBoolean(xmlXPathCompExprPtr comp,
}
/**
- * xmlXPathEvalExpr:
- * @ctxt: the XPath Parser context
+ * @param ctxt the XPath Parser context
*
- * DEPRECATED: Internal function, don't use.
+ * @deprecated Internal function, don't use.
*
* Parse and evaluate an XPath expression in the given context,
* then push the result on the context stack
@@ -12609,13 +12378,12 @@ xmlXPathEvalExpr(xmlXPathParserContextPtr ctxt) {
}
/**
- * xmlXPathEval:
- * @str: the XPath expression
- * @ctx: the XPath context
+ * @param str the XPath expression
+ * @param ctx the XPath context
*
* Evaluate the XPath Location Path in the given context.
*
- * Returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
+ * @returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
* the caller has to free the object.
*/
xmlXPathObjectPtr
@@ -12649,14 +12417,13 @@ xmlXPathEval(const xmlChar *str, xmlXPathContextPtr ctx) {
}
/**
- * xmlXPathSetContextNode:
- * @node: the node to to use as the context node
- * @ctx: the XPath context
+ * @param node the node to to use as the context node
+ * @param ctx the XPath context
*
* Sets 'node' as the context node. The node must be in the same
* document as that associated with the context.
*
- * Returns -1 in case of error or 0 if successful
+ * @returns -1 in case of error or 0 if successful
*/
int
xmlXPathSetContextNode(xmlNodePtr node, xmlXPathContextPtr ctx) {
@@ -12671,15 +12438,14 @@ xmlXPathSetContextNode(xmlNodePtr node, xmlXPathContextPtr ctx) {
}
/**
- * xmlXPathNodeEval:
- * @node: the node to to use as the context node
- * @str: the XPath expression
- * @ctx: the XPath context
+ * @param node the node to to use as the context node
+ * @param str the XPath expression
+ * @param ctx the XPath context
*
* Evaluate the XPath Location Path in the given context. The node 'node'
* is set as the context node. The context node is not restored.
*
- * Returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
+ * @returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
* the caller has to free the object.
*/
xmlXPathObjectPtr
@@ -12692,13 +12458,12 @@ xmlXPathNodeEval(xmlNodePtr node, const xmlChar *str, xmlXPathContextPtr ctx) {
}
/**
- * xmlXPathEvalExpression:
- * @str: the XPath expression
- * @ctxt: the XPath context
+ * @param str the XPath expression
+ * @param ctxt the XPath context
*
* Alias for xmlXPathEval().
*
- * Returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
+ * @returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
* the caller has to free the object.
*/
xmlXPathObjectPtr
@@ -12707,10 +12472,9 @@ xmlXPathEvalExpression(const xmlChar *str, xmlXPathContextPtr ctxt) {
}
/**
- * xmlXPathRegisterAllFunctions:
- * @ctxt: the XPath context
+ * @param ctxt the XPath context
*
- * DEPRECATED: No-op since 2.14.0.
+ * @deprecated No-op since 2.14.0.
*
* Registers all default XPath functions in this context
*/
diff --git a/xpointer.c b/xpointer.c
index 993335d2..73f38200 100644
--- a/xpointer.c
+++ b/xpointer.c
@@ -54,11 +54,10 @@
************************************************************************/
/**
- * xmlXPtrErr:
- * @ctxt: an XPTR evaluation context
- * @code: error code
- * @msg: error message
- * @extra: extra information
+ * @param ctxt an XPTR evaluation context
+ * @param code error code
+ * @param msg error message
+ * @param extra extra information
*
* Handle an XPointer error
*/
@@ -117,11 +116,10 @@ xmlXPtrErr(xmlXPathParserContextPtr ctxt, int code,
************************************************************************/
/**
- * xmlXPtrGetNthChild:
- * @cur: the node
- * @no: the child number
+ * @param cur the node
+ * @param no the child number
*
- * Returns the @no'th element child of @cur or NULL
+ * @returns the `no`'th element child of `cur` or NULL
*/
static xmlNodePtr
xmlXPtrGetNthChild(xmlNodePtr cur, int no) {
@@ -184,9 +182,8 @@ static void xmlXPtrEvalChildSeq(xmlXPathParserContextPtr ctxt, xmlChar *name);
#define NEXT ((*ctxt->cur) ? ctxt->cur++: ctxt->cur)
/*
- * xmlXPtrGetChildNo:
- * @ctxt: the XPointer Parser context
- * @index: the child number
+ * @param ctxt the XPointer Parser context
+ * @param index the child number
*
* Move the current node of the nodeset on the stack to the
* given child if found
@@ -216,9 +213,8 @@ xmlXPtrGetChildNo(xmlXPathParserContextPtr ctxt, int indx) {
}
/**
- * xmlXPtrEvalXPtrPart:
- * @ctxt: the XPointer Parser context
- * @name: the preparsed Scheme for the XPtrPart
+ * @param ctxt the XPointer Parser context
+ * @param name the preparsed Scheme for the XPtrPart
*
* XPtrPart ::= 'xpointer' '(' XPtrExpr ')'
* | Scheme '(' SchemeSpecificExpr ')'
@@ -384,9 +380,8 @@ xmlXPtrEvalXPtrPart(xmlXPathParserContextPtr ctxt, xmlChar *name) {
}
/**
- * xmlXPtrEvalFullXPtr:
- * @ctxt: the XPointer Parser context
- * @name: the preparsed Scheme for the first XPtrPart
+ * @param ctxt the XPointer Parser context
+ * @param name the preparsed Scheme for the first XPtrPart
*
* FullXPtr ::= XPtrPart (S? XPtrPart)*
*
@@ -464,9 +459,8 @@ xmlXPtrEvalFullXPtr(xmlXPathParserContextPtr ctxt, xmlChar *name) {
}
/**
- * xmlXPtrEvalChildSeq:
- * @ctxt: the XPointer Parser context
- * @name: a possible ID name of the child sequence
+ * @param ctxt the XPointer Parser context
+ * @param name a possible ID name of the child sequence
*
* ChildSeq ::= '/1' ('/' [0-9]*)*
* | Name ('/' [0-9]*)+
@@ -516,8 +510,7 @@ xmlXPtrEvalChildSeq(xmlXPathParserContextPtr ctxt, xmlChar *name) {
/**
- * xmlXPtrEvalXPointer:
- * @ctxt: the XPointer Parser context
+ * @param ctxt the XPointer Parser context
*
* XPointer ::= Name
* | ChildSeq
@@ -571,15 +564,14 @@ xmlXPtrEvalXPointer(xmlXPathParserContextPtr ctxt) {
************************************************************************/
/**
- * xmlXPtrNewContext:
- * @doc: the XML document
- * @here: the node that directly contains the XPointer being evaluated or NULL
- * @origin: the element from which a user or program initiated traversal of
+ * @param doc the XML document
+ * @param here the node that directly contains the XPointer being evaluated or NULL
+ * @param origin the element from which a user or program initiated traversal of
* the link, or NULL.
*
* Create a new XPointer context
*
- * Returns the xmlXPathContext just allocated.
+ * @returns the xmlXPathContext just allocated.
*/
xmlXPathContextPtr
xmlXPtrNewContext(xmlDocPtr doc, xmlNodePtr here, xmlNodePtr origin) {
@@ -595,13 +587,12 @@ xmlXPtrNewContext(xmlDocPtr doc, xmlNodePtr here, xmlNodePtr origin) {
}
/**
- * xmlXPtrEval:
- * @str: the XPointer expression
- * @ctx: the XPointer context
+ * @param str the XPointer expression
+ * @param ctx the XPointer context
*
* Evaluate the XPath Location Path in the given context.
*
- * Returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
+ * @returns the xmlXPathObjectPtr resulting from the evaluation or NULL.
* the caller has to free the object.
*/
xmlXPathObjectPtr