doc: Misc fixes

include/libxml/xinclude.h

@@ -1,12 +1,9 @@
 /**
  * @file
- * 
+ *
- * @brief implementation of XInclude
+ * @brief Implementation of XInclude 1.0
- * 
+ *
- * API to handle XInclude processing,
+ * API to process XML Inclusions.
- * implements the
- * World Wide Web Consortium Last Call Working Draft 10 November 2003
- * http://www.w3.org/TR/2003/WD-xinclude-20031110
  *
  * @copyright See Copyright for the status of this software.
  *

include/libxml/xmlautomata.h

@@ -3,7 +3,7 @@
  * 
  * @brief API to build regexp automata
  * 
- * the API to build regexp automata
+ * These are internal functions and shouldn't be used.
  *
  * @copyright See Copyright for the status of this software.
  *

include/libxml/xmlmodule.h

@@ -1,10 +1,10 @@
 /**
  * @file
- * 
+ *
- * @brief dynamic module loading
+ * @brief Dynamic module loading
- * 
+ *
- * basic API for dynamic module loading, used by
+ * API for dynamic module loading. Only used by old libxslt versions
- *              libexslt added in 2.6.17
+ * and subject to removal.
  *
  * @copyright See Copyright for the status of this software.
  *

xmlmodule.c

@@ -43,6 +43,9 @@ static int xmlModulePlatformSymbol(void *handle, const char *name, void **result
 
 /**
  * Opens a module/shared library given its name or path
+ *
+ * @deprecated Will be removed.
+ *
  * NOTE: that due to portability issues, behaviour can only be
  * guaranteed with `name` using ASCII. We cannot guarantee that
  * an UTF-8 string would work, which is why name is a const char *
@@ -77,6 +80,9 @@ xmlModuleOpen(const char *name, int options ATTRIBUTE_UNUSED)
 
 /**
  * Lookup for a symbol address in the given module
+ *
+ * @deprecated Will be removed.
+ *
  * NOTE: that due to portability issues, behaviour can only be
  * guaranteed with `name` using ASCII. We cannot guarantee that
  * an UTF-8 string would work, which is why name is a const char *
@@ -107,6 +113,8 @@ xmlModuleSymbol(xmlModule *module, const char *name, void **symbol)
  * The close operations unload the associated module and free the
  * data associated to the module.
  *
+ * @deprecated Will be removed.
+ *
  * @param module  the module handle
  * @returns 0 in case of success, -1 in case of argument error and -2
  *         if the module could not be closed/unloaded.
@@ -133,6 +141,8 @@ xmlModuleClose(xmlModule *module)
  * but does not unload the associated shared library which may still
  * be in use.
  *
+ * @deprecated Will be removed.
+ *
  * @param module  the module handle
  * @returns 0 in case of success, -1 in case of argument error
  */

xmlregexp.c

@@ -5568,6 +5568,8 @@ xmlRegFreeRegexp(xmlRegexp *regexp) {
 /**
  * Create a new automata
  *
+ * @deprecated Internal function, don't use.
+ *
  * @returns the new object or NULL in case of failure
  */
 xmlAutomata *
@@ -5596,6 +5598,8 @@ xmlNewAutomata(void) {
 /**
  * Free an automata
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  */
 void
@@ -5608,6 +5612,8 @@ xmlFreeAutomata(xmlAutomata *am) {
 /**
  * Set some flags on the automata
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param flags  a set of internal flags
  */
@@ -5621,6 +5627,8 @@ xmlAutomataSetFlags(xmlAutomata *am, int flags) {
 /**
  * Initial state lookup
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @returns the initial state of the automata
  */
@@ -5634,6 +5642,8 @@ xmlAutomataGetInitState(xmlAutomata *am) {
 /**
  * Makes that state a final state
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param state  a state in this automata
  * @returns 0 or -1 in case of error
@@ -5647,10 +5657,14 @@ xmlAutomataSetFinalState(xmlAutomata *am, xmlAutomataState *state) {
 }
 
 /**
+ * Add a transition.
+ *
  * If `to` is NULL, this creates first a new target state in the automata
  * and then adds a transition from the `from` state to the target state
  * activated by the value of `token`
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -5691,6 +5705,8 @@ xmlAutomataNewTransition(xmlAutomata *am, xmlAutomataState *from,
  * and then adds a transition from the `from` state to the target state
  * activated by the value of `token`
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -5749,6 +5765,8 @@ xmlAutomataNewTransition2(xmlAutomata *am, xmlAutomataState *from,
  * Note that if `token2` is not NULL, then (X, NULL) won't match to follow
  * the semantic of XSD \#\#other
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -5812,6 +5830,8 @@ xmlAutomataNewNegTrans(xmlAutomata *am, xmlAutomataState *from,
  * activated by a succession of input of value `token` and `token2` and
  * whose number is between `min` and `max`
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -5906,6 +5926,8 @@ error:
  * activated by a succession of input of value `token` and whose number
  * is between `min` and `max`
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -5981,6 +6003,8 @@ error:
  * number is between `min` and `max`, moreover that transition can only be
  * crossed once.
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -6068,6 +6092,8 @@ error:
  * is between `min` and `max`, moreover that transition can only be crossed
  * once.
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -6127,6 +6153,8 @@ error:
 /**
  * Create a new disconnected state in the automata
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @returns the new state or NULL in case of error
  */
@@ -6142,6 +6170,8 @@ xmlAutomataNewState(xmlAutomata *am) {
  * and then adds an epsilon transition from the `from` state to the
  * target state
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -6164,6 +6194,8 @@ xmlAutomataNewEpsilon(xmlAutomata *am, xmlAutomataState *from,
  * target state. That transition is an epsilon transition allowed only when
  * all transitions from the `from` node have been activated.
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -6184,6 +6216,8 @@ xmlAutomataNewAllTrans(xmlAutomata *am, xmlAutomataState *from,
 /**
  * Create a new counter
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param min  the minimal value on the counter
  * @param max  the maximal value on the counter
@@ -6209,6 +6243,8 @@ xmlAutomataNewCounter(xmlAutomata *am, int min, int max) {
  * and then adds an epsilon transition from the `from` state to the target state
  * which will increment the counter provided
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -6231,6 +6267,8 @@ xmlAutomataNewCountedTrans(xmlAutomata *am, xmlAutomataState *from,
  * and then adds an epsilon transition from the `from` state to the target state
  * which will be allowed only if the counter is within the right range.
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @param from  the starting point of the transition
  * @param to  the target point of the transition or NULL
@@ -6252,6 +6290,8 @@ xmlAutomataNewCounterTrans(xmlAutomata *am, xmlAutomataState *from,
  * Compile the automata into a Reg Exp ready for being executed.
  * The automata should be free after this point.
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @returns the compiled regexp or NULL in case of error
  */
@@ -6272,6 +6312,8 @@ xmlAutomataCompile(xmlAutomata *am) {
 /**
  * Checks if an automata is determinist.
  *
+ * @deprecated Internal function, don't use.
+ *
  * @param am  an automata
  * @returns 1 if true, 0 if not, and -1 in case of error
  */