From 06d2524e8069c7ab0626d03910ac29484741f811 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Wed, 25 Feb 2004 13:01:42 +0000 Subject: [PATCH] applied a cleanup patch from Peter Breitenlohner removed a doc build * Makefile.am catalog.c configure.in: applied a cleanup patch from Peter Breitenlohner * tree.c: removed a doc build warning by fixing a param comment * doc/* : rebuilt the docs Daniel --- ChangeLog | 7 +++++ Makefile.am | 9 +++++++ catalog.c | 52 ++++++++++++++++++------------------ configure.in | 4 +-- doc/APIchunk12.html | 1 - doc/APIchunk16.html | 26 ------------------ doc/html/libxml-catalog.html | 22 +++++++-------- doc/html/libxml-tree.html | 2 +- doc/libxml2-api.xml | 28 +++++++++---------- doc/libxml2-refs.xml | 29 -------------------- tree.c | 2 +- 11 files changed, 71 insertions(+), 111 deletions(-) diff --git a/ChangeLog b/ChangeLog index 272f2cf8..7dabc250 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +Wed Feb 25 13:57:25 CET 2004 Daniel Veillard + + * Makefile.am catalog.c configure.in: applied a cleanup patch + from Peter Breitenlohner + * tree.c: removed a doc build warning by fixing a param comment + * doc/* : rebuilt the docs + Wed Feb 25 13:33:07 CET 2004 Daniel Veillard * valid.c HTMLparser.c: avoid ID error message if using diff --git a/Makefile.am b/Makefile.am index bb1b3af0..693e5adf 100644 --- a/Makefile.am +++ b/Makefile.am @@ -901,6 +901,15 @@ rpm: cleanup cleantar ## the value NONE in configure if the user doesn't specify them (this ## is an autoconf feature, not a bug). +xml2Conf.sh: xml2Conf.sh.in Makefile +## Use sed and then mv to avoid problems if the user interrupts. + sed -e 's?\@XML_LIBDIR\@?$(XML_LIBDIR)?g' \ + -e 's?\@XML_INCLUDEDIR\@?$(XML_INCLUDEDIR)?g' \ + -e 's?\@VERSION\@?$(VERSION)?g' \ + -e 's?\@XML_LIBS\@?$(XML_LIBS)?g' \ + < $(srcdir)/xml2Conf.sh.in > xml2Conf.tmp \ + && mv xml2Conf.tmp xml2Conf.sh + CLEANFILES=xml2Conf.sh confexecdir=$(libdir) diff --git a/catalog.c b/catalog.c index 86df2ebd..602e16bf 100644 --- a/catalog.c +++ b/catalog.c @@ -392,7 +392,7 @@ xmlCreateNewCatalog(xmlCatalogType type, xmlCatalogPrefer prefer) { /** * xmlFreeCatalog: - * @catal: a Catalog entry + * @catal: a Catalog * * Free the memory allocated to a Catalog */ @@ -417,7 +417,7 @@ xmlFreeCatalog(xmlCatalogPtr catal) { #ifdef LIBXML_OUTPUT_ENABLED /** * xmlCatalogDumpEntry: - * @entry: the + * @entry: the catalog entry * @out: the file. * * Serialize an SGML Catalog entry @@ -960,7 +960,7 @@ xmlCatalogListXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI); * * lookup the internal type associated to an XML catalog entry name * - * Returns the type associate with that name + * Returns the type associated with that name */ static xmlCatalogEntryType xmlGetXMLCatalogEntryType(const xmlChar *name) { @@ -1469,8 +1469,8 @@ xmlDelXMLCatalog(xmlCatalogEntryPtr catal, const xmlChar *value) { /** * xmlCatalogXMLResolve: * @catal: a catalog list - * @pubId: the public ID string - * @sysId: the system ID string + * @pubID: the public ID string + * @sysID: the system ID string * * Do a complete resolution lookup of an External Identifier for a * list of catalog entries. @@ -1700,7 +1700,7 @@ xmlCatalogXMLResolve(xmlCatalogEntryPtr catal, const xmlChar *pubID, * xmlCatalogXMLResolveURI: * @catal: a catalog list * @URI: the URI - * @sysId: the system ID string + * @sysID: the system ID string * * Do a complete resolution lookup of an External Identifier for a * list of catalog entries. @@ -1835,8 +1835,8 @@ xmlCatalogXMLResolveURI(xmlCatalogEntryPtr catal, const xmlChar *URI) { /** * xmlCatalogListXMLResolve: * @catal: a catalog list - * @pubId: the public ID string - * @sysId: the system ID string + * @pubID: the public ID string + * @sysID: the system ID string * * Do a complete resolution lookup of an External Identifier for a * list of catalogs @@ -2355,11 +2355,11 @@ xmlParseSGMLCatalog(xmlCatalogPtr catal, const xmlChar *value, /** * xmlCatalogGetSGMLPublic: * @catal: an SGML catalog hash - * @pubId: the public ID string + * @pubID: the public ID string * - * Try to lookup the system ID associated to a public ID + * Try to lookup the catalog local reference associated to a public ID * - * Returns the system ID if found or NULL otherwise. + * Returns the local resource if found or NULL otherwise. */ static const xmlChar * xmlCatalogGetSGMLPublic(xmlHashTablePtr catal, const xmlChar *pubID) { @@ -2379,7 +2379,7 @@ xmlCatalogGetSGMLPublic(xmlHashTablePtr catal, const xmlChar *pubID) { /** * xmlCatalogGetSGMLSystem: * @catal: an SGML catalog hash - * @sysId: the public ID string + * @sysID: the system ID string * * Try to lookup the catalog local reference for a system ID * @@ -2403,8 +2403,8 @@ xmlCatalogGetSGMLSystem(xmlHashTablePtr catal, const xmlChar *sysID) { /** * xmlCatalogSGMLResolve: * @catal: the SGML catalog - * @pubId: the public ID string - * @sysId: the system ID string + * @pubID: the public ID string + * @sysID: the system ID string * * Do a complete resolution lookup of an External Identifier * @@ -2576,11 +2576,11 @@ xmlExpandCatalog(xmlCatalogPtr catal, const char *filename) /** * xmlACatalogResolveSystem: * @catal: a Catalog - * @sysID: the public ID string + * @sysID: the system ID string * * Try to lookup the catalog resource for a system ID * - * Returns the system ID if found or NULL otherwise, the value returned + * Returns the resource if found or NULL otherwise, the value returned * must be freed by the caller. */ xmlChar * @@ -2613,9 +2613,9 @@ xmlACatalogResolveSystem(xmlCatalogPtr catal, const xmlChar *sysID) { * @catal: a Catalog * @pubID: the public ID string * - * Try to lookup the system ID associated to a public ID in that catalog + * Try to lookup the catalog local reference associated to a public ID in that catalog * - * Returns the system ID if found or NULL otherwise, the value returned + * Returns the local resource if found or NULL otherwise, the value returned * must be freed by the caller. */ xmlChar * @@ -3063,11 +3063,11 @@ xmlCatalogCleanup(void) { /** * xmlCatalogResolveSystem: - * @sysID: the public ID string + * @sysID: the system ID string * * Try to lookup the catalog resource for a system ID * - * Returns the system ID if found or NULL otherwise, the value returned + * Returns the resource if found or NULL otherwise, the value returned * must be freed by the caller. */ xmlChar * @@ -3085,9 +3085,9 @@ xmlCatalogResolveSystem(const xmlChar *sysID) { * xmlCatalogResolvePublic: * @pubID: the public ID string * - * Try to lookup the system ID associated to a public ID + * Try to lookup the catalog reference associated to a public ID * - * Returns the system ID if found or NULL otherwise, the value returned + * Returns the resource if found or NULL otherwise, the value returned * must be freed by the caller. */ xmlChar * @@ -3502,10 +3502,10 @@ xmlCatalogLocalResolveURI(void *catalogs, const xmlChar *URI) { * xmlCatalogGetSystem: * @sysID: the system ID string * - * Try to lookup the system ID associated to a public ID + * Try to lookup the catalog reference associated to a system ID * DEPRECATED, use xmlCatalogResolveSystem() * - * Returns the system ID if found or NULL otherwise. + * Returns the resource if found or NULL otherwise. */ const xmlChar * xmlCatalogGetSystem(const xmlChar *sysID) { @@ -3546,10 +3546,10 @@ xmlCatalogGetSystem(const xmlChar *sysID) { * xmlCatalogGetPublic: * @pubID: the public ID string * - * Try to lookup the system ID associated to a public ID + * Try to lookup the catalog reference associated to a public ID * DEPRECATED, use xmlCatalogResolvePublic() * - * Returns the system ID if found or NULL otherwise. + * Returns the resource if found or NULL otherwise. */ const xmlChar * xmlCatalogGetPublic(const xmlChar *pubID) { diff --git a/configure.in b/configure.in index c808a26b..6acc92d7 100644 --- a/configure.in +++ b/configure.in @@ -1054,6 +1054,6 @@ rm -f COPYING.LIB COPYING ln -s Copyright COPYING # keep on one line for cygwin c.f. #130896 -AC_OUTPUT(libxml2.spec:libxml.spec.in Makefile include/Makefile include/libxml/Makefile doc/Makefile doc/examples/Makefile example/Makefile python/Makefile python/tests/Makefile include/libxml/xmlversion.h xml2-config libxml-2.0.pc libxml-2.0-uninstalled.pc xml2Conf.sh python/setup.py) +AC_OUTPUT(libxml2.spec:libxml.spec.in Makefile include/Makefile include/libxml/Makefile doc/Makefile doc/examples/Makefile example/Makefile python/Makefile python/tests/Makefile include/libxml/xmlversion.h xml2-config libxml-2.0.pc libxml-2.0-uninstalled.pc python/setup.py) -chmod +x xml2-config xml2Conf.sh python/setup.py +chmod +x xml2-config python/setup.py diff --git a/doc/APIchunk12.html b/doc/APIchunk12.html index cd55cf9a..d50869ae 100644 --- a/doc/APIchunk12.html +++ b/doc/APIchunk12.html @@ -179,7 +179,6 @@ A:link, A:visited, A:active { text-decoration: underline } xmlCatalogAdd
xmlCatalogAddLocal
xmlCatalogRemove
-xmlFreeCatalog
xmlHashUpdateEntry
xmlHashUpdateEntry2
xmlHashUpdateEntry3
diff --git a/doc/APIchunk16.html b/doc/APIchunk16.html index 973c0e40..66697525 100644 --- a/doc/APIchunk16.html +++ b/doc/APIchunk16.html @@ -282,32 +282,6 @@ A:link, A:visited, A:active { text-decoration: underline }
loadsubset
XML_COMPLETE_ATTRS
XML_DETECT_IDS
XML_SKIP_IDS
-
local
_xmlNs
-endElementNsSAX2Func
-startElementNsSAX2Func
-xmlCatalogAddLocal
-xmlNamespaceParseQName
-xmlNoNetExternalEntityLoader
-xmlOutputBufferCreateFilename
-xmlSAX2EndElementNs
-xmlSAX2StartElementNs
-xmlSplitQName
-xmlSplitQName2
-xmlTextReaderConstLocalName
-xmlTextReaderConstName
-xmlTextReaderGetAttributeNs
-xmlTextReaderLocalName
-xmlTextReaderMoveToAttributeNs
-xmlTextReaderName
-xmlTextWriterStartAttributeNS
-xmlTextWriterStartElementNS
-xmlTextWriterWriteAttributeNS
-xmlTextWriterWriteElementNS
-xmlTextWriterWriteFormatAttributeNS
-xmlTextWriterWriteFormatElementNS
-xmlTextWriterWriteVFormatAttributeNS
-xmlTextWriterWriteVFormatElementNS
-xmlXPathLocalNameFunction
local-name
xmlXPathLocalNameFunction
localname
startElementNsSAX2Func
xmlSAX2StartElementNs
diff --git a/doc/html/libxml-catalog.html b/doc/html/libxml-catalog.html index 199f42bc..f4817b9a 100644 --- a/doc/html/libxml-catalog.html +++ b/doc/html/libxml-catalog.html @@ -76,10 +76,10 @@ The content of this structure is not made public by the API.
catal:a Catalog
value:the value to remove
Returns:the number of entries removed if successful, -1 otherwise

Function: xmlACatalogResolve

xmlChar *	xmlACatalogResolve	(xmlCatalogPtr catal, 
					 const xmlChar * pubID, 
					 const xmlChar * sysID)

Do a complete resolution lookup of an External Identifier

catal:a Catalog
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

Function: xmlACatalogResolvePublic

xmlChar *	xmlACatalogResolvePublic	(xmlCatalogPtr catal, 
						 const xmlChar * pubID)

-

Try to lookup the system ID associated to a public ID in that catalog

-
catal:a Catalog
pubID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlACatalogResolveSystem

xmlChar *	xmlACatalogResolveSystem	(xmlCatalogPtr catal, 
						 const xmlChar * sysID)

+

Try to lookup the catalog local reference associated to a public ID in that catalog

+
catal:a Catalog
pubID:the public ID string
Returns:the local resource if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlACatalogResolveSystem

xmlChar *	xmlACatalogResolveSystem	(xmlCatalogPtr catal, 
						 const xmlChar * sysID)

Try to lookup the catalog resource for a system ID

-
catal:a Catalog
sysID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlACatalogResolveURI

xmlChar *	xmlACatalogResolveURI	(xmlCatalogPtr catal, 
					 const xmlChar * URI)

+
catal:a Catalog
sysID:the system ID string
Returns:the resource if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlACatalogResolveURI
xmlChar *	xmlACatalogResolveURI	(xmlCatalogPtr catal, 
					 const xmlChar * URI)

 
Do a complete resolution lookup of an URI

 
catal:a Catalog
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlCatalogAdd
int	xmlCatalogAdd			(const xmlChar * type, 
					 const xmlChar * orig, 
					 const xmlChar * replace)

 
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();

@@ -96,10 +96,10 @@ The content of this structure is not made public by the API.
 
catalogs:a document's list of catalogs
Function: xmlCatalogGetDefaults
xmlCatalogAllow	xmlCatalogGetDefaults	(void)

 
Used to get the user preference w.r.t. to what catalogs should be accepted

 
Returns:the current xmlCatalogAllow value
Function: xmlCatalogGetPublic
const xmlChar *	xmlCatalogGetPublic	(const xmlChar * pubID)

-
Try to lookup the system ID associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()

-
pubID:the public ID string
Returns:the system ID if found or NULL otherwise.
Function: xmlCatalogGetSystem
const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

-
Try to lookup the system ID associated to a public ID DEPRECATED, use xmlCatalogResolveSystem()

-
sysID:the system ID string
Returns:the system ID if found or NULL otherwise.
Function: xmlCatalogIsEmpty
int	xmlCatalogIsEmpty		(xmlCatalogPtr catal)

+
Try to lookup the catalog reference associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()

+
pubID:the public ID string
Returns:the resource if found or NULL otherwise.
Function: xmlCatalogGetSystem
const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

+
Try to lookup the catalog reference associated to a system ID DEPRECATED, use xmlCatalogResolveSystem()

+
sysID:the system ID string
Returns:the resource if found or NULL otherwise.
Function: xmlCatalogIsEmpty
int	xmlCatalogIsEmpty		(xmlCatalogPtr catal)

 
Check is a catalog is empty

 
catal:should this create an SGML catalog
Returns:1 if the catalog is empty, 0 if not, amd -1 in case of error.
Function: xmlCatalogLocalResolve
xmlChar *	xmlCatalogLocalResolve	(void * catalogs, 
					 const xmlChar * pubID, 
					 const xmlChar * sysID)

 
Do a complete resolution lookup of an External Identifier using a document's private catalog list

@@ -110,10 +110,10 @@ The content of this structure is not made public by the API.
 
value:the value to remove
Returns:the number of entries removed if successful, -1 otherwise
Function: xmlCatalogResolve
xmlChar *	xmlCatalogResolve	(const xmlChar * pubID, 
					 const xmlChar * sysID)

 
Do a complete resolution lookup of an External Identifier

 
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlCatalogResolvePublic
xmlChar *	xmlCatalogResolvePublic	(const xmlChar * pubID)

-
Try to lookup the system ID associated to a public ID

-
pubID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogResolveSystem
xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

+
Try to lookup the catalog reference associated to a public ID

+
pubID:the public ID string
Returns:the resource if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogResolveSystem
xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

 
Try to lookup the catalog resource for a system ID

-
sysID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogResolveURI
xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

+
sysID:the system ID string
Returns:the resource if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogResolveURI
xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

 
Do a complete resolution lookup of an URI

 
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlCatalogSetDebug
int	xmlCatalogSetDebug		(int level)

 
Used to set the debug level for catalog operation, 0 disable debugging, 1 enable it

@@ -125,7 +125,7 @@ The content of this structure is not made public by the API.
 
Convert all the SGML catalog entries as XML ones

 
catal:the catalog
Returns:the number of entries converted if successful, -1 otherwise
Function: xmlFreeCatalog
void	xmlFreeCatalog			(xmlCatalogPtr catal)

 
Free the memory allocated to a Catalog

-
catal:a Catalog entry
Function: xmlInitializeCatalog
void	xmlInitializeCatalog		(void)

+
catal:a Catalog
Function: xmlInitializeCatalog
void	xmlInitializeCatalog		(void)

 
Do the catalog initialization. this function is not thread safe, catalog initialization should preferably be done once at startup

 
Function: xmlLoadACatalog
xmlCatalogPtr	xmlLoadACatalog		(const char * filename)

 
Load the catalog and build the associated data structures. This can be either an XML Catalog or an SGML Catalog It will recurse in SGML CATALOG entries. On the other hand XML Catalogs are not handled recursively.

diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html
index 301c8a4d..676e5ccf 100644
--- a/doc/html/libxml-tree.html
+++ b/doc/html/libxml-tree.html
@@ -602,7 +602,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 
Add a new element @elem to the list of siblings of @cur merging adjacent TEXT nodes (@elem may be freed) If the new element was already inserted in a document it is first unlinked from its existing context.

 
cur:the child node
elem:the new node
Returns:the new element or NULL in case of error.
Function: xmlAttrSerializeTxtContent
void	xmlAttrSerializeTxtContent	(xmlBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlAttrPtr attr, 
					 const xmlChar * string)

 
Serialize text attribute values to an xml simple buffer

-
buf:the XML buffer output
doc:the document
attr:the attribute node
string:
Function: xmlBufferAdd
void	xmlBufferAdd			(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

+
buf:the XML buffer output
doc:the document
attr:the attribute node
string:the text content
Function: xmlBufferAdd
void	xmlBufferAdd			(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

 
Add a string range to an XML buffer. if len == -1, the length of str is recomputed.

 
buf:the buffer to dump
str:the #xmlChar string
len:the number of #xmlChar to add
Function: xmlBufferAddHead
void	xmlBufferAddHead		(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

 
Add a string range to the beginning of an XML buffer. if len == -1, the length of @str is recomputed.

diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml
index 2b69a2d4..e6108a65 100644
--- a/doc/libxml2-api.xml
+++ b/doc/libxml2-api.xml
@@ -6518,16 +6518,16 @@ actually an xmlCharEncoding'/>
       
     
     
-      Try to lookup the system ID associated to a public ID in that catalog
-      
+      Try to lookup the catalog local reference associated to a public ID in that catalog
+      
       
       
     
     
       Try to lookup the catalog resource for a system ID
-      
+      
       
-      
+      
     
     
       Do a complete resolution lookup of an URI
@@ -6654,7 +6654,7 @@ actually an xmlCharEncoding'/>
       
       
       
-      
+      
     
     
       Compile the automata into a Reg Exp ready for being executed. The automata should be free after this point.
@@ -6984,13 +6984,13 @@ actually an xmlCharEncoding'/>
       
     
     
-      Try to lookup the system ID associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()
-      
+      Try to lookup the catalog reference associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()
+      
       
     
     
-      Try to lookup the system ID associated to a public ID DEPRECATED, use xmlCatalogResolveSystem()
-      
+      Try to lookup the catalog reference associated to a system ID DEPRECATED, use xmlCatalogResolveSystem()
+      
       
     
     
@@ -7023,14 +7023,14 @@ actually an xmlCharEncoding'/>
       
     
     
-      Try to lookup the system ID associated to a public ID
-      
+      Try to lookup the catalog reference associated to a public ID
+      
       
     
     
       Try to lookup the catalog resource for a system ID
-      
-      
+      
+      
     
     
       Do a complete resolution lookup of an URI
@@ -7773,7 +7773,7 @@ actually an xmlCharEncoding'/>
     
       Free the memory allocated to a Catalog
       
-      
+      
     
     
       Free up all the structures used by a document, tree included.
diff --git a/doc/libxml2-refs.xml b/doc/libxml2-refs.xml
index 7d9e3e08..007642c7 100644
--- a/doc/libxml2-refs.xml
+++ b/doc/libxml2-refs.xml
@@ -18832,7 +18832,6 @@
           
           
           
-          
           
           
           
@@ -21033,34 +21032,6 @@
           
           
         
-        
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-        
         
           
         
diff --git a/tree.c b/tree.c
index 12a83ceb..84290819 100644
--- a/tree.c
+++ b/tree.c
@@ -7007,7 +7007,7 @@ xmlSaveErr(int code, xmlNodePtr node, const char *extra)
  * @buf:  the XML buffer output
  * @doc:  the document
  * @attr: the attribute node
- * @value: the text content
+ * @string: the text content
  *
  * Serialize text attribute values to an xml simple buffer
  */
-- 
GitLab