diff --git a/HTMLparser.c b/HTMLparser.c index 9a17a589..27e5ee32 100644 --- a/HTMLparser.c +++ b/HTMLparser.c @@ -1165,7 +1165,7 @@ static const htmlStartCloseEntry htmlStartClose[] = { /* * The list of HTML attributes which are of content %Script; - * NOTE: when adding ones, check htmlIsScriptAttribute() since + * NOTE: when adding ones, check #htmlIsScriptAttribute since * it assumes the name starts with 'on' */ static const char *const htmlScriptAttributes[] = { @@ -2863,7 +2863,7 @@ htmlParseEntityRef(htmlParserCtxt *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 * * @param ctxt an HTML parser context @@ -4118,7 +4118,7 @@ htmlParseEndTag(htmlParserCtxtPtr ctxt) /** * Parse a content: comment, sub-element, reference or text. - * New version for non recursive htmlParseElementInternal() + * New version for non recursive #htmlParseElementInternal * * @param ctxt an HTML parser context */ @@ -4339,7 +4339,7 @@ htmlCtxtParseContentInternal(htmlParserCtxt *ctxt, xmlParserInput *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. * * @param ctxt an HTML parser context * @returns 0, -1 in case of error. @@ -4557,13 +4557,13 @@ htmlFreeParserCtxt(htmlParserCtxt *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 htmlParserCtxt or NULL in case of allocation error */ @@ -4580,9 +4580,9 @@ htmlNewParserCtxt(void) * @since 2.11.0 * * If you want support older versions, it's best to invoke - * htmlNewParserCtxt() and set `ctxt->sax` with struct assignment. + * #htmlNewParserCtxt and set `ctxt->sax` with struct assignment. * - * Also see htmlNewParserCtxt(). + * Also see #htmlNewParserCtxt. * * @param sax SAX handler * @param userData user data @@ -4639,7 +4639,7 @@ htmlCreateMemoryParserCtxtInternal(const char *url, * Create a parser context for an HTML in-memory document. The input * buffer must not contain any terminating null bytes. * - * @deprecated Use htmlNewParserCtxt() and htmlCtxtReadMemory(). + * @deprecated Use #htmlNewParserCtxt and #htmlCtxtReadMemory. * * @param buffer a pointer to a char array * @param size the size of the array @@ -5106,7 +5106,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 @@ -5115,7 +5115,7 @@ htmlParseTryOrFinish(htmlParserCtxtPtr ctxt, int terminate) { * * If the document isn't well-formed, `ctxt->myDoc` is set to NULL. * - * Since 2.14.0, xmlCtxtGetDocument() can be used to retrieve the + * Since 2.14.0, #xmlCtxtGetDocument can be used to retrieve the * result document. * * @param ctxt an HTML parser context @@ -5223,7 +5223,7 @@ htmlCreatePushParserCtxt(htmlSAXHandler *sax, void *user_data, * to handle parse events. If sax is NULL, fallback to the default DOM * behavior and return a tree. * - * @deprecated Use htmlNewSAXParserCtxt() and htmlCtxtReadDoc(). + * @deprecated Use #htmlNewSAXParserCtxt and #htmlCtxtReadDoc. * * @param cur a pointer to an array of xmlChar * @param encoding a free form C string describing the HTML document encoding, or NULL @@ -5261,7 +5261,7 @@ htmlSAXParseDoc(const xmlChar *cur, const char *encoding, /** * Parse an HTML in-memory document and build a tree. * - * @deprecated Use htmlReadDoc(). + * @deprecated Use #htmlReadDoc. * * This function uses deprecated global parser options. * @@ -5279,7 +5279,7 @@ htmlParseDoc(const xmlChar *cur, const char *encoding) { /** * Create a parser context to read from a file. * - * @deprecated Use htmlNewParserCtxt() and htmlCtxtReadFile(). + * @deprecated Use #htmlNewParserCtxt and #htmlCtxtReadFile. * * A non-NULL encoding overrides encoding declarations in the document. * @@ -5324,7 +5324,7 @@ htmlCreateFileParserCtxt(const char *filename, const char *encoding) * It use the given SAX function block to handle the parsing callback. * If sax is NULL, fallback to the default DOM tree building routines. * - * @deprecated Use htmlNewSAXParserCtxt() and htmlCtxtReadFile(). + * @deprecated Use #htmlNewSAXParserCtxt and #htmlCtxtReadFile. * * @param filename the filename * @param encoding encoding (optional) @@ -5615,7 +5615,7 @@ htmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * * @since 2.14.0 * - * With older versions, you can use htmlCtxtUseOptions(). + * With older versions, you can use #htmlCtxtUseOptions. * * @param ctxt an HTML parser context * @param options a bitmask of htmlParserOption values @@ -5632,7 +5632,7 @@ htmlCtxtSetOptions(htmlParserCtxt *ctxt, int options) * Applies the options to the parser context. The following options * are never cleared and can only be enabled: * - * @deprecated Use htmlCtxtSetOptions(). + * @deprecated Use #htmlCtxtSetOptions. * * - HTML_PARSE_NODEFDTD * - HTML_PARSE_NOERROR @@ -5713,7 +5713,7 @@ htmlCtxtParseDocument(htmlParserCtxt *ctxt, xmlParserInput *input) * Convenience function to parse an HTML document from a zero-terminated * string. * - * See htmlCtxtReadDoc() for details. + * See #htmlCtxtReadDoc for details. * * @param str a pointer to a zero terminated string * @param url only used for error reporting (optoinal) @@ -5749,7 +5749,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. * * @param filename a file or URL * @param encoding the document encoding (optional) @@ -5782,7 +5782,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. * * @param buffer a pointer to a char array * @param size the size of the array @@ -5825,7 +5825,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. * * @param fd an open file descriptor * @param url only used for error reporting (optional) @@ -5859,7 +5859,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. * * @param ioread an I/O read function * @param ioclose an I/O close function (optional) @@ -5896,7 +5896,7 @@ htmlReadIO(xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, /** * Parse an HTML in-memory document and build a tree. * - * See htmlCtxtUseOptions() for details. + * See #htmlCtxtUseOptions for details. * * @param ctxt an HTML parser context * @param str a pointer to a zero terminated string @@ -5929,7 +5929,7 @@ htmlCtxtReadDoc(xmlParserCtxt *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. * * @param ctxt an HTML parser context * @param filename a file or URL @@ -5960,7 +5960,7 @@ htmlCtxtReadFile(xmlParserCtxt *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. * * @param ctxt an HTML parser context * @param buffer a pointer to a char array @@ -5993,7 +5993,7 @@ htmlCtxtReadMemory(xmlParserCtxt *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. @@ -6027,7 +6027,7 @@ htmlCtxtReadFd(xmlParserCtxt *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. * * @param ctxt an HTML parser context * @param ioread an I/O read function diff --git a/HTMLtree.c b/HTMLtree.c index 65c5dc64..48bd4b95 100644 --- a/HTMLtree.c +++ b/HTMLtree.c @@ -571,9 +571,9 @@ htmlNodeDumpFileFormat(FILE *out, xmlDoc *doc ATTRIBUTE_UNUSED, } /** - * Same as htmlNodeDumpFileFormat() with `format` set to 1 which is + * Same as #htmlNodeDumpFileFormat with `format` set to 1 which is * typically undesired. Use of this function is DISCOURAGED in favor - * of htmlNodeDumpFileFormat(). + * of #htmlNodeDumpFileFormat. * * @param out the FILE pointer * @param doc the document @@ -638,10 +638,10 @@ htmlDocDumpMemoryFormat(xmlDoc *cur, xmlChar**mem, int *size, int format) { } /** - * Same as htmlDocDumpMemoryFormat() with `format` set to 1 which + * Same as #htmlDocDumpMemoryFormat with `format` set to 1 which * is typically undesired. Also see the warnings there. Use of * this function is DISCOURAGED in favor of - * htmlDocContentDumpFormatOutput(). + * #htmlDocContentDumpFormatOutput. * * @param cur the document * @param mem OUT: the memory pointer @@ -1132,9 +1132,9 @@ htmlNodeDumpFormatOutput(xmlOutputBuffer *buf, } /** - * Same as htmlNodeDumpFormatOutput() with `format` set to 1 which is + * Same as #htmlNodeDumpFormatOutput with `format` set to 1 which is * typically undesired. Use of this function is DISCOURAGED in favor - * of htmlNodeDumpFormatOutput(). + * of #htmlNodeDumpFormatOutput. * * @param buf the HTML buffer output * @param doc the document (unused) @@ -1163,9 +1163,9 @@ htmlDocContentDumpFormatOutput(xmlOutputBuffer *buf, xmlDoc *cur, } /** - * Same as htmlDocContentDumpFormatDump() with `format` set to 1 + * Same as #htmlDocContentDumpFormatDump with `format` set to 1 * which is typically undesired. Use of this function is DISCOURAGED - * in favor of htmlDocContentDumpFormatOutput(). + * in favor of #htmlDocContentDumpFormatOutput. * * @param buf the HTML buffer output * @param cur the document @@ -1195,7 +1195,7 @@ htmlDocContentDumpOutput(xmlOutputBuffer *buf, xmlDoc *cur, * undesired. * * Use of this function is DISCOURAGED in favor of - * htmlNodeDumpFileFormat(). + * #htmlNodeDumpFileFormat. * * @param f the FILE* * @param cur the document @@ -1229,11 +1229,11 @@ htmlDocDump(FILE *f, xmlDoc *cur) { /** * Serialize an HTML document to a file. * - * Same as htmlSaveFileFormat() with `encoding` set to NULL and + * Same as #htmlSaveFileFormat with `encoding` set to NULL and * `format` set to 1 which is typically undesired. * * Use of this function is DISCOURAGED in favor of - * htmlSaveFileFormat(). + * #htmlSaveFileFormat. * * @param filename the filename (or URL) * @param cur the document @@ -1295,9 +1295,9 @@ htmlSaveFileFormat(const char *filename, xmlDoc *cur, /** * Serialize an HTML document to a file. * - * Same as htmlSaveFileFormat() with `format` set to 1 which is + * Same as #htmlSaveFileFormat with `format` set to 1 which is * typically undesired. Also see the warnings there. Use of this - * function is DISCOURAGED in favor of htmlSaveFileFormat(). + * function is DISCOURAGED in favor of #htmlSaveFileFormat. * * @param filename the filename * @param cur the document diff --git a/SAX2.c b/SAX2.c index ff1021db..a2fc6e66 100644 --- a/SAX2.c +++ b/SAX2.c @@ -381,7 +381,7 @@ error: /** * This is only used to load DTDs. The preferred way to install - * custom resolvers is xmlCtxtSetResourceLoader(). + * custom resolvers is #xmlCtxtSetResourceLoader. * * @param ctx the user data (XML parser context) * @param publicId The public ID of the entity @@ -2325,7 +2325,7 @@ xmlSAX2EndElementNs(void *ctx, } /** - * called when an entity xmlSAX2Reference() is detected. + * called when an entity #xmlSAX2Reference is detected. * * @param ctx the user data (XML parser context) * @param name The entity name @@ -2497,7 +2497,7 @@ xmlSAX2Characters(void *ctx, const xmlChar *ch, int len) /** * 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 * * @param ctx the user data (XML parser context) * @param ch a xmlChar string @@ -2534,10 +2534,10 @@ xmlSAX2ProcessingInstruction(void *ctx, const xmlChar *target, } /** - * A xmlSAX2Comment() has been parsed. + * A #xmlSAX2Comment has been parsed. * * @param ctx the user data (XML parser context) - * @param value the xmlSAX2Comment() content + * @param value the #xmlSAX2Comment content */ void xmlSAX2Comment(void *ctx, const xmlChar *value) @@ -2665,7 +2665,7 @@ xmlSAX2InitDefaultSAXHandler(xmlSAXHandler *hdlr, int warning) /** * Initialize the default SAX2 handler * - * @deprecated This function is a no-op. Call xmlInitParser() to + * @deprecated This function is a no-op. Call #xmlInitParser to * initialize the library. * */ @@ -2719,7 +2719,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 c022a94f..adc70c63 100644 --- a/buf.c +++ b/buf.c @@ -228,7 +228,7 @@ xmlBufEmpty(xmlBuf *buf) { /** * Discard bytes at the start of a buffer. * - * NOTE that the return value differs from xmlBufferShrink() + * NOTE that the return value differs from #xmlBufferShrink * as it will return 0 on error instead of -1 due to size_t being * used as the return type. * @@ -493,7 +493,7 @@ xmlBufCat(xmlBuf *buf, const xmlChar *str) { /** * Helper routine to switch from the old buffer structures in use * in various APIs. It creates a wrapper xmlBuf which will be - * used for internal processing until the xmlBufBackToBuffer() is + * used for internal processing until the #xmlBufBackToBuffer is * issued. * * @param buffer incoming old buffer to convert to a new one @@ -1097,7 +1097,7 @@ xmlBufferWriteCHAR(xmlBuffer *buf, const xmlChar *string) { /** * Append a zero-terminated C string to a buffer. * - * Same as xmlBufferCCat(). + * Same as #xmlBufferCCat. * * @param buf the buffer * @param string the string to add diff --git a/c14n.c b/c14n.c index 24eba9b0..1b000411 100644 --- a/c14n.c +++ b/c14n.c @@ -2059,12 +2059,12 @@ xmlC14NDocSave(xmlDoc *doc, xmlNodeSet *nodes, /** * Converts a string to a canonical (normalized) format. The code is stolen - * from xmlEscapeText(). Added normalization of `\x09`, `\x0a`, + * from #xmlEscapeText. Added normalization of `\x09`, `\x0a`, * `\x0A` and the `mode` parameter. * * @param input the input string * @param mode the normalization mode (attribute, comment, PI or text) - * @returns a normalized string (caller is responsible for calling xmlFree()) + * @returns a normalized string (caller is responsible for calling #xmlFree) * or NULL if an error occurs */ static xmlChar * diff --git a/catalog.c b/catalog.c index ed25ccc6..f6387cb3 100644 --- a/catalog.c +++ b/catalog.c @@ -169,7 +169,7 @@ static xmlCatalogPtr xmlDefaultCatalog = NULL; * A mutex for modifying the shared global catalog(s) * xmlDefaultCatalog tree. * It also protects xmlCatalogXMLFiles - * The core of this readers/writer scheme is in xmlFetchXMLCatalogFile() + * The core of this readers/writer scheme is in #xmlFetchXMLCatalogFile */ static xmlRMutex xmlCatalogMutex; @@ -504,7 +504,7 @@ xmlCatalogDumpEntry(void *payload, void *data, } /** - * Serializes a Catalog entry, called by xmlDumpXMLCatalog() and recursively + * Serializes a Catalog entry, called by #xmlDumpXMLCatalog and recursively * for group entries * * @param catal top catalog entry @@ -848,7 +848,7 @@ xmlCatalogUnWrapURN(const xmlChar *urn) { } /** - * parse an XML file and build a tree. It's like xmlParseFile() + * parse an XML file and build a tree. It's like #xmlParseFile * except it bypass all catalog lookups. * * @deprecated Use XML_PARSE_NO_SYS_CATALOG. @@ -3233,7 +3233,7 @@ xmlCatalogDump(FILE *out) { * Add an entry in the catalog, it may overwrite existing but * different entries. * If called before any other catalog routine, allows to override the - * default shared catalog put in place by xmlInitializeCatalog(); + * default shared catalog put in place by #xmlInitializeCatalog; * * @param type the type of record to add to the catalog * @param orig the system, public or prefix to match @@ -3548,7 +3548,7 @@ xmlCatalogLocalResolveURI(void *catalogs, const xmlChar *URI) { /** * Try to lookup the catalog reference associated to a system ID * - * @deprecated use xmlCatalogResolveSystem() + * @deprecated use #xmlCatalogResolveSystem * * @param sysID the system ID string * @returns the resource if found or NULL otherwise. @@ -3591,7 +3591,7 @@ xmlCatalogGetSystem(const xmlChar *sysID) { /** * Try to lookup the catalog reference associated to a public ID * - * @deprecated use xmlCatalogResolvePublic() + * @deprecated use #xmlCatalogResolvePublic * * @param pubID the public ID string * @returns the resource if found or NULL otherwise. diff --git a/chvalid.c b/chvalid.c index 57df5e75..dd66db10 100644 --- a/chvalid.c +++ b/chvalid.c @@ -78,7 +78,7 @@ xmlCharInRange (unsigned int val, const xmlChRangeGroup *rptr) { /** - * @deprecated Use xmlIsBaseChar_ch() or xmlIsBaseCharQ(). + * @deprecated Use #xmlIsBaseChar_ch or #xmlIsBaseCharQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -90,7 +90,7 @@ xmlIsBaseChar(unsigned int ch) { /** - * @deprecated Use xmlIsBlank_ch() or xmlIsBlankQ(). + * @deprecated Use #xmlIsBlank_ch or #xmlIsBlankQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -102,7 +102,7 @@ xmlIsBlank(unsigned int ch) { /** - * @deprecated Use xmlIsChar_ch() or xmlIsCharQ(). + * @deprecated Use #xmlIsChar_ch or #xmlIsCharQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -114,7 +114,7 @@ xmlIsChar(unsigned int ch) { /** - * @deprecated Use xmlIsCombiningQ(). + * @deprecated Use #xmlIsCombiningQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -126,7 +126,7 @@ xmlIsCombining(unsigned int ch) { /** - * @deprecated Use xmlIsDigit_ch() or xmlIsDigitQ(). + * @deprecated Use #xmlIsDigit_ch or #xmlIsDigitQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -138,7 +138,7 @@ xmlIsDigit(unsigned int ch) { /** - * @deprecated Use xmlIsExtender_ch() or xmlIsExtenderQ(). + * @deprecated Use #xmlIsExtender_ch or #xmlIsExtenderQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -150,7 +150,7 @@ xmlIsExtender(unsigned int ch) { /** - * @deprecated Use xmlIsIdeographicQ(). + * @deprecated Use #xmlIsIdeographicQ. * * @param ch character to validate * @returns true if argument valid, false otherwise @@ -162,7 +162,7 @@ xmlIsIdeographic(unsigned int ch) { /** - * @deprecated Use xmlIsPubidChar_ch() or xmlIsPubidCharQ(). + * @deprecated Use #xmlIsPubidChar_ch or #xmlIsPubidCharQ. * * @param ch character to validate * @returns true if argument valid, false otherwise diff --git a/dict.c b/dict.c index 1529271e..fed3a0ac 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 4e4b6359..7dfd37aa 100644 --- a/encoding.c +++ b/encoding.c @@ -439,7 +439,7 @@ xmlDetectCharEncoding(const unsigned char* in, int len) * Unregisters all aliases. * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. + * thread-safe. See #xmlCtxtSetCharEncConvImpl for an alternative. * */ void @@ -502,7 +502,7 @@ xmlGetEncodingAlias(const char *alias) { * aliases will be overwritten. * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. + * thread-safe. See #xmlCtxtSetCharEncConvImpl for an alternative. * * @param name the encoding name as parsed, in UTF-8 format (ASCII actually) * @param alias the alias name as parsed, in UTF-8 format (ASCII actually) @@ -575,7 +575,7 @@ xmlAddEncodingAlias(const char *name, const char *alias) { * Unregisters an encoding alias. * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. + * thread-safe. See #xmlCtxtSetCharEncConvImpl for an alternative. * * @param alias the alias name as parsed, in UTF-8 format (ASCII actually) * @returns 0 in case of success, -1 in case of error. @@ -690,7 +690,7 @@ xmlGetCharEncodingName(xmlCharEncoding enc) { * Create and registers an xmlCharEncodingHandler. * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. + * thread-safe. See #xmlCtxtSetCharEncConvImpl for an alternative. * * @param name the encoding name, in UTF-8 format (ASCII actually) * @param input the xmlCharEncodingInputFunc to read that encoding @@ -807,7 +807,7 @@ error: } /** - * @deprecated Alias for xmlInitParser(). + * @deprecated Alias for #xmlInitParser. */ void xmlInitCharEncodingHandlers(void) { @@ -830,8 +830,8 @@ xmlInitEncodingInternal(void) { * Cleanup the memory allocated for the char encoding support, it * unregisters all the encoding handlers and the aliases. * - * @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. * @@ -862,7 +862,7 @@ xmlCleanupCharEncodingHandlers(void) { * Register the char encoding handler. * * @deprecated This function modifies global state and is not - * thread-safe. See xmlCtxtSetCharEncConvImpl() for an alternative. + * thread-safe. See #xmlCtxtSetCharEncConvImpl for an alternative. * * @param handler the xmlCharEncodingHandler handler block */ @@ -969,7 +969,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. @@ -1018,7 +1018,7 @@ xmlLookupCharEncodingHandler(xmlCharEncoding enc, } /** - * @deprecated Use xmlLookupCharEncodingHandler() which has better error + * @deprecated Use #xmlLookupCharEncodingHandler which has better error * reporting. * * @param enc an xmlCharEncoding value. @@ -1043,7 +1043,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. @@ -1151,7 +1151,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. @@ -1176,7 +1176,7 @@ xmlOpenCharEncodingHandler(const char *name, int output, * If the encoding is UTF-8, this will return a no-op handler that * shouldn't be used. * - * @deprecated Use xmlOpenCharEncodingHandler() which has better error + * @deprecated Use #xmlOpenCharEncodingHandler which has better error * reporting. * * @param name a string describing the char encoding. diff --git a/entities.c b/entities.c index 14bad706..101f5f98 100644 --- a/entities.c +++ b/entities.c @@ -332,7 +332,7 @@ xmlGetPredefinedEntity(const xmlChar *name) { /** * Add a new entity to the document's external subset. * - * xmlAddEntity() offers better error handling. + * #xmlAddEntity offers better error handling. * * @param doc the document * @param name the entity name @@ -355,7 +355,7 @@ xmlAddDtdEntity(xmlDoc *doc, const xmlChar *name, int type, /** * Add a new entity to the document's internal subset. * - * xmlAddEntity() offers better error handling. + * #xmlAddEntity offers better error handling. * * @param doc the document * @param name the entity name @@ -378,7 +378,7 @@ xmlAddDocEntity(xmlDoc *doc, const xmlChar *name, int type, /** * Create a new entity. * - * Like xmlAddDocEntity(), but if `doc` is NULL or has no internal + * Like #xmlAddDocEntity, but if `doc` is NULL or has no internal * subset defined, an unlinked entity will be returned. It is then * the responsibility of the caller to link it to the document later * or free it when not needed anymore. @@ -511,7 +511,7 @@ xmlGetDocEntity(const xmlDoc *doc, const xmlChar *name) { * Silently removes some invalid characters like ASCII control * codes. * - * See xmlEncodeSpecialChars() for an alternative. + * See #xmlEncodeSpecialChars for an alternative. * * @param doc the document containing the string (optional) * @param input A string to convert to XML. diff --git a/error.c b/error.c index 7753e011..9326170a 100644 --- a/error.c +++ b/error.c @@ -245,7 +245,7 @@ xmlGenericErrorDefaultFunc(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...) { * of error messages which should be concatenated or printed to a * stream. * - * @deprecated See xmlSetStructuredErrorFunc() for alternatives. + * @deprecated See #xmlSetStructuredErrorFunc for alternatives. * * If handler is NULL, use the built-in default handler which prints * to stderr. @@ -276,14 +276,14 @@ xmlSetGenericErrorFunc(void *ctx, xmlGenericErrorFunc handler) { * * @deprecated Use a per-context error handler. * - * - xmlCtxtSetErrorHandler() (since 2.13.0) - * - xmlTextReaderSetStructuredErrorHandler() - * - xmlXPathSetErrorHandler() (since 2.13.0) - * - xmlXIncludeSetErrorHandler() (since 2.13.0) - * - xmlSchemaSetParserStructuredErrors() - * - xmlSchemaSetValidStructuredErrors() - * - xmlRelaxNGSetParserStructuredErrors() - * - xmlRelaxNGSetValidStructuredErrors() + * - #xmlCtxtSetErrorHandler (since 2.13.0) + * - #xmlTextReaderSetStructuredErrorHandler + * - #xmlXPathSetErrorHandler (since 2.13.0) + * - #xmlXIncludeSetErrorHandler (since 2.13.0) + * - #xmlSchemaSetParserStructuredErrors + * - #xmlSchemaSetValidStructuredErrors + * - #xmlRelaxNGSetParserStructuredErrors + * - #xmlRelaxNGSetValidStructuredErrors * * Set the thread-local "structured" handler and context for error * messages. If handler is NULL, the error handler is deactivated. @@ -319,7 +319,7 @@ xmlSetStructuredErrorFunc(void *ctx, xmlStructuredErrorFunc handler) { * Displays the associated file and line information for the * current input. * - * @deprecated Use xmlFormatError(). + * @deprecated Use #xmlFormatError. * * @param input an xmlParserInput input */ @@ -414,7 +414,7 @@ xmlParserPrintFileContextInternal(xmlParserInputPtr input , * Displays current context within the input content for * error reporting. * - * @deprecated Use xmlFormatError(). + * @deprecated Use #xmlFormatError. * * @param input an xmlParserInput input */ @@ -852,7 +852,7 @@ xmlVFormatLegacyError(void *ctx, const char *level, /** * This is the default SAX error handler, but it will never be * called. If it isn't replaced by the user, errors will be - * handled by xmlFormatError(). + * handled by #xmlFormatError. * * @deprecated Do not call directly. * @@ -876,7 +876,7 @@ xmlParserError(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...) /** * This is the default SAX warning handler, but it will never be * called. If it isn't replaced by the user, warnings will be - * handled by xmlFormatError(). + * handled by #xmlFormatError. * * @deprecated Do not call directly. * @@ -900,7 +900,7 @@ xmlParserWarning(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...) /** * This is the default validity error handler, but it will never be * called. If it isn't replaced by the user, errors will be - * handled by xmlFormatError(). + * handled by #xmlFormatError. * * @deprecated Do not call directly. * @@ -924,7 +924,7 @@ xmlParserValidityError(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...) /** * This is the default validity warning handler, but it will never * be called. If it isn't replaced by the user, warnings will be - * handled by xmlFormatError(). + * handled by #xmlFormatError. * * @deprecated Do not call directly. * diff --git a/globals.c b/globals.c index 2b71a508..dca7be27 100644 --- a/globals.c +++ b/globals.c @@ -340,7 +340,7 @@ xmlInitGlobalState(xmlGlobalStatePtr gs); ************************************************************************/ /** - * @deprecated Alias for xmlInitParser(). + * @deprecated Alias for #xmlInitParser. */ void xmlInitGlobals(void) { xmlInitParser(); @@ -365,8 +365,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. */ @@ -459,7 +459,7 @@ xmlRegisterGlobalStateDtor(xmlGlobalState *gs) { #ifndef USE_TLS /** - * xmlNewGlobalState() allocates a global state. This structure is used to + * #xmlNewGlobalState allocates a global state. This structure is used to * hold all data for use by a thread when supporting backwards compatibility * of libxml2 to pre-thread-safe behaviour. * @@ -826,7 +826,7 @@ DllMain(ATTRIBUTE_UNUSED HINSTANCE hinstDLL, DWORD fdwReason, /** * Set per-thread default value. * - * @deprecated Call xmlSetGenericErrorFunc() in each thread. + * @deprecated Call #xmlSetGenericErrorFunc in each thread. */ void xmlThrDefSetGenericErrorFunc(void *ctx, xmlGenericErrorFunc handler) { @@ -842,7 +842,7 @@ xmlThrDefSetGenericErrorFunc(void *ctx, xmlGenericErrorFunc handler) { /** * Set per-thread default value. * - * @deprecated Call xmlSetStructuredErrorFunc() in each thread. + * @deprecated Call #xmlSetStructuredErrorFunc in each thread. */ void xmlThrDefSetStructuredErrorFunc(void *ctx, xmlStructuredErrorFunc handler) { @@ -899,7 +899,7 @@ int xmlThrDefIndentTreeOutput(int v) { /** * Set per-thread default value. * - * @deprecated Use the xmlsave.h API and xmlSaveSetIndentString(). + * @deprecated Use the xmlsave.h API and #xmlSaveSetIndentString. */ const char * xmlThrDefTreeIndentString(const char * v) { const char * ret; @@ -1034,7 +1034,7 @@ xmlThrDefDeregisterNodeDefault(xmlDeregisterNodeFunc func) /** * Set per-thread default value. * - * @deprecated Call xmlParserInputBufferCreateFilenameDefault() + * @deprecated Call #xmlParserInputBufferCreateFilenameDefault * in each thread. */ xmlParserInputBufferCreateFilenameFunc @@ -1057,7 +1057,7 @@ xmlThrDefParserInputBufferCreateFilenameDefault(xmlParserInputBufferCreateFilena /** * Set per-thread default value. * - * @deprecated Call xmlOutputBufferCreateFilenameDefault() + * @deprecated Call #xmlOutputBufferCreateFilenameDefault * in each thread. */ xmlOutputBufferCreateFilenameFunc diff --git a/hash.c b/hash.c index f21c00b2..b2f1423c 100644 --- a/hash.c +++ b/hash.c @@ -614,7 +614,7 @@ xmlHashAdd(xmlHashTable *hash, const xmlChar *key, void *payload) { /** * Add a hash table entry with two strings as key. * - * See xmlHashAdd(). + * See #xmlHashAdd. * * @since 2.13.0 * @@ -633,7 +633,7 @@ xmlHashAdd2(xmlHashTable *hash, const xmlChar *key, /** * Add a hash table entry with three strings as key. * - * See xmlHashAdd(). + * See #xmlHashAdd. * * @since 2.13.0 * @@ -658,7 +658,7 @@ xmlHashAdd3(xmlHashTable *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. * * @param hash hash table * @param key string key @@ -680,7 +680,7 @@ xmlHashAddEntry(xmlHashTable *hash, const xmlChar *key, void *payload) { /** * Add a hash table entry with two strings as key. * - * See xmlHashAddEntry(). + * See #xmlHashAddEntry. * * @param hash hash table * @param key first string key @@ -704,7 +704,7 @@ xmlHashAddEntry2(xmlHashTable *hash, const xmlChar *key, /** * Add a hash table entry with three strings as key. * - * See xmlHashAddEntry(). + * See #xmlHashAddEntry. * * @param hash hash table * @param key first string key @@ -752,7 +752,7 @@ xmlHashUpdateEntry(xmlHashTable *hash, const xmlChar *key, /** * Add a hash table entry with two strings as key. * - * See xmlHashUpdateEntry(). + * See #xmlHashUpdateEntry. * * @param hash hash table * @param key first string key @@ -777,7 +777,7 @@ xmlHashUpdateEntry2(xmlHashTable *hash, const xmlChar *key, /** * Add a hash table entry with three strings as key. * - * See xmlHashUpdateEntry(). + * See #xmlHashUpdateEntry. * * @param hash hash table * @param key first string key @@ -1193,7 +1193,7 @@ int xmlHashRemoveEntry(xmlHashTable *hash, const xmlChar *key, /** * Remove an entry with two strings as key. * - * See xmlHashRemoveEntry(). + * See #xmlHashRemoveEntry. * * @param hash hash table * @param key first string key @@ -1210,7 +1210,7 @@ xmlHashRemoveEntry2(xmlHashTable *hash, const xmlChar *key, /** * Remove an entry with three strings as key. * - * See xmlHashRemoveEntry(). + * See #xmlHashRemoveEntry. * * @param hash hash table * @param key first string key diff --git a/include/libxml/HTMLparser.h b/include/libxml/HTMLparser.h index f4925bd3..d8722fc5 100644 --- a/include/libxml/HTMLparser.h +++ b/include/libxml/HTMLparser.h @@ -212,7 +212,7 @@ XMLPUBFUN void /** * This is the set of HTML parser options that can be passed to - * htmlReadDoc(), htmlCtxtSetOptions() and other functions. + * #htmlReadDoc, #htmlCtxtSetOptions and other functions. */ typedef enum { /** diff --git a/include/libxml/encoding.h b/include/libxml/encoding.h index 524f8b55..bf5e4d08 100644 --- a/include/libxml/encoding.h +++ b/include/libxml/encoding.h @@ -214,7 +214,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/list.h b/include/libxml/list.h index ee8565e7..c96ac8b9 100644 --- a/include/libxml/list.h +++ b/include/libxml/list.h @@ -41,7 +41,7 @@ typedef void (*xmlListDeallocator) (xmlLink *lk); */ typedef int (*xmlListDataCompare) (const void *data0, const void *data1); /** - * Callback function used when walking a list with xmlListWalk(). + * Callback function used when walking a list with #xmlListWalk. * * @param data the data found in the list * @param user extra user provided data to the walker diff --git a/include/libxml/parser.h b/include/libxml/parser.h index eaf3087b..ca3dc910 100644 --- a/include/libxml/parser.h +++ b/include/libxml/parser.h @@ -648,7 +648,7 @@ struct _xmlSAXLocator { * SAX callback to resolve external entities. * * This is only used to load DTDs. The preferred way to install - * custom resolvers is xmlCtxtSetResourceLoader(). + * custom resolvers is #xmlCtxtSetResourceLoader. * * @param ctx the user data (XML parser context) * @param publicId The public identifier of the entity @@ -1676,7 +1676,7 @@ XMLPUBFUN long /** * This is the set of XML parser options that can be passed to - * xmlReadDoc(), xmlCtxtSetOptions() and other functions. + * #xmlReadDoc, #xmlCtxtSetOptions and other functions. */ typedef enum { /** diff --git a/include/libxml/parserInternals.h b/include/libxml/parserInternals.h index 8b43e8f4..fd6bdd02 100644 --- a/include/libxml/parserInternals.h +++ b/include/libxml/parserInternals.h @@ -27,13 +27,13 @@ extern "C" { /** * Push an input on the stack. * - * @deprecated Use xmlCtxtPushInput() + * @deprecated Use #xmlCtxtPushInput */ #define inputPush xmlCtxtPushInput /** * Pop an input from the stack. * - * @deprecated Use xmlCtxtPushInput() + * @deprecated Use #xmlCtxtPushInput */ #define inputPop xmlCtxtPopInput /** diff --git a/include/libxml/xmlerror.h b/include/libxml/xmlerror.h index 309c4149..2b0b6e70 100644 --- a/include/libxml/xmlerror.h +++ b/include/libxml/xmlerror.h @@ -22,7 +22,7 @@ extern "C" { /** * Set generic error callback. * - * @deprecated Use xmlSetGenericErrorFunc() + * @deprecated Use #xmlSetGenericErrorFunc */ #define initGenericErrorDefaultFunc(h) \ xmlSetGenericErrorFunc(NULL, (h) ? *(h) : NULL) diff --git a/include/libxml/xmlmemory.h b/include/libxml/xmlmemory.h index f19cacd7..bad77a53 100644 --- a/include/libxml/xmlmemory.h +++ b/include/libxml/xmlmemory.h @@ -92,7 +92,7 @@ XMLPUBVAR xmlMallocFunc xmlMalloc; * data (i.e. blocks not containing pointers), useful when using a * garbage collecting allocator. * - * @deprecated Use xmlMalloc() + * @deprecated Use #xmlMalloc */ XMLPUBVAR xmlMallocFunc xmlMallocAtomic; /** diff --git a/include/libxml/xmlmodule.h b/include/libxml/xmlmodule.h index e2bad3cd..c939c570 100644 --- a/include/libxml/xmlmodule.h +++ b/include/libxml/xmlmodule.h @@ -29,7 +29,7 @@ typedef struct _xmlModule xmlModule; typedef xmlModule *xmlModulePtr; /** - * enumeration of options that can be passed down to xmlModuleOpen() + * enumeration of options that can be passed down to #xmlModuleOpen */ typedef enum { XML_MODULE_LAZY = 1, /* lazy binding */ diff --git a/include/libxml/xmlreader.h b/include/libxml/xmlreader.h index 4e8c1421..ad1eb59b 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/xmlsave.h b/include/libxml/xmlsave.h index b4c5b212..ce06ad6f 100644 --- a/include/libxml/xmlsave.h +++ b/include/libxml/xmlsave.h @@ -25,7 +25,7 @@ extern "C" { /** * This is the set of XML save options that can be passed down - * to the xmlSaveToFd() and similar calls. + * to the #xmlSaveToFd and similar calls. */ typedef enum { /** diff --git a/include/libxml/xmlwriter.h b/include/libxml/xmlwriter.h index 43993ea5..5fa24c76 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/include/libxml/xpathInternals.h b/include/libxml/xpathInternals.h index 1b66a166..c94f646a 100644 --- a/include/libxml/xpathInternals.h +++ b/include/libxml/xpathInternals.h @@ -28,13 +28,13 @@ extern "C" { /** * Push a value on the stack * - * @deprecated Use xmlXPathValuePush() + * @deprecated Use #xmlXPathValuePush */ #define valuePush xmlXPathValuePush /** * Pop a value from the stack * - * @deprecated Use xmlXPathValuePop() + * @deprecated Use #xmlXPathValuePop */ #define valuePop xmlXPathValuePop diff --git a/parser.c b/parser.c index aa10f961..c7e89056 100644 --- a/parser.c +++ b/parser.c @@ -426,10 +426,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. @@ -1558,7 +1558,7 @@ xmlParserNsLookupUri(xmlParserCtxtPtr ctxt, const xmlHashedString *prefix) { /** * Lookup extra data for the given prefix. This returns data stored - * with xmlParserNsUdpateSax(). + * with #xmlParserNsUdpateSax. * * @param ctxt parser context * @param prefix namespace prefix @@ -1586,7 +1586,7 @@ xmlParserNsLookupSax(xmlParserCtxt *ctxt, const xmlChar *prefix) { /** * 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. * * @param ctxt parser context @@ -4267,7 +4267,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 * * @deprecated Internal function, don't use. * @@ -4647,7 +4647,7 @@ get_more: * Always makes progress if the first char isn't '<' or '&'. * * parse a CharData section.this is the fallback function - * of xmlParseCharData() when the parsing requires handling + * of #xmlParseCharData when the parsing requires handling * of non-ASCII characters. * * @param ctxt an XML parser context @@ -5302,7 +5302,7 @@ xmlParsePI(xmlParserCtxt *ctxt) { * 'PUBLIC' S PubidLiteral S SystemLiteral * 'SYSTEM' S SystemLiteral * - * See the NOTE on xmlParseExternalID(). + * See the NOTE on #xmlParseExternalID. * * @param ctxt an XML parser context */ @@ -5633,14 +5633,14 @@ done: * * [ VC: Attribute Default Legal ] * The declared default value must meet the lexical constraints of - * the declared attribute type c.f. xmlValidateAttributeDecl() + * the declared attribute type c.f. #xmlValidateAttributeDecl * * [ VC: Fixed Attribute Default ] * if an attribute has a default value declared with the \#FIXED * keyword, instances of that attribute must match the default value. * * [ WFC: No < in Attribute Values ] - * handled in xmlParseAttValue() + * handled in #xmlParseAttValue * * @param ctxt an XML parser context * @param value Receive a possible fixed default value for the attribute @@ -5876,7 +5876,7 @@ xmlParseEnumeratedType(xmlParserCtxt *ctxt, xmlEnumeration **tree) { * 'ENTITIES' | 'NMTOKEN' | 'NMTOKENS' * * Validity constraints for attribute values syntax are checked in - * xmlValidateAttributeValue() + * #xmlValidateAttributeValue * * [ VC: ID ] * Values of type ID must match the Name production. A name must not @@ -6110,7 +6110,7 @@ xmlSkipBlankCharsPEBalanced(xmlParserCtxt *ctxt, int openInputNr) { /** * 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 * * @deprecated Internal function, don't use. * @@ -6228,7 +6228,7 @@ mem_error: /** * 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) ('?' | '*' | '+')? * @@ -6529,7 +6529,7 @@ xmlParseElementChildrenContentDeclPriv(xmlParserCtxtPtr ctxt, int openInputNr, /** * 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 * * @deprecated Internal function, don't use. * @@ -6565,7 +6565,7 @@ xmlParseElementChildrenContentDecl(xmlParserCtxt *ctxt, int inputchk) { /** * 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 * * @deprecated Internal function, don't use. * @@ -9626,7 +9626,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. * * @param ctxt an XML parser context */ @@ -10362,7 +10362,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. * * @param ctxt an XML parser context * @returns 0, -1 in case of error. @@ -11202,20 +11202,20 @@ 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. * - * Since 2.14.0, xmlCtxtGetDocument() can be used to retrieve the + * Since 2.14.0, #xmlCtxtGetDocument can be used to retrieve the * result document. * * @param ctxt an XML parser context @@ -11329,7 +11329,7 @@ xmlParseChunk(xmlParserCtxt *ctxt, const char *chunk, int size, /** * Create a parser context for using the XML parser in push mode. - * See xmlParseChunk(). + * See #xmlParseChunk. * * Passing an initial chunk is useless and deprecated. * @@ -11518,7 +11518,7 @@ error: /** * Load and parse a DTD * - * @deprecated Use xmlCtxtParseDtd(). + * @deprecated Use #xmlCtxtParseDtd. * * @param sax the SAX handler block or NULL * @param input an Input Buffer @@ -11568,7 +11568,7 @@ xmlIOParseDTD(xmlSAXHandler *sax, xmlParserInputBuffer *input, /** * Load and parse an external subset. * - * @deprecated Use xmlCtxtParseDtd(). + * @deprecated Use #xmlCtxtParseDtd. * * @param sax the SAX handler block * @param publicId public identifier of the DTD (optional) @@ -11898,7 +11898,7 @@ xmlParseCtxtExternalEntity(xmlParserCtxt *ctxt, const xmlChar *URL, * An external general parsed entity is well-formed if it matches the * production labeled extParsedEnt. * - * @deprecated Use xmlParseCtxtExternalEntity(). + * @deprecated Use #xmlParseCtxtExternalEntity. * * [78] extParsedEnt ::= TextDecl? content * @@ -12118,7 +12118,7 @@ exit: * * This function assumes the encoding of `node`'s document which is * typically not what you want. A better alternative is - * xmlCtxtParseContent(). + * #xmlCtxtParseContent. * * @param node the context node * @param data the input string @@ -12386,7 +12386,7 @@ error: * Automatic support for ZLIB/Compress compressed document is provided * by default if found at compile-time and for file accesses * - * @deprecated Use xmlNewParserCtxt() and xmlCtxtReadFile(). + * @deprecated Use #xmlNewParserCtxt and #xmlCtxtReadFile. * * @param filename the filename or URL * @param options a combination of xmlParserOption @@ -12425,7 +12425,7 @@ xmlCreateURLParserCtxt(const char *filename, int options) * Automatic support for ZLIB/Compress compressed document is provided * by default if found at compile-time. * - * @deprecated Use xmlNewParserCtxt() and xmlCtxtReadFile(). + * @deprecated Use #xmlNewParserCtxt and #xmlCtxtReadFile. * * @param filename the filename * @returns the new parser context or NULL @@ -12443,7 +12443,7 @@ xmlCreateFileParserCtxt(const char *filename) * It use the given SAX function block to handle the parsing callback. * If sax is NULL, fallback to the default DOM tree building routines. * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadFile(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadFile. * * User data (void *) is stored within the parser context in the * context's _private member, so it is available nearly everywhere in libxml @@ -12493,7 +12493,7 @@ xmlSAXParseFileWithData(xmlSAXHandler *sax, const char *filename, * It use the given SAX function block to handle the parsing callback. * If sax is NULL, fallback to the default DOM tree building routines. * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadFile(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadFile. * * @param sax the SAX handler block * @param filename the filename @@ -12513,7 +12513,7 @@ xmlSAXParseFile(xmlSAXHandler *sax, const char *filename, * In the case the document is not Well Formed, a attempt to build a * tree is tried anyway * - * @deprecated Use xmlReadDoc() with XML_PARSE_RECOVER. + * @deprecated Use #xmlReadDoc with XML_PARSE_RECOVER. * * @param cur a pointer to an array of xmlChar * @returns the resulting document tree or NULL in case of failure @@ -12528,7 +12528,7 @@ xmlRecoverDoc(const xmlChar *cur) { * parse an XML file and build a tree. Automatic support for ZLIB/Compress * compressed document is provided by default if found at compile-time. * - * @deprecated Use xmlReadFile(). + * @deprecated Use #xmlReadFile. * * @param filename the filename * @returns the resulting document tree if the file was wellformed, @@ -12546,7 +12546,7 @@ xmlParseFile(const char *filename) { * In the case the document is not Well Formed, it attempts to build * a tree anyway * - * @deprecated Use xmlReadFile() with XML_PARSE_RECOVER. + * @deprecated Use #xmlReadFile with XML_PARSE_RECOVER. * * @param filename the filename * @returns the resulting document tree or NULL in case of failure @@ -12592,7 +12592,7 @@ xmlSetupParserForBuffer(xmlParserCtxt *ctxt, const xmlChar* buffer, * parse an XML file and call the given SAX handler routines. * Automatic support for ZLIB/Compress compressed document is provided * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadFile(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadFile. * * @param sax a SAX handler * @param user_data The user data returned on SAX callbacks @@ -12683,7 +12683,7 @@ xmlCreateMemoryParserCtxt(const char *buffer, int size) { * to handle the parsing callback. If sax is NULL, fallback to the default * DOM tree building routines. * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadMemory(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadMemory. * * User data (void *) is stored within the parser context in the * context's _private member, so it is available nearly everywhere in libxml @@ -12734,7 +12734,7 @@ xmlSAXParseMemoryWithData(xmlSAXHandler *sax, const char *buffer, * to handle the parsing callback. If sax is NULL, fallback to the default * DOM tree building routines. * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadMemory(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadMemory. * * @param sax the SAX handler block * @param buffer an pointer to a char array @@ -12752,7 +12752,7 @@ xmlSAXParseMemory(xmlSAXHandler *sax, const char *buffer, /** * parse an XML in-memory block and build a tree. * - * @deprecated Use xmlReadMemory(). + * @deprecated Use #xmlReadMemory. * * @param buffer an pointer to a char array * @param size the size of the array @@ -12768,7 +12768,7 @@ xmlDoc *xmlParseMemory(const char *buffer, int size) { * In the case the document is not Well Formed, an attempt to * build a tree is tried anyway * - * @deprecated Use xmlReadMemory() with XML_PARSE_RECOVER. + * @deprecated Use #xmlReadMemory with XML_PARSE_RECOVER. * * @param buffer an pointer to a char array * @param size the size of the array @@ -12782,7 +12782,7 @@ xmlDoc *xmlRecoverMemory(const char *buffer, int size) { /** * parse an XML in-memory buffer and call the given SAX handler routines. * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadMemory(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadMemory. * * @param sax a SAX handler * @param user_data The user data returned on SAX callbacks @@ -12862,7 +12862,7 @@ xmlCreateDocParserCtxt(const xmlChar *str) { * It use the given SAX function block to handle the parsing callback. * If sax is NULL, fallback to the default DOM tree building routines. * - * @deprecated Use xmlNewSAXParserCtxt() and xmlCtxtReadDoc(). + * @deprecated Use #xmlNewSAXParserCtxt and #xmlCtxtReadDoc. * * @param sax the SAX handler block * @param cur a pointer to an array of xmlChar @@ -12905,7 +12905,7 @@ xmlSAXParseDoc(xmlSAXHandler *sax, const xmlChar *cur, int recovery) { /** * parse an XML in-memory document and build a tree. * - * @deprecated Use xmlReadDoc(). + * @deprecated Use #xmlReadDoc. * * @param cur a pointer to an array of xmlChar * @returns the resulting document tree @@ -13149,7 +13149,7 @@ xmlCtxtSetOptionsInternal(xmlParserCtxtPtr ctxt, int options, int keepMask) * * @since 2.13.0 * - * With older versions, you can use xmlCtxtUseOptions(). + * With older versions, you can use #xmlCtxtUseOptions. * * @param ctxt an XML parser context * @param options a bitmask of xmlParserOption values @@ -13188,7 +13188,7 @@ xmlCtxtGetOptions(xmlParserCtxt *ctxt) * Applies the options to the parser context. The following options * are never cleared and can only be enabled: * - * @deprecated Use xmlCtxtSetOptions(). + * @deprecated Use #xmlCtxtSetOptions. * * - XML_PARSE_NOERROR * - XML_PARSE_NOWARNING @@ -13300,7 +13300,7 @@ xmlCtxtParseDocument(xmlParserCtxt *ctxt, xmlParserInput *input) * Convenience function to parse an XML document from a * zero-terminated string. * - * See xmlCtxtReadDoc() for details. + * See #xmlCtxtReadDoc for details. * * @param cur a pointer to a zero terminated string * @param URL base URL (optional) @@ -13341,7 +13341,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. * * @param filename a file or URL * @param encoding the document encoding (optional) @@ -13385,7 +13385,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. * * @param buffer a pointer to a char array * @param size the size of the array @@ -13424,7 +13424,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. @@ -13460,7 +13460,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. * * @param ioread an I/O read function * @param ioclose an I/O close function (optional) @@ -13500,7 +13500,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. * * @param ctxt an XML parser context * @param str a pointer to a zero terminated string @@ -13571,7 +13571,7 @@ xmlCtxtReadFile(xmlParserCtxt *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. * * @param ctxt an XML parser context * @param buffer a pointer to a char array @@ -13610,7 +13610,7 @@ xmlCtxtReadMemory(xmlParserCtxt *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. * * @param ctxt an XML parser context * @param fd an open file descriptor @@ -13645,7 +13645,7 @@ xmlCtxtReadFd(xmlParserCtxt *ctxt, int fd, * `URL` is used as base to resolve external entities and for error * reporting. * - * See xmlCtxtUseOptions() for details. + * See #xmlCtxtUseOptions for details. * * @param ctxt an XML parser context * @param ioread an I/O read function diff --git a/parserInternals.c b/parserInternals.c index 5744c67c..0320ae07 100644 --- a/parserInternals.c +++ b/parserInternals.c @@ -101,11 +101,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 * * @since 2.13.0 @@ -1188,7 +1188,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. * * @param ctxt the parser context * @param enc the encoding value (number) @@ -1259,7 +1259,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. * * @since 2.13.0 * @@ -1400,7 +1400,7 @@ xmlSwitchInputEncoding(xmlParserCtxt *ctxt, xmlParserInput *input, * Use encoding handler to decode input data. * * This function can be used to enforce the encoding of chunks passed - * to xmlParseChunk(). + * to #xmlParseChunk. * * @param ctxt the parser context * @param handler the encoding handler @@ -1716,7 +1716,7 @@ xmlFreeInputStream(xmlParserInput *input) { /** * Create a new input stream structure. * - * @deprecated Use xmlNewInputFromUrl() or similar functions. + * @deprecated Use #xmlNewInputFromUrl or similar functions. * * @param ctxt an XML parser context * @returns the new input stream or NULL @@ -2191,7 +2191,7 @@ xmlNewEntityInputStream(xmlParserCtxt *ctxt, xmlEntity *ent) { /** * Create a new input stream based on a memory buffer. * - * @deprecated Use xmlNewInputFromString(). + * @deprecated Use #xmlNewInputFromString. * * @param ctxt an XML parser context * @param buffer an memory buffer @@ -2363,11 +2363,11 @@ xmlCheckHTTPInput(xmlParserCtxt *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. * @@ -2431,7 +2431,7 @@ xmlNewInputFromUrl(const char *url, xmlParserInputFlags flags, * Unlike the default external entity loader, this function * doesn't use XML catalogs. * - * @deprecated Use xmlNewInputFromUrl(). + * @deprecated Use #xmlNewInputFromUrl. * * @param ctxt an XML parser context * @param filename the filename to use as entity @@ -2544,7 +2544,7 @@ xmlCurrentExternalEntityLoader = xmlDefaultExternalEntityLoader; * application. * * @deprecated This is a global setting and not thread-safe. Use - * xmlCtxtSetResourceLoader() or similar functions. + * #xmlCtxtSetResourceLoader or similar functions. * * @param f the new entity resolver function */ @@ -2556,9 +2556,9 @@ xmlSetExternalEntityLoader(xmlExternalEntityLoader f) { /** * Get the default external entity resolver function for the application * - * @deprecated See xmlSetExternalEntityLoader(). + * @deprecated See #xmlSetExternalEntityLoader. * - * @returns the xmlExternalEntityLoader() function pointer + * @returns the #xmlExternalEntityLoader function pointer */ xmlExternalEntityLoader xmlGetExternalEntityLoader(void) { @@ -2658,15 +2658,15 @@ xmlLoadResource(xmlParserCtxt *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. * @@ -2977,7 +2977,7 @@ xmlNewParserCtxt(void) * @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. * * @param sax SAX handler @@ -3221,9 +3221,9 @@ xmlCtxtGetValidCtxt(xmlParserCtxt *ctxt) { ************************************************************************/ /** - * Same as xmlCtxtReset() + * Same as #xmlCtxtReset * - * @deprecated Use xmlCtxtReset() + * @deprecated Use #xmlCtxtReset * * @param ctxt an XML parser context */ diff --git a/pattern.c b/pattern.c index 4373a124..fd376ee3 100644 --- a/pattern.c +++ b/pattern.c @@ -14,7 +14,7 @@ /* * TODO: * - compilation flags to check for specific syntaxes - * using flags of xmlPatterncompile() + * using flags of #xmlPatterncompile * - making clear how pattern starting with / or . need to be handled, * currently push(NULL, NULL) means a reset of the streaming context * and indicating we are on / (the document node), probably need @@ -1601,7 +1601,7 @@ xmlStreamCtxtAddState(xmlStreamCtxtPtr comp, int idx, int level) { } /** - * Push new data onto the stream. NOTE: if the call xmlPatterncompile() + * Push new data onto the stream. NOTE: if the call #xmlPatterncompile * indicated a dictionary, then strings for name and ns will be expected * to come from the dictionary. * Both `name` and `ns` being NULL means the / i.e. the root of the document. @@ -1923,7 +1923,7 @@ stream_next: } /** - * Push new data onto the stream. NOTE: if the call xmlPatterncompile() + * Push new data onto the stream. NOTE: if the call #xmlPatterncompile * indicated a dictionary, then strings for name and ns will be expected * to come from the dictionary. * Both `name` and `ns` being NULL means the / i.e. the root of the document. @@ -1943,12 +1943,12 @@ xmlStreamPush(xmlStreamCtxt *stream, } /** - * Push new data onto the stream. NOTE: if the call xmlPatterncompile() + * Push new data onto the stream. NOTE: if the call #xmlPatterncompile * indicated a dictionary, then strings for name and ns will be expected * to come from the dictionary. * Both `name` and `ns` being NULL means the / i.e. the root of the document. * This can also act as a reset. - * Different from xmlStreamPush() this function can be fed with nodes of type: + * Different from #xmlStreamPush this function can be fed with nodes of type: * element-, attribute-, text-, cdata-section-, comment- and * processing-instruction-node. * @@ -1971,7 +1971,7 @@ xmlStreamPushNode(xmlStreamCtxt *stream, /** * Push new attribute data onto the stream. * - * NOTE: If the call to xmlPatterncompile() indicated a dictionary, + * NOTE: If the call to #xmlPatterncompile indicated a dictionary, * then strings for `name` and `ns` will be expected to come from * the dictionary. * @@ -2233,7 +2233,7 @@ xmlPatternMatch(xmlPattern *comp, xmlNode *node) /** * Get a streaming context for that pattern - * Use xmlFreeStreamCtxt() to free the context. + * Use #xmlFreeStreamCtxt to free the context. * * @param comp the precompiled pattern * @returns a pointer to the context or NULL in case of failure @@ -2268,7 +2268,7 @@ failed: } /** - * Check if the pattern is streamable i.e. xmlPatternGetStreamCtxt() + * Check if the pattern is streamable i.e. #xmlPatternGetStreamCtxt * should work. * * @param comp the precompiled pattern diff --git a/relaxng.c b/relaxng.c index 5eb5ee2d..8132fe8f 100644 --- a/relaxng.c +++ b/relaxng.c @@ -2709,8 +2709,8 @@ xmlRelaxNGInitTypes(void) /** * Cleanup the default Schemas type library associated to RelaxNG * - * @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. * @@ -7319,7 +7319,7 @@ xmlRelaxNGParse(xmlRelaxNGParserCtxt *ctxt) /** * Set the callback functions used to handle errors for a validation context * - * @deprecated Use xmlRelaxNGSetParserStructuredErrors(). + * @deprecated Use #xmlRelaxNGSetParserStructuredErrors. * * @param ctxt a Relax-NG validation context * @param err the error callback @@ -8116,7 +8116,7 @@ xmlRelaxNGValidatePopElement(xmlRelaxNGValidCtxt *ctxt, } /** - * Validate a full subtree when xmlRelaxNGValidatePushElement() returned + * Validate a full subtree when #xmlRelaxNGValidatePushElement returned * 0 and the content of the node has been expanded. * * @param ctxt the validation context @@ -10508,7 +10508,7 @@ xmlRelaxNGFreeValidCtxt(xmlRelaxNGValidCtxt *ctxt) /** * Set the error and warning callback information * - * @deprecated Use xmlRelaxNGSetValidStructuredErrors(). + * @deprecated Use #xmlRelaxNGSetValidStructuredErrors. * * @param ctxt a Relax-NG validation context * @param err the error function diff --git a/runtest.c b/runtest.c index 8f6087e2..8eb1523c 100644 --- a/runtest.c +++ b/runtest.c @@ -1797,7 +1797,7 @@ htmlTokenizerTest(const char *filename, const char *result, * * ************************************************************************/ /** - * 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. * @@ -2364,7 +2364,7 @@ testParseContent(xmlParserCtxtPtr ctxt, xmlDocPtr doc, const char *filename) { } /** - * 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. * @@ -2474,7 +2474,7 @@ noentParseTest(const char *filename, const char *result, } /** - * Parse a file using the xmlReadFile() API and check for errors. + * Parse a file using the #xmlReadFile API and check for errors. * * @param filename the file to parse * @param result the file with expected result @@ -2561,7 +2561,7 @@ errParseTest(const char *filename, const char *result, const char *err, #if defined(LIBXML_VALID_ENABLED) || defined(LIBXML_HTML_ENABLED) /** - * Parse a file using the xmlReadFd() API and check for errors. + * Parse a file using the #xmlReadFd API and check for errors. * * @param filename the file to parse * @param result the file with expected result diff --git a/threads.c b/threads.c index 0c356510..235298b7 100644 --- a/threads.c +++ b/threads.c @@ -65,7 +65,7 @@ xmlInitMutex(xmlMutex *mutex) } /** - * xmlNewMutex() is used to allocate a libxml2 token struct for use in + * #xmlNewMutex is used to allocate a libxml2 token struct for use in * synchronizing access to data. * * @returns a new simple mutex pointer or NULL in case of error @@ -115,7 +115,7 @@ xmlFreeMutex(xmlMutex *tok) } /** - * xmlMutexLock() is used to lock a libxml2 token. + * #xmlMutexLock is used to lock a libxml2 token. * * @param tok the simple mutex */ @@ -137,7 +137,7 @@ xmlMutexLock(xmlMutex *tok) } /** - * xmlMutexUnlock() is used to unlock a libxml2 token. + * #xmlMutexUnlock is used to unlock a libxml2 token. * * @param tok the simple mutex */ @@ -173,7 +173,7 @@ xmlInitRMutex(xmlRMutex *tok) { } /** - * xmlRNewMutex() is used to allocate a reentrant mutex for use in + * #xmlRNewMutex is used to allocate a reentrant mutex for use in * synchronizing access to data. token_r is a re-entrant lock and thus useful * for synchronizing access to data structures that may be manipulated in a * recursive fashion. @@ -210,7 +210,7 @@ xmlCleanupRMutex(xmlRMutex *tok) { } /** - * xmlRFreeMutex() is used to reclaim resources associated with a + * #xmlRFreeMutex is used to reclaim resources associated with a * reentrant mutex. * * @param tok the reentrant mutex @@ -225,7 +225,7 @@ xmlFreeRMutex(xmlRMutex *tok) } /** - * xmlRMutexLock() is used to lock a libxml2 token_r. + * #xmlRMutexLock is used to lock a libxml2 token_r. * * @param tok the reentrant mutex */ @@ -257,7 +257,7 @@ xmlRMutexLock(xmlRMutex *tok) } /** - * xmlRMutexUnlock() is used to unlock a libxml2 token_r. + * #xmlRMutexUnlock is used to unlock a libxml2 token_r. * * @param tok the reentrant mutex */ @@ -287,7 +287,7 @@ xmlRMutexUnlock(xmlRMutex *tok ATTRIBUTE_UNUSED) ************************************************************************/ /** - * xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 + * #xmlLockLibrary is used to take out a re-entrant lock on the libxml2 * library. */ void @@ -297,7 +297,7 @@ xmlLockLibrary(void) } /** - * xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 + * #xmlUnlockLibrary is used to release a re-entrant lock on the libxml2 * library. */ void @@ -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 7a82ee23..ec83e984 100644 --- a/tree.c +++ b/tree.c @@ -622,7 +622,7 @@ xmlFreeNsList(xmlNs *cur) { * external subset. If the document has no external subset, it * will be set to the created DTD. * - * To create an internal subset, use xmlCreateIntSubset(). + * To create an internal subset, use #xmlCreateIntSubset. * * @param doc the document pointer (optional) * @param name the DTD name (optional) @@ -958,7 +958,7 @@ xmlFreeDoc(xmlDoc *cur) { } /** - * See xmlNodeParseContent(). + * See #xmlNodeParseContent. * * @param doc a document (optional) * @param parent an element or attribute (optional) @@ -1242,9 +1242,9 @@ xmlNodeParseContent(xmlNode *node, const xmlChar *content, int len) { } /** - * See xmlStringGetNodeList(). + * See #xmlStringGetNodeList. * - * @deprecated Use xmlNodeSetContentLen(). + * @deprecated Use #xmlNodeSetContentLen. * * @param doc a document (optional) * @param value an attribute value @@ -1266,7 +1266,7 @@ xmlStringLenGetNodeList(const xmlDoc *doc, const xmlChar *value, int len) { * associated with the document if provided. The document is also * used to look up entities. * - * @deprecated Use xmlNodeSetContent(). + * @deprecated Use #xmlNodeSetContent. * * The input is not validated. Syntax errors or references to * undeclared entities will be ignored silently with unspecified @@ -1357,10 +1357,10 @@ 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 - * xmlEncodeEntitiesReentrant() for details. If `list` is the child + * #xmlEncodeEntitiesReentrant for details. If `list` is the child * of an attribute, escaping rules apply are adjusted. * - * See xmlNodeListGetRawString() for an alternative option. + * See #xmlNodeListGetRawString for an alternative option. * * @param doc a document (optional) * @param list a node list of attribute children @@ -1399,7 +1399,7 @@ xmlNodeListGetString(xmlDoc *doc, const xmlNode *list, int inLine) * * If `inLine` is true, entity references will be substituted. * Otherwise, entity references will be kept and special characters - * like `&` will be escaped. See xmlEncodeSpecialChars() for + * like `&` will be escaped. See #xmlEncodeSpecialChars for * details. * * @param doc a document (unused) @@ -1579,7 +1579,7 @@ xmlNewNsProp(xmlNode *node, xmlNs *ns, const xmlChar *name, /** * Create an attribute node. * - * 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. * @@ -1607,7 +1607,7 @@ xmlNewNsPropEatName(xmlNode *node, xmlNs *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. * * @param doc the target document (optional) * @param name the name of the attribute @@ -1785,7 +1785,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. * * @param name the processing instruction target * @param content the PI content (optional) @@ -1800,7 +1800,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. * * @param ns namespace (optional) * @param name the node name @@ -1815,9 +1815,9 @@ xmlNewNode(xmlNs *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. * @@ -1867,7 +1867,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: * @@ -1917,7 +1917,7 @@ xmlNewDocNode(xmlDoc *doc, xmlNs *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. * @@ -2016,7 +2016,7 @@ xmlNewDocFragment(xmlDoc *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. * * @param content raw text content (optional) * @returns a pointer to the new node object or NULL if a memory @@ -2058,7 +2058,7 @@ error: * of the parent. * * If `content` is provided, a text node will be added to the child - * element, see xmlNewDocRawNode(). + * element, see #xmlNewDocRawNode. * * @param parent the parent node * @param ns a namespace (optional) @@ -2266,7 +2266,7 @@ xmlNewDocText(const xmlDoc *doc, const xmlChar *content) { /** * Create a new text node. * - * Use of this function is DISCOURAGED in favor of xmlNewDocTextLen(). + * Use of this function is DISCOURAGED in favor of #xmlNewDocTextLen. * * @param content raw text content (optional) * @param len size of text content @@ -2319,7 +2319,7 @@ xmlNewDocTextLen(xmlDoc *doc, const xmlChar *content, int len) { } /** - * Use of this function is DISCOURAGED in favor of xmlNewDocComment(). + * Use of this function is DISCOURAGED in favor of #xmlNewDocComment. * * Create a comment node. * @@ -2559,8 +2559,8 @@ xmlNodeSetDoc(xmlNodePtr node, xmlDocPtr doc) { * Associate all nodes in a tree with a 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. * * Also copy strings from the old document's dictionary and @@ -2612,7 +2612,7 @@ xmlSetTreeDoc(xmlNode *tree, xmlDoc *doc) { /** * Associate all subtrees in `list` with a new document. * - * Internal function, see xmlSetTreeDoc(). + * Internal function, see #xmlSetTreeDoc. * * @param list a node list * @param doc new document @@ -2649,7 +2649,7 @@ xmlSetListDoc(xmlNode *list, xmlDoc *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. * * @param parent the parent node * @param ns a namespace (optional) @@ -2865,13 +2865,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. * * @param prev the target node * @param cur the new node @@ -2894,13 +2894,13 @@ xmlAddNextSibling(xmlNode *prev, xmlNode *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. * * @param next the target node * @param cur the new node @@ -2931,7 +2931,7 @@ xmlAddPrevSibling(xmlNode *next, xmlNode *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. * * @param node the target node * @param cur the new node @@ -2966,7 +2966,7 @@ xmlAddSibling(xmlNode *node, xmlNode *cur) { /** * Append a node list to another node. * - * See xmlAddChild(). + * See #xmlAddChild. * * @param parent the parent node * @param cur the first node in the list @@ -3051,14 +3051,14 @@ xmlAddChildList(xmlNode *parent, xmlNode *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 @@ -3393,7 +3393,7 @@ xmlFreeNodeList(xmlNode *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. * * @param cur the node @@ -3494,7 +3494,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. * * @param cur the node */ @@ -3529,10 +3529,10 @@ xmlUnlinkNode(xmlNode *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. * * @param old the old node * @param cur the node (optional) @@ -3764,7 +3764,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. * * @param target the element where the attribute will be grafted @@ -4119,7 +4119,7 @@ error: * If `extended` is 2, make a shallow copy including properties and * namespaces of elements. * - * Use of this function is DISCOURAGED in favor of xmlDocCopyNode(). + * Use of this function is DISCOURAGED in favor of #xmlDocCopyNode. * * @param node the node * @param extended mode of operation @@ -4173,7 +4173,7 @@ xmlNode *xmlDocCopyNodeList(xmlDoc *doc, xmlNode *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. * * @param node the first node in the list. * @returns the head of the copied list or NULL if a memory @@ -4709,7 +4709,7 @@ xmlDocGetRootElement(const xmlDoc *doc) { /** * If `root` is NULL no action is taken. To remove a node from a - * document, use xmlUnlinkNode() instead. + * document, use #xmlUnlinkNode instead. * * Set the root element of the document (`doc->children` is a list * containing possibly comments, PIs, etc ...). @@ -4788,7 +4788,7 @@ xmlNodeSetLang(xmlNode *cur, const xmlChar *lang) { * * @param cur the node being checked * @returns a pointer to the lang value, or NULL if not found - * It's up to the caller to free the memory with xmlFree(). + * It's up to the caller to free the memory with #xmlFree. */ xmlChar * xmlNodeGetLang(const xmlNode *cur) { @@ -5102,13 +5102,13 @@ found: } /** - * 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. * * @param doc the document the node pertains to * @param cur the node being checked * @returns a pointer to the base URL, or NULL if not found - * It's up to the caller to free the memory with xmlFree(). + * It's up to the caller to free the memory with #xmlFree. */ xmlChar * xmlNodeGetBase(const xmlDoc *doc, const xmlNode *cur) { @@ -5265,7 +5265,7 @@ xmlBufGetNodeContent(xmlBuf *buf, const xmlNode *cur) * * Entity references are substituted. * - * It's up to the caller to free the result with xmlFree(). + * It's up to the caller to free the result with #xmlFree. * * @param cur the node being read * @returns a new string or NULL if arguments are invalid or a @@ -5383,11 +5383,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. + * #xmlNodeAddContent accepts raw text. * * @param cur the node being modified * @param content the new value of the content @@ -5399,7 +5399,7 @@ xmlNodeSetContent(xmlNode *cur, const xmlChar *content) { } /** - * See xmlNodeSetContent(). + * See #xmlNodeSetContent. * * @param cur the node being modified * @param content the new value of the content @@ -5414,7 +5414,7 @@ xmlNodeSetContentLen(xmlNode *cur, const xmlChar *content, int len) { /** * Append the extra substring to the node content. * - * NOTE: In contrast to xmlNodeSetContentLen(), `content` is supposed + * NOTE: In contrast to #xmlNodeSetContentLen, `content` is supposed * to be raw text, so unescaped XML special chars are allowed, entity * references are not supported. * @@ -5462,7 +5462,7 @@ xmlNodeAddContentLen(xmlNode *cur, const xmlChar *content, int len) { /** * Append the extra substring to the node content. * - * NOTE: In contrast to xmlNodeSetContent(), `content` is supposed + * NOTE: In contrast to #xmlNodeSetContent, `content` is supposed * to be raw text, so unescaped XML special chars are allowed, entity * references are not supported. * @@ -5584,7 +5584,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. * * @param doc the document * @param node the current node @@ -6385,8 +6385,8 @@ xmlNodeGetAttrValue(const xmlNode *node, const xmlChar *name, * This function looks in DTD attribute declarations for \#FIXED or * default declaration values. * - * NOTE: This function is ignores namespaces. Use xmlGetNsProp() or - * xmlGetNoNsProp() for namespace aware processing. + * NOTE: This function is ignores namespaces. Use #xmlGetNsProp or + * #xmlGetNoNsProp for namespace aware processing. * * NOTE: This function doesn't allow to distinguish malloc failures from * missing attributes. @@ -6415,11 +6415,11 @@ xmlGetProp(const xmlNode *node, const xmlChar *name) { * This function looks in DTD attribute declarations 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. * * @param node the element * @param name the attribute name @@ -6449,7 +6449,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. * * @param node the element * @param name the attribute name @@ -6711,7 +6711,7 @@ xmlSetDocCompressMode (xmlDoc *doc, int mode) { /** * Get the global compression level, ZLIB based. * - * @deprecated Use xmlGetDocCompressMode() + * @deprecated Use #xmlGetDocCompressMode * * @returns 0 (uncompressed) to 9 (max compression) */ @@ -6724,7 +6724,7 @@ xmlGetCompressMode(void) /** * Set the global compression level, ZLIB based. * - * @deprecated Use xmlSetDocCompressMode() + * @deprecated Use #xmlSetDocCompressMode * * Correct values: 0 (uncompressed) to 9 (max compression) * diff --git a/uri.c b/uri.c index ee7652e0..cfeca1e0 100644 --- a/uri.c +++ b/uri.c @@ -1701,7 +1701,7 @@ xmlURIEscapeStr(const xmlChar *str, const xmlChar *list) { * based it's impossible to be sure. * * 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 * @param str the string of the URI to escape @@ -2703,7 +2703,7 @@ done: } /** - * See xmlBuildRelativeURISafe(). + * See #xmlBuildRelativeURISafe. * * @param URI the URI reference under consideration * @param base the base value diff --git a/valid.c b/valid.c index 97a424f5..b50e0a45 100644 --- a/valid.c +++ b/valid.c @@ -740,7 +740,7 @@ error: /** * Allocate an element content structure. - * Deprecated in favor of xmlNewDocElementContent() + * Deprecated in favor of #xmlNewDocElementContent * * @deprecated Internal function, don't use. * @@ -850,7 +850,7 @@ error: /** * Build a copy of an element content description. - * Deprecated, use xmlCopyDocElementContent() instead + * Deprecated, use #xmlCopyDocElementContent instead * * @deprecated Internal function, don't use. * @@ -919,7 +919,7 @@ xmlFreeDocElementContent(xmlDoc *doc, xmlElementContent *cur) { /** * Free an element content structure. The whole subtree is removed. - * Deprecated, use xmlFreeDocElementContent() instead + * Deprecated, use #xmlFreeDocElementContent instead * * @deprecated Internal function, don't use. * @@ -932,7 +932,7 @@ xmlFreeElementContent(xmlElementContent *cur) { #ifdef LIBXML_OUTPUT_ENABLED /** - * Deprecated, unsafe, use xmlSnprintfElementContent() + * Deprecated, unsafe, use #xmlSnprintfElementContent * * @deprecated Internal function, don't use. * @@ -1322,7 +1322,7 @@ xmlCopyElementTable(xmlElementTable *table) { * This will dump the content of the element declaration as an XML * DTD definition. * - * @deprecated Use xmlSaveTree(). + * @deprecated Use #xmlSaveTree. * * @param buf the XML buffer output * @param elem An element table @@ -1818,7 +1818,7 @@ xmlCopyAttributeTable(xmlAttributeTable *table) { * This will dump the content of the attribute declaration as an XML * DTD definition. * - * @deprecated Use xmlSaveTree(). + * @deprecated Use #xmlSaveTree. * * @param buf the XML buffer output * @param attr An attribute declaration @@ -5415,7 +5415,7 @@ xmlValidatePopElement(xmlValidCtxt *ctxt, xmlDoc *doc ATTRIBUTE_UNUSED, * - [ VC: Element Valid ] * - [ VC: Required Attribute ] * - * Then calls xmlValidateOneAttribute() for each attribute present. + * Then calls #xmlValidateOneAttribute for each attribute present. * * ID/IDREF checks are handled separately. * @@ -6071,7 +6071,7 @@ xmlValidateDtd(xmlValidCtxt *ctxt, xmlDoc *doc, xmlDtd *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. * * @since 2.14.0 * @@ -6313,7 +6313,7 @@ xmlValidateDocumentInternal(xmlParserCtxtPtr ctxt, xmlValidCtxtPtr vctxt, * Try to validate the document instance. * * @deprecated This function can't report malloc or other failures. - * Use xmlCtxtValidateDocument(). + * Use #xmlCtxtValidateDocument. * * Performs the all the checks described by the XML Rec, * i.e. validates the internal and external subset (if present) @@ -6331,7 +6331,7 @@ xmlValidateDocument(xmlValidCtxt *vctxt, xmlDoc *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 6ce70e04..a92eb3f1 100644 --- a/xmlIO.c +++ b/xmlIO.c @@ -1371,7 +1371,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. * * @param enc the charset encoding if known (deprecated) * @returns the new parser input or NULL @@ -1616,9 +1616,9 @@ xmlParserInputBufferCreateUrl(const char *URI, xmlCharEncoding enc, * Do an encoding check if enc == XML_CHAR_ENCODING_NONE * * Internal implementation, never uses the callback installed with - * xmlParserInputBufferCreateFilenameDefault(). + * #xmlParserInputBufferCreateFilenameDefault. * - * @deprecated Use xmlNewInputFromUrl(). + * @deprecated Use #xmlNewInputFromUrl. * * @param URI a C string containing the URI or filename * @param enc the charset encoding if known @@ -1639,9 +1639,9 @@ __xmlParserInputBufferCreateFilename(const char *URI, xmlCharEncoding enc) { * Do an encoding check if enc == XML_CHAR_ENCODING_NONE * * Allows the actual function to be overridden with - * xmlParserInputBufferCreateFilenameDefault(). + * #xmlParserInputBufferCreateFilenameDefault. * - * @deprecated Use xmlNewInputFromUrl(). + * @deprecated Use #xmlNewInputFromUrl. * * @param URI a C string containing the URI or filename * @param enc the charset encoding if known @@ -1682,7 +1682,7 @@ xmlParserInputBufferCreateFilename(const char *URI, xmlCharEncoding enc) { * Consumes `encoder` but not in error case. * * Internal implementation, never uses the callback installed with - * xmlOutputBufferCreateFilenameDefault(). + * #xmlOutputBufferCreateFilenameDefault. * * @param URI a C string containing the URI or filename * @param encoder the encoding converter or NULL @@ -1771,7 +1771,7 @@ error: * Consumes `encoder` but not in error case. * * Allows the actual function to be overridden with - * xmlOutputBufferCreateFilenameDefault(). + * #xmlOutputBufferCreateFilenameDefault. * * @param URI a C string containing the URI or filename * @param encoder the encoding converter or NULL @@ -1797,7 +1797,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. * * @param file a FILE* * @param enc the charset encoding if known (deprecated) @@ -1907,11 +1907,11 @@ xmlOutputBufferGetSize(xmlOutputBuffer *out) { * Create a buffered parser input for the progressive parsing for the input * from a file descriptor * - * @deprecated Use xmlNewInputFromFd(). + * @deprecated Use #xmlNewInputFromFd. * * 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. * * @param fd a file descriptor number * @param enc the charset encoding if known (deprecated) @@ -2027,16 +2027,16 @@ xmlNewInputBufferMemory(const void *mem, size_t size, /** * Create a parser input buffer for parsing from a memory area. * - * @deprecated Use xmlNewInputFromMemory(). + * @deprecated Use #xmlNewInputFromMemory. * * 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. * * @param mem the memory input * @param size the length of the memory block @@ -2054,15 +2054,15 @@ xmlParserInputBufferCreateMem(const char *mem, int size, xmlCharEncoding enc) { /** * Create a parser input buffer for parsing from a memory area. * - * @deprecated Use xmlNewInputFromMemory(). + * @deprecated Use #xmlNewInputFromMemory. * * 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. * * @param mem the memory input * @param size the length of the memory block @@ -2081,7 +2081,7 @@ xmlParserInputBufferCreateStatic(const char *mem, int size, /** * Create an input buffer for a null-terminated C string. * - * @deprecated Use xmlNewInputFromString(). + * @deprecated Use #xmlNewInputFromString. * * @param str C string * @param flags flags @@ -2149,11 +2149,11 @@ xmlOutputBufferCreateFd(int fd, xmlCharEncodingHandler *encoder) { * Create a buffered parser input for the progressive parsing for the input * from an I/O handler * - * @deprecated Use xmlNewInputFromIO(). + * @deprecated Use #xmlNewInputFromIO. * * 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. * * @param ioread an I/O read function * @param ioclose an I/O close function @@ -2215,7 +2215,7 @@ xmlOutputBufferCreateIO(xmlOutputWriteCallback iowrite, /** * Registers a callback for URI input file handling * - * @deprecated Use xmlCtxtSetResourceLoader() or similar functions. + * @deprecated Use #xmlCtxtSetResourceLoader or similar functions. * * @param func function pointer to the new ParserInputBufferCreateFilenameFunc * @returns the old value of the registration function @@ -2414,7 +2414,7 @@ xmlParserInputBufferGrow(xmlParserInputBuffer *in, int len) { } /** - * Same as xmlParserInputBufferGrow(). + * Same as #xmlParserInputBufferGrow. * * @deprecated Internal function, don't use. * @@ -2776,7 +2776,7 @@ xmlParserGetDirectory(const char *filename) { } /** - * Like xmlCheckFilename() but handles file URIs. + * Like #xmlCheckFilename but handles file URIs. * * @deprecated Internal function, don't use. * @@ -2827,7 +2827,7 @@ xmlInitIOCallbacks(void) /** * Register a new set of I/O callback for handling parser input. * - * @deprecated Use xmlCtxtSetResourceLoader() or similar functions. + * @deprecated Use #xmlCtxtSetResourceLoader or similar functions. * * @param matchFunc the xmlInputMatchCallback * @param openFunc the xmlInputOpenCallback diff --git a/xmlmemory.c b/xmlmemory.c index b71a6aaf..24e5e93a 100644 --- a/xmlmemory.c +++ b/xmlmemory.c @@ -351,7 +351,7 @@ xmlMemoryDump(void) ****************************************************************/ /** - * @deprecated Alias for xmlInitParser(). + * @deprecated Alias for #xmlInitParser. * * @returns 0. */ @@ -370,8 +370,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. */ @@ -454,7 +454,7 @@ xmlMemGet(xmlFreeFunc *freeFunc, xmlMallocFunc *mallocFunc, * The mallocAtomicFunc is specialized for atomic block * allocations (i.e. of areas useful for garbage collected memory allocators * - * @deprecated Use xmlMemSetup(). + * @deprecated Use #xmlMemSetup. * * Should this be blocked if there was already some allocations * done ? @@ -493,7 +493,7 @@ xmlGcMemSetup(xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc, * The mallocAtomicFunc is specialized for atomic block * allocations (i.e. of areas useful for garbage collected memory allocators * - * @deprecated xmlMemGet(). + * @deprecated #xmlMemGet. * * @param freeFunc place to save the free() function in use * @param mallocFunc place to save the malloc() function in use diff --git a/xmlreader.c b/xmlreader.c index d90bf5b6..b5082ba2 100644 --- a/xmlreader.c +++ b/xmlreader.c @@ -426,7 +426,7 @@ xmlTextReaderFreeNodeList(xmlTextReaderPtr reader, xmlNodePtr cur) { /** * Free a node, this is a recursive behaviour, all the children are freed too. - * This doesn't unlink the child from the list, use xmlUnlinkNode() first. + * This doesn't unlink the child from the list, use #xmlUnlinkNode first. * * @param reader the xmlTextReader used * @param cur the node @@ -1563,10 +1563,10 @@ xmlTextReaderReadState(xmlTextReader *reader) { /** * Reads the contents of the current node and the full subtree. It then makes - * the subtree available until the next xmlTextReaderRead() call + * the subtree available until the next #xmlTextReaderRead call * * @param reader the xmlTextReader used - * @returns a node pointer valid until the next xmlTextReaderRead() call + * @returns a node pointer valid until the next #xmlTextReaderRead call * or NULL in case of error. */ xmlNode * @@ -3447,7 +3447,7 @@ xmlTextReaderHasValue(xmlTextReader *reader) { * * @param reader the xmlTextReader used * @returns the string or NULL if not available. The result must be deallocated - * with xmlFree() + * with #xmlFree */ xmlChar * xmlTextReaderValue(xmlTextReader *reader) { @@ -3806,7 +3806,7 @@ xmlTextReaderCurrentNode(xmlTextReader *reader) { /** * This tells the XML Reader to preserve the current node. - * The caller must also use xmlTextReaderCurrentDoc() to + * The caller must also use #xmlTextReaderCurrentDoc to * keep an handle on the resulting document once parsing has finished * * @param reader the xmlTextReader used @@ -3841,7 +3841,7 @@ xmlTextReaderPreserve(xmlTextReader *reader) { #ifdef LIBXML_PATTERN_ENABLED /** * This tells the XML Reader to preserve all nodes matched by the - * pattern. The caller must also use xmlTextReaderCurrentDoc() to + * pattern. The caller must also use #xmlTextReaderCurrentDoc to * keep an handle on the resulting document once parsing has finished * * @param reader the xmlTextReader used @@ -3889,7 +3889,7 @@ xmlTextReaderPreservePattern(xmlTextReader *reader, const xmlChar *pattern, * Hacking interface allowing to get the xmlDoc corresponding to the * current document being accessed by the xmlTextReader. * NOTE: as a result of this call, the reader will not destroy the - * associated XML document and calling xmlFreeDoc() on the result + * associated XML document and calling #xmlFreeDoc on the result * is needed once the reader parsing has finished. * * @param reader the xmlTextReader used @@ -4516,7 +4516,7 @@ xmlTextReaderLocatorBaseURI(xmlTextReaderLocatorPtr locator) { /** * Register a callback function that will be called on error and warnings. * - * @deprecated Use xmlTextReaderSetStructuredErrorHandler(). + * @deprecated Use #xmlTextReaderSetStructuredErrorHandler. * * If `f` is NULL, the default error and warning handlers are restored. * @@ -4892,7 +4892,7 @@ xmlTextReaderSetup(xmlTextReader *reader, } /** - * Set the maximum amplification factor. See xmlCtxtSetMaxAmplification(). + * Set the maximum amplification factor. See #xmlCtxtSetMaxAmplification. * * @param reader an XML reader * @param maxAmpl maximum amplification factor @@ -4922,9 +4922,9 @@ xmlTextReaderGetLastError(xmlTextReader *reader) /** * This function provides the current index of the parser used * by the reader, relative to the start of the current entity. - * This function actually just wraps a call to xmlBytesConsumed() + * This function actually just wraps a call to #xmlBytesConsumed * for the parser context associated with the reader. - * See xmlBytesConsumed() for more information. + * See #xmlBytesConsumed for more information. * * @deprecated The returned value is mostly random and useless. * It reflects the parser reading ahead and is in no way related to diff --git a/xmlregexp.c b/xmlregexp.c index 80983f1a..ef44a322 100644 --- a/xmlregexp.c +++ b/xmlregexp.c @@ -1318,7 +1318,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) @@ -2364,7 +2364,7 @@ xmlFACompareRanges(xmlRegRangePtr range1, xmlRegRangePtr range2) { /** * Compares two atoms type to check whether they intersect in some ways, - * this is used by xmlFACompareAtoms() only + * this is used by #xmlFACompareAtoms only * * @param type1 an atom type * @param type2 an atom type @@ -2606,7 +2606,7 @@ xmlFAEqualAtoms(xmlRegAtomPtr atom1, xmlRegAtomPtr atom2, int deep) { /** * 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 * * @param atom1 an atom * @param atom2 an atom @@ -2703,7 +2703,7 @@ not_determinist: /** * Check whether the associated regexp is determinist, - * should be called after xmlFAEliminateEpsilonTransitions() + * should be called after #xmlFAEliminateEpsilonTransitions * * @param ctxt a regexp parser context * @param state regexp state @@ -2788,7 +2788,7 @@ xmlFAFinishRecurseDeterminism(xmlRegParserCtxtPtr ctxt, xmlRegStatePtr state) { /** * Check whether the associated regexp is determinist, - * should be called after xmlFAEliminateEpsilonTransitions() + * should be called after #xmlFAEliminateEpsilonTransitions * * @param ctxt a regexp parser context */ @@ -4249,7 +4249,7 @@ xmlRegExecPushString2(xmlRegExecCtxt *exec, const xmlChar *value, /** * Extract information from the regexp execution. Internal routine to - * implement xmlRegExecNextValues() and xmlRegExecErrInfo() + * implement #xmlRegExecNextValues and #xmlRegExecErrInfo * * @param exec a regexp execution context * @param err error extraction or normal one @@ -6921,7 +6921,7 @@ xmlExpNewAtom(xmlExpCtxt *ctxt, const xmlChar *name, int len) { /** * Get the atom associated to the choice `left` | `right` * Note that `left` and `right` are consumed in the operation, to keep - * an handle on them use xmlExpRef() and use xmlExpFree() to release them, + * an handle on them use #xmlExpRef and use #xmlExpFree to release them, * this is true even in case of failure (unless ctxt == NULL). * * @param ctxt the expression context @@ -6944,7 +6944,7 @@ xmlExpNewOr(xmlExpCtxt *ctxt, xmlExpNode *left, xmlExpNode *right) { /** * Get the atom associated to the sequence `left` , `right` * Note that `left` and `right` are consumed in the operation, to keep - * an handle on them use xmlExpRef() and use xmlExpFree() to release them, + * an handle on them use #xmlExpRef and use #xmlExpFree to release them, * this is true even in case of failure (unless ctxt == NULL). * * @param ctxt the expression context @@ -6967,7 +6967,7 @@ xmlExpNewSeq(xmlExpCtxt *ctxt, xmlExpNode *left, xmlExpNode *right) { /** * Get the atom associated to the range (`subset`){`min`, `max`} * Note that `subset` is consumed in the operation, to keep - * an handle on it use xmlExpRef() and use xmlExpFree() to release it, + * an handle on it use #xmlExpRef and use #xmlExpFree to release it, * this is true even in case of failure (unless ctxt == NULL). * * @param ctxt the expression context diff --git a/xmlsave.c b/xmlsave.c index 2d24175f..50ed2b54 100644 --- a/xmlsave.c +++ b/xmlsave.c @@ -1816,8 +1816,8 @@ xhtmlNodeDumpOutput(xmlSaveCtxtPtr ctxt, xmlNodePtr cur) { * Create a document saving context serializing to a file descriptor * with the encoding and the options given. * - * If `encoding` is NULL, xmlSaveDoc() uses the document's - * encoding and xmlSaveTree() uses UTF-8. + * If `encoding` is NULL, #xmlSaveDoc uses the document's + * encoding and #xmlSaveTree uses UTF-8. * * This function doesn't allow to distinguish unsupported * encoding errors from failed memory allocations. @@ -1847,8 +1847,8 @@ xmlSaveToFd(int fd, const char *encoding, int options) * Create a document saving context serializing to a filename * with the encoding and the options given. * - * If `encoding` is NULL, xmlSaveDoc() uses the document's - * encoding and xmlSaveTree() uses UTF-8. + * If `encoding` is NULL, #xmlSaveDoc uses the document's + * encoding and #xmlSaveTree uses UTF-8. * * This function doesn't allow to distinguish unsupported * encoding errors from failed memory allocations. @@ -1880,8 +1880,8 @@ xmlSaveToFilename(const char *filename, const char *encoding, int options) * Create a document saving context serializing to a buffer * with the encoding and the options given. * - * If `encoding` is NULL, xmlSaveDoc() uses the document's - * encoding and xmlSaveTree() uses UTF-8. + * If `encoding` is NULL, #xmlSaveDoc uses the document's + * encoding and #xmlSaveTree uses UTF-8. * * This function doesn't allow to distinguish unsupported * encoding errors from failed memory allocations. @@ -1912,8 +1912,8 @@ xmlSaveToBuffer(xmlBuffer *buffer, const char *encoding, int options) * Create a document saving context serializing to a file descriptor * with the encoding and the options given * - * If `encoding` is NULL, xmlSaveDoc() uses the document's - * encoding and xmlSaveTree() uses UTF-8. + * If `encoding` is NULL, #xmlSaveDoc uses the document's + * encoding and #xmlSaveTree uses UTF-8. * * This function doesn't allow to distinguish unsupported * encoding errors from failed memory allocations. @@ -2182,7 +2182,7 @@ xmlAttrSerializeTxtContent(xmlBuffer *buf, xmlDoc *doc, * XML_PARSE_NOBLANKS. * * Since this is using xmlBuffer structures it is limited to 2GB and - * somewhat deprecated, use xmlNodeDumpOutput() instead. + * somewhat deprecated, use #xmlNodeDumpOutput instead. * * @param buf the XML buffer output * @param doc the document @@ -2411,7 +2411,7 @@ xmlDocDumpInternal(xmlOutputBufferPtr buf, xmlDocPtr doc, const char *encoding, * encoding declaration. * * It is up to the caller of this function to free the returned - * memory with xmlFree(). + * memory with #xmlFree. * * Note that `format` only works if the document was parsed with * XML_PARSE_NOBLANKS. @@ -2459,7 +2459,7 @@ xmlDocDumpFormatMemoryEnc(xmlDoc *out_doc, xmlChar **doc_txt_ptr, } /** - * Same as xmlDocDumpFormatMemoryEnc() with `encoding` set to + * Same as #xmlDocDumpFormatMemoryEnc with `encoding` set to * NULL and `format` set to 0. * * @param cur the document @@ -2472,7 +2472,7 @@ xmlDocDumpMemory(xmlDoc *cur, xmlChar**mem, int *size) { } /** - * Same as xmlDocDumpFormatMemoryEnc() with `encoding` set to + * Same as #xmlDocDumpFormatMemoryEnc with `encoding` set to * NULL. * * @param cur the document @@ -2486,7 +2486,7 @@ xmlDocDumpFormatMemory(xmlDoc *cur, xmlChar**mem, int *size, int format) { } /** - * Same as xmlDocDumpFormatMemoryEnc() with `format` set to 0. + * Same as #xmlDocDumpFormatMemoryEnc with `format` set to 0. * * @param out_doc Document to generate XML text from * @param doc_txt_ptr Memory pointer for allocated XML text @@ -2547,9 +2547,9 @@ xmlDocDump(FILE *f, xmlDoc *cur) { } /** - * Same as xmlSaveFormatFileTo() with `format` set to 0. + * Same as #xmlSaveFormatFileTo with `format` set to 0. * - * WARNING: This calls xmlOutputBufferClose() and frees `buf`. + * WARNING: This calls #xmlOutputBufferClose and frees `buf`. * * @param buf an output I/O buffer * @param cur the document @@ -2572,7 +2572,7 @@ xmlSaveFileTo(xmlOutputBuffer *buf, xmlDoc *cur, const char *encoding) { * Note that `format` only works if the document was parsed with * XML_PARSE_NOBLANKS. * - * WARNING: This calls xmlOutputBufferClose() and frees `buf`. + * WARNING: This calls #xmlOutputBufferClose and frees `buf`. * * @param buf an output I/O buffer * @param cur the document @@ -2639,7 +2639,7 @@ xmlSaveFormatFileEnc( const char * filename, xmlDoc *cur, /** - * Same as xmlSaveFormatFileEnc() with `format` set to 0. + * Same as #xmlSaveFormatFileEnc with `format` set to 0. * * @param filename the filename (or URL) * @param cur the document @@ -2652,7 +2652,7 @@ xmlSaveFileEnc(const char *filename, xmlDoc *cur, const char *encoding) { } /** - * Same as xmlSaveFormatFileEnc() with `encoding` set to NULL. + * Same as #xmlSaveFormatFileEnc with `encoding` set to NULL. * * @param filename the filename (or URL) * @param cur the document @@ -2665,7 +2665,7 @@ xmlSaveFormatFile(const char *filename, xmlDoc *cur, int format) { } /** - * Same as xmlSaveFormatFileEnc() with `encoding` set to NULL + * Same as #xmlSaveFormatFileEnc with `encoding` set to NULL * and `format` set to 0. * * @param filename the filename (or URL) diff --git a/xmlschemas.c b/xmlschemas.c index fca1834b..e887f17b 100644 --- a/xmlschemas.c +++ b/xmlschemas.c @@ -37,9 +37,9 @@ * All Group Limited (cos-all-limited) * Status: complete * (1.2) - * In xmlSchemaGroupDefReferenceTermFixup() and + * In #xmlSchemaGroupDefReferenceTermFixup and * (2) - * In xmlSchemaParseModelGroup() + * In #xmlSchemaParseModelGroup * TODO: Actually this should go to component-level checks, * but is done here due to performance. Move it to an other layer * is schema construction via an API is implemented. @@ -12977,7 +12977,7 @@ xmlSchemaResolveElementReferences(xmlSchemaElementPtr elemDecl, /** * Checks and builds the "member type definitions" property of the union * simple type. This handles part (1), part (2) is done in - * xmlSchemaFinishMemberTypeDefinitionsProperty() + * #xmlSchemaFinishMemberTypeDefinitionsProperty * * @param ctxt the schema parser context * @param type the schema simple type definition diff --git a/xmlschemastypes.c b/xmlschemastypes.c index 2efa0ab3..32bcd2e1 100644 --- a/xmlschemastypes.c +++ b/xmlschemastypes.c @@ -861,8 +861,8 @@ error: /** * Cleanup the default XML Schemas type library * - * @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 22fae3cd..9c844328 100644 --- a/xmlstring.c +++ b/xmlstring.c @@ -146,7 +146,7 @@ xmlStrcmp(const xmlChar *str1, const xmlChar *str2) { /** * Check if both strings are equal of have same content. - * Should be a bit more readable and faster than xmlStrcmp() + * Should be a bit more readable and faster than #xmlStrcmp * * @param str1 the first xmlChar * * @param str2 the second xmlChar * @@ -445,7 +445,7 @@ xmlStrncat(xmlChar *cur, const xmlChar *add, int len) { } /** - * 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. * @@ -669,7 +669,7 @@ xmlStrVASPrintf(xmlChar **out, int maxSize, const char *msg, va_list ap) { } /** - * See xmlStrVASPrintf(). + * See #xmlStrVASPrintf. * * @param out pointer to the resulting string * @param maxSize maximum size of the output buffer @@ -739,7 +739,7 @@ xmlUTF8Size(const xmlChar *utf) { * * @param utf1 pointer to first UTF8 char * @param utf2 pointer to second UTF8 char - * @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 6bbd2636..35dfd468 100644 --- a/xmlwriter.c +++ b/xmlwriter.c @@ -3751,7 +3751,7 @@ xmlTextWriterWriteDTDInternalEntity(xmlTextWriter *writer, } /** - * 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 * * @param writer the xmlTextWriter * @param pe TRUE if this is a parameter entity, FALSE if not diff --git a/xpath.c b/xpath.c index 35f7f664..7f72bebc 100644 --- a/xpath.c +++ b/xpath.c @@ -59,7 +59,7 @@ /** * Use the Timsort algorithm provided in timsort.h to sort * nodeset as this is a great improvement over the old Shell sort - * used in xmlXPathNodeSetSort() + * used in #xmlXPathNodeSetSort */ #define WITH_TIM_SORT @@ -174,7 +174,7 @@ double xmlXPathPINF = 0.0; double xmlXPathNINF = 0.0; /** - * @deprecated Alias for xmlInitParser(). + * @deprecated Alias for #xmlInitParser. */ void xmlXPathInit(void) { @@ -1591,7 +1591,7 @@ xmlXPathContextSetCache(xmlXPathContext *ctxt, } /** - * This is the cached version of xmlXPathWrapNodeSet(). + * This is the cached version of #xmlXPathWrapNodeSet. * Wrap the Nodeset `val` in a new xmlXPathObject * * In case of error the node set is destroyed and NULL is returned. @@ -1628,7 +1628,7 @@ xmlXPathCacheWrapNodeSet(xmlXPathParserContextPtr pctxt, xmlNodeSetPtr val) } /** - * This is the cached version of xmlXPathWrapString(). + * This is the cached version of #xmlXPathWrapString. * Wraps the `val` string into an XPath object. * * @param pctxt the XPath context @@ -1661,7 +1661,7 @@ xmlXPathCacheWrapString(xmlXPathParserContextPtr pctxt, xmlChar *val) } /** - * This is the cached version of xmlXPathNewNodeSet(). + * This is the cached version of #xmlXPathNewNodeSet. * Acquire an xmlXPathObject of type NodeSet and initialize * it with the single Node `val` * @@ -1729,7 +1729,7 @@ xmlXPathCacheNewNodeSet(xmlXPathParserContextPtr pctxt, xmlNodePtr val) } /** - * This is the cached version of xmlXPathNewString(). + * This is the cached version of #xmlXPathNewString. * Acquire an xmlXPathObject of type string and of value `val` * * @param pctxt the XPath context @@ -1772,7 +1772,7 @@ xmlXPathCacheNewString(xmlXPathParserContextPtr pctxt, const xmlChar *val) } /** - * This is the cached version of xmlXPathNewCString(). + * This is the cached version of #xmlXPathNewCString. * Acquire an xmlXPathObject of type string and of value `val` * * @param pctxt the XPath context @@ -1786,7 +1786,7 @@ xmlXPathCacheNewCString(xmlXPathParserContextPtr pctxt, const char *val) } /** - * This is the cached version of xmlXPathNewBoolean(). + * This is the cached version of #xmlXPathNewBoolean. * Acquires an xmlXPathObject of type boolean and of value `val` * * @param pctxt the XPath context @@ -1820,7 +1820,7 @@ xmlXPathCacheNewBoolean(xmlXPathParserContextPtr pctxt, int val) } /** - * This is the cached version of xmlXPathNewFloat(). + * This is the cached version of #xmlXPathNewFloat. * Acquires an xmlXPathObject of type double and of value `val` * * @param pctxt the XPath context @@ -1854,7 +1854,7 @@ xmlXPathCacheNewFloat(xmlXPathParserContextPtr pctxt, double val) } /** - * This is the cached version of xmlXPathObjectCopy(). + * This is the cached version of #xmlXPathObjectCopy. * Acquire a copy of a given object * * @param pctxt the XPath context @@ -3265,7 +3265,7 @@ xmlXPathWrapNodeSet(xmlNodeSet *val) { /** * Free up the xmlXPathObject `obj` but don't deallocate the objects in - * the list contrary to xmlXPathFreeObject(). + * the list contrary to #xmlXPathFreeObject. * * @param obj an existing NodeSetList object */ @@ -3584,7 +3584,7 @@ xmlXPathNodeTrailingSorted (xmlNodeSet *nodes, xmlNode *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. * * @param nodes a node-set @@ -3621,7 +3621,7 @@ xmlXPathTrailingSorted (xmlNodeSet *nodes1, xmlNodeSet *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. * * @param nodes1 a node-set * @param nodes2 a node-set @@ -4410,7 +4410,7 @@ xmlXPathCastNodeSetToString (xmlNodeSet *ns) { * * @param val an XPath object * @returns the allocated string value of the object, NULL in case of error. - * It's up to the caller to free the string memory with xmlFree(). + * It's up to the caller to free the string memory with #xmlFree. */ xmlChar * xmlXPathCastToString(xmlXPathObject *val) { @@ -6105,7 +6105,7 @@ typedef xmlNode *(*xmlXPathTraversalFunctionExt) (xmlNode *cur, xmlNode *contextNode); /* - * Used for merging node sets in xmlXPathCollectAndTest(). + * Used for merging node sets in #xmlXPathCollectAndTest. */ typedef xmlNodeSet *(*xmlXPathNodeSetMergeFunction) (xmlNodeSet *, xmlNodeSet *); @@ -8423,7 +8423,7 @@ xmlXPathParseLiteral(xmlXPathParserContextPtr ctxt) { * [29] Literal ::= '"' [^"]* '"' * | "'" [^']* "'" * - * TODO: xmlXPathCompLiteral() memory allocation could be improved. + * TODO: #xmlXPathCompLiteral memory allocation could be improved. * * @param ctxt the XPath Parser context */ @@ -12054,7 +12054,7 @@ xmlXPathNodeEval(xmlNode *node, const xmlChar *str, xmlXPathContext *ctx) { } /** - * Alias for xmlXPathEval(). + * Alias for #xmlXPathEval. * * @param str the XPath expression * @param ctxt the XPath context