modified the file header to add more informations, painful... updated to
* include/libxml/*.h include/libxml/*.h.in: modified the file
header to add more informations, painful...
* genChRanges.py genUnicode.py: updated to generate said changes
in headers
* doc/apibuild.py: extract headers, add them to libxml2-api.xml
* *.html *.xsl *.xml: updated the stylesheets to flag geprecated
APIs modules. Updated the stylesheets, some cleanups, regenerated
* doc/html/*.html: regenerated added back book1 and libxml-lib.html
Daniel
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml
index f24e752..7eadd4e 100644
--- a/doc/libxml2-api.xml
+++ b/doc/libxml2-api.xml
@@ -2,6 +2,10 @@
<api name='libxml2'>
<files>
<file name='DOCBparser'>
+ <summary>old DocBook SGML parser</summary>
+ <description>interface for a DocBook SGML non-verifying parser This code is DEPRECATED, and should not be used anymore. </description>
+ <author>Daniel Veillard </author>
+ <deprecated/>
<exports symbol='docbFreeParserCtxt'/>
<exports symbol='docbParseDoc'/>
<exports symbol='docbDocPtr'/>
@@ -21,6 +25,9 @@
<exports symbol='docbParserInputPtr'/>
</file>
<file name='HTMLparser'>
+ <summary>interface for an HTML 4.0 non-verifying parser</summary>
+ <description>this module implements an HTML 4.0 non-verifying parser with API compatible with the XML parser ones. It should be able to parse "real world" HTML, even if severely broken from a specification point of view. </description>
+ <author>Daniel Veillard </author>
<exports symbol='htmlParserNodeInfo'/>
<exports symbol='htmlIsScriptAttribute'/>
<exports symbol='htmlHandleOmittedElem'/>
@@ -90,6 +97,9 @@
<exports symbol='htmlParseDocument'/>
</file>
<file name='HTMLtree'>
+ <summary>specific APIs to process HTML tree, especially serialization</summary>
+ <description>this module implements a few function needed to process tree in an HTML specific way. </description>
+ <author>Daniel Veillard </author>
<exports symbol='htmlDocDumpMemory'/>
<exports symbol='htmlSaveFile'/>
<exports symbol='HTML_TEXT_NODE'/>
@@ -114,6 +124,10 @@
<exports symbol='htmlDocContentDumpOutput'/>
</file>
<file name='SAX'>
+ <summary>Old SAX version 1 handler, deprecated</summary>
+ <description>DEPRECATED set of SAX version 1 interfaces used to build the DOM tree. </description>
+ <author>Daniel Veillard </author>
+ <deprecated/>
<exports symbol='cdataBlock'/>
<exports symbol='comment'/>
<exports symbol='checkNamespace'/>
@@ -153,6 +167,9 @@
<exports symbol='getLineNumber'/>
</file>
<file name='SAX2'>
+ <summary>SAX2 parser interface used to build the DOM tree</summary>
+ <description>those are the default SAX2 interfaces used by the library when building DOM tree. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlSAX2CheckNamespace'/>
<exports symbol='xmlSAX2EndElementNs'/>
<exports symbol='xmlSAX2Reference'/>
@@ -198,6 +215,9 @@
<exports symbol='xmlSAX2GetSystemId'/>
</file>
<file name='c14n'>
+ <summary>Provide Canonical XML and Exclusive XML Canonicalization</summary>
+ <description>the c14n modules provides a "Canonical XML" implementation</description>
+ <author>Aleksey Sanin <aleksey@aleksey.com> </author>
<exports symbol='xmlC14NExecute'/>
<exports symbol='xmlC14NDocSaveTo'/>
<exports symbol='xmlC14NIsVisibleCallback'/>
@@ -205,6 +225,9 @@
<exports symbol='xmlC14NDocDumpMemory'/>
</file>
<file name='catalog'>
+ <summary>interfaces to the Catalog handling system</summary>
+ <description>the catalog module implements the support for XML Catalogs and SGML catalogs </description>
+ <author>Daniel Veillard </author>
<exports symbol='XML_CATA_ALLOW_NONE'/>
<exports symbol='XML_CATALOGS_NAMESPACE'/>
<exports symbol='xmlCatalogLocalResolve'/>
@@ -256,6 +279,9 @@
<exports symbol='xmlCatalogResolveURI'/>
</file>
<file name='chvalid'>
+ <summary>Unicode character range checking</summary>
+ <description>this module exports interfaces for the character range validation APIs This file is automatically generated from the cvs source definition files using the genChRanges.py Python script </description>
+ <author>William Brack <wbrack@mmm.com.hk> </author>
<exports symbol='_xmlChSRange'/>
<exports symbol='xmlIsPubidChar_ch'/>
<exports symbol='xmlIsBlank'/>
@@ -297,6 +323,9 @@
<exports symbol='xmlIsBaseChar'/>
</file>
<file name='debugXML'>
+ <summary>Tree debugging APIs</summary>
+ <description>Interfaces to a set of routines used for debugging the tree produced by the XML parser. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlShellWrite'/>
<exports symbol='xmlDebugDumpEntities'/>
<exports symbol='_xmlShellCtxt'/>
@@ -331,6 +360,9 @@
<exports symbol='xmlShell'/>
</file>
<file name='dict'>
+ <summary>string dictionnary</summary>
+ <description>dictionary of reusable strings, just used to avoid allocation and freeing operations. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlDictQLookup'/>
<exports symbol='xmlDictPtr'/>
<exports symbol='xmlDictReference'/>
@@ -342,6 +374,9 @@
<exports symbol='xmlDictOwns'/>
</file>
<file name='encoding'>
+ <summary>interface for the encoding conversion functions</summary>
+ <description>interface for the encoding conversion functions needed for XML basic encoding and iconv() support. Related specs are rfc2044 (UTF-8 and UTF-16) F. Yergeau Alis Technologies [ISO-10646] UTF-8 and UTF-16 in Annexes [ISO-8859-1] ISO Latin-1 characters codes. [UNICODE] The Unicode Consortium, "The Unicode Standard -- Worldwide Character Encoding -- Version 1.0", Addison- Wesley, Volume 1, 1991, Volume 2, 1992. UTF-8 is described in Unicode Technical Report #4. [US-ASCII] Coded Character Set--7-bit American Standard Code for Information Interchange, ANSI X3.4-1986. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlDelEncodingAlias'/>
<exports symbol='XML_CHAR_ENCODING_UCS4LE'/>
<exports symbol='XML_CHAR_ENCODING_ERROR'/>
@@ -403,6 +438,9 @@
<exports symbol='xmlCleanupEncodingAliases'/>
</file>
<file name='entities'>
+ <summary>interface for the XML entities handling</summary>
+ <description>this module provides some of the entity API needed for the parser and applications. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlAddDocEntity'/>
<exports symbol='XML_EXTERNAL_GENERAL_UNPARSED_ENTITY'/>
<exports symbol='xmlGetDtdEntity'/>
@@ -431,6 +469,9 @@
<exports symbol='xmlCreateEntitiesTable'/>
</file>
<file name='globals'>
+ <summary>interface for all global variables of the library</summary>
+ <description>all the global variables and thread handling for those variables is handled by this module. The bottom of this file is automatically generated by build_glob.py based on the description file global.data </description>
+ <author>Gary Pennington <Gary.Pennington@uk.sun.com>, Daniel Veillard </author>
<exports symbol='xmlThrDefSetStructuredErrorFunc'/>
<exports symbol='_xmlGlobalState'/>
<exports symbol='xmlInitializeGlobalState'/>
@@ -490,6 +531,8 @@
<exports symbol='xmlDefaultSAXLocator'/>
</file>
<file name='hash'>
+ <summary>chained hash tables</summary>
+ <author>Bjorn Reese <bjorn.reese@systematic.dk> </author>
<exports symbol='xmlHashScanFull'/>
<exports symbol='xmlHashDeallocator'/>
<exports symbol='xmlHashScannerFull'/>
@@ -521,6 +564,9 @@
<exports symbol='xmlHashSize'/>
</file>
<file name='list'>
+ <summary>lists interfaces</summary>
+ <description>this module implement the list support used in various place in the library. </description>
+ <author>Gary Pennington <Gary.Pennington@uk.sun.com> </author>
<exports symbol='xmlListWalker'/>
<exports symbol='xmlLinkPtr'/>
<exports symbol='xmlListReverseWalk'/>
@@ -556,6 +602,9 @@
<exports symbol='xmlListMerge'/>
</file>
<file name='nanoftp'>
+ <summary>minimal FTP implementation</summary>
+ <description>minimal FTP implementation allowing to fetch resources like external subset. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlNanoFTPScanProxy'/>
<exports symbol='xmlNanoFTPQuit'/>
<exports symbol='xmlNanoFTPClose'/>
@@ -582,6 +631,9 @@
<exports symbol='xmlNanoFTPGetConnection'/>
</file>
<file name='nanohttp'>
+ <summary>minimal HTTP implementation</summary>
+ <description>minimal HTTP implementation allowing to fetch resources like external subset. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlNanoHTTPSave'/>
<exports symbol='xmlNanoHTTPRedir'/>
<exports symbol='xmlNanoHTTPAuthHeader'/>
@@ -600,6 +652,9 @@
<exports symbol='xmlNanoHTTPReturnCode'/>
</file>
<file name='parser'>
+ <summary>the core parser module</summary>
+ <description>Interfaces, constants and types related to the XML parser </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlSetupParserForBuffer'/>
<exports symbol='xmlCtxtReadFile'/>
<exports symbol='XML_PARSER_ENTITY_DECL'/>
@@ -773,6 +828,9 @@
<exports symbol='xmlSetExternalEntityLoader'/>
</file>
<file name='parserInternals'>
+ <summary>internals routines exported by the parser.</summary>
+ <description>this module exports a number of internal parsing routines they are not really all intended for applications but can prove useful doing low level processing. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlParseAttValue'/>
<exports symbol='xmlCreateMemoryParserCtxt'/>
<exports symbol='xmlParseAttributeListDecl'/>
@@ -896,6 +954,9 @@
<exports symbol='xmlParseEntityDecl'/>
</file>
<file name='relaxng'>
+ <summary>implementation of the Relax-NG validation</summary>
+ <description>implementation of the Relax-NG validation </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlRelaxNGFreeValidCtxt'/>
<exports symbol='XML_RELAXNG_ERR_DUPID'/>
<exports symbol='XML_RELAXNG_ERR_VALELEM'/>
@@ -967,6 +1028,9 @@
<exports symbol='xmlRelaxNGValidityWarningFunc'/>
</file>
<file name='schemasInternals'>
+ <summary>internal interfaces for XML Schemas</summary>
+ <description>internal interfaces for the XML Schemas handling and schema validity checking </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlSchemaNotationPtr'/>
<exports symbol='XML_SCHEMA_TYPE_SIMPLE'/>
<exports symbol='xmlSchemaAttributeGroupPtr'/>
@@ -1053,6 +1117,9 @@
<exports symbol='XML_SCHEMAS_FACET_REPLACE'/>
</file>
<file name='threads'>
+ <summary>interfaces for thread handling</summary>
+ <description>set of generic threading related routines should work with pthreads, Windows native or TLS threads </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlRMutexPtr'/>
<exports symbol='xmlFreeRMutex'/>
<exports symbol='xmlGetThreadId'/>
@@ -1074,6 +1141,9 @@
<exports symbol='xmlRMutexLock'/>
</file>
<file name='tree'>
+ <summary>interfaces for tree manipulation</summary>
+ <description>this module describes the structures found in an tree resulting from an XML or HTML parsing, as well as the API provided for various processing on that tree </description>
+ <author>Daniel Veillard </author>
<exports symbol='XML_ATTRIBUTE_IMPLIED'/>
<exports symbol='xmlNewDocRawNode'/>
<exports symbol='xmlElementContent'/>
@@ -1340,6 +1410,9 @@
<exports symbol='xmlGetLastChild'/>
</file>
<file name='uri'>
+ <summary>library of generic URI related routines</summary>
+ <description>library of generic URI related routines Implements RFC 2396 </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlNormalizeURIPath'/>
<exports symbol='xmlPrintURI'/>
<exports symbol='xmlURIUnescapeString'/>
@@ -1357,6 +1430,9 @@
<exports symbol='xmlBuildURI'/>
</file>
<file name='valid'>
+ <summary>The DTD validation</summary>
+ <description>API for the DTD handling and the validity checking </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlValidateDocument'/>
<exports symbol='xmlFreeNotationTable'/>
<exports symbol='xmlNotationTable'/>
@@ -1443,6 +1519,9 @@
<exports symbol='xmlRefTablePtr'/>
</file>
<file name='xinclude'>
+ <summary>implementation of XInclude</summary>
+ <description>API to handle XInclude processing, implements the World Wide Web Consortium Working Draft 26 October 2000</description>
+ <author>Daniel Veillard </author>
<exports symbol='XINCLUDE_PARSE_TEXT'/>
<exports symbol='xmlXIncludeCtxt'/>
<exports symbol='XINCLUDE_HREF'/>
@@ -1460,6 +1539,9 @@
<exports symbol='XINCLUDE_PARSE_ENCODING'/>
</file>
<file name='xlink'>
+ <summary>unfinished XLink detection module</summary>
+ <description>unfinished XLink detection module </description>
+ <author>Daniel Veillard </author>
<exports symbol='xlinkShow'/>
<exports symbol='XLINK_TYPE_SIMPLE'/>
<exports symbol='xlinkHRef'/>
@@ -1491,6 +1573,9 @@
<exports symbol='XLINK_SHOW_EMBED'/>
</file>
<file name='xmlIO'>
+ <summary>interface for the I/O interfaces used by the parser</summary>
+ <description>interface for the I/O interfaces used by the parser </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlIOHTTPRead'/>
<exports symbol='xmlInputMatchCallback'/>
<exports symbol='xmlRegisterDefaultOutputCallbacks'/>
@@ -1548,6 +1633,9 @@
<exports symbol='xmlAllocParserInputBuffer'/>
</file>
<file name='xmlautomata'>
+ <summary>API to build regexp automata</summary>
+ <description>the API to build regexp automata </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlFreeAutomata'/>
<exports symbol='xmlAutomataNewCounter'/>
<exports symbol='xmlAutomataGetInitState'/>
@@ -1570,6 +1658,9 @@
<exports symbol='xmlAutomataIsDeterminist'/>
</file>
<file name='xmlerror'>
+ <summary>error handling</summary>
+ <description>the API used to report errors </description>
+ <author>Daniel Veillard </author>
<exports symbol='XML_DTD_CONTENT_ERROR'/>
<exports symbol='XML_SCHEMAV_NOROOT'/>
<exports symbol='XML_DTD_ATTRIBUTE_VALUE'/>
@@ -2105,6 +2196,9 @@
<exports symbol='XML_IO_BUFFER_FULL'/>
</file>
<file name='xmlexports'>
+ <summary>macros for marking symbols as exportable/importable.</summary>
+ <description>macros for marking symbols as exportable/importable. </description>
+ <author>Igor Zlatovic <igor@zlatkovic.com> </author>
<exports symbol='XMLCALL'/>
<exports symbol='_REENTRANT'/>
<exports symbol='XMLPUBFUN'/>
@@ -2112,6 +2206,9 @@
<exports symbol='LIBXML_DLL_IMPORT'/>
</file>
<file name='xmlmemory'>
+ <summary>interface for the memory allocator</summary>
+ <description>provides interfaces for the memory allocator, including debugging capabilities. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlMemRealloc'/>
<exports symbol='xmlReallocLoc'/>
<exports symbol='xmlGcMemGet'/>
@@ -2140,6 +2237,9 @@
<exports symbol='xmlMemStrdupLoc'/>
</file>
<file name='xmlreader'>
+ <summary>the XMLReader implementation</summary>
+ <description>API of the XML streaming API based on C# interfaces. </description>
+ <author>Daniel Veillard </author>
<exports symbol='XML_READER_TYPE_DOCUMENT_FRAGMENT'/>
<exports symbol='xmlTextReaderBaseUri'/>
<exports symbol='xmlNewTextReaderFilename'/>
@@ -2247,6 +2347,9 @@
<exports symbol='xmlTextReaderConstBaseUri'/>
</file>
<file name='xmlregexp'>
+ <summary>regular expressions handling</summary>
+ <description>basic API for libxml regular expressions handling used for XML Schemas and validation. </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlRegFreeExecCtxt'/>
<exports symbol='xmlRegexpExec'/>
<exports symbol='xmlRegExecCallbacks'/>
@@ -2263,6 +2366,9 @@
<exports symbol='xmlRegexpPrint'/>
</file>
<file name='xmlschemas'>
+ <summary>incomplete XML Schemas structure implementation</summary>
+ <description>interface to the XML Schemas handling and schema validity checking, it is incomplete right now. </description>
+ <author>Daniel Veillard </author>
<exports symbol='XML_SCHEMAS_ERR_NOTNILLABLE'/>
<exports symbol='XML_SCHEMAS_ERR_OK'/>
<exports symbol='XML_SCHEMAS_ERR_NOROOT'/>
@@ -2313,6 +2419,9 @@
<exports symbol='XML_SCHEMAS_ERR_'/>
</file>
<file name='xmlschemastypes'>
+ <summary>implementation of XML Schema Datatypes</summary>
+ <description>module providing the XML Schema Datatypes implementation both definition and validity checking </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlSchemaNewFacet'/>
<exports symbol='xmlSchemaValPredefTypeNode'/>
<exports symbol='xmlSchemaFreeFacet'/>
@@ -2326,6 +2435,9 @@
<exports symbol='xmlSchemaCheckFacet'/>
</file>
<file name='xmlunicode'>
+ <summary>Unicode character APIs</summary>
+ <description>API for the Unicode character APIs This file is automatically generated from the UCS description files of the Unicode Character Database</description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlUCSIsBlockElements'/>
<exports symbol='xmlUCSIsVariationSelectorsSupplement'/>
<exports symbol='xmlUCSIsTags'/>
@@ -2494,6 +2606,9 @@
<exports symbol='xmlUCSIsCatS'/>
</file>
<file name='xmlversion'>
+ <summary>compile-time version informations</summary>
+ <description>compile-time version informations for the XML library </description>
+ <author>Daniel Veillard </author>
<exports symbol='LIBXML_VERSION_STRING'/>
<exports symbol='LIBXML_DOCB_ENABLED'/>
<exports symbol='LIBXML_CATALOG_ENABLED'/>
@@ -2530,6 +2645,9 @@
<exports symbol='LIBXML_WRITER_ENABLED'/>
</file>
<file name='xmlwriter'>
+ <summary>text writing API for XML</summary>
+ <description>text writing API for XML </description>
+ <author>Alfred Mickautsch <alfred@mickautsch.de> </author>
<exports symbol='xmlTextWriterStartDocument'/>
<exports symbol='xmlTextWriterEndPI'/>
<exports symbol='xmlTextWriterWriteBase64'/>
@@ -2607,6 +2725,9 @@
<exports symbol='xmlTextWriterWriteFormatElementNS'/>
</file>
<file name='xpath'>
+ <summary>XML Path Language implementation</summary>
+ <description>API for the XML Path Language implementation XML Path Language implementation XPath is a language for addressing parts of an XML document, designed to be used by both XSLT and XPointer</description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlXPathCastNodeSetToBoolean'/>
<exports symbol='_xmlXPathVariable'/>
<exports symbol='xmlXPathObjectPtr'/>
@@ -2714,6 +2835,9 @@
<exports symbol='XPATH_UNFINISHED_LITERAL_ERROR'/>
</file>
<file name='xpathInternals'>
+ <summary>internal interfaces for XML Path Language implementation</summary>
+ <description>internal interfaces for XML Path Language implementation used to build new modules on top of XPath like XPointer and XSLT </description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlXPathNodeSetMerge'/>
<exports symbol='xmlXPathRoundFunction'/>
<exports symbol='CAST_TO_NUMBER'/>
@@ -2864,6 +2988,9 @@
<exports symbol='xmlXPathPopNumber'/>
</file>
<file name='xpointer'>
+ <summary>API to handle XML Pointers</summary>
+ <description>API to handle XML Pointers Base implementation was made accordingly to W3C Candidate Recommendation 7 June 2000</description>
+ <author>Daniel Veillard </author>
<exports symbol='xmlXPtrNewRangePoints'/>
<exports symbol='xmlLocationSetPtr'/>
<exports symbol='xmlXPtrBuildNodeList'/>