1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-10-21 14:53:44 +03:00

Heiko W. Rupp fixed a lot of comments to generate better API descriptions

* include/libxml/*.h: Heiko W. Rupp fixed a lot of comments
  to generate better API descriptions etc...
Daniel
This commit is contained in:
Daniel Veillard
2002-03-12 18:46:39 +00:00
parent 9ff8817e67
commit 61f261749f
23 changed files with 277 additions and 272 deletions

View File

@@ -18,7 +18,7 @@ extern "C" {
#endif
/*
* Validation state added for non-determinist content model
* Validation state added for non-determinist content model.
*/
typedef struct _xmlValidState xmlValidState;
typedef xmlValidState *xmlValidStatePtr;
@@ -29,7 +29,7 @@ typedef xmlValidState *xmlValidStatePtr;
* @msg: the string to format *printf like vararg
* @...: remaining arguments to the format
*
* Callback called when a validity error is found, this is a message
* Callback called when a validity error is found. This is a message
* oriented function similar to an *printf function.
*/
typedef void (*xmlValidityErrorFunc) (void *ctx,
@@ -42,7 +42,7 @@ typedef void (*xmlValidityErrorFunc) (void *ctx,
* @msg: the string to format *printf like vararg
* @...: remaining arguments to the format
*
* Callback called when a validity warning is found, this is a message
* Callback called when a validity warning is found. This is a message
* oriented function similar to an *printf function.
*/
typedef void (*xmlValidityWarningFunc) (void *ctx,
@@ -51,7 +51,7 @@ typedef void (*xmlValidityWarningFunc) (void *ctx,
/**
* xmlValidCtxt:
* an xmlValidCtxt is used for error reporting when validating
* An xmlValidCtxt is used for error reporting when validating.
*/
typedef struct _xmlValidCtxt xmlValidCtxt;
typedef xmlValidCtxt *xmlValidCtxtPtr;
@@ -78,40 +78,40 @@ struct _xmlValidCtxt {
};
/*
* ALl notation declarations are stored in a table
* there is one table per DTD
* ALL notation declarations are stored in a table.
* There is one table per DTD.
*/
typedef struct _xmlHashTable xmlNotationTable;
typedef xmlNotationTable *xmlNotationTablePtr;
/*
* ALl element declarations are stored in a table
* there is one table per DTD
* ALL element declarations are stored in a table.
* There is one table per DTD.
*/
typedef struct _xmlHashTable xmlElementTable;
typedef xmlElementTable *xmlElementTablePtr;
/*
* ALl attribute declarations are stored in a table
* there is one table per DTD
* ALL attribute declarations are stored in a table.
* There is one table per DTD.
*/
typedef struct _xmlHashTable xmlAttributeTable;
typedef xmlAttributeTable *xmlAttributeTablePtr;
/*
* ALl IDs attributes are stored in a table
* there is one table per document
* ALL IDs attributes are stored in a table.
* There is one table per document.
*/
typedef struct _xmlHashTable xmlIDTable;
typedef xmlIDTable *xmlIDTablePtr;
/*
* ALl Refs attributes are stored in a table
* there is one table per document
* ALL Refs attributes are stored in a table.
* There is one table per document.
*/
typedef struct _xmlHashTable xmlRefTable;
@@ -211,7 +211,7 @@ xmlListPtr xmlGetRefs (xmlDocPtr doc,
const xmlChar *ID);
/**
* The public function calls related to validity checking
* The public function calls related to validity checking.
*/
int xmlValidateRoot (xmlValidCtxtPtr ctxt,