From e78e05c990751bd2e9facc9bd29a5440386cba0a Mon Sep 17 00:00:00 2001 From: Nick Wellnhofer Date: Fri, 2 May 2025 17:32:51 +0200 Subject: [PATCH] doc: Fix autolinks to functions Unfortunately, autolinks in .c files aren't converted by Doxygen for some reason. --- HTMLparser.c | 56 ++++++++++----------- SAX2.c | 14 +++--- buf.c | 4 +- catalog.c | 2 +- chvalid.c | 16 +++--- dict.c | 6 +-- encoding.c | 26 +++++----- entities.c | 4 +- error.c | 18 +++---- globals.c | 6 +-- hash.c | 18 +++---- include/libxml/encoding.h | 2 +- include/libxml/xmlreader.h | 2 +- include/libxml/xmlwriter.h | 4 +- parser.c | 92 +++++++++++++++++----------------- parserInternals.c | 48 +++++++++--------- pattern.c | 2 +- relaxng.c | 8 +-- runtest.c | 8 +-- threads.c | 8 +-- tree.c | 100 ++++++++++++++++++------------------- uri.c | 4 +- valid.c | 18 +++---- xmlIO.c | 36 ++++++------- xmlmemory.c | 10 ++-- xmlreader.c | 4 +- xmlregexp.c | 6 +-- xmlschemastypes.c | 4 +- xmlstring.c | 6 +-- xmlwriter.c | 2 +- xpath.c | 8 +-- 31 files changed, 271 insertions(+), 271 deletions(-) diff --git a/HTMLparser.c b/HTMLparser.c index 65a1fffd..faf33140 100644 --- a/HTMLparser.c +++ b/HTMLparser.c @@ -2878,7 +2878,7 @@ htmlParseEntityRef(htmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED, * * 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 + * will be handled later in xmlStringGetNodeList(), unless it was * asked for ctxt->replaceEntities != 0 * * @returns the AttValue parsed or NULL. @@ -4149,7 +4149,7 @@ htmlParseEndTag(htmlParserCtxtPtr ctxt) * @param ctxt an HTML parser context * * Parse a content: comment, sub-element, reference or text. - * New version for non recursive htmlParseElementInternal + * New version for non recursive htmlParseElementInternal() */ static void @@ -4382,7 +4382,7 @@ htmlCtxtParseContentInternal(htmlParserCtxtPtr ctxt, xmlParserInputPtr input) { * * 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. + * document tree, use htmlCtxtParseDocument(). * * @returns 0, -1 in case of error. */ @@ -4617,13 +4617,13 @@ htmlFreeParserCtxt(htmlParserCtxtPtr ctxt) * Allocate and initialize a new HTML parser context. * * This can be used to parse HTML documents into DOM trees with - * functions like xmlCtxtReadFile or xmlCtxtReadMemory. + * functions like xmlCtxtReadFile() or xmlCtxtReadMemory(). * - * See htmlCtxtUseOptions for parser options. + * See htmlCtxtUseOptions() for parser options. * - * See xmlCtxtSetErrorHandler for advanced error handling. + * See xmlCtxtSetErrorHandler() for advanced error handling. * - * See htmlNewSAXParserCtxt for custom SAX parsers. + * See htmlNewSAXParserCtxt() for custom SAX parsers. * * @returns the htmlParserCtxtPtr or NULL in case of allocation error */ @@ -4642,10 +4642,10 @@ htmlNewParserCtxt(void) * is NULL, the parser context will be passed as user data. * * Available since 2.11.0. If you want support older versions, - * it's best to invoke htmlNewParserCtxt and set ctxt->sax with + * it's best to invoke htmlNewParserCtxt() and set ctxt->sax with * struct assignment. * - * Also see htmlNewParserCtxt. + * Also see htmlNewParserCtxt(). * * @returns the htmlParserCtxtPtr or NULL in case of allocation error */ @@ -4701,7 +4701,7 @@ htmlCreateMemoryParserCtxtInternal(const char *url, * @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. @@ -5179,7 +5179,7 @@ htmlParseTryOrFinish(htmlParserCtxtPtr ctxt, int terminate) { * Parse a chunk of memory in push parser mode. * * Assumes that the parser context was initialized with - * htmlCreatePushParserCtxt. + * htmlCreatePushParserCtxt(). * * The last chunk, which will often be empty, must be marked with * the `terminate` flag. With the default SAX callbacks, the resulting @@ -5305,7 +5305,7 @@ htmlCreatePushParserCtxt(htmlSAXHandlerPtr sax, void *user_data, * @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 @@ -5344,7 +5344,7 @@ htmlSAXParseDoc(const xmlChar *cur, const char *encoding, * @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. * @@ -5363,7 +5363,7 @@ htmlParseDoc(const xmlChar *cur, const char *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. * @@ -5408,7 +5408,7 @@ htmlCreateFileParserCtxt(const char *filename, const char *encoding) * @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. @@ -5710,7 +5710,7 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * cleared. * * Available since 2.14.0. With older versions, you can use - * htmlCtxtUseOptions. + * htmlCtxtUseOptions(). * * HTML_PARSE_RECOVER * @@ -5733,7 +5733,7 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * HTML_PARSE_NOERROR * * Disable error and warning reports to the error handlers. - * Errors are still accessible with xmlCtxtGetLastError. + * Errors are still accessible with xmlCtxtGetLastError(). * * HTML_PARSE_NOWARNING * @@ -5810,7 +5810,7 @@ htmlCtxtSetOptions(xmlParserCtxtPtr ctxt, int options) * @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: @@ -5898,7 +5898,7 @@ htmlCtxtParseDocument(htmlParserCtxtPtr ctxt, xmlParserInputPtr input) * Convenience function to parse an HTML document from a zero-terminated * string. * - * See htmlCtxtReadDoc for details. + * See htmlCtxtReadDoc() for details. * * @returns the resulting document tree. */ @@ -5934,7 +5934,7 @@ htmlReadDoc(const xmlChar *str, const char *url, const char *encoding, * Convenience function to parse an HTML file from the filesystem, * the network or a global user-defined resource loader. * - * See htmlCtxtReadFile for details. + * See htmlCtxtReadFile() for details. * * @returns the resulting document tree. */ @@ -5970,7 +5970,7 @@ htmlReadFile(const char *filename, const char *encoding, int options) * Convenience function to parse an HTML document from memory. * The input buffer must not contain any terminating null bytes. * - * See htmlCtxtReadMemory for details. + * See htmlCtxtReadMemory() for details. * * @returns the resulting document tree */ @@ -6013,7 +6013,7 @@ htmlReadMemory(const char *buffer, int size, const char *url, * NOTE that the file descriptor will not be closed when the * context is freed or reset. * - * See htmlCtxtReadFd for details. + * See htmlCtxtReadFd() for details. * * @returns the resulting document tree */ @@ -6050,7 +6050,7 @@ htmlReadFd(int fd, const char *url, const char *encoding, int options) * Convenience function to parse an HTML document from I/O functions * and context. * - * See htmlCtxtReadIO for details. + * See htmlCtxtReadIO() for details. * * @returns the resulting document tree */ @@ -6087,7 +6087,7 @@ htmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, * * Parse an HTML in-memory document and build a tree. * - * See htmlCtxtUseOptions for details. + * See htmlCtxtUseOptions() for details. * * @returns the resulting document tree */ @@ -6120,7 +6120,7 @@ htmlCtxtReadDoc(htmlParserCtxtPtr ctxt, const xmlChar *str, * Parse an HTML file from the filesystem, the network or a * user-defined resource loader. * - * See htmlCtxtUseOptions for details. + * See htmlCtxtUseOptions() for details. * * @returns the resulting document tree */ @@ -6154,7 +6154,7 @@ htmlCtxtReadFile(htmlParserCtxtPtr ctxt, const char *filename, * Parse an HTML in-memory document and build a tree. The input buffer must * not contain any terminating null bytes. * - * See htmlCtxtUseOptions for details. + * See htmlCtxtUseOptions() for details. * * @returns the resulting document tree */ @@ -6187,7 +6187,7 @@ htmlCtxtReadMemory(htmlParserCtxtPtr ctxt, const char *buffer, int size, * * Parse an HTML from a file descriptor and build a tree. * - * See htmlCtxtUseOptions for details. + * See htmlCtxtUseOptions() for details. * * NOTE that the file descriptor will not be closed when the * context is freed or reset. @@ -6224,7 +6224,7 @@ htmlCtxtReadFd(htmlParserCtxtPtr ctxt, int fd, * * Parse an HTML document from I/O functions and source and build a tree. * - * See htmlCtxtUseOptions for details. + * See htmlCtxtUseOptions() for details. * * @returns the resulting document tree */ diff --git a/SAX2.c b/SAX2.c index 14eaf821..e09ae15c 100644 --- a/SAX2.c +++ b/SAX2.c @@ -374,7 +374,7 @@ error: * @param systemId The system ID of the entity * * This is only used to load DTDs. The preferred way to install - * custom resolvers is xmlCtxtSetResourceLoader. + * custom resolvers is xmlCtxtSetResourceLoader(). * * @returns a parser input. */ @@ -2376,7 +2376,7 @@ xmlSAX2EndElementNs(void *ctx, * @param ctx the user data (XML parser context) * @param name The entity name * - * called when an entity xmlSAX2Reference is detected. + * called when an entity xmlSAX2Reference() is detected. */ void xmlSAX2Reference(void *ctx, const xmlChar *name) @@ -2554,7 +2554,7 @@ xmlSAX2Characters(void *ctx, const xmlChar *ch, int len) * @param len the number of xmlChar * * receiving some ignorable whitespaces from the parser. - * UNUSED: by default the DOM building will use xmlSAX2Characters + * UNUSED: by default the DOM building will use xmlSAX2Characters() */ void xmlSAX2IgnorableWhitespace(void *ctx ATTRIBUTE_UNUSED, const xmlChar *ch ATTRIBUTE_UNUSED, int len ATTRIBUTE_UNUSED) @@ -2588,9 +2588,9 @@ xmlSAX2ProcessingInstruction(void *ctx, const xmlChar *target, /** * @param ctx the user data (XML parser context) - * @param value the xmlSAX2Comment content + * @param value the xmlSAX2Comment() content * - * A xmlSAX2Comment has been parsed. + * A xmlSAX2Comment() has been parsed. */ void xmlSAX2Comment(void *ctx, const xmlChar *value) @@ -2718,7 +2718,7 @@ xmlSAX2InitDefaultSAXHandler(xmlSAXHandler *hdlr, int warning) } /** - * @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 @@ -2773,7 +2773,7 @@ xmlSAX2InitHtmlDefaultSAXHandler(xmlSAXHandler *hdlr) } /** - * @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 77a7982e..32c2ab96 100644 --- a/buf.c +++ b/buf.c @@ -682,7 +682,7 @@ xmlBufUpdateInput(xmlBufPtr buf, xmlParserInputPtr input, size_t pos) { /** * @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 @@ -694,7 +694,7 @@ xmlSetBufferAllocationScheme(xmlBufferAllocationScheme scheme ATTRIBUTE_UNUSED) } /** - * @deprecated Use xmlBufferSetAllocationScheme. + * @deprecated Use xmlBufferSetAllocationScheme(). * * Types are * XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down diff --git a/catalog.c b/catalog.c index d17ed2b7..7b2dee6e 100644 --- a/catalog.c +++ b/catalog.c @@ -512,7 +512,7 @@ xmlCatalogDumpEntry(void *payload, void *data, * @param ns the current namespace * @param cgroup group node for group members * - * Serializes a Catalog entry, called by xmlDumpXMLCatalog and recursively + * Serializes a Catalog entry, called by xmlDumpXMLCatalog() and recursively * for group entries */ static void xmlDumpXMLCatalogNode(xmlCatalogEntryPtr catal, xmlNodePtr catalog, diff --git a/chvalid.c b/chvalid.c index f78c49fc..82077c1e 100644 --- a/chvalid.c +++ b/chvalid.c @@ -217,7 +217,7 @@ xmlCharInRange (unsigned int val, const xmlChRangeGroup *rptr) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsBaseChar_ch or xmlIsBaseCharQ instead + * Use xmlIsBaseChar_ch() or xmlIsBaseCharQ() instead * * @returns true if argument valid, false otherwise */ @@ -231,7 +231,7 @@ xmlIsBaseChar(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsBlank_ch or xmlIsBlankQ instead + * Use xmlIsBlank_ch() or xmlIsBlankQ() instead * * @returns true if argument valid, false otherwise */ @@ -245,7 +245,7 @@ xmlIsBlank(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsChar_ch or xmlIsCharQ instead + * Use xmlIsChar_ch() or xmlIsCharQ() instead * * @returns true if argument valid, false otherwise */ @@ -259,7 +259,7 @@ xmlIsChar(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsCombiningQ instead + * Use xmlIsCombiningQ() instead * * @returns true if argument valid, false otherwise */ @@ -273,7 +273,7 @@ xmlIsCombining(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsDigit_ch or xmlIsDigitQ instead + * Use xmlIsDigit_ch() or xmlIsDigitQ() instead * * @returns true if argument valid, false otherwise */ @@ -287,7 +287,7 @@ xmlIsDigit(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsExtender_ch or xmlIsExtenderQ instead + * Use xmlIsExtender_ch() or xmlIsExtenderQ() instead * * @returns true if argument valid, false otherwise */ @@ -301,7 +301,7 @@ xmlIsExtender(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsIdeographicQ instead + * Use xmlIsIdeographicQ() instead * * @returns true if argument valid, false otherwise */ @@ -315,7 +315,7 @@ xmlIsIdeographic(unsigned int ch) { * @param ch character to validate * * This function is DEPRECATED. - * Use xmlIsPubidChar_ch or xmlIsPubidCharQ instead + * Use xmlIsPubidChar_ch() or xmlIsPubidCharQ() instead * * @returns true if argument valid, false otherwise */ diff --git a/dict.c b/dict.c index 88edf351..6eb952d9 100644 --- a/dict.c +++ b/dict.c @@ -81,7 +81,7 @@ struct _xmlDict { static xmlMutex xmlDictMutex; /** - * @deprecated Alias for xmlInitParser. + * @deprecated Alias for xmlInitParser(). * * @returns 0. */ @@ -100,8 +100,8 @@ xmlInitDictInternal(void) { } /** - * @deprecated This function is a no-op. Call xmlCleanupParser - * to free global state but see the warnings there. 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. */ diff --git a/encoding.c b/encoding.c index 8e50a87a..5f559eab 100644 --- a/encoding.c +++ b/encoding.c @@ -316,7 +316,7 @@ xmlDetectCharEncoding(const unsigned char* in, int len) /** * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative. + * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. * * Unregisters all aliases */ @@ -381,7 +381,7 @@ xmlGetEncodingAlias(const char *alias) { * @param alias the alias name as parsed, in UTF-8 format (ASCII actually) * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative. + * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. * * Registers an alias `alias` for an encoding named `name`. Existing alias * will be overwritten. @@ -455,7 +455,7 @@ xmlAddEncodingAlias(const char *name, const char *alias) { * @param alias the alias name as parsed, in UTF-8 format (ASCII actually) * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative. + * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. * * Unregisters an encoding alias `alias` * @@ -575,7 +575,7 @@ xmlGetCharEncodingName(xmlCharEncoding enc) { * @param output the xmlCharEncodingOutputFunc to write that encoding * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative. + * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. * * Create and registers an xmlCharEncodingHandler. * @@ -692,7 +692,7 @@ error: } /** - * @deprecated Alias for xmlInitParser. + * @deprecated Alias for xmlInitParser(). */ void xmlInitCharEncodingHandlers(void) { @@ -712,8 +712,8 @@ xmlInitEncodingInternal(void) { } /** - * @deprecated This function will be made private. Call xmlCleanupParser - * to free global state but see the warnings there. 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. * @@ -746,7 +746,7 @@ xmlCleanupCharEncodingHandlers(void) { * @param handler the xmlCharEncodingHandlerPtr handler block * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl for an alternative. + * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. * * Register the char encoding handler. */ @@ -857,7 +857,7 @@ xmlFindExtraHandler(const char *norig, const char *name, xmlCharEncFlags flags, * - iconv if enabled * - ICU if enabled * - * The handler must be closed with xmlCharEncCloseFunc. + * The handler must be closed with xmlCharEncCloseFunc(). * * If the encoding is UTF-8, a NULL handler and no error code will * be returned. @@ -906,7 +906,7 @@ xmlLookupCharEncodingHandler(xmlCharEncoding enc, /** * @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 @@ -936,7 +936,7 @@ xmlGetCharEncodingHandler(xmlCharEncoding enc) { * - iconv if enabled * - ICU if enabled * - * The handler must be closed with xmlCharEncCloseFunc. + * The handler must be closed with xmlCharEncCloseFunc(). * * If the encoding is UTF-8, a NULL handler and no error code will * be returned. @@ -999,7 +999,7 @@ xmlCreateCharEncodingHandler(const char *name, xmlCharEncFlags flags, * - iconv if enabled * - ICU if enabled * - * The handler must be closed with xmlCharEncCloseFunc. + * The handler must be closed with xmlCharEncCloseFunc(). * * If the encoding is UTF-8, a NULL handler and no error code will * be returned. @@ -1020,7 +1020,7 @@ xmlOpenCharEncodingHandler(const char *name, int output, /** * @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 diff --git a/entities.c b/entities.c index a9bb2c4c..1aea10eb 100644 --- a/entities.c +++ b/entities.c @@ -775,7 +775,7 @@ xmlEscapeText(const xmlChar *text, int 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 + * Contrary to xmlEncodeEntities(), this routine is reentrant, and result * must be deallocated. * * @returns A newly allocated string with the substitution done. @@ -800,7 +800,7 @@ xmlEncodeEntitiesInternal(xmlDocPtr doc, const xmlChar *input, * * 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 + * Contrary to xmlEncodeEntities(), this routine is reentrant, and result * must be deallocated. * * This escapes `<`, `>`, `&` and `\r`. If the document has no encoding, diff --git a/error.c b/error.c index 879098d4..c5ea4222 100644 --- a/error.c +++ b/error.c @@ -236,7 +236,7 @@ xmlGenericErrorDefaultFunc(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...) { * @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 @@ -269,14 +269,14 @@ xmlSetGenericErrorFunc(void *ctx, xmlGenericErrorFunc handler) { * * It's recommended to use the per-context error handlers instead: * - * - xmlCtxtSetErrorHandler (since 2.13.0) - * - xmlTextReaderSetStructuredErrorHandler - * - xmlXPathSetErrorHandler (since 2.13.0) - * - xmlXIncludeSetErrorHandler (since 2.13.0) + * - xmlCtxtSetErrorHandler() (since 2.13.0) + * - xmlTextReaderSetStructuredErrorHandler() + * - xmlXPathSetErrorHandler() (since 2.13.0) + * - xmlXIncludeSetErrorHandler() (since 2.13.0) * - xmlSchemaSetParserStructuredErrors * - xmlSchemaSetValidStructuredErrors - * - xmlRelaxNGSetParserStructuredErrors - * - xmlRelaxNGSetValidStructuredErrors + * - xmlRelaxNGSetParserStructuredErrors() + * - xmlRelaxNGSetValidStructuredErrors() * * Set the global "structured" handler and context for error messages. * If handler is NULL, the error handler is deactivated. @@ -305,7 +305,7 @@ xmlSetStructuredErrorFunc(void *ctx, xmlStructuredErrorFunc handler) { /** * @param input an xmlParserInputPtr input * - * @deprecated Use xmlFormatError. + * @deprecated Use xmlFormatError(). * * Displays the associated file and line information for the current input */ @@ -398,7 +398,7 @@ xmlParserPrintFileContextInternal(xmlParserInputPtr input , /** * @param input an xmlParserInputPtr input * - * @deprecated Use xmlFormatError. + * @deprecated Use xmlFormatError(). * * Displays current context within the input content for error tracking */ diff --git a/globals.c b/globals.c index ee5ddb77..fd1cca29 100644 --- a/globals.c +++ b/globals.c @@ -374,7 +374,7 @@ xmlInitGlobalState(xmlGlobalStatePtr gs); ************************************************************************/ /** - * @deprecated Alias for xmlInitParser. + * @deprecated Alias for xmlInitParser(). */ void xmlInitGlobals(void) { xmlInitParser(); @@ -399,8 +399,8 @@ void xmlInitGlobalsInternal(void) { } /** - * @deprecated This function is a no-op. Call xmlCleanupParser - * to free global state but see the warnings there. 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. */ diff --git a/hash.c b/hash.c index 7b807e56..3423f572 100644 --- a/hash.c +++ b/hash.c @@ -623,7 +623,7 @@ xmlHashAdd(xmlHashTablePtr hash, const xmlChar *key, void *payload) { * * Add a hash table entry with two strings as key. * - * See xmlHashAdd. + * See xmlHashAdd(). * * Available since 2.13.0. * @@ -644,7 +644,7 @@ xmlHashAdd2(xmlHashTablePtr hash, const xmlChar *key, * * Add a hash table entry with three strings as key. * - * See xmlHashAdd. + * See xmlHashAdd(). * * Available since 2.13.0. * @@ -668,7 +668,7 @@ xmlHashAdd3(xmlHashTablePtr hash, const xmlChar *key, * should be used with care. * * NOTE: This function doesn't allow to distinguish malloc failures from - * existing entries. Use xmlHashAdd instead. + * existing entries. Use xmlHashAdd() instead. * * @returns 0 on success and -1 in case of error. */ @@ -692,7 +692,7 @@ xmlHashAddEntry(xmlHashTablePtr hash, const xmlChar *key, void *payload) { * * Add a hash table entry with two strings as key. * - * See xmlHashAddEntry. + * See xmlHashAddEntry(). * * @returns 0 on success and -1 in case of error. */ @@ -718,7 +718,7 @@ xmlHashAddEntry2(xmlHashTablePtr hash, const xmlChar *key, * * Add a hash table entry with three strings as key. * - * See xmlHashAddEntry. + * See xmlHashAddEntry(). * * @returns 0 on success and -1 in case of error. */ @@ -768,7 +768,7 @@ xmlHashUpdateEntry(xmlHashTablePtr hash, const xmlChar *key, * * Add a hash table entry with two strings as key. * - * See xmlHashUpdateEntry. + * See xmlHashUpdateEntry(). * * @returns 0 on success and -1 in case of error. */ @@ -795,7 +795,7 @@ xmlHashUpdateEntry2(xmlHashTablePtr hash, const xmlChar *key, * * Add a hash table entry with three strings as key. * - * See xmlHashUpdateEntry. + * See xmlHashUpdateEntry(). * * @returns 0 on success and -1 in case of error. */ @@ -1218,7 +1218,7 @@ int xmlHashRemoveEntry(xmlHashTablePtr hash, const xmlChar *key, * * Remove an entry with two strings as key. * - * See xmlHashRemoveEntry. + * See xmlHashRemoveEntry(). * * @returns 0 on success and -1 in case of error. */ @@ -1237,7 +1237,7 @@ xmlHashRemoveEntry2(xmlHashTablePtr hash, const xmlChar *key, * * Remove an entry with three strings as key. * - * See xmlHashRemoveEntry. + * See xmlHashRemoveEntry(). * * @returns 0 on success and -1 in case of error. */ diff --git a/include/libxml/encoding.h b/include/libxml/encoding.h index 79752b2d..be0ac268 100644 --- a/include/libxml/encoding.h +++ b/include/libxml/encoding.h @@ -230,7 +230,7 @@ struct _xmlCharEncodingHandler { * * If this function returns XML_ERR_OK, it must fill the `out` * pointer with an encoding handler. The handler can be obtained - * from xmlCharEncNewCustomHandler. + * from xmlCharEncNewCustomHandler(). * * `flags` can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both. * diff --git a/include/libxml/xmlreader.h b/include/libxml/xmlreader.h index 10a882d1..2cc67a3d 100644 --- a/include/libxml/xmlreader.h +++ b/include/libxml/xmlreader.h @@ -55,7 +55,7 @@ typedef enum { } xmlTextReaderMode; /** - * Some common options to use with xmlTextReaderSetParserProp, but it + * Some common options to use with xmlTextReaderSetParserProp(), but it * is better to use xmlParserOption and the xmlReaderNewxxx and * xmlReaderForxxx APIs now. */ diff --git a/include/libxml/xmlwriter.h b/include/libxml/xmlwriter.h index 07a8afcc..65943556 100644 --- a/include/libxml/xmlwriter.h +++ b/include/libxml/xmlwriter.h @@ -271,7 +271,7 @@ extern "C" { const xmlChar * content); /** - * This macro maps to xmlTextWriterWritePI + * This macro maps to xmlTextWriterWritePI() */ #define xmlTextWriterWriteProcessingInstruction xmlTextWriterWritePI @@ -331,7 +331,7 @@ extern "C" { const xmlChar * subset); /** - * this macro maps to xmlTextWriterWriteDTD + * this macro maps to xmlTextWriterWriteDTD() */ #define xmlTextWriterWriteDocType xmlTextWriterWriteDTD diff --git a/parser.c b/parser.c index 332e6e71..5288155a 100644 --- a/parser.c +++ b/parser.c @@ -417,10 +417,10 @@ xmlSaturatedAddSizeT(unsigned long *dst, unsigned long val) { * * Check for non-linear entity expansion behaviour. * - * In some cases like xmlExpandEntityInAttValue, this function is called + * In some cases like xmlExpandEntityInAttValue(), this function is called * for each, possibly nested entity and its unexpanded content length. * - * In other cases like xmlParseReference, it's only called for each + * In other cases like xmlParseReference(), it's only called for each * top-level entity with its unexpanded content length plus the sum of * the unexpanded content lengths (plus fixed cost) of all nested * entities. @@ -1568,7 +1568,7 @@ xmlParserNsLookupUri(xmlParserCtxtPtr ctxt, const xmlHashedString *prefix) { * @param prefix namespace prefix * * Lookup extra data for the given prefix. This returns data stored - * with xmlParserNsUdpateSax. + * with xmlParserNsUdpateSax(). * * @returns the data on success, NULL if no namespace was found. */ @@ -1598,7 +1598,7 @@ xmlParserNsLookupSax(xmlParserCtxtPtr ctxt, const xmlChar *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 + * 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. @@ -4491,7 +4491,7 @@ error: * * parse a value for an attribute * Note: the parser won't do substitution of entities here, this - * will be handled later in xmlStringGetNodeList + * will be handled later in xmlStringGetNodeList() * * [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | * "'" ([^<&'] | Reference)* "'" @@ -6274,7 +6274,7 @@ xmlParseAttributeListDecl(xmlParserCtxtPtr ctxt) { * @deprecated Internal function, don't use. * * parse the declaration for a Mixed Element content - * The leading '(' and spaces have been skipped in xmlParseElementContentDecl + * The leading '(' and spaces have been skipped in xmlParseElementContentDecl() * * [51] Mixed ::= '(' S? '\#PCDATA' (S? '|' S? Name)* S? ')*' | * '(' S? '\#PCDATA' S? ')' @@ -6386,7 +6386,7 @@ mem_error: * @param depth the level of recursion * * parse the declaration for a Mixed Element content - * The leading '(' and spaces have been skipped in xmlParseElementContentDecl + * The leading '(' and spaces have been skipped in xmlParseElementContentDecl() * * * [47] children ::= (choice | seq) ('?' | '*' | '+')? @@ -6693,7 +6693,7 @@ xmlParseElementChildrenContentDeclPriv(xmlParserCtxtPtr ctxt, int inputchk, * @deprecated Internal function, don't use. * * parse the declaration for a Mixed Element content - * The leading '(' and spaces have been skipped in xmlParseElementContentDecl + * The leading '(' and spaces have been skipped in xmlParseElementContentDecl() * * [47] children ::= (choice | seq) ('?' | '*' | '+')? * @@ -6731,7 +6731,7 @@ xmlParseElementChildrenContentDecl(xmlParserCtxtPtr ctxt, int inputchk) { * @deprecated Internal function, don't use. * * parse the declaration for an Element content either Mixed or Children, - * the cases EMPTY and ANY are handled directly in xmlParseElementDecl + * the cases EMPTY and ANY are handled directly in xmlParseElementDecl() * * [46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children * @@ -9748,7 +9748,7 @@ xmlParseContentInternal(xmlParserCtxtPtr ctxt) { * * Parse XML element content. This is useful if you're only interested * in custom SAX callbacks. If you want a node list, use - * xmlCtxtParseContent. + * xmlCtxtParseContent(). */ void xmlParseContent(xmlParserCtxtPtr ctxt) { @@ -10505,7 +10505,7 @@ xmlFinishDocument(xmlParserCtxtPtr ctxt) { * * Parse an XML 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 xmlCtxtParseDocument. + * document tree, use xmlCtxtParseDocument(). * * @returns 0, -1 in case of error. */ @@ -11351,16 +11351,16 @@ done: * Parse a chunk of memory in push parser mode. * * Assumes that the parser context was initialized with - * xmlCreatePushParserCtxt. + * xmlCreatePushParserCtxt(). * * The last chunk, which will often be empty, must be marked with * the `terminate` flag. With the default SAX callbacks, the resulting * document will be available in ctxt->myDoc. This pointer will not - * be freed when calling xmlFreeParserCtxt and must be freed by the + * be freed when calling xmlFreeParserCtxt() and must be freed by the * caller. If the document isn't well-formed, it will still be returned * in ctxt->myDoc. * - * As an exception, xmlCtxtResetPush will free the document in + * As an exception, xmlCtxtResetPush() will free the document in * ctxt->myDoc. So ctxt->myDoc should be set to NULL after extracting * the document. * @@ -11477,7 +11477,7 @@ xmlParseChunk(xmlParserCtxtPtr ctxt, const char *chunk, int size, * @param filename file name or URI (optional) * * Create a parser context for using the XML parser in push mode. - * See xmlParseChunk. + * See xmlParseChunk(). * * Passing an initial chunk is useless and deprecated. * @@ -11665,7 +11665,7 @@ error: * @param input an Input Buffer * @param enc the charset encoding if known * - * @deprecated Use xmlCtxtParseDtd. + * @deprecated Use xmlCtxtParseDtd(). * * Load and parse a DTD * @@ -11716,7 +11716,7 @@ xmlIOParseDTD(xmlSAXHandlerPtr sax, xmlParserInputBufferPtr input, * @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. * @@ -12051,7 +12051,7 @@ xmlParseCtxtExternalEntity(xmlParserCtxtPtr ctxt, const xmlChar *URL, * @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 @@ -12274,7 +12274,7 @@ exit: * * This function assumes the encoding of `node`'s document which is * typically not what you want. A better alternative is - * xmlCtxtParseContent. + * xmlCtxtParseContent(). * * @returns XML_ERR_OK if the chunk is well balanced, and the parser * error code otherwise @@ -12539,7 +12539,7 @@ error: * @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 @@ -12579,7 +12579,7 @@ xmlCreateURLParserCtxt(const char *filename, int options) /** * @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 @@ -12601,7 +12601,7 @@ xmlCreateFileParserCtxt(const char *filename) * documents * @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. @@ -12651,7 +12651,7 @@ xmlSAXParseFileWithData(xmlSAXHandlerPtr sax, const char *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. @@ -12670,7 +12670,7 @@ xmlSAXParseFile(xmlSAXHandlerPtr sax, const char *filename, /** * @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 @@ -12687,7 +12687,7 @@ xmlRecoverDoc(const xmlChar *cur) { /** * @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. @@ -12704,7 +12704,7 @@ xmlParseFile(const char *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. @@ -12755,7 +12755,7 @@ xmlSetupParserForBuffer(xmlParserCtxtPtr ctxt, const xmlChar* buffer, * @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 @@ -12850,7 +12850,7 @@ xmlCreateMemoryParserCtxt(const char *buffer, int size) { * documents * @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 @@ -12901,7 +12901,7 @@ xmlSAXParseMemoryWithData(xmlSAXHandlerPtr sax, const char *buffer, * @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 @@ -12919,7 +12919,7 @@ xmlSAXParseMemory(xmlSAXHandlerPtr sax, const char *buffer, * @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. * @@ -12934,7 +12934,7 @@ xmlDocPtr xmlParseMemory(const char *buffer, int size) { * @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 @@ -12953,7 +12953,7 @@ xmlDocPtr xmlRecoverMemory(const char *buffer, int size) { * @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. * @@ -13033,7 +13033,7 @@ xmlCreateDocParserCtxt(const xmlChar *str) { * @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. @@ -13076,7 +13076,7 @@ xmlSAXParseDoc(xmlSAXHandlerPtr sax, const xmlChar *cur, int recovery) { /** * @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. * @@ -13326,7 +13326,7 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * cleared. * * Available since 2.13.0. With older versions, you can use - * xmlCtxtUseOptions. + * xmlCtxtUseOptions(). * * XML_PARSE_RECOVER * @@ -13376,7 +13376,7 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * XML_PARSE_NOERROR * * Disable error and warning reports to the error handlers. - * Errors are still accessible with xmlCtxtGetLastError. + * Errors are still accessible with xmlCtxtGetLastError(). * * XML_PARSE_NOWARNING * @@ -13527,7 +13527,7 @@ xmlCtxtGetOptions(xmlParserCtxtPtr ctxt) * @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: @@ -13646,7 +13646,7 @@ xmlCtxtParseDocument(xmlParserCtxtPtr ctxt, xmlParserInputPtr input) * Convenience function to parse an XML document from a * zero-terminated string. * - * See xmlCtxtReadDoc for details. + * See xmlCtxtReadDoc() for details. * * @returns the resulting document tree */ @@ -13687,7 +13687,7 @@ xmlReadDoc(const xmlChar *cur, const char *URL, const char *encoding, * read from stdin. Both of these features are potentially * insecure and might be removed from later versions. * - * See xmlCtxtReadFile for details. + * See xmlCtxtReadFile() for details. * * @returns the resulting document tree */ @@ -13734,7 +13734,7 @@ xmlReadFile(const char *filename, const char *encoding, int options) * Parse an XML in-memory document and build a tree. The input buffer must * not contain a terminating null byte. * - * See xmlCtxtReadMemory for details. + * See xmlCtxtReadMemory() for details. * * @returns the resulting document tree */ @@ -13773,7 +13773,7 @@ xmlReadMemory(const char *buffer, int size, const char *url, * * Parse an XML from a file descriptor and build a tree. * - * See xmlCtxtReadFd for details. + * See xmlCtxtReadFd() for details. * * NOTE that the file descriptor will not be closed when the * context is freed or reset. @@ -13812,7 +13812,7 @@ xmlReadFd(int fd, const char *URL, const char *encoding, int options) * * Parse an XML document from I/O functions and context and build a tree. * - * See xmlCtxtReadIO for details. + * See xmlCtxtReadIO() for details. * * @returns the resulting document tree */ @@ -13852,7 +13852,7 @@ xmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, * `URL` is used as base to resolve external entities and for error * reporting. * - * See xmlCtxtUseOptions for details. + * See xmlCtxtUseOptions() for details. * * @returns the resulting document tree */ @@ -13926,7 +13926,7 @@ xmlCtxtReadFile(xmlParserCtxtPtr ctxt, const char *filename, * `URL` is used as base to resolve external entities and for error * reporting. * - * See xmlCtxtUseOptions for details. + * See xmlCtxtUseOptions() for details. * * @returns the resulting document tree */ @@ -13965,7 +13965,7 @@ xmlCtxtReadMemory(xmlParserCtxtPtr ctxt, const char *buffer, int size, * `URL` is used as base to resolve external entities and for error * reporting. * - * See xmlCtxtUseOptions for details. + * See xmlCtxtUseOptions() for details. * * @returns the resulting document tree */ @@ -14003,7 +14003,7 @@ xmlCtxtReadFd(xmlParserCtxtPtr ctxt, int fd, * `URL` is used as base to resolve external entities and for error * reporting. * - * See xmlCtxtUseOptions for details. + * See xmlCtxtUseOptions() for details. * * @returns the resulting document tree */ diff --git a/parserInternals.c b/parserInternals.c index 08e5255b..e0a50c74 100644 --- a/parserInternals.c +++ b/parserInternals.c @@ -104,11 +104,11 @@ xmlCheckVersion(int version) { * takes precedence over all other error reporting mechanisms. * These are (in order of precedence): * - * - per-context structured handler (xmlCtxtSetErrorHandler) + * - per-context structured handler (xmlCtxtSetErrorHandler()) * - per-context structured "serror" SAX handler - * - global structured handler (xmlSetStructuredErrorFunc) + * - global structured handler (xmlSetStructuredErrorFunc()) * - per-context generic "error" and "warning" SAX handlers - * - global generic handler (xmlSetGenericErrorFunc) + * - global generic handler (xmlSetGenericErrorFunc()) * - print to stderr * * Available since 2.13.0. @@ -1194,7 +1194,7 @@ done: * the encoding found in the XML declaration. * * This function can also be used to override the encoding of chunks - * passed to xmlParseChunk. + * passed to xmlParseChunk(). * * @returns 0 in case of success, -1 otherwise */ @@ -1267,7 +1267,7 @@ xmlSwitchInputEncodingName(xmlParserCtxtPtr ctxt, xmlParserInputPtr input, * encoding found in the XML declaration. * * This function can also be used to override the encoding of chunks - * passed to xmlParseChunk. + * passed to xmlParseChunk(). * * Available since 2.13.0. * @@ -1411,7 +1411,7 @@ xmlSwitchInputEncoding(xmlParserCtxtPtr ctxt, xmlParserInputPtr input, * Use encoding handler to decode input data. * * This function can be used to enforce the encoding of chunks passed - * to xmlParseChunk. + * to xmlParseChunk(). * * @returns 0 in case of success, -1 otherwise */ @@ -1724,7 +1724,7 @@ xmlFreeInputStream(xmlParserInputPtr input) { /** * @param ctxt an XML parser context * - * @deprecated Use xmlNewInputFromUrl or similar functions. + * @deprecated Use xmlNewInputFromUrl() or similar functions. * * Create a new input stream structure. * @@ -2214,7 +2214,7 @@ xmlNewEntityInputStream(xmlParserCtxtPtr ctxt, xmlEntityPtr ent) { * @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. * @@ -2241,8 +2241,8 @@ xmlNewStringInputStream(xmlParserCtxtPtr ctxt, const xmlChar *buffer) { * @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. + * This function is used by xmlDefaultExternalEntityLoader() and + * xmlNoNetExternalEntityLoader(). * * @returns a new allocated URL, or NULL. */ @@ -2349,11 +2349,11 @@ xmlCheckHTTPInput(xmlParserCtxtPtr ctxt ATTRIBUTE_UNUSED, * The following resource loaders will be called if they were * registered (in order of precedence): * - * - the per-thread xmlParserInputBufferCreateFilenameFunc set with - * xmlParserInputBufferCreateFilenameDefault (deprecated) + * - the per-thread xmlParserInputBufferCreateFilenameFunc() set with + * xmlParserInputBufferCreateFilenameDefault() (deprecated) * - the default loader which will return * - the result from a matching global input callback set with - * xmlRegisterInputCallbacks (deprecated) + * xmlRegisterInputCallbacks() (deprecated) * - a file opened from the filesystem, with automatic detection * of compressed files if support is compiled in. * @@ -2398,7 +2398,7 @@ xmlNewInputFromUrl(const char *filename, xmlParserInputFlags flags, * @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. * @@ -2512,7 +2512,7 @@ xmlCurrentExternalEntityLoader = xmlDefaultExternalEntityLoader; * @param f the new entity resolver function * * @deprecated This is a global setting and not thread-safe. Use - * xmlCtxtSetResourceLoader or similar functions. + * xmlCtxtSetResourceLoader() or similar functions. * * Changes the default external entity resolver function for the * application. @@ -2523,11 +2523,11 @@ xmlSetExternalEntityLoader(xmlExternalEntityLoader f) { } /** - * @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) { @@ -2626,15 +2626,15 @@ xmlLoadResource(xmlParserCtxtPtr ctxt, const char *url, const char *publicId, * result. Then the following resource loaders will be called if * they were registered (in order of precedence): * - * - the resource loader set with xmlCtxtSetResourceLoader + * - the resource loader set with xmlCtxtSetResourceLoader() * - the global external entity loader set with - * xmlSetExternalEntityLoader (without catalog resolution, + * xmlSetExternalEntityLoader() (without catalog resolution, * deprecated) - * - the per-thread xmlParserInputBufferCreateFilenameFunc set with - * xmlParserInputBufferCreateFilenameDefault (deprecated) + * - the per-thread xmlParserInputBufferCreateFilenameFunc() set with + * xmlParserInputBufferCreateFilenameDefault() (deprecated) * - the default loader which will return * - the result from a matching global input callback set with - * xmlRegisterInputCallbacks (deprecated) + * xmlRegisterInputCallbacks() (deprecated) * - a file opened from the filesystem, with automatic detection * of compressed files if support is compiled in. * @@ -2946,7 +2946,7 @@ xmlNewParserCtxt(void) * the parser context will be passed as user data. * * Available since 2.11.0. If you want support older versions, - * it's best to invoke xmlNewParserCtxt and set ctxt->sax with + * it's best to invoke xmlNewParserCtxt() and set ctxt->sax with * struct assignment. * * @returns the xmlParserCtxtPtr or NULL if memory allocation failed. @@ -3278,7 +3278,7 @@ xmlClearNodeInfoSeq(xmlParserNodeInfoSeqPtr seq) * * @deprecated Don't use. * - * xmlParserFindNodeInfoIndex : Find the index that the info record for + * 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 diff --git a/pattern.c b/pattern.c index 97b7558c..48e51ba5 100644 --- a/pattern.c +++ b/pattern.c @@ -2272,7 +2272,7 @@ xmlPatternMatch(xmlPatternPtr comp, xmlNodePtr node) * @param comp the precompiled pattern * * Get a streaming context for that pattern - * Use xmlFreeStreamCtxt to free the context. + * Use xmlFreeStreamCtxt() to free the context. * * @returns a pointer to the context or NULL in case of failure */ diff --git a/relaxng.c b/relaxng.c index 66ca38dd..96688a6c 100644 --- a/relaxng.c +++ b/relaxng.c @@ -2739,8 +2739,8 @@ xmlRelaxNGInitTypes(void) } /** - * @deprecated This function will be made private. Call xmlCleanupParser - * to free global state but see the warnings there. 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. * @@ -7390,7 +7390,7 @@ xmlRelaxNGParse(xmlRelaxNGParserCtxtPtr ctxt) * @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 */ @@ -10608,7 +10608,7 @@ xmlRelaxNGFreeValidCtxt(xmlRelaxNGValidCtxtPtr ctxt) * @param warn the warning function * @param ctx the functions context * - * @deprecated Use xmlRelaxNGSetValidStructuredErrors. + * @deprecated Use xmlRelaxNGSetValidStructuredErrors(). * * Set the error and warning callback information */ diff --git a/runtest.c b/runtest.c index efae6ac9..8f78ad81 100644 --- a/runtest.c +++ b/runtest.c @@ -1808,7 +1808,7 @@ htmlTokenizerTest(const char *filename, const char *result, * @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 + * Parse a file using the old xmlParseFile() API, then serialize back * reparse the result and serialize again, then check for deviation * in serialization. * @@ -2378,7 +2378,7 @@ testParseContent(xmlParserCtxtPtr ctxt, xmlDocPtr doc, const char *filename) { * @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 + * Parse a file using the old xmlReadMemory() API, then serialize back * reparse the result and serialize again, then check for deviation * in serialization. * @@ -2490,7 +2490,7 @@ noentParseTest(const char *filename, const char *result, * @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. + * Parse a file using the xmlReadFile() API and check for errors. * * @returns 0 in case of success, an error code otherwise */ @@ -2578,7 +2578,7 @@ errParseTest(const char *filename, const char *result, const char *err, * @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. + * Parse a file using the xmlReadFd() API and check for errors. * * @returns 0 in case of success, an error code otherwise */ diff --git a/threads.c b/threads.c index 076512c1..bcb29e22 100644 --- a/threads.c +++ b/threads.c @@ -307,7 +307,7 @@ xmlUnlockLibrary(void) } /** - * @deprecated Alias for xmlInitParser. + * @deprecated Alias for xmlInitParser(). */ void xmlInitThreads(void) @@ -316,8 +316,8 @@ xmlInitThreads(void) } /** - * @deprecated This function is a no-op. Call xmlCleanupParser - * to free global state but see the warnings there. 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. */ @@ -417,7 +417,7 @@ xmlInitParser(void) { * be used to avoid false positives from memory leak checkers in * static builds. * - * WARNING: xmlCleanupParser assumes that all other threads that called + * WARNING: xmlCleanupParser() assumes that all other threads that called * libxml2 functions have terminated. No library calls must be made * after calling this function. In general, THIS FUNCTION SHOULD ONLY * BE CALLED RIGHT BEFORE THE WHOLE PROCESS EXITS. diff --git a/tree.c b/tree.c index 15fdc7f7..a9afb258 100644 --- a/tree.c +++ b/tree.c @@ -1130,7 +1130,7 @@ xmlFreeDoc(xmlDocPtr cur) { * @param len maximum length of the attribute value * @param listPtr pointer to the resulting node list (optional) * - * See xmlNodeParseContent. + * See xmlNodeParseContent(). * * @returns 0 on success, -1 if a memory allocation failed. */ @@ -1414,9 +1414,9 @@ xmlNodeParseContent(xmlNodePtr node, const xmlChar *content, int len) { * @param value an attribute value * @param len maximum length of the attribute value * - * @deprecated Use xmlNodeSetContentLen. + * @deprecated Use xmlNodeSetContentLen(). * - * See xmlStringGetNodeList. + * See xmlStringGetNodeList(). * * @returns a pointer to the first child or NULL if the value if empty * or a memory allocation failed. @@ -1433,7 +1433,7 @@ xmlStringLenGetNodeList(const xmlDoc *doc, const xmlChar *value, int len) { * @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 @@ -1539,7 +1539,7 @@ error: * 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. + * xmlNodeListGetRawString() for an alternative option. * * @returns a string or NULL if a memory allocation failed. */ @@ -1749,7 +1749,7 @@ xmlNewNsProp(xmlNodePtr node, xmlNsPtr ns, const xmlChar *name, * @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 + * 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. * @@ -1777,7 +1777,7 @@ xmlNewNsPropEatName(xmlNodePtr node, xmlNsPtr ns, xmlChar *name, * 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. + * If you want to pass a raw string, see xmlNewProp(). * * @returns a pointer to the attribute or NULL if arguments are invalid * or a memory allocation failed. @@ -1957,7 +1957,7 @@ error: * * Create a processing instruction node. * - * Use of this function is DISCOURAGED in favor of xmlNewDocPI. + * Use of this function is DISCOURAGED in favor of xmlNewDocPI(). * * @returns a pointer to the new node object or NULL if arguments are * invalid or a memory allocation failed. @@ -1973,7 +1973,7 @@ xmlNewPI(const xmlChar *name, const xmlChar *content) { * * Create an element node. * - * Use of this function is DISCOURAGED in favor of xmlNewDocNode. + * Use of this function is DISCOURAGED in favor of xmlNewDocNode(). * * @returns a pointer to the new node object or NULL if arguments are * invalid or a memory allocation failed. @@ -1989,9 +1989,9 @@ xmlNewNode(xmlNsPtr ns, const xmlChar *name) { * * Create an element node. * - * Use of this function is DISCOURAGED in favor of xmlNewDocNodeEatName. + * Use of this function is DISCOURAGED in favor of xmlNewDocNodeEatName(). * - * Like xmlNewNode, but the `name` string will be used directly + * 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. * @@ -2044,7 +2044,7 @@ xmlNewElem(xmlDocPtr doc, xmlNsPtr ns, const xmlChar *name, * 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. See xmlNewDocRawNode for an alternative. + * not. See xmlNewDocRawNode() for an alternative. * * General notes on object creation: * @@ -2095,7 +2095,7 @@ xmlNewDocNode(xmlDocPtr doc, xmlNsPtr ns, * * Create an element node. * - * Like xmlNewDocNode, but the `name` string will be used directly + * 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. * @@ -2194,7 +2194,7 @@ xmlNewDocFragment(xmlDocPtr doc) { * * Create a text node. * - * Use of this function is DISCOURAGED in favor of xmlNewDocText. + * Use of this function is DISCOURAGED in favor of xmlNewDocText(). * * @returns a pointer to the new node object or NULL if a memory * allocation failed. @@ -2240,7 +2240,7 @@ error: * of the parent. * * If `content` is provided, a text node will be added to the child - * element, see xmlNewDocRawNode. + * element, see xmlNewDocRawNode(). * * @returns a pointer to the new node object or NULL if arguments * are invalid or a memory allocation failed. @@ -2448,7 +2448,7 @@ xmlNewDocText(const xmlDoc *doc, const xmlChar *content) { * @param content raw text content (optional) * @param len size of text content * - * Use of this function is DISCOURAGED in favor of xmlNewDocTextLen. + * Use of this function is DISCOURAGED in favor of xmlNewDocTextLen(). * * @returns a pointer to the new node object or NULL if a memory * allocation failed. @@ -2502,7 +2502,7 @@ xmlNewDocTextLen(xmlDocPtr doc, const xmlChar *content, int len) { /** * @param content the comment content (optional) * - * Use of this function is DISCOURAGED in favor of xmlNewDocComment. + * Use of this function is DISCOURAGED in favor of xmlNewDocComment(). * * Create a comment node. * @@ -2744,8 +2744,8 @@ xmlNodeSetDoc(xmlNodePtr node, xmlDocPtr doc) { * @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 + * invoked by functions like xmlAddChild(), xmlAddSibling() or + * xmlReplaceNode(). `tree` must be the root node of an unlinked * subtree. * * Associate all nodes in a tree with a new document. @@ -2800,7 +2800,7 @@ xmlSetTreeDoc(xmlNodePtr tree, xmlDocPtr doc) { * * Associate all subtrees in `list` with a new document. * - * Internal function, see xmlSetTreeDoc. + * Internal function, see xmlSetTreeDoc(). * * @returns 0 on success. If a memory allocation fails, returns -1. * All subtrees will be updated on failure but some strings @@ -2840,7 +2840,7 @@ xmlSetListDoc(xmlNodePtr list, xmlDocPtr doc) { * 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. + * see xmlNewDocNode(). * * @returns a pointer to the new node object or NULL if arguments * are invalid or a memory allocation failed. @@ -3055,13 +3055,13 @@ xmlInsertNode(xmlDocPtr doc, xmlNodePtr cur, xmlNodePtr parent, * * Unlinks `cur` and inserts it as next sibling after `prev`. * - * Unlike xmlAddChild this function does not merge text nodes. + * 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. * - * See the notes in xmlAddChild. + * See the notes in xmlAddChild(). * * @returns `cur` or a sibling if `cur` was merged. Returns NULL * if arguments are invalid or a memory allocation failed. @@ -3085,13 +3085,13 @@ xmlAddNextSibling(xmlNodePtr prev, xmlNodePtr cur) { * * Unlinks `cur` and inserts it as previous sibling before `next`. * - * Unlike xmlAddChild this function does not merge text nodes. + * 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. * - * See the notes in xmlAddChild. + * See the notes in xmlAddChild(). * * @returns `cur` or a sibling if `cur` was merged. Returns NULL * if arguments are invalid or a memory allocation failed. @@ -3123,7 +3123,7 @@ xmlAddPrevSibling(xmlNodePtr next, xmlNodePtr cur) { * 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. + * See the notes in xmlAddChild(). * * @returns `cur` or a sibling if `cur` was merged. Returns NULL * if arguments are invalid or a memory allocation failed. @@ -3159,7 +3159,7 @@ xmlAddSibling(xmlNodePtr node, xmlNodePtr cur) { * * Append a node list to another node. * - * See xmlAddChild. + * See xmlAddChild(). * * @returns the last child or NULL in case of error. */ @@ -3245,14 +3245,14 @@ xmlAddChildList(xmlNodePtr parent, xmlNodePtr cur) { * * General notes: * - * Move operations like xmlAddChild can cause element or attribute + * Move operations like xmlAddChild() can cause element or attribute * nodes to reference namespaces that aren't declared in one of * their ancestors. This can lead to use-after-free errors if the * elements containing the declarations are freed later, especially * when moving nodes from one document to another. You should - * consider calling xmlReconciliateNs after a move operation to + * consider calling xmlReconciliateNs() after a move operation to * normalize namespaces. Another option is to call - * xmlDOMWrapAdoptNode with the target parent before moving a node. + * xmlDOMWrapAdoptNode() with the target parent before moving a node. * * For the most part, move operations don't check whether the * resulting tree structure is valid. Users must make sure that @@ -3593,7 +3593,7 @@ xmlFreeNodeList(xmlNodePtr cur) { * * Free a node including all the children. * - * This doesn't unlink the node from the tree. Call xmlUnlinkNode first + * This doesn't unlink the node from the tree. Call xmlUnlinkNode() first * unless `cur` is a root node. */ void @@ -3694,7 +3694,7 @@ xmlUnlinkNodeInternal(xmlNodePtr cur) { * Unlink a node from its tree. * * The node is not freed. Unless it is reinserted, it must be managed - * manually and freed eventually by calling xmlFreeNode. + * manually and freed eventually by calling xmlFreeNode(). */ void xmlUnlinkNode(xmlNodePtr cur) { @@ -3730,10 +3730,10 @@ xmlUnlinkNode(xmlNodePtr cur) { * * It is an error if `old` has no parent. * - * Unlike xmlAddChild, this function doesn't merge text nodes or + * Unlike xmlAddChild(), this function doesn't merge text nodes or * delete duplicate attributes. * - * See the notes in xmlAddChild. + * See the notes in xmlAddChild(). * * @returns `old` or NULL if arguments are invalid or a memory * allocation failed. @@ -3968,7 +3968,7 @@ error: * Create a copy of the attribute. This function sets the parent * 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 + * by calling xmlAddChild() afterwards or reset the parent pointer to * NULL. * * @returns the copied attribute or NULL if a memory allocation @@ -4321,7 +4321,7 @@ error: * * Copy a node. * - * Use of this function is DISCOURAGED in favor of xmlDocCopyNode. + * Use of this function is DISCOURAGED in favor of xmlDocCopyNode(). * * @returns the copied node or NULL if a memory allocation failed. */ @@ -4371,7 +4371,7 @@ xmlNodePtr xmlDocCopyNodeList(xmlDocPtr doc, xmlNodePtr node) { * * Copy a node list and all children. * - * Use of this function is DISCOURAGED in favor of xmlDocCopyNodeList. + * Use of this function is DISCOURAGED in favor of xmlDocCopyNodeList(). * * @returns the head of the copied list or NULL if a memory * allocation failed. @@ -5310,7 +5310,7 @@ found: * @param doc the document the node pertains to * @param cur the node being checked * - * See xmlNodeGetBaseSafe. This function doesn't allow to distinguish + * 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 @@ -5589,11 +5589,11 @@ xmlNodeSetContentInternal(xmlNodePtr cur, const xmlChar *content, int len) { * entity references. Syntax errors and references to undeclared * entities are ignored silently. Unfortunately, there isn't an * API to pass raw content directly. An inefficient work-around - * is to escape the content with xmlEncodeSpecialChars before + * is to escape the content with xmlEncodeSpecialChars() before * passing it. A better trick is clearing the old content - * with xmlNodeSetContent(node, NULL) first and then calling - * xmlNodeAddContent(node, content). Unlike this function, - * xmlNodeAddContent accepts raw text. + * with `xmlNodeSetContent(node, NULL)` first and then calling + * `xmlNodeAddContent(node, content)`. Unlike this function, + * xmlNodeAddContent() accepts raw text. * * @returns 0 on success, 1 on error, -1 if a memory allocation failed. */ @@ -5607,7 +5607,7 @@ xmlNodeSetContent(xmlNodePtr cur, const xmlChar *content) { * @param content the new value of the content * @param len the size of `content` * - * See xmlNodeSetContent. + * See xmlNodeSetContent(). * * @returns 0 on success, 1 on error, -1 if a memory allocation failed. */ @@ -5794,7 +5794,7 @@ xmlGetNsListSafe(const xmlDoc *doc ATTRIBUTE_UNUSED, const xmlNode *node, * * Find all in-scope namespaces of a node. * - * Use xmlGetNsListSafe for better error reporting. + * Use xmlGetNsListSafe() for better error reporting. * * @returns a NULL terminated array of namespace pointers that must * be freed by the caller or NULL if no namespaces were found or @@ -6600,7 +6600,7 @@ xmlNodeGetAttrValue(const xmlNode *node, const xmlChar *name, * for namespace aware processing. * * NOTE: This function doesn't allow to distinguish malloc failures from - * missing attributes. It's more robust to use xmlNodeGetAttrValue. + * missing attributes. It's more robust to use xmlNodeGetAttrValue(). * * @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(). @@ -6623,11 +6623,11 @@ xmlGetProp(const xmlNode *node, const xmlChar *name) { * This does the entity substitution. * This function looks in DTD attribute declaration for \#FIXED or * default declaration values. - * This function is similar to xmlGetProp except it will accept only + * This function is similar to xmlGetProp() except it will accept only * an attribute in no namespace. * * NOTE: This function doesn't allow to distinguish malloc failures from - * missing attributes. It's more robust to use xmlNodeGetAttrValue. + * missing attributes. It's more robust to use xmlNodeGetAttrValue(). * * @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(). @@ -6654,7 +6654,7 @@ xmlGetNoNsProp(const xmlNode *node, const xmlChar *name) { * default declaration values. * * NOTE: This function doesn't allow to distinguish malloc failures from - * missing attributes. It's more robust to use xmlNodeGetAttrValue. + * missing attributes. It's more robust to use xmlNodeGetAttrValue(). * * @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(). @@ -6915,7 +6915,7 @@ xmlSetDocCompressMode (xmlDocPtr doc, int mode) { } /** - * @deprecated Use xmlGetDocCompressMode + * @deprecated Use xmlGetDocCompressMode() * * get the default compression mode used, ZLIB based. * @returns 0 (uncompressed) to 9 (max compression) @@ -6929,7 +6929,7 @@ xmlGetCompressMode(void) /** * @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) diff --git a/uri.c b/uri.c index a2013c15..33566ab1 100644 --- a/uri.c +++ b/uri.c @@ -1731,7 +1731,7 @@ xmlURIEscapeStr(const xmlChar *str, const xmlChar *list) { * @returns an copy of the string, but escaped * * 25 May 2001 - * Uses xmlParseURI and xmlURIEscapeStr to try to escape correctly + * Uses xmlParseURI() and xmlURIEscapeStr() to try to escape correctly * according to RFC2396. * - Carl Douglas */ @@ -2738,7 +2738,7 @@ done: * @param URI the URI reference under consideration * @param base the base value * - * See xmlBuildRelativeURISafe. + * See xmlBuildRelativeURISafe(). * * @returns a new URI string (to be freed by the caller) or NULL in case * error. diff --git a/valid.c b/valid.c index 88ad1dfa..34f01c0e 100644 --- a/valid.c +++ b/valid.c @@ -768,7 +768,7 @@ error: * @deprecated Internal function, don't use. * * Allocate an element content structure. - * Deprecated in favor of xmlNewDocElementContent + * Deprecated in favor of xmlNewDocElementContent() * * @returns NULL if not, otherwise the new element content structure */ @@ -878,7 +878,7 @@ error: * @deprecated Internal function, don't use. * * Build a copy of an element content description. - * Deprecated, use xmlCopyDocElementContent instead + * Deprecated, use xmlCopyDocElementContent() instead * * @returns the new xmlElementContentPtr or NULL in case of error. */ @@ -960,7 +960,7 @@ xmlFreeDocElementContent(xmlDocPtr doc, xmlElementContentPtr cur) { * @deprecated Internal function, don't use. * * Free an element content structure. The whole subtree is removed. - * Deprecated, use xmlFreeDocElementContent instead + * Deprecated, use xmlFreeDocElementContent() instead */ void xmlFreeElementContent(xmlElementContentPtr cur) { @@ -975,7 +975,7 @@ xmlFreeElementContent(xmlElementContentPtr cur) { * * @deprecated Internal function, don't use. * - * Deprecated, unsafe, use xmlSnprintfElementContent + * Deprecated, unsafe, use xmlSnprintfElementContent() */ void xmlSprintfElementContent(char *buf ATTRIBUTE_UNUSED, @@ -1403,7 +1403,7 @@ xmlCopyElementTable(xmlElementTablePtr 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 @@ -1948,7 +1948,7 @@ xmlCopyAttributeTable(xmlAttributeTablePtr table) { * @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 @@ -6422,7 +6422,7 @@ xmlValidateDtd(xmlValidCtxtPtr ctxt, xmlDocPtr doc, xmlDtdPtr dtd) { * * Validate a document against a DTD. * - * Like xmlValidateDtd but uses the parser context's error handler. + * Like xmlValidateDtd() but uses the parser context's error handler. * * Availabe since 2.14.0. * @@ -6694,7 +6694,7 @@ xmlValidateDocumentInternal(xmlParserCtxtPtr ctxt, xmlValidCtxtPtr vctxt, * @param doc a document instance * * @deprecated This function can't report malloc or other failures. - * Use xmlCtxtValidateDocument. + * Use xmlCtxtValidateDocument(). * * Try to validate the document instance * @@ -6715,7 +6715,7 @@ xmlValidateDocument(xmlValidCtxtPtr vctxt, xmlDocPtr doc) { * * Validate a document. * - * Like xmlValidateDocument but uses the parser context's error handler. + * Like xmlValidateDocument() but uses the parser context's error handler. * * Option XML_PARSE_DTDLOAD should be enabled in the parser context * to make external entities work. diff --git a/xmlIO.c b/xmlIO.c index a7c79e17..63ab4d90 100644 --- a/xmlIO.c +++ b/xmlIO.c @@ -1134,7 +1134,7 @@ xmlOutputDefaultOpen(xmlOutputBufferPtr buf, const char *filename, * * The encoding argument is deprecated and should be set to * XML_CHAR_ENCODING_NONE. The encoding can be changed with - * xmlSwitchEncoding or xmlSwitchEncodingName later on. + * xmlSwitchEncoding() or xmlSwitchEncodingName() later on. * * @returns the new parser input or NULL */ @@ -1380,7 +1380,7 @@ __xmlParserInputBufferCreateFilename(const char *URI, xmlCharEncoding enc) { * @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 @@ -1527,7 +1527,7 @@ xmlOutputBufferCreateFilename(const char *URI, * * The encoding argument is deprecated and should be set to * XML_CHAR_ENCODING_NONE. The encoding can be changed with - * xmlSwitchEncoding or xmlSwitchEncodingName later on. + * xmlSwitchEncoding() or xmlSwitchEncodingName() later on. * * @returns the new parser input or NULL */ @@ -1641,14 +1641,14 @@ xmlOutputBufferGetSize(xmlOutputBufferPtr out) { * @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 * * The encoding argument is deprecated and should be set to * XML_CHAR_ENCODING_NONE. The encoding can be changed with - * xmlSwitchEncoding or xmlSwitchEncodingName later on. + * xmlSwitchEncoding() or xmlSwitchEncodingName() later on. * * @returns the new parser input or NULL */ @@ -1765,18 +1765,18 @@ xmlNewInputBufferMemory(const void *mem, size_t size, * @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. * * This function makes a copy of the whole input buffer. If you are sure * that the contents of the buffer will remain valid until the document * was parsed, you can avoid the copy by using - * xmlParserInputBufferCreateStatic. + * xmlParserInputBufferCreateStatic(). * * The encoding argument is deprecated and should be set to * XML_CHAR_ENCODING_NONE. The encoding can be changed with - * xmlSwitchEncoding or xmlSwitchEncodingName later on. + * xmlSwitchEncoding() or xmlSwitchEncodingName() later on. * * @returns the new parser input or NULL in case of error. */ @@ -1793,17 +1793,17 @@ xmlParserInputBufferCreateMem(const char *mem, int size, xmlCharEncoding enc) { * @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. * * This functions assumes that the contents of the input buffer remain - * valid until the document was parsed. Use xmlParserInputBufferCreateMem + * valid until the document was parsed. Use xmlParserInputBufferCreateMem() * otherwise. * * The encoding argument is deprecated and should be set to * XML_CHAR_ENCODING_NONE. The encoding can be changed with - * xmlSwitchEncoding or xmlSwitchEncodingName later on. + * xmlSwitchEncoding() or xmlSwitchEncodingName() later on. * * @returns the new parser input or NULL in case of error. */ @@ -1820,7 +1820,7 @@ xmlParserInputBufferCreateStatic(const char *mem, int size, * @param str C string * @param flags flags * - * @deprecated Use xmlNewInputFromString. + * @deprecated Use xmlNewInputFromString(). * * Create an input buffer for a null-terminated C string. * @@ -1892,14 +1892,14 @@ xmlOutputBufferCreateFd(int fd, xmlCharEncodingHandlerPtr encoder) { * @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 * * The encoding argument is deprecated and should be set to * XML_CHAR_ENCODING_NONE. The encoding can be changed with - * xmlSwitchEncoding or xmlSwitchEncodingName later on. + * xmlSwitchEncoding() or xmlSwitchEncodingName() later on. * * @returns the new parser input or NULL */ @@ -1959,7 +1959,7 @@ xmlOutputBufferCreateIO(xmlOutputWriteCallback iowrite, /** * @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 * @@ -2167,7 +2167,7 @@ xmlParserInputBufferGrow(xmlParserInputBufferPtr in, int len) { * * @deprecated Internal function, don't use. * - * Same as xmlParserInputBufferGrow. + * Same as xmlParserInputBufferGrow(). * * @returns the number of chars read and stored in the buffer, or -1 * in case of error. @@ -2528,7 +2528,7 @@ xmlParserGetDirectory(const char *filename) { * * @deprecated Internal function, don't use. * - * Like xmlCheckFilename but handles file URIs. + * Like xmlCheckFilename() but handles file URIs. * * @returns 0, 1, or 2. */ @@ -2579,7 +2579,7 @@ xmlInitIOCallbacks(void) * @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. * diff --git a/xmlmemory.c b/xmlmemory.c index b15b067f..6cf59277 100644 --- a/xmlmemory.c +++ b/xmlmemory.c @@ -362,7 +362,7 @@ xmlMemoryDump(void) ****************************************************************/ /** - * @deprecated Alias for xmlInitParser. + * @deprecated Alias for xmlInitParser(). * * @returns 0. */ @@ -381,8 +381,8 @@ xmlInitMemoryInternal(void) { } /** - * @deprecated This function is a no-op. Call xmlCleanupParser - * to free global state but see the warnings there. 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. */ @@ -468,7 +468,7 @@ xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc, * @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 ! @@ -509,7 +509,7 @@ xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc, * @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 diff --git a/xmlreader.c b/xmlreader.c index e4af3477..f087db32 100644 --- a/xmlreader.c +++ b/xmlreader.c @@ -4589,7 +4589,7 @@ xmlTextReaderLocatorBaseURI(xmlTextReaderLocatorPtr locator) { * @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. * @@ -4969,7 +4969,7 @@ xmlTextReaderSetup(xmlTextReaderPtr reader, * @param reader an XML reader * @param maxAmpl maximum amplification factor * - * Set the maximum amplification factor. See xmlCtxtSetMaxAmplification. + * Set the maximum amplification factor. See xmlCtxtSetMaxAmplification(). */ void xmlTextReaderSetMaxAmplification(xmlTextReaderPtr reader, unsigned maxAmpl) diff --git a/xmlregexp.c b/xmlregexp.c index 743e5ed1..535078f9 100644 --- a/xmlregexp.c +++ b/xmlregexp.c @@ -1265,7 +1265,7 @@ xmlRegPrintStateCompact(FILE* output, xmlRegexpPtr regexp, int state) * @param regexp the regexp instance * * Print the compact representation of a regexp, in the same fashion as the - * public xmlRegexpPrint function. + * public xmlRegexpPrint() function. */ static void xmlRegPrintCompact(FILE* output, xmlRegexpPtr regexp) @@ -2319,7 +2319,7 @@ xmlFACompareRanges(xmlRegRangePtr range1, xmlRegRangePtr range2) { * @param type2 an atom type * * Compares two atoms type to check whether they intersect in some ways, - * this is used by xmlFACompareAtoms only + * this is used by xmlFACompareAtoms() only * * @returns 1 if they may intersect and 0 otherwise */ @@ -2564,7 +2564,7 @@ xmlFAEqualAtoms(xmlRegAtomPtr atom1, xmlRegAtomPtr atom2, int deep) { * @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 + * this is used by xmlFAComputesDeterminism() and xmlFARecurseDeterminism() only * * @returns 1 if yes and 0 otherwise */ diff --git a/xmlschemastypes.c b/xmlschemastypes.c index ec8e9500..6274f995 100644 --- a/xmlschemastypes.c +++ b/xmlschemastypes.c @@ -861,8 +861,8 @@ error: } /** - * @deprecated This function will be made private. Call xmlCleanupParser - * to free global state but see the warnings there. 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. * diff --git a/xmlstring.c b/xmlstring.c index 9e05aeb2..fb8643cc 100644 --- a/xmlstring.c +++ b/xmlstring.c @@ -465,7 +465,7 @@ xmlStrncat(xmlChar *cur, const xmlChar *add, int len) { * @param str2 second xmlChar string * @param len the len of `str2` or < 0 * - * same as xmlStrncat, but creates a new string. The original + * same as xmlStrncat(), but creates a new string. The original * two strings are not freed. If `len` is < 0 then the length * will be calculated automatically. * @@ -695,7 +695,7 @@ xmlStrVASPrintf(xmlChar **out, int maxSize, const char *msg, va_list ap) { * @param msg printf format string * @...: arguments for format string * - * See xmlStrVASPrintf. + * See xmlStrVASPrintf(). * * @returns 0 on success, 1 if the result was truncated or on other * errors, -1 if a memory allocation failed. @@ -763,7 +763,7 @@ xmlUTF8Size(const xmlChar *utf) { * * 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) { diff --git a/xmlwriter.c b/xmlwriter.c index 5971d551..62c30205 100644 --- a/xmlwriter.c +++ b/xmlwriter.c @@ -3832,7 +3832,7 @@ xmlTextWriterWriteDTDInternalEntity(xmlTextWriterPtr writer, * @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 + * 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 */ diff --git a/xpath.c b/xpath.c index 7232e09a..655c099b 100644 --- a/xpath.c +++ b/xpath.c @@ -173,7 +173,7 @@ double xmlXPathPINF = 0.0; double xmlXPathNINF = 0.0; /** - * @deprecated Alias for xmlInitParser. + * @deprecated Alias for xmlInitParser(). */ void xmlXPathInit(void) { @@ -3640,7 +3640,7 @@ xmlXPathNodeTrailingSorted (xmlNodeSetPtr nodes, xmlNodePtr 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, @@ -3679,7 +3679,7 @@ xmlXPathTrailingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2) { * 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. + * 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 @@ -8772,7 +8772,7 @@ xmlXPathParseLiteral(xmlXPathParserContextPtr ctxt) { * [29] Literal ::= '"' [^"]* '"' * | "'" [^']* "'" * - * TODO: xmlXPathCompLiteral memory allocation could be improved. + * TODO: xmlXPathCompLiteral() memory allocation could be improved. */ static void xmlXPathCompLiteral(xmlXPathParserContextPtr ctxt) {