diff --git a/HTMLparser.c b/HTMLparser.c index faf33140..bdd65896 100644 --- a/HTMLparser.c +++ b/HTMLparser.c @@ -4641,7 +4641,9 @@ htmlNewParserCtxt(void) * Allocate and initialize a new HTML SAX parser context. If userData * is NULL, the parser context will be passed as user data. * - * Available since 2.11.0. If you want support older versions, + * @since 2.11.0 + * + * If you want support older versions, * it's best to invoke htmlNewParserCtxt() and set ctxt->sax with * struct assignment. * @@ -5709,7 +5711,9 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * Applies the options to the parser context. Unset options are * cleared. * - * Available since 2.14.0. With older versions, you can use + * @since 2.14.0 + * + * With older versions, you can use * htmlCtxtUseOptions(). * * HTML_PARSE_RECOVER @@ -5724,7 +5728,7 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * For now, this is only usable to tokenize HTML5 with custom SAX * callbacks. A tree builder isn't implemented yet. * - * Available since 2.14.0. + * @since 2.14.0 * * HTML_PARSE_NODEFDTD * @@ -5768,7 +5772,9 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * * Relax some internal limits. * - * Available since 2.14.0. Use XML_PARSE_HUGE with older versions. + * @since 2.14.0 + * + * Use XML_PARSE_HUGE with older versions. * * Maximum size of text nodes, tags, comments, CDATA sections * @@ -5795,7 +5801,7 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * * Enable reporting of line numbers larger than 65535. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns 0 in case of success, the set of unknown or unimplemented options * in case of error. @@ -5853,7 +5859,7 @@ htmlCtxtUseOptions(htmlParserCtxtPtr ctxt, int options) * * Parse an HTML document and return the resulting document tree. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns the resulting document tree or NULL */ diff --git a/encoding.c b/encoding.c index 5f559eab..3ba1ea3b 100644 --- a/encoding.c +++ b/encoding.c @@ -862,7 +862,7 @@ xmlFindExtraHandler(const char *norig, const char *name, xmlCharEncFlags flags, * If the encoding is UTF-8, a NULL handler and no error code will * be returned. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another * xmlParserErrors error code. @@ -943,7 +943,7 @@ xmlGetCharEncodingHandler(xmlCharEncoding enc) { * * `flags` can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another * xmlParserErrors error code. @@ -1004,7 +1004,7 @@ xmlCreateCharEncodingHandler(const char *name, xmlCharEncFlags flags, * If the encoding is UTF-8, a NULL handler and no error code will * be returned. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns XML_ERR_OK, XML_ERR_UNSUPPORTED_ENCODING or another * xmlParserErrors error code. diff --git a/entities.c b/entities.c index 1aea10eb..72143fd5 100644 --- a/entities.c +++ b/entities.c @@ -178,7 +178,7 @@ error: * * Register a new entity for this document. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns an xmlParserErrors error code. */ diff --git a/error.c b/error.c index c5ea4222..2db65d28 100644 --- a/error.c +++ b/error.c @@ -418,7 +418,7 @@ xmlParserPrintFileContext(xmlParserInputPtr input) { * This can result in a verbose multi-line report including additional * information from the parser context. * - * Available since 2.13.0. + * @since 2.13.0 */ void xmlFormatError(const xmlError *err, xmlGenericErrorFunc channel, void *data) diff --git a/globals.c b/globals.c index fd1cca29..09677878 100644 --- a/globals.c +++ b/globals.c @@ -776,7 +776,7 @@ xmlGetLocalRngState(void) { * allocation signals a typically fatal and irrecoverable out-of-memory * situation. Don't call any library functions in this case. * - * Available since 2.12.0. + * @since 2.12.0 */ int xmlCheckThreadLocalStorage(void) { diff --git a/hash.c b/hash.c index 3423f572..34a562fb 100644 --- a/hash.c +++ b/hash.c @@ -606,7 +606,7 @@ xmlHashDefaultDeallocator(void *entry, const xmlChar *key ATTRIBUTE_UNUSED) { * can't be distinguished from out-of-memory errors, so this function * should be used with care. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 1 on success, 0 if an entry exists and -1 in case of error. */ @@ -625,7 +625,7 @@ xmlHashAdd(xmlHashTablePtr hash, const xmlChar *key, void *payload) { * * See xmlHashAdd(). * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 1 on success, 0 if an entry exists and -1 in case of error. */ @@ -646,7 +646,7 @@ xmlHashAdd2(xmlHashTablePtr hash, const xmlChar *key, * * See xmlHashAdd(). * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 1 on success, 0 if an entry exists and -1 in case of error. */ @@ -1120,7 +1120,7 @@ xmlHashScanFull3(xmlHashTablePtr hash, const xmlChar *key, * * Copy the hash table using `copyFunc` to copy payloads. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns the new table or NULL if a memory allocation failed. */ diff --git a/parser.c b/parser.c index 5288155a..13e48ba3 100644 --- a/parser.c +++ b/parser.c @@ -10415,7 +10415,7 @@ xmlParseXMLDecl(xmlParserCtxtPtr ctxt) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the version from the XML declaration. */ @@ -10430,7 +10430,7 @@ xmlCtxtGetVersion(xmlParserCtxtPtr ctxt) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the value from the standalone document declaration. */ @@ -11593,7 +11593,7 @@ xmlCreateIOParserCtxt(xmlSAXHandlerPtr sax, void *user_data, * Option XML_PARSE_DTDLOAD should be enabled in the parser context * to make external entities work. * - * Availabe since 2.14.0. + * @since 2.14.0 * * @returns the resulting xmlDtdPtr or NULL in case of error. * `input` will be freed by the function in any case. @@ -12127,7 +12127,7 @@ xmlParseBalancedChunkMemory(xmlDocPtr doc, xmlSAXHandlerPtr sax, * * Always consumes `input` even in error case. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns a node list or NULL in case of error. */ @@ -13325,7 +13325,9 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * Applies the options to the parser context. Unset options are * cleared. * - * Available since 2.13.0. With older versions, you can use + * @since 2.13.0 + * + * With older versions, you can use * xmlCtxtUseOptions(). * * XML_PARSE_RECOVER @@ -13371,7 +13373,7 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * * Disables loading of external DTDs or entities. * - * Available since 2.13.0. + * @since 2.13.0 * * XML_PARSE_NOERROR * @@ -13477,19 +13479,19 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * Enable input decompression. Setting this option is discouraged * to avoid zip bombs. * - * Available since 2.14.0. + * @since 2.14.0 * * XML_PARSE_NO_SYS_CATALOG * * Disables the global system XML catalog. * - * Available since 2.14.0. + * @since 2.14.0 * * XML_PARSE_CATALOG_PI * * Enable XML catalog processing instructions. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns 0 in case of success, the set of unknown or unimplemented options * in case of error. @@ -13510,7 +13512,7 @@ xmlCtxtSetOptions(xmlParserCtxtPtr ctxt, int options) * * Get the current options of the parser context. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the current options set in the parser context, or -1 if ctxt is NULL. */ @@ -13602,7 +13604,7 @@ xmlCtxtSetMaxAmplification(xmlParserCtxtPtr ctxt, unsigned maxAmpl) * Parse an XML document and return the resulting document tree. * Takes ownership of the input object. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns the resulting document tree or NULL */ diff --git a/parserInternals.c b/parserInternals.c index e0a50c74..666d29d2 100644 --- a/parserInternals.c +++ b/parserInternals.c @@ -111,7 +111,7 @@ xmlCheckVersion(int version) { * - global generic handler (xmlSetGenericErrorFunc()) * - print to stderr * - * Available since 2.13.0. + * @since 2.13.0 */ void xmlCtxtSetErrorHandler(xmlParserCtxtPtr ctxt, xmlStructuredErrorFunc handler, @@ -166,7 +166,7 @@ xmlCtxtResetLastError(void *ctx) * * Handle an out-of-memory error. * - * Available since 2.13.0. + * @since 2.13.0 */ void xmlCtxtErrMemory(xmlParserCtxtPtr ctxt) @@ -428,7 +428,7 @@ xmlCtxtErr(xmlParserCtxtPtr ctxt, xmlNodePtr node, xmlErrorDomain domain, * reports catastrophic errors which are not related to parsing * like out-of-memory, I/O or other errors. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns a bitmask of XML_STATUS_* flags ORed together. */ @@ -1091,7 +1091,7 @@ xmlCopyChar(int len ATTRIBUTE_UNUSED, xmlChar *out, int val) { * This bypasses legacy feature like global encoding handlers or * encoding aliases. * - * Available since 2.14.0. + * @since 2.14.0 */ void xmlCtxtSetCharEncConvImpl(xmlParserCtxtPtr ctxt, xmlCharEncConvImpl impl, @@ -1269,7 +1269,7 @@ xmlSwitchInputEncodingName(xmlParserCtxtPtr ctxt, xmlParserInputPtr input, * This function can also be used to override the encoding of chunks * passed to xmlParseChunk(). * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 in case of success, -1 otherwise */ @@ -1661,7 +1661,7 @@ xmlSetDeclaredEncoding(xmlParserCtxtPtr ctxt, xmlChar *encoding) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the encoding from the encoding declaration. This can differ * from the actual encoding. @@ -1831,7 +1831,7 @@ xmlNewInputInternal(xmlParserInputBufferPtr buf, const char *filename) { * area must contain a zero byte after the buffer at position `size`. * This can avoid temporary copies. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns a new parser input or NULL if a memory allocation failed. */ @@ -1895,7 +1895,7 @@ xmlCtxtNewInputFromMemory(xmlParserCtxtPtr ctxt, const char *url, * stay unchanged until parsing has finished. This can avoid * temporary copies. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns a new parser input or NULL if a memory allocation failed. */ @@ -1960,7 +1960,7 @@ xmlCtxtNewInputFromString(xmlParserCtxtPtr ctxt, const char *url, * automatically. This feature is deprecated and will be removed * in a future release. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns a new parser input or NULL if a memory allocation failed. */ @@ -2037,7 +2037,7 @@ xmlCtxtNewInputFromFd(xmlParserCtxtPtr ctxt, const char *url, * * `ioCtxt` is an opaque pointer passed to the callbacks. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns a new parser input or NULL if a memory allocation failed. */ @@ -2357,7 +2357,7 @@ xmlCheckHTTPInput(xmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED, * - a file opened from the filesystem, with automatic detection * of compressed files if support is compiled in. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns an xmlParserErrors code. */ @@ -2542,7 +2542,7 @@ xmlGetExternalEntityLoader(void) { * Installs a custom callback to load documents, DTDs or external * entities. * - * Available since 2.14.0. + * @since 2.14.0 */ void xmlCtxtSetResourceLoader(xmlParserCtxtPtr ctxt, xmlResourceLoader loader, @@ -2945,7 +2945,9 @@ xmlNewParserCtxt(void) * Allocate and initialize a new SAX parser context. If userData is NULL, * the parser context will be passed as user data. * - * Available since 2.11.0. If you want support older versions, + * @since 2.11.0 + * + * If you want support older versions, * it's best to invoke xmlNewParserCtxt() and set ctxt->sax with * struct assignment. * @@ -2973,7 +2975,7 @@ xmlNewSAXParserCtxt(const xmlSAXHandler *sax, void *userData) /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the private application data. */ @@ -2989,7 +2991,7 @@ xmlCtxtGetPrivate(xmlParserCtxtPtr ctxt) { * @param ctxt parser context * @param priv private application data * - * Available since 2.14.0. + * @since 2.14.0 * * Set the private application data. */ @@ -3004,7 +3006,7 @@ xmlCtxtSetPrivate(xmlParserCtxtPtr ctxt, void *priv) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the local catalogs. */ @@ -3020,7 +3022,7 @@ xmlCtxtGetCatalogs(xmlParserCtxtPtr ctxt) { * @param ctxt parser context * @param catalogs catalogs pointer * - * Available since 2.14.0. + * @since 2.14.0 * * Set the local catalogs. */ @@ -3035,7 +3037,7 @@ xmlCtxtSetCatalogs(xmlParserCtxtPtr ctxt, void *catalogs) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the dictionary. */ @@ -3051,7 +3053,7 @@ xmlCtxtGetDict(xmlParserCtxtPtr ctxt) { * @param ctxt parser context * @param dict dictionary * - * Available since 2.14.0. + * @since 2.14.0 * * Set the dictionary. This should only be done immediately after * creating a parser context. @@ -3071,7 +3073,7 @@ xmlCtxtSetDict(xmlParserCtxtPtr ctxt, xmlDictPtr dict) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the SAX handler struct. This is not a copy and must not * be freed. Handlers can be updated. @@ -3088,7 +3090,7 @@ xmlCtxtGetSaxHandler(xmlParserCtxtPtr ctxt) { * @param ctxt parser context * @param sax SAX handler * - * Available since 2.14.0. + * @since 2.14.0 * * Set the SAX handler struct to a copy of `sax`. * @@ -3115,7 +3117,7 @@ xmlCtxtSetSaxHandler(xmlParserCtxtPtr ctxt, const xmlSAXHandler *sax) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the parsed document or NULL if a fatal error occurred when * parsing. The document must be freed by the caller. Resets the @@ -3146,7 +3148,7 @@ xmlCtxtGetDocument(xmlParserCtxtPtr ctxt) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns 1 if this is a HTML parser context, 0 otherwise. */ @@ -3161,7 +3163,7 @@ xmlCtxtIsHtml(xmlParserCtxtPtr ctxt) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns 1 if the parser is stopped, 0 otherwise. */ @@ -3177,7 +3179,7 @@ xmlCtxtIsStopped(xmlParserCtxtPtr ctxt) { /** * @param ctxt parser context * - * Available since 2.14.0. + * @since 2.14.0 * * @returns the validation context. */ diff --git a/pattern.c b/pattern.c index 48e51ba5..bad9d6f4 100644 --- a/pattern.c +++ b/pattern.c @@ -2105,7 +2105,7 @@ xmlStreamWantsAnyNode(xmlStreamCtxtPtr streamCtxt) * * Compile a pattern. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 on success, 1 on error, -1 if a memory allocation failed. */ diff --git a/tree.c b/tree.c index a9afb258..f8fd5221 100644 --- a/tree.c +++ b/tree.c @@ -5201,7 +5201,7 @@ xmlNodeSetBase(xmlNodePtr cur, const xmlChar* uri) { * However it does not return the document base (5.1.3), use * doc->URL in this case * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 in case of success, 1 if a URI or argument is invalid, -1 if a * memory allocation failed. @@ -5720,7 +5720,7 @@ xmlTextMerge(xmlNodePtr first, xmlNodePtr second) { * terminated array of namespace pointers that must be freed by * the caller. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 on success, 1 if no namespaces were found, -1 if a * memory allocation failed. @@ -6562,7 +6562,7 @@ xmlHasNsProp(const xmlNode *node, const xmlChar *name, const xmlChar *nameSpace) * This does the entity substitution. The returned value must be * freed by the caller. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 on success, 1 if no attribute was found, -1 if a * memory allocation failed. diff --git a/uri.c b/uri.c index 33566ab1..ee3efbd6 100644 --- a/uri.c +++ b/uri.c @@ -971,7 +971,7 @@ xmlParse3986URIReference(xmlURIPtr uri, const char *str) { * * URI-reference = [ absoluteURI | relativeURI ] [ "\#" fragment ] * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 on success, an error code (typically 1) if the URI is invalid * or -1 if a memory allocation failed. @@ -1991,7 +1991,7 @@ err_memory: * * 5.2. Resolving Relative References to Absolute Form * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 on success, -1 if a memory allocation failed or an error * code if URI or base are invalid. @@ -2512,7 +2512,7 @@ done: * img/pic1.gif ../img/pic1.gif * http://site1.com/docs/pic1.gif http://site1.com/docs/pic1.gif * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 0 on success, -1 if a memory allocation failed or an error * code if URI or base are invalid. diff --git a/valid.c b/valid.c index 34f01c0e..fbe77aad 100644 --- a/valid.c +++ b/valid.c @@ -2367,7 +2367,7 @@ xmlAddIDInternal(xmlAttrPtr attr, const xmlChar *value, xmlIDPtr *idPtr) { * * Register a new id declaration * - * Available since 2.13.0. + * @since 2.13.0 * * @returns 1 on success, 0 if the ID already exists, -1 if a memory * allocation fails. @@ -6424,7 +6424,7 @@ xmlValidateDtd(xmlValidCtxtPtr ctxt, xmlDocPtr doc, xmlDtdPtr dtd) { * * Like xmlValidateDtd() but uses the parser context's error handler. * - * Availabe since 2.14.0. + * @since 2.14.0 * * @returns 1 if valid or 0 otherwise. */ @@ -6720,7 +6720,7 @@ xmlValidateDocument(xmlValidCtxtPtr vctxt, xmlDocPtr doc) { * Option XML_PARSE_DTDLOAD should be enabled in the parser context * to make external entities work. * - * Availabe since 2.14.0. + * @since 2.14.0 * * @returns 1 if valid or 0 otherwise. */ diff --git a/xinclude.c b/xinclude.c index b7782ada..565e6ddd 100644 --- a/xinclude.c +++ b/xinclude.c @@ -1982,7 +1982,7 @@ xmlXIncludeDoProcessRoot(xmlXIncludeCtxtPtr ctxt, xmlNodePtr tree) { /** * @param ctxt an XInclude processing context * - * Available since 2.13.0. + * @since 2.13.0 * * @returns the last error code. */ @@ -2001,7 +2001,7 @@ xmlXIncludeGetLastError(xmlXIncludeCtxtPtr ctxt) { * Register a callback function that will be called on errors and * warnings. If handler is NULL, the error handler will be deactivated. * - * Available since 2.13.0. + * @since 2.13.0 */ void xmlXIncludeSetErrorHandler(xmlXIncludeCtxtPtr ctxt, @@ -2020,7 +2020,7 @@ xmlXIncludeSetErrorHandler(xmlXIncludeCtxtPtr ctxt, * Register a callback function that will be called to load included * documents. * - * Available since 2.14.0. + * @since 2.14.0 */ void xmlXIncludeSetResourceLoader(xmlXIncludeCtxtPtr ctxt, diff --git a/xmlreader.c b/xmlreader.c index f087db32..61759a7e 100644 --- a/xmlreader.c +++ b/xmlreader.c @@ -4722,7 +4722,7 @@ xmlTextReaderGetErrorHandler(xmlTextReaderPtr reader, * Register a callback function that will be called to load external * resources like entities. * - * Available since 2.14.0. + * @since 2.14.0 */ void xmlTextReaderSetResourceLoader(xmlTextReaderPtr reader, @@ -4982,7 +4982,7 @@ xmlTextReaderSetMaxAmplification(xmlTextReaderPtr reader, unsigned maxAmpl) /** * @param reader an XML reader * - * Available since 2.13.0. + * @since 2.13.0 * * @returns the last error. */ diff --git a/xmlsave.c b/xmlsave.c index 9ed6851d..3444c0db 100644 --- a/xmlsave.c +++ b/xmlsave.c @@ -228,7 +228,7 @@ xmlSerializeText(xmlOutputBufferPtr buf, const xmlChar *string, * * Sets the indent string. * - * Available since 2.14.0. + * @since 2.14.0 * * @returns 0 on success, -1 if the string is NULL, empty or too long. */ @@ -2168,7 +2168,7 @@ xmlSaveClose(xmlSaveCtxtPtr ctxt) * 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. + * @since 2.13.0 * * @returns an xmlParserErrors code. */ diff --git a/xmlschemas.c b/xmlschemas.c index 29122f12..71bff12b 100644 --- a/xmlschemas.c +++ b/xmlschemas.c @@ -21173,7 +21173,7 @@ xmlSchemaGetParserErrors(xmlSchemaParserCtxtPtr ctxt, * Register a callback function that will be called to load documents * or external entities. * - * Available since 2.14.0. + * @since 2.14.0 */ void xmlSchemaSetResourceLoader(xmlSchemaParserCtxtPtr ctxt, diff --git a/xmlwriter.c b/xmlwriter.c index 62c30205..17e2c615 100644 --- a/xmlwriter.c +++ b/xmlwriter.c @@ -4154,7 +4154,7 @@ xmlTextWriterFlush(xmlTextWriterPtr writer) * * Flushes and closes the output buffer. * - * Available since 2.13.0. + * @since 2.13.0 * * @returns an xmlParserErrors code. */ diff --git a/xpath.c b/xpath.c index 655c099b..9f2a64da 100644 --- a/xpath.c +++ b/xpath.c @@ -4857,7 +4857,7 @@ xmlXPathFreeContext(xmlXPathContextPtr ctxt) { * Register a callback function that will be called on errors and * warnings. If handler is NULL, the error handler will be deactivated. * - * Available since 2.13.0. + * @since 2.13.0 */ void xmlXPathSetErrorHandler(xmlXPathContextPtr ctxt,