1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-10-21 14:53:44 +03:00

doc: Prefix autolinks with '#'

Use `#func` instead of `func()` to ignore parameters and make all
autolinks work.
This commit is contained in:
Nick Wellnhofer
2025-05-28 15:53:38 +02:00
parent 6e33d136e1
commit 7bd8d1d9cc
44 changed files with 405 additions and 405 deletions

View File

@@ -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