c/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2 synced 2025-03-28 21:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Documentation fixes

Browse Source
This commit is contained in:
Nick Wellnhofer 2025-03-08 23:00:29 +01:00
parent 5f0b1378d7
commit d96911f100
4 changed files with 40 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/apibuild.py
View File

@ -21,6 +21,7 @@ debugsym=None
ignored_files = { ignored_files = {
"config.h": "generated portability layer", "config.h": "generated portability layer",
"libxml.h": "internal only", "libxml.h": "internal only",
"lintmain.c": "executable",
"testModule.c": "test tool", "testModule.c": "test tool",
"testapi.c": "generated regression tests", "testapi.c": "generated regression tests",
"runtest.c": "regression tests program", "runtest.c": "regression tests program",
@ -33,6 +34,8 @@ ignored_files = {
"nanoftp.h": "empty", "nanoftp.h": "empty",
"SAX.h": "empty", "SAX.h": "empty",
"xmlunicode.h": "empty", "xmlunicode.h": "empty",
"xmllint.c": "executable",
"xmlcatalog.c": "executable",
} }
ignored_words = { ignored_words = {

20
doc/libxml2-api.xml
View File

@ -5724,10 +5724,6 @@ crash if you try to modify the tree)'/>
<typedef name='xmlCharEncoding' file='encoding' type='enum'/> <typedef name='xmlCharEncoding' file='encoding' type='enum'/>
<struct name='xmlCharEncodingHandler' file='encoding' type='struct _xmlCharEncodingHandler'> <struct name='xmlCharEncodingHandler' file='encoding' type='struct _xmlCharEncodingHandler'>
<field name='name' type='char *'/> <field name='name' type='char *'/>
<field name='input' type='xmlCharEncodingInputFunc'/>
<field name='output' type='xmlCharEncodingOutputFunc'/>
<field name='iconv_in' type='void *'/>
<field name='iconv_out' type='void *'/>
<field name='inputCtxt' type='void *'/> <field name='inputCtxt' type='void *'/>
<field name='outputCtxt' type='void *'/> <field name='outputCtxt' type='void *'/>
<field name='ctxtDtor' type='xmlCharEncConvCtxtDtor'/> <field name='ctxtDtor' type='xmlCharEncConvCtxtDtor'/>
@ -12263,14 +12259,14 @@ crash if you try to modify the tree)'/>
<return type='void'/> <return type='void'/>
</function> </function>
<functype name='xmlResourceLoader' file='parser' module='parser'> <functype name='xmlResourceLoader' file='parser' module='parser'>
<info></info> <info>Callback for custom resource loaders. @flags can contain XML_INPUT_UNZIP and XML_INPUT_NETWORK.</info>
<return type='int' info=''/> <return type='int' info='an xmlParserError code.'/>
<arg name='ctxt' type='void *' info=''/> <arg name='ctxt' type='void *' info='parser context'/>
<arg name='url' type='const char *' info=''/> <arg name='url' type='const char *' info='URL to load'/>
<arg name='publicId' type='const char *' info=''/> <arg name='publicId' type='const char *' info='publid ID from DTD (optional)'/>
<arg name='type' type='xmlResourceType' info=''/> <arg name='type' type='xmlResourceType' info='resource type'/>
<arg name='flags' type='int' info=''/> <arg name='flags' type='int' info='flags'/>
<arg name='out' type='xmlParserInputPtr *' info=''/> <arg name='out' type='xmlParserInputPtr *' info='result pointer'/>
</functype> </functype>
<function name='xmlSAX2AttributeDecl' file='SAX2' module='SAX2'> <function name='xmlSAX2AttributeDecl' file='SAX2' module='SAX2'>
<info>An attribute definition has been parsed</info> <info>An attribute definition has been parsed</info>

18
include/libxml/parser.h
View File

@ -193,6 +193,24 @@ typedef struct _xmlStartTag xmlStartTag;
typedef struct _xmlParserNsData xmlParserNsData; typedef struct _xmlParserNsData xmlParserNsData;
typedef struct _xmlAttrHashBucket xmlAttrHashBucket; typedef struct _xmlAttrHashBucket xmlAttrHashBucket;
/**
* xmlResourceLoader:
* @ctxt: parser context
* @url: URL to load
* @publicId: publid ID from DTD (optional)
* @type: resource type
* @flags: flags
* @out: result pointer
*
* Callback for custom resource loaders.
*
* @flags can contain XML_INPUT_UNZIP and XML_INPUT_NETWORK.
*
* On success, @out should be set to a new parser input object and
* XML_ERR_OK should be returned.
*
* Returns an xmlParserError code.
*/
typedef int typedef int
(*xmlResourceLoader)(void *ctxt, const char *url, const char *publicId, (*xmlResourceLoader)(void *ctxt, const char *url, const char *publicId,
xmlResourceType type, int flags, xmlParserInputPtr *out); xmlResourceType type, int flags, xmlParserInputPtr *out);

11
xmlIO.c
View File

@ -1037,6 +1037,17 @@ xmlIODefaultMatch(const char *filename ATTRIBUTE_UNUSED) {
return(1); return(1);
} }
/**
* xmlInputFromFd:
* @buf: parser input buffer
* @fd: file descriptor
* @flags: flags
*
* Update the buffer to read from @fd. Supports the XML_INPUT_UNZIP
* flag.
*
* Returns an xmlParserError code.
*/
int int
xmlInputFromFd(xmlParserInputBufferPtr buf, int fd, int flags) { xmlInputFromFd(xmlParserInputBufferPtr buf, int fd, int flags) {
xmlFdIOCtxt *fdctxt; xmlFdIOCtxt *fdctxt;