applied 42 documentation patches from Charlie Bozeman. Regenerated the

* *.c include/libxml/*.h doc/html/*: applied 42 documentation patches from Charlie Bozeman. Regenerated the HTML docs. Daniel
2025-07-14 20:01:04 +03:00 · 2001-12-31 16:16:02 +00:00
parent 7f9a6806ed
commit cbaf399537
70 changed files with 3535 additions and 3170 deletions
--- a/doc/html/libxml-debugxml.html
+++ b/doc/html/libxml-debugxml.html
@ -123,7 +123,7 @@ NAME="LIBXML-DEBUGXML"
 ><DIV
 CLASS="REFNAMEDIV"
 ><A
-NAME="AEN25191"
+NAME="AEN25274"
 ></A
 ><H2
 >Name</H2
@ -131,7 +131,7 @@ NAME="AEN25191"
 ><DIV
 CLASS="REFSYNOPSISDIV"
 ><A
-NAME="AEN25194"
+NAME="AEN25277"
 ></A
 ><H2
 >Synopsis</H2
@ -279,10 +279,6 @@ HREF="libxml-debugxml.html#XMLLSCOUNTNODE"
 HREF="libxml-tree.html#XMLNODEPTR"
 >xmlNodePtr</A
 > node);
-const char* <A
-HREF="libxml-debugxml.html#XMLBOOLTOTEXT"
->xmlBoolToText</A
->                   (int boolval);
 char*       (<A
 HREF="libxml-debugxml.html#XMLSHELLREADLINEFUNC"
 >*xmlShellReadlineFunc</A
@ -513,7 +509,7 @@ HREF="FILE-CAPS"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN25289"
+NAME="AEN25371"
 ></A
 ><H2
 >Description</H2
@ -523,14 +519,14 @@ NAME="AEN25289"
 ><DIV
 CLASS="REFSECT1"
 ><A
-NAME="AEN25292"
+NAME="AEN25374"
 ></A
 ><H2
 >Details</H2
 ><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25294"
+NAME="AEN25376"
 ></A
 ><H3
 ><A
@ -564,7 +560,7 @@ HREF="libxml-tree.html#XMLCHAR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25302"
+NAME="AEN25384"
 ></A
 ><P
 ></P
@ -619,7 +615,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25315"
+NAME="AEN25397"
 ></A
 ><H3
 ><A
@ -654,7 +650,7 @@ HREF="libxml-tree.html#XMLATTRPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25323"
+NAME="AEN25405"
 ></A
 ><P
 ></P
@ -726,7 +722,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25340"
+NAME="AEN25422"
 ></A
 ><H3
 ><A
@ -761,7 +757,7 @@ HREF="libxml-tree.html#XMLATTRPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25348"
+NAME="AEN25430"
 ></A
 ><P
 ></P
@ -833,7 +829,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25365"
+NAME="AEN25447"
 ></A
 ><H3
 ><A
@ -868,7 +864,7 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25373"
+NAME="AEN25455"
 ></A
 ><P
 ></P
@ -940,7 +936,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25390"
+NAME="AEN25472"
 ></A
 ><H3
 ><A
@ -975,7 +971,7 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25398"
+NAME="AEN25480"
 ></A
 ><P
 ></P
@ -1047,7 +1043,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25415"
+NAME="AEN25497"
 ></A
 ><H3
 ><A
@ -1082,7 +1078,7 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25423"
+NAME="AEN25505"
 ></A
 ><P
 ></P
@ -1154,7 +1150,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25440"
+NAME="AEN25522"
 ></A
 ><H3
 ><A
@ -1188,7 +1184,7 @@ HREF="libxml-tree.html#XMLDOCPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25448"
+NAME="AEN25530"
 ></A
 ><P
 ></P
@ -1243,7 +1239,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25461"
+NAME="AEN25543"
 ></A
 ><H3
 ><A
@ -1277,7 +1273,7 @@ HREF="libxml-tree.html#XMLDOCPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25469"
+NAME="AEN25551"
 ></A
 ><P
 ></P
@ -1332,7 +1328,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25482"
+NAME="AEN25564"
 ></A
 ><H3
 ><A
@ -1366,7 +1362,7 @@ HREF="libxml-tree.html#XMLDTDPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25490"
+NAME="AEN25572"
 ></A
 ><P
 ></P
@ -1421,7 +1417,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25503"
+NAME="AEN25585"
 ></A
 ><H3
 ><A
@ -1455,7 +1451,7 @@ HREF="libxml-tree.html#XMLDOCPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25511"
+NAME="AEN25593"
 ></A
 ><P
 ></P
@ -1510,7 +1506,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25524"
+NAME="AEN25606"
 ></A
 ><H3
 ><A
@ -1538,11 +1534,23 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ></TR
 ></TABLE
 ><P
+>Dump to <TT
+CLASS="PARAMETER"
+><I
+>output</I
+></TT
+> the type and name of <TT
+CLASS="PARAMETER"
+><I
+>node</I
+></TT
+>.</P
+><P
 ></P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25531"
+NAME="AEN25616"
 ></A
 ><P
 ></P
@ -1569,7 +1577,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->&nbsp;</TD
+>  the FILE * for the output</TD
 ></TR
 ><TR
 ><TD
@ -1586,7 +1594,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->&nbsp;</TD
+>  the node to dump</TD
 ></TR
 ></TBODY
 ></TABLE
@ -1597,7 +1605,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25544"
+NAME="AEN25629"
 ></A
 ><H3
 ><A
@ -1621,11 +1629,18 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ></TR
 ></TABLE
 ><P
+>Count the children of <TT
+CLASS="PARAMETER"
+><I
+>node</I
+></TT
+>.</P
+><P
 ></P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25550"
+NAME="AEN25637"
 ></A
 ><P
 ></P
@ -1652,7 +1667,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->&nbsp;</TD
+>  the node to count</TD
 ></TR
 ><TR
 ><TD
@ -1667,87 +1682,12 @@ CLASS="EMPHASIS"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->&nbsp;</TD
-></TR
-></TBODY
-></TABLE
-><P
-></P
-></DIV
-></DIV
-><HR><DIV
-CLASS="REFSECT2"
-><A
-NAME="AEN25563"
-></A
-><H3
-><A
-NAME="XMLBOOLTOTEXT"
-></A
->xmlBoolToText ()</H3
-><TABLE
-BORDER="0"
-BGCOLOR="#D6E8FF"
-WIDTH="100%"
-CELLPADDING="6"
-><TR
-><TD
-><PRE
-CLASS="PROGRAMLISTING"
->const char* xmlBoolToText                   (int boolval);</PRE
-></TD
-></TR
-></TABLE
-><P
->Convenient way to turn bool into text</P
-><P
-></P
-><DIV
-CLASS="INFORMALTABLE"
-><A
-NAME="AEN25569"
-></A
-><P
-></P
-><TABLE
-BORDER="0"
-WIDTH="100%"
-BGCOLOR="#FFD0D0"
-CELLSPACING="0"
-CELLPADDING="4"
-CLASS="CALSTABLE"
-><TBODY
-><TR
-><TD
-WIDTH="20%"
-ALIGN="RIGHT"
-VALIGN="TOP"
-><TT
+>the number of children of <TT
 CLASS="PARAMETER"
 ><I
->boolval</I
+>node</I
 ></TT
->&nbsp;:</TD
-><TD
-WIDTH="80%"
-ALIGN="LEFT"
-VALIGN="TOP"
-> a bool to turn into text</TD
-></TR
-><TR
-><TD
-WIDTH="20%"
-ALIGN="RIGHT"
-VALIGN="TOP"
-><I
-CLASS="EMPHASIS"
->Returns</I
-> :</TD
-><TD
-WIDTH="80%"
-ALIGN="LEFT"
-VALIGN="TOP"
->&nbsp;</TD
+>.</TD
 ></TR
 ></TBODY
 ></TABLE
@ -1758,7 +1698,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25582"
+NAME="AEN25651"
 ></A
 ><H3
 ><A
@ -1785,7 +1725,7 @@ CLASS="PROGRAMLISTING"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25588"
+NAME="AEN25657"
 ></A
 ><P
 ></P
@ -1838,7 +1778,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25601"
+NAME="AEN25670"
 ></A
 ><H3
 ><A
@ -1875,7 +1815,7 @@ TODO: add the defined function tables.</P
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25607"
+NAME="AEN25676"
 ></A
 ><H3
 ><A
@ -1901,7 +1841,7 @@ CLASS="PROGRAMLISTING"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25612"
+NAME="AEN25681"
 ></A
 ><H3
 ><A
@ -1940,7 +1880,7 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25621"
+NAME="AEN25690"
 ></A
 ><P
 ></P
@ -2044,7 +1984,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25646"
+NAME="AEN25715"
 ></A
 ><H3
 ><A
@ -2066,11 +2006,13 @@ CLASS="PROGRAMLISTING"
 ></TR
 ></TABLE
 ><P
+>Print the xpath error to libxml default error channel</P
+><P
 ></P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25651"
+NAME="AEN25721"
 ></A
 ><P
 ></P
@ -2097,7 +2039,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->&nbsp;</TD
+> valid xpath error id</TD
 ></TR
 ><TR
 ><TD
@ -2114,7 +2056,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->&nbsp;</TD
+> the argument that cause xpath to fail</TD
 ></TR
 ></TBODY
 ></TABLE
@ -2125,7 +2067,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25664"
+NAME="AEN25734"
 ></A
 ><H3
 ><A
@ -2155,7 +2097,7 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25671"
+NAME="AEN25741"
 ></A
 ><P
 ></P
@ -2193,7 +2135,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25680"
+NAME="AEN25750"
 ></A
 ><H3
 ><A
@ -2223,7 +2165,7 @@ HREF="libxml-xpath.html#XMLXPATHOBJECTPTR"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25687"
+NAME="AEN25757"
 ></A
 ><P
 ></P
@ -2261,7 +2203,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25696"
+NAME="AEN25766"
 ></A
 ><H3
 ><A
@ -2301,7 +2243,7 @@ Does an Unix like listing of the given node (like a directory)</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25705"
+NAME="AEN25775"
 ></A
 ><P
 ></P
@ -2405,7 +2347,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25730"
+NAME="AEN25800"
 ></A
 ><H3
 ><A
@ -2445,7 +2387,7 @@ dumps the current XML base of the node</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25739"
+NAME="AEN25809"
 ></A
 ><P
 ></P
@ -2549,7 +2491,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25764"
+NAME="AEN25834"
 ></A
 ><H3
 ><A
@ -2589,7 +2531,7 @@ dumps informations about the node (namespace, attributes, content).</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25773"
+NAME="AEN25843"
 ></A
 ><P
 ></P
@ -2693,7 +2635,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25798"
+NAME="AEN25868"
 ></A
 ><H3
 ><A
@ -2733,7 +2675,7 @@ dumps the serialization node content (XML or HTML).</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25807"
+NAME="AEN25877"
 ></A
 ><P
 ></P
@ -2837,7 +2779,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25832"
+NAME="AEN25902"
 ></A
 ><H3
 ><A
@ -2877,7 +2819,7 @@ loads a new document specified by the filename</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25841"
+NAME="AEN25911"
 ></A
 ><P
 ></P
@ -2981,7 +2923,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25866"
+NAME="AEN25936"
 ></A
 ><H3
 ><A
@ -3015,7 +2957,7 @@ HREF="libxml-tree.html#XMLNODEPTR"
 ></TABLE
 ><P
 >Implements the XML shell function "write"
-Write the current node to the filename, it saves the serailization
+Write the current node to the filename, it saves the serialization
 of the subtree under the <TT
 CLASS="PARAMETER"
 ><I
@ -3027,7 +2969,7 @@ CLASS="PARAMETER"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25876"
+NAME="AEN25946"
 ></A
 ><P
 ></P
@ -3131,7 +3073,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25901"
+NAME="AEN25971"
 ></A
 ><H3
 ><A
@ -3171,7 +3113,7 @@ Write the current document to the filename, or it's original name</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25910"
+NAME="AEN25980"
 ></A
 ><P
 ></P
@ -3215,7 +3157,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->  the file name (optionnal)</TD
+>  the file name (optional)</TD
 ></TR
 ><TR
 ><TD
@ -3275,7 +3217,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25935"
+NAME="AEN26005"
 ></A
 ><H3
 ><A
@ -3316,7 +3258,7 @@ is done against the given DTD.</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25944"
+NAME="AEN26014"
 ></A
 ><P
 ></P
@ -3360,7 +3302,7 @@ CLASS="PARAMETER"
 WIDTH="80%"
 ALIGN="LEFT"
 VALIGN="TOP"
->  the DTD URI (optionnal)</TD
+>  the DTD URI (optional)</TD
 ></TR
 ><TR
 ><TD
@ -3420,7 +3362,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN25969"
+NAME="AEN26039"
 ></A
 ><H3
 ><A
@ -3471,7 +3413,7 @@ CLASS="PARAMETER"
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN25980"
+NAME="AEN26050"
 ></A
 ><P
 ></P
@ -3575,7 +3517,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN26005"
+NAME="AEN26075"
 ></A
 ><H3
 ><A
@ -3617,7 +3559,7 @@ The output is compatible with XPath commands.</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN26014"
+NAME="AEN26084"
 ></A
 ><P
 ></P
@ -3721,7 +3663,7 @@ VALIGN="TOP"
 ><HR><DIV
 CLASS="REFSECT2"
 ><A
-NAME="AEN26039"
+NAME="AEN26109"
 ></A
 ><H3
 ><A
@ -3762,7 +3704,7 @@ using a environment similar to a UNIX commandline.</P
 ><DIV
 CLASS="INFORMALTABLE"
 ><A
-NAME="AEN26048"
+NAME="AEN26118"
 ></A
 ><P
 ></P