From 7a82165d2e28e39326eae0e49242bd59d06752e9 Mon Sep 17 00:00:00 2001 From: "William M. Brack" Date: Fri, 15 Aug 2003 07:27:40 +0000 Subject: [PATCH] Minor changes to comments, etc. for improving documentation generation * encoding.c, threads.c, include/libxml/HTMLparser.h, doc/libxml2-api.xml: Minor changes to comments, etc. for improving documentation generation * doc/Makefile.am: further adjustment to auto-generation of win32/libxml2.def.src --- ChangeLog | 8 + doc/Makefile.am | 4 +- doc/libxml2-api.xml | 1001 ++++++++++++++++++----------------- encoding.c | 9 +- include/libxml/HTMLparser.h | 22 + threads.c | 7 +- 6 files changed, 548 insertions(+), 503 deletions(-) diff --git a/ChangeLog b/ChangeLog index 07e259d9..ec6ddd4b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +Fri Aug 15 14:58:37 HKT 2003 William Brack + + * encoding.c, threads.c, include/libxml/HTMLparser.h, + doc/libxml2-api.xml: Minor changes to comments, etc. for + improving documentation generation + * doc/Makefile.am: further adjustment to auto-generation of + win32/libxml2.def.src + Fri Aug 15 02:24:20 CEST 2003 Daniel Veillard * News configure.in: preparing libxml2-2.5.10 release diff --git a/doc/Makefile.am b/doc/Makefile.am index cb7d4c9c..b51354c7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -69,10 +69,10 @@ xml: templates -gtkdoc-mkdb --module=libxml --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --main-sgml-file=$(DOC_MAIN_XML_FILE) -libxml2-api.xml: apibuild.py ../include/libxml/*.h +libxml2-api.xml: apibuild.py ../include/libxml/*.h ../*.c -(./apibuild.py) -$(WIN32_DIR)/libxml2.def.src: +$(WIN32_DIR)/libxml2.def.src: libxml2-api.xml -@(if [ -x $(bindir)/xsltproc ] ; then \ $(bindir)/xsltproc -o $(WIN32_DIR)/libxml2.def.src \ --nonet $(WIN32_DIR)/defgen.xsl libxml2-api.xml ; fi ) diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index b0c12ba6..e804fcb0 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -1,108 +1,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -222,6 +120,242 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -429,6 +563,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -501,19 +670,6 @@ - - - - - - - - - - - - - @@ -642,6 +798,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -705,40 +895,76 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1298,126 +1524,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1502,6 +1608,97 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1942,157 +2139,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2110,66 +2156,20 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + @@ -2452,10 +2452,17 @@ + Returns the default subelement for this element + + Checks whether an HTML element description may be a direct child of the specified element. Returns 1 if allowed; 0 otherwise. + + + Returns the attributes required for the specified element. + Macro for compatibility naming layer with libxml1. @@ -6763,9 +6770,9 @@ actually an xmlCharEncoding'/> - a free() equivalent, with error checking. + - + Provides the memory access functions set currently in use @@ -6776,15 +6783,15 @@ actually an xmlCharEncoding'/> - a malloc() equivalent, with logging of the allocation info. - - + + + - a realloc() equivalent, with logging of the allocation info. - - - + + + + Override the default memory access functions with a new set This has to be called before any other libxml routines ! Should this be blocked if there was already some allocations done ? @@ -6816,9 +6823,9 @@ actually an xmlCharEncoding'/> - a strdup() equivalent, with logging of the allocation info. - - + + + xmlMutexLock() is used to lock a libxml2 token. @@ -10052,13 +10059,13 @@ actually an xmlCharEncoding'/> - - - - + compares the two UCS4 values + + + - + calulates the internal size of a UTF8 character diff --git a/encoding.c b/encoding.c index 2d3ccd0f..90fd38c1 100644 --- a/encoding.c +++ b/encoding.c @@ -92,6 +92,8 @@ static int xmlLittleEndian = 1; * xmlUTF8Size: * @utf: pointer to the UTF8 character * + * calulates the internal size of a UTF8 character + * * returns the numbers of bytes in the character, -1 on format error */ int @@ -117,12 +119,13 @@ xmlUTF8Size(const xmlChar *utf) { } /** - * xmlUTF8Charcmp + * xmlUTF8Charcmp: * @utf1: pointer to first UTF8 char * @utf2: pointer to second UTF8 char * - * returns result of comparing the two UCS4 values - * as with xmlStrncmp + * compares the two UCS4 values + * + * returns result of the compare as with xmlStrncmp */ int xmlUTF8Charcmp(const xmlChar *utf1, const xmlChar *utf2) { diff --git a/include/libxml/HTMLparser.h b/include/libxml/HTMLparser.h index 1c90c0b5..975d6cf4 100644 --- a/include/libxml/HTMLparser.h +++ b/include/libxml/HTMLparser.h @@ -149,9 +149,31 @@ htmlStatus htmlAttrAllowed(const htmlElemDesc*, const xmlChar*, int) ; int htmlElementAllowedHere(const htmlElemDesc*, const xmlChar*) ; htmlStatus htmlElementStatusHere(const htmlElemDesc*, const htmlElemDesc*) ; htmlStatus htmlNodeStatus(const htmlNodePtr, int) ; +/** + * htmlDefaultSubelement: + * @elt: HTML element + * + * Returns the default subelement for this element + */ #define htmlDefaultSubelement(elt) elt->defaultsubelt +/** + * htmlElementAllowedHereDesc: + * @parent: HTML parent element + * @elt: HTML element + * + * Checks whether an HTML element description may be a + * direct child of the specified element. + * + * Returns 1 if allowed; 0 otherwise. + */ #define htmlElementAllowedHereDesc(parent,elt) \ htmlElementAllowedHere((parent), (elt)->name) +/** + * htmlRequiredAttrs: + * @elt: HTML element + * + * Returns the attributes required for the specified element. + */ #define htmlRequiredAttrs(elt) (elt)->attrs_req diff --git a/threads.c b/threads.c index 8e7a08cb..8db1aac2 100644 --- a/threads.c +++ b/threads.c @@ -546,10 +546,15 @@ xmlOnceInit(void) { } /** - * DllMain + * DllMain: + * @hinstDLL: handle to DLL instance + * @fdwReason: Reason code for entry + * @lpvReserved: generic pointer (depends upon reason code) * * Entry point for Windows library. It is being used to free thread-specific * storage. + * + * Returns TRUE always */ #if defined(HAVE_WIN32_THREADS) && !defined(LIBXML_STATIC) BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)