Skip to content
This repository was archived by the owner on Jan 26, 2026. It is now read-only.

Commit 7a94fd0

Browse files
nwellnhofnwellnhof
committed
doc: Update documentation
1 parent d3fafde commit 7a94fd0

34 files changed

Lines changed: 2302 additions & 1308 deletions

‎doc/devhelp/libxml2-HTMLparser.html‎

Lines changed: 108 additions & 74 deletions
Large diffs are not rendered by default.

‎doc/devhelp/libxml2-SAX.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ <h3>
827827
<a name="setDocumentLocator"></a>setDocumentLocator ()</h3>
828828
<pre class="programlisting">void setDocumentLocator (void * ctx, <br> <a href="libxml2-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc)<br>
829829
</pre>
830-
<p>Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case. DEPRECATED</p>
830+
<p>Receive the document locator at startup, actually <a href="libxml2-parser.html#xmlDefaultSAXLocator">xmlDefaultSAXLocator</a> Everything is available on the context, so this is useless in our case. DEPRECATED</p>
831831
<div class="variablelist"><table border="0">
832832
<col align="left">
833833
<tbody>

‎doc/devhelp/libxml2-SAX2.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ <h3>
750750
<a name="xmlSAX2SetDocumentLocator"></a>xmlSAX2SetDocumentLocator ()</h3>
751751
<pre class="programlisting">void xmlSAX2SetDocumentLocator (void * ctx, <br> <a href="libxml2-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc)<br>
752752
</pre>
753-
<p>Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case.</p>
753+
<p>Receive the document locator at startup, actually <a href="libxml2-parser.html#xmlDefaultSAXLocator">xmlDefaultSAXLocator</a> Everything is available on the context, so this is useless in our case.</p>
754754
<div class="variablelist"><table border="0">
755755
<col align="left">
756756
<tbody>

‎doc/devhelp/libxml2-debugXML.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ <h2>Synopsis</h2>
3838
void <a href="#xmlDebugDumpString">xmlDebugDumpString</a> (FILE * output, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str);
3939
int <a href="#xmlLsCountNode">xmlLsCountNode</a> (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node);
4040
void <a href="#xmlLsOneNode">xmlLsOneNode</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node);
41-
void <a href="#xmlShell">xmlShell</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> char * filename, <br> <a href="libxml2-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input, <br> FILE * output);
41+
void <a href="#xmlShell">xmlShell</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> const char * filename, <br> <a href="libxml2-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input, <br> FILE * output);
4242
int <a href="#xmlShellBase">xmlShellBase</a> (<a href="libxml2-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt, <br> char * arg, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
4343
int <a href="#xmlShellCat">xmlShellCat</a> (<a href="libxml2-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt, <br> char * arg, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
4444
typedef int <a href="#xmlShellCmd">xmlShellCmd</a> (<a href="libxml2-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt, <br> char * arg, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
@@ -460,7 +460,7 @@ <h3>
460460
<div class="refsect2" lang="en">
461461
<h3>
462462
<a name="xmlShell"></a>xmlShell ()</h3>
463-
<pre class="programlisting">void xmlShell (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> char * filename, <br> <a href="libxml2-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input, <br> FILE * output)<br>
463+
<pre class="programlisting">void xmlShell (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> const char * filename, <br> <a href="libxml2-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input, <br> FILE * output)<br>
464464
</pre>
465465
<p>Implements the XML shell This allow to load, validate, view, modify and save a document using a environment similar to a UNIX commandline.</p>
466466
<div class="variablelist"><table border="0">

‎doc/devhelp/libxml2-encoding.html‎

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ <h2>Synopsis</h2>
4444
const char * <a href="#xmlGetCharEncodingName">xmlGetCharEncodingName</a> (<a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
4545
const char * <a href="#xmlGetEncodingAlias">xmlGetEncodingAlias</a> (const char * alias);
4646
void <a href="#xmlInitCharEncodingHandlers">xmlInitCharEncodingHandlers</a> (void);
47+
int <a href="#xmlLookupCharEncodingHandler">xmlLookupCharEncodingHandler</a> (<a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc, <br> <a href="libxml2-encoding.html#xmlCharEncodingHandler">xmlCharEncodingHandler</a> ** out);
4748
<a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> <a href="#xmlNewCharEncodingHandler">xmlNewCharEncodingHandler</a> (const char * name, <br> <a href="libxml2-encoding.html#xmlCharEncodingInputFunc">xmlCharEncodingInputFunc</a> input, <br> <a href="libxml2-encoding.html#xmlCharEncodingOutputFunc">xmlCharEncodingOutputFunc</a> output);
49+
int <a href="#xmlOpenCharEncodingHandler">xmlOpenCharEncodingHandler</a> (const char * name, <br> int output, <br> <a href="libxml2-encoding.html#xmlCharEncodingHandler">xmlCharEncodingHandler</a> ** out);
4850
<a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> <a href="#xmlParseCharEncoding">xmlParseCharEncoding</a> (const char * name);
4951
void <a href="#xmlRegisterCharEncodingHandler">xmlRegisterCharEncodingHandler</a> (<a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> handler);
5052
</pre>
@@ -457,7 +459,7 @@ <h3>
457459
<a name="xmlFindCharEncodingHandler"></a>xmlFindCharEncodingHandler ()</h3>
458460
<pre class="programlisting"><a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> xmlFindCharEncodingHandler (const char * name)<br>
459461
</pre>
460-
<p>Search in the registered set the handler able to read/write that encoding or create a new one.</p>
462+
<p>DEPRECATED: Use <a href="libxml2-encoding.html#xmlOpenCharEncodingHandler">xmlOpenCharEncodingHandler</a> which has better error reporting.</p>
461463
<div class="variablelist"><table border="0">
462464
<col align="left">
463465
<tbody>
@@ -467,7 +469,7 @@ <h3>
467469
</tr>
468470
<tr>
469471
<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
470-
<td>the handler or NULL if not found</td>
472+
<td>the handler or NULL if no handler was found or an error occurred.</td>
471473
</tr>
472474
</tbody>
473475
</table></div>
@@ -478,7 +480,7 @@ <h3>
478480
<a name="xmlGetCharEncodingHandler"></a>xmlGetCharEncodingHandler ()</h3>
479481
<pre class="programlisting"><a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> xmlGetCharEncodingHandler (<a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc)<br>
480482
</pre>
481-
<p>Search in the registered set the handler able to read/write that encoding.</p>
483+
<p>DEPRECATED: Use <a href="libxml2-encoding.html#xmlLookupCharEncodingHandler">xmlLookupCharEncodingHandler</a> which has better error reporting.</p>
482484
<div class="variablelist"><table border="0">
483485
<col align="left">
484486
<tbody>
@@ -488,7 +490,7 @@ <h3>
488490
</tr>
489491
<tr>
490492
<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
491-
<td>the handler or NULL if not found</td>
493+
<td>the handler or NULL if no handler was found or an error occurred.</td>
492494
</tr>
493495
</tbody>
494496
</table></div>
@@ -546,6 +548,31 @@ <h3>
546548
<hr>
547549
<div class="refsect2" lang="en">
548550
<h3>
551+
<a name="xmlLookupCharEncodingHandler"></a>xmlLookupCharEncodingHandler ()</h3>
552+
<pre class="programlisting">int xmlLookupCharEncodingHandler (<a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc, <br> <a href="libxml2-encoding.html#xmlCharEncodingHandler">xmlCharEncodingHandler</a> ** out)<br>
553+
</pre>
554+
<p>Find or create a handler matching the encoding. If no default or registered handler could be found, try to create a handler using iconv or ICU if supported. The handler must be closed with <a href="libxml2-encoding.html#xmlCharEncCloseFunc">xmlCharEncCloseFunc</a>. Available since 2.13.0.</p>
555+
<div class="variablelist"><table border="0">
556+
<col align="left">
557+
<tbody>
558+
<tr>
559+
<td><span class="term"><i><tt>enc</tt></i>:</span></td>
560+
<td>an <a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> value.</td>
561+
</tr>
562+
<tr>
563+
<td><span class="term"><i><tt>out</tt></i>:</span></td>
564+
<td>pointer to result</td>
565+
</tr>
566+
<tr>
567+
<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
568+
<td>an <a href="libxml2-xmlerror.html#xmlParserErrors">xmlParserErrors</a> error code.</td>
569+
</tr>
570+
</tbody>
571+
</table></div>
572+
</div>
573+
<hr>
574+
<div class="refsect2" lang="en">
575+
<h3>
549576
<a name="xmlNewCharEncodingHandler"></a>xmlNewCharEncodingHandler ()</h3>
550577
<pre class="programlisting"><a href="libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> xmlNewCharEncodingHandler (const char * name, <br> <a href="libxml2-encoding.html#xmlCharEncodingInputFunc">xmlCharEncodingInputFunc</a> input, <br> <a href="libxml2-encoding.html#xmlCharEncodingOutputFunc">xmlCharEncodingOutputFunc</a> output)<br>
551578
</pre>
@@ -575,6 +602,35 @@ <h3>
575602
<hr>
576603
<div class="refsect2" lang="en">
577604
<h3>
605+
<a name="xmlOpenCharEncodingHandler"></a>xmlOpenCharEncodingHandler ()</h3>
606+
<pre class="programlisting">int xmlOpenCharEncodingHandler (const char * name, <br> int output, <br> <a href="libxml2-encoding.html#xmlCharEncodingHandler">xmlCharEncodingHandler</a> ** out)<br>
607+
</pre>
608+
<p>Find or create a handler matching the encoding. If no default or registered handler could be found, try to create a handler using iconv or ICU if supported. The handler must be closed with <a href="libxml2-encoding.html#xmlCharEncCloseFunc">xmlCharEncCloseFunc</a>. Available since 2.13.0.</p>
609+
<div class="variablelist"><table border="0">
610+
<col align="left">
611+
<tbody>
612+
<tr>
613+
<td><span class="term"><i><tt>name</tt></i>:</span></td>
614+
<td>a string describing the char encoding.</td>
615+
</tr>
616+
<tr>
617+
<td><span class="term"><i><tt>output</tt></i>:</span></td>
618+
<td>boolean, use handler for output</td>
619+
</tr>
620+
<tr>
621+
<td><span class="term"><i><tt>out</tt></i>:</span></td>
622+
<td>pointer to result</td>
623+
</tr>
624+
<tr>
625+
<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
626+
<td>an <a href="libxml2-xmlerror.html#xmlParserErrors">xmlParserErrors</a> error code.</td>
627+
</tr>
628+
</tbody>
629+
</table></div>
630+
</div>
631+
<hr>
632+
<div class="refsect2" lang="en">
633+
<h3>
578634
<a name="xmlParseCharEncoding"></a>xmlParseCharEncoding ()</h3>
579635
<pre class="programlisting"><a href="libxml2-encoding.html#xmlCharEncoding">xmlCharEncoding</a> xmlParseCharEncoding (const char * name)<br>
580636
</pre>

‎doc/devhelp/libxml2-entities.html‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ <h2>Synopsis</h2>
2727
typedef enum <a href="#xmlEntityType">xmlEntityType</a>;
2828
<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="#xmlAddDocEntity">xmlAddDocEntity</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content);
2929
<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="#xmlAddDtdEntity">xmlAddDtdEntity</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content);
30+
int <a href="#xmlAddEntity">xmlAddEntity</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> int extSubset, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content, <br> <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> * out);
3031
void <a href="#xmlCleanupPredefinedEntities">xmlCleanupPredefinedEntities</a> (void);
3132
<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> <a href="#xmlCopyEntitiesTable">xmlCopyEntitiesTable</a> (<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> table);
3233
<a href="libxml2-entities.html#xmlEntitiesTablePtr">xmlEntitiesTablePtr</a> <a href="#xmlCreateEntitiesTable">xmlCreateEntitiesTable</a> (void);
@@ -166,6 +167,55 @@ <h3>
166167
<hr>
167168
<div class="refsect2" lang="en">
168169
<h3>
170+
<a name="xmlAddEntity"></a>xmlAddEntity ()</h3>
171+
<pre class="programlisting">int xmlAddEntity (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br> int extSubset, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content, <br> <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> * out)<br>
172+
</pre>
173+
<p>Register a new entity for this document. Available since 2.13.0.</p>
174+
<div class="variablelist"><table border="0">
175+
<col align="left">
176+
<tbody>
177+
<tr>
178+
<td><span class="term"><i><tt>doc</tt></i>:</span></td>
179+
<td>the document</td>
180+
</tr>
181+
<tr>
182+
<td><span class="term"><i><tt>extSubset</tt></i>:</span></td>
183+
<td>add to the external or internal subset</td>
184+
</tr>
185+
<tr>
186+
<td><span class="term"><i><tt>name</tt></i>:</span></td>
187+
<td>the entity name</td>
188+
</tr>
189+
<tr>
190+
<td><span class="term"><i><tt>type</tt></i>:</span></td>
191+
<td>the entity type XML_xxx_yyy_ENTITY</td>
192+
</tr>
193+
<tr>
194+
<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td>
195+
<td>the entity external ID if available</td>
196+
</tr>
197+
<tr>
198+
<td><span class="term"><i><tt>SystemID</tt></i>:</span></td>
199+
<td>the entity system ID if available</td>
200+
</tr>
201+
<tr>
202+
<td><span class="term"><i><tt>content</tt></i>:</span></td>
203+
<td>the entity content</td>
204+
</tr>
205+
<tr>
206+
<td><span class="term"><i><tt>out</tt></i>:</span></td>
207+
<td>pointer to resulting entity (optional)</td>
208+
</tr>
209+
<tr>
210+
<td><span class="term"><i><tt>Returns</tt></i>:</span></td>
211+
<td>an <a href="libxml2-xmlerror.html#xmlParserErrors">xmlParserErrors</a> error code.</td>
212+
</tr>
213+
</tbody>
214+
</table></div>
215+
</div>
216+
<hr>
217+
<div class="refsect2" lang="en">
218+
<h3>
169219
<a name="xmlCleanupPredefinedEntities"></a>xmlCleanupPredefinedEntities ()</h3>
170220
<pre class="programlisting">void xmlCleanupPredefinedEntities (void)<br>
171221
</pre>
@@ -345,12 +395,12 @@ <h3>
345395
<a name="xmlFreeEntity"></a>xmlFreeEntity ()</h3>
346396
<pre class="programlisting">void xmlFreeEntity (<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity)<br>
347397
</pre>
348-
<p></p>
398+
<p>Frees the entity.</p>
349399
<div class="variablelist"><table border="0">
350400
<col align="left">
351401
<tbody><tr>
352402
<td><span class="term"><i><tt>entity</tt></i>:</span></td>
353-
<td></td>
403+
<td>an entity</td>
354404
</tr></tbody>
355405
</table></div>
356406
</div>

‎doc/devhelp/libxml2-globals.html‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ <h2><span class="refentrytitle">globals</span></h2>
2424
<h2>Synopsis</h2>
2525
<pre class="synopsis">typedef struct _xmlGlobalState <a href="#xmlGlobalState">xmlGlobalState</a>;
2626
typedef <a href="libxml2-globals.html#xmlGlobalState">xmlGlobalState</a> * <a href="#xmlGlobalStatePtr">xmlGlobalStatePtr</a>;
27-
void <a href="#xmlCleanupGlobals">xmlCleanupGlobals</a> (void);
2827
<a href="libxml2-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> <a href="#xmlGetGlobalState">xmlGetGlobalState</a> (void);
29-
void <a href="#xmlInitGlobals">xmlInitGlobals</a> (void);
3028
void <a href="#xmlInitializeGlobalState">xmlInitializeGlobalState</a> (<a href="libxml2-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> gs);
3129
</pre>
3230
</div>
@@ -54,14 +52,6 @@ <h3>
5452
<hr>
5553
<div class="refsect2" lang="en">
5654
<h3>
57-
<a name="xmlCleanupGlobals"></a>xmlCleanupGlobals ()</h3>
58-
<pre class="programlisting">void xmlCleanupGlobals (void)<br>
59-
</pre>
60-
<p>DEPRECATED: This function is a no-op. Call <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> to free global state but see the warnings there. <a href="libxml2-parser.html#xmlCleanupParser">xmlCleanupParser</a> should be only called once at program exit. In most cases, you don't have call cleanup functions at all.</p>
61-
</div>
62-
<hr>
63-
<div class="refsect2" lang="en">
64-
<h3>
6555
<a name="xmlGetGlobalState"></a>xmlGetGlobalState ()</h3>
6656
<pre class="programlisting"><a href="libxml2-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> xmlGetGlobalState (void)<br>
6757
</pre>
@@ -77,14 +67,6 @@ <h3>
7767
<hr>
7868
<div class="refsect2" lang="en">
7969
<h3>
80-
<a name="xmlInitGlobals"></a>xmlInitGlobals ()</h3>
81-
<pre class="programlisting">void xmlInitGlobals (void)<br>
82-
</pre>
83-
<p>DEPRECATED: Alias for <a href="libxml2-parser.html#xmlInitParser">xmlInitParser</a>.</p>
84-
</div>
85-
<hr>
86-
<div class="refsect2" lang="en">
87-
<h3>
8870
<a name="xmlInitializeGlobalState"></a>xmlInitializeGlobalState ()</h3>
8971
<pre class="programlisting">void xmlInitializeGlobalState (<a href="libxml2-globals.html#xmlGlobalStatePtr">xmlGlobalStatePtr</a> gs)<br>
9072
</pre>

0 commit comments

Comments
 (0)