diff --git a/ChangeLog b/ChangeLog index 13bf2af8..94ab6ba5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue Mar 12 19:45:24 CET 2002 Daniel Veillard + + * include/libxml/*.h: Heiko W. Rupp fixed a lot of comments + to generate better API descriptions etc... + Mon Mar 11 10:10:30 CET 2002 Daniel Veillard * c14n.c: Fixing #74186, made sure all boolean expressions diff --git a/include/libxml/DOCBparser.h b/include/libxml/DOCBparser.h index 5c4589b9..4b7230f1 100644 --- a/include/libxml/DOCBparser.h +++ b/include/libxml/DOCBparser.h @@ -15,7 +15,7 @@ extern "C" { #endif /* - * Most of the back-end structures from XML and SGML are shared + * Most of the back-end structures from XML and SGML are shared. */ typedef xmlParserCtxt docbParserCtxt; typedef xmlParserCtxtPtr docbParserCtxtPtr; @@ -49,7 +49,7 @@ docbDocPtr docbParseFile (const char *filename, const char *encoding); /** - * Interfaces for the Push mode + * Interfaces for the Push mode. */ void docbFreeParserCtxt (docbParserCtxtPtr ctxt); docbParserCtxtPtr docbCreatePushParserCtxt(docbSAXHandlerPtr sax, diff --git a/include/libxml/HTMLparser.h b/include/libxml/HTMLparser.h index 2e7f009c..20f304bc 100644 --- a/include/libxml/HTMLparser.h +++ b/include/libxml/HTMLparser.h @@ -15,7 +15,7 @@ extern "C" { #endif /* - * Most of the back-end structures from XML and HTML are shared + * Most of the back-end structures from XML and HTML are shared. */ typedef xmlParserCtxt htmlParserCtxt; typedef xmlParserCtxtPtr htmlParserCtxtPtr; @@ -28,7 +28,7 @@ typedef xmlDocPtr htmlDocPtr; typedef xmlNodePtr htmlNodePtr; /* - * Internal description of an HTML element + * Internal description of an HTML element. */ typedef struct _htmlElemDesc htmlElemDesc; typedef htmlElemDesc *htmlElemDescPtr; @@ -45,7 +45,7 @@ struct _htmlElemDesc { }; /* - * Internal description of an HTML entity + * Internal description of an HTML entity. */ typedef struct _htmlEntityDesc htmlEntityDesc; typedef htmlEntityDesc *htmlEntityDescPtr; @@ -96,7 +96,7 @@ int htmlIsScriptAttribute(const xmlChar *name); int htmlHandleOmittedElem(int val); /** - * Interfaces for the Push mode + * Interfaces for the Push mode. */ void htmlFreeParserCtxt (htmlParserCtxtPtr ctxt); htmlParserCtxtPtr htmlCreatePushParserCtxt(htmlSAXHandlerPtr sax, diff --git a/include/libxml/HTMLtree.h b/include/libxml/HTMLtree.h index e17a414e..ada80fbf 100644 --- a/include/libxml/HTMLtree.h +++ b/include/libxml/HTMLtree.h @@ -22,35 +22,35 @@ extern "C" { /** * HTML_TEXT_NODE: * - * Macro, a text node in a HTML document is really implemented + * Macro. A text node in a HTML document is really implemented * the same way as a text node in an XML document. */ #define HTML_TEXT_NODE XML_TEXT_NODE /** * HTML_ENTITY_REF_NODE: * - * Macro, an entity reference in a HTML document is really implemented + * Macro. An entity reference in a HTML document is really implemented * the same way as an entity reference in an XML document. */ #define HTML_ENTITY_REF_NODE XML_ENTITY_REF_NODE /** * HTML_COMMENT_NODE: * - * Macro, a comment in a HTML document is really implemented + * Macro. A comment in a HTML document is really implemented * the same way as a comment in an XML document. */ #define HTML_COMMENT_NODE XML_COMMENT_NODE /** * HTML_PRESERVE_NODE: * - * Macro, a preserved node in a HTML document is really implemented + * Macro. A preserved node in a HTML document is really implemented * the same way as a CDATA section in an XML document. */ #define HTML_PRESERVE_NODE XML_CDATA_SECTION_NODE /** * HTML_PI_NODE: * - * Macro, a processing instruction in a HTML document is really implemented + * Macro. A processing instruction in a HTML document is really implemented * the same way as a processing instruction in an XML document. */ #define HTML_PI_NODE XML_PI_NODE diff --git a/include/libxml/catalog.h b/include/libxml/catalog.h index d7511c25..24141aeb 100644 --- a/include/libxml/catalog.h +++ b/include/libxml/catalog.h @@ -31,20 +31,20 @@ extern "C" { /** * XML_CATALOGS_NAMESPACE: * - * The namespace for the XML Catalogs elements + * The namespace for the XML Catalogs elements. */ #define XML_CATALOGS_NAMESPACE \ (const xmlChar *) "urn:oasis:names:tc:entity:xmlns:xml:catalog" /** * XML_CATALOG_PI: * - * the specific XML Catalog Processing Instuction name + * The specific XML Catalog Processing Instuction name. */ #define XML_CATALOG_PI \ (const xmlChar *) "oasis-xml-catalog" /* - * The API is voluntarily limited to general cataloging + * The API is voluntarily limited to general cataloging. */ typedef enum { XML_CATA_PREFER_NONE = 0, @@ -63,7 +63,7 @@ typedef struct _xmlCatalog xmlCatalog; typedef xmlCatalog *xmlCatalogPtr; /* - * Operations on a given catalog + * Operations on a given catalog. */ xmlCatalogPtr xmlNewCatalog (int sgml); xmlCatalogPtr xmlLoadACatalog (const char *filename); @@ -90,7 +90,7 @@ void xmlFreeCatalog (xmlCatalogPtr catal); int xmlCatalogIsEmpty (xmlCatalogPtr catal); /* - * Global operations + * Global operations. */ void xmlInitializeCatalog (void); int xmlLoadCatalog (const char *filename); @@ -122,7 +122,7 @@ xmlChar * xmlCatalogLocalResolve (void *catalogs, xmlChar * xmlCatalogLocalResolveURI(void *catalogs, const xmlChar *URI); /* - * Preference settings + * Preference settings. */ int xmlCatalogSetDebug (int level); xmlCatalogPrefer xmlCatalogSetDefaultPrefer(xmlCatalogPrefer prefer); diff --git a/include/libxml/debugXML.h b/include/libxml/debugXML.h index f977d777..cf017a4a 100644 --- a/include/libxml/debugXML.h +++ b/include/libxml/debugXML.h @@ -19,7 +19,7 @@ extern "C" { #endif /* - * The standard Dump routines + * The standard Dump routines. */ void xmlDebugDumpString (FILE *output, const xmlChar *str); @@ -62,16 +62,16 @@ LIBXML_DLL_IMPORT const char *xmlBoolToText (int boolval); * xmlShellReadlineFunc: * @prompt: a string prompt * - * This is a generic signature for the XML shell input function + * This is a generic signature for the XML shell input function. * - * Returns a string which will be freed by the Shell + * Returns a string which will be freed by the Shell. */ typedef char * (* xmlShellReadlineFunc)(char *prompt); /** * xmlShellCtxt: * - * A debugging shell context + * A debugging shell context. * TODO: add the defined function tables. */ typedef struct _xmlShellCtxt xmlShellCtxt; @@ -93,9 +93,9 @@ struct _xmlShellCtxt { * @node: a first node * @node2: a second node * - * This is a generic signature for the XML shell functions + * This is a generic signature for the XML shell functions. * - * Returns an int, negative returns indicating errors + * Returns an int, negative returns indicating errors. */ typedef int (* xmlShellCmd) (xmlShellCtxtPtr ctxt, char *arg, diff --git a/include/libxml/encoding.h b/include/libxml/encoding.h index 8e2eb268..8b4a36c2 100644 --- a/include/libxml/encoding.h +++ b/include/libxml/encoding.h @@ -36,8 +36,8 @@ extern "C" { /** * xmlCharEncoding: * - * Predefined values for some standard encodings - * Libxml don't do beforehand translation on UTF8, ISOLatinX + * Predefined values for some standard encodings. + * Libxml don't do beforehand translation on UTF8, ISOLatinX. * It also support UTF16 (LE and BE) by default. * * Anything else would have to be translated to UTF8 before being @@ -108,7 +108,7 @@ typedef int (* xmlCharEncodingInputFunc)(unsigned char *out, int *outlen, * Take a block of UTF-8 chars in and try to convert it to an other * encoding. * Note: a first call designed to produce heading info is called with - * in = NULL. If stateful this should also initialize the encoder state + * in = NULL. If stateful this should also initialize the encoder state. * * Returns the number of byte written, or -1 by lack of space, or -2 * if the transcoding failed. @@ -122,7 +122,7 @@ typedef int (* xmlCharEncodingOutputFunc)(unsigned char *out, int *outlen, /* * Block defining the handlers for non UTF-8 encodings. - * If iconv is supported, there is two extra fields + * If iconv is supported, there is two extra fields. */ typedef struct _xmlCharEncodingHandler xmlCharEncodingHandler; @@ -146,7 +146,7 @@ extern "C" { #endif /* - * Interfaces for encoding handlers + * Interfaces for encoding handlers. */ void xmlInitCharEncodingHandlers (void); void xmlCleanupCharEncodingHandlers (void); @@ -158,7 +158,7 @@ xmlCharEncodingHandlerPtr /* - * Interfaces for encoding names and aliases + * Interfaces for encoding names and aliases. */ int xmlAddEncodingAlias (const char *name, const char *alias); @@ -202,7 +202,7 @@ int isolat1ToUTF8 (unsigned char *out, const unsigned char *in, int *inlen); /* - * exports additional "UTF-8 aware" string routines which are + * exports additional "UTF-8 aware" string routines which are. */ int xmlCheckUTF8 (const unsigned char *utf); diff --git a/include/libxml/entities.h b/include/libxml/entities.h index c3b8021b..480009c0 100644 --- a/include/libxml/entities.h +++ b/include/libxml/entities.h @@ -16,7 +16,7 @@ extern "C" { #endif /* - * The different valid entity types + * The different valid entity types. */ typedef enum { XML_INTERNAL_GENERAL_ENTITY = 1, @@ -55,15 +55,15 @@ struct _xmlEntity { }; /* - * All entities are stored in an hash table - * there is 2 separate hash tables for global and parameter entities + * All entities are stored in an hash table. + * There is 2 separate hash tables for global and parameter entities. */ typedef struct _xmlHashTable xmlEntitiesTable; typedef xmlEntitiesTable *xmlEntitiesTablePtr; /* - * External functions : + * External functions: */ void xmlInitializePredefinedEntities (void); diff --git a/include/libxml/hash.h b/include/libxml/hash.h index bd333781..ec590c91 100644 --- a/include/libxml/hash.h +++ b/include/libxml/hash.h @@ -25,7 +25,7 @@ extern "C" { #endif /* - * The hash table + * The hash table. */ typedef struct _xmlHashTable xmlHashTable; typedef xmlHashTable *xmlHashTablePtr; @@ -38,7 +38,7 @@ typedef xmlHashTable *xmlHashTablePtr; * @payload: the data in the hash * @name: the name associated * - * Callback to free data from a hash + * Callback to free data from a hash. */ typedef void (*xmlHashDeallocator)(void *payload, xmlChar *name); /** @@ -46,9 +46,9 @@ typedef void (*xmlHashDeallocator)(void *payload, xmlChar *name); * @payload: the data in the hash * @name: the name associated * - * Callback to copy data from a hash + * Callback to copy data from a hash. * - * Returns a copy of the data or NULL in case of error + * Returns a copy of the data or NULL in case of error. */ typedef void *(*xmlHashCopier)(void *payload, xmlChar *name); /** @@ -57,7 +57,7 @@ typedef void *(*xmlHashCopier)(void *payload, xmlChar *name); * @data: extra scannner data * @name: the name associated * - * Callback when scanning data in a hash with the simple scanner + * Callback when scanning data in a hash with the simple scanner. */ typedef void (*xmlHashScanner)(void *payload, void *data, xmlChar *name); /** @@ -68,21 +68,21 @@ typedef void (*xmlHashScanner)(void *payload, void *data, xmlChar *name); * @name2: the second name associated * @name3: the third name associated * - * Callback when scanning data in a hash with the full scanner + * Callback when scanning data in a hash with the full scanner. */ typedef void (*xmlHashScannerFull)(void *payload, void *data, const xmlChar *name, const xmlChar *name2, const xmlChar *name3); /* - * Constructor and destructor + * Constructor and destructor. */ xmlHashTablePtr xmlHashCreate (int size); void xmlHashFree (xmlHashTablePtr table, xmlHashDeallocator f); /* - * Add a new entry to the hash table + * Add a new entry to the hash table. */ int xmlHashAddEntry (xmlHashTablePtr table, const xmlChar *name, @@ -113,7 +113,7 @@ int xmlHashUpdateEntry3(xmlHashTablePtr table, xmlHashDeallocator f); /* - * Remove an entry from the hash table + * Remove an entry from the hash table. */ int xmlHashRemoveEntry(xmlHashTablePtr table, const xmlChar *name, xmlHashDeallocator f); @@ -124,7 +124,7 @@ int xmlHashRemoveEntry3(xmlHashTablePtr table, const xmlChar *name, xmlHashDeallocator f); /* - * Retrieve the userdata + * Retrieve the userdata. */ void * xmlHashLookup (xmlHashTablePtr table, const xmlChar *name); @@ -137,7 +137,7 @@ void * xmlHashLookup3 (xmlHashTablePtr table, const xmlChar *name3); /* - * Helpers + * Helpers. */ xmlHashTablePtr xmlHashCopy (xmlHashTablePtr table, xmlHashCopier f); diff --git a/include/libxml/list.h b/include/libxml/list.h index 654400d0..8c9515fe 100644 --- a/include/libxml/list.h +++ b/include/libxml/list.h @@ -32,7 +32,7 @@ typedef xmlList *xmlListPtr; * xmlListDeallocator: * @lk: the data to deallocate * - * Callback function used to free data from a list + * Callback function used to free data from a list. */ typedef void (*xmlListDeallocator) (xmlLinkPtr lk); /** @@ -40,9 +40,9 @@ typedef void (*xmlListDeallocator) (xmlLinkPtr lk); * @data0: the first data * @data1: the second data * - * Callback function used to compare 2 data + * Callback function used to compare 2 data. * - * Returns 0 is equality, -1 or 1 otherwise depending on the ordering + * Returns 0 is equality, -1 or 1 otherwise depending on the ordering. */ typedef int (*xmlListDataCompare) (const void *data0, const void *data1); /** @@ -50,9 +50,9 @@ typedef int (*xmlListDataCompare) (const void *data0, const void *data1); * @data: the data found in the list * @user: extra user provided data to the walker * - * Callback function used when walking a list with xmlListWalk() + * Callback function used when walking a list with xmlListWalk(). * - * Returns 0 to stop walking the list, 1 otherwise + * Returns 0 to stop walking the list, 1 otherwise. */ typedef int (*xmlListWalker) (const void *data, const void *user); diff --git a/include/libxml/nanoftp.h b/include/libxml/nanoftp.h index df45a6ee..92433498 100644 --- a/include/libxml/nanoftp.h +++ b/include/libxml/nanoftp.h @@ -35,8 +35,8 @@ extern "C" { * @hour: the hour * @minute: the minute * - * A callback for the xmlNanoFTPList command - * Note that only one of year and day:minute are specified + * A callback for the xmlNanoFTPList command. + * Note that only one of year and day:minute are specified. */ typedef void (*ftpListCallback) (void *userData, const char *filename, const char *attrib, @@ -50,7 +50,7 @@ typedef void (*ftpListCallback) (void *userData, * @data: the data received * @len: its size in bytes * - * A callback for the xmlNanoFTPGet command + * A callback for the xmlNanoFTPGet command. */ typedef void (*ftpDataCallback) (void *userData, const char *data, @@ -63,14 +63,14 @@ void xmlNanoFTPInit (void); void xmlNanoFTPCleanup (void); /* - * Creating/freeing contexts + * Creating/freeing contexts. */ void * xmlNanoFTPNewCtxt (const char *URL); void xmlNanoFTPFreeCtxt (void * ctx); void * xmlNanoFTPConnectTo (const char *server, int port); /* - * Opening/closing session connections + * Opening/closing session connections. */ void * xmlNanoFTPOpen (const char *URL); int xmlNanoFTPConnect (void *ctx); @@ -86,13 +86,13 @@ int xmlNanoFTPUpdateURL (void *ctx, const char *URL); /* - * Rathern internal commands + * Rather internal commands. */ int xmlNanoFTPGetResponse (void *ctx); int xmlNanoFTPCheckResponse (void *ctx); /* - * CD/DIR/GET handlers + * CD/DIR/GET handlers. */ int xmlNanoFTPCwd (void *ctx, char *directory); diff --git a/include/libxml/parser.h b/include/libxml/parser.h index 341c5597..cd48dc50 100644 --- a/include/libxml/parser.h +++ b/include/libxml/parser.h @@ -27,7 +27,7 @@ extern "C" { /** * xmlParserInput: * - * an xmlParserInput is an input flow for the XML processor. + * An xmlParserInput is an input flow for the XML processor. * Each entity parsed is associated an xmlParserInput (except the * few predefined ones). This is the case both for internal entities * - in which case the flow is already completely in memory - or @@ -39,7 +39,7 @@ extern "C" { * xmlParserInputDeallocate: * @str: the string to deallocate * - * Callback for freeing some parser input allocations + * Callback for freeing some parser input allocations. */ typedef void (* xmlParserInputDeallocate)(xmlChar *str); @@ -65,7 +65,7 @@ struct _xmlParserInput { /** * xmlParserNodeInfo: * - * the parser can be asked to collect Node informations, i.e. at what + * The parser can be asked to collect Node informations, i.e. at what * place in the file they were detected. * NOTE: This is off by default and not very well tested. */ @@ -92,8 +92,8 @@ struct _xmlParserNodeInfoSeq { /** * xmlParserInputState: * - * The parser is now working also as a state based parser - * The recursive one use the state info for entities processing + * The parser is now working also as a state based parser. + * The recursive one use the state info for entities processing. */ typedef enum { XML_PARSER_EOF = -1, /* nothing is to be parsed */ @@ -119,8 +119,8 @@ typedef enum { /** * XML_DETECT_IDS: * - * Bit in the loadsubset context field to tell to do ID/REFs lookups - * Use it to initialize xmlLoadExtDtdDefaultValue + * Bit in the loadsubset context field to tell to do ID/REFs lookups. + * Use it to initialize xmlLoadExtDtdDefaultValue. */ #define XML_DETECT_IDS 2 @@ -128,8 +128,8 @@ typedef enum { * XML_COMPLETE_ATTRS: * * Bit in the loadsubset context field to tell to do complete the - * elements attributes lists with the ones defaulted from the DTDs - * Use it to initialize xmlLoadExtDtdDefaultValue + * elements attributes lists with the ones defaulted from the DTDs. + * Use it to initialize xmlLoadExtDtdDefaultValue. */ #define XML_COMPLETE_ATTRS 4 @@ -137,7 +137,7 @@ typedef enum { * xmlParserCtxt: * * The parser context. - * NOTE This doesn't completely defines the parser state, the (current ?) + * NOTE This doesn't completely define the parser state, the (current ?) * design of the parser uses recursive function calls since this allow * and easy mapping from the production rules of the specification * to the actual code. The drawback is that the actual function call @@ -224,7 +224,7 @@ struct _xmlParserCtxt { /** * xmlSAXLocator: * - * a SAX Locator. + * A SAX Locator. */ struct _xmlSAXLocator { const xmlChar *(*getPublicId)(void *ctx); @@ -236,7 +236,7 @@ struct _xmlSAXLocator { /** * xmlSAXHandler: * - * a SAX handler is bunch of callbacks called by the parser when processing + * A SAX handler is bunch of callbacks called by the parser when processing * of the input generate data or structure informations. */ @@ -289,7 +289,7 @@ typedef void (*externalSubsetSAXFunc) (void *ctx, * @ctx: the user data (XML parser context) * @name: The entity name * - * Get an entity by name + * Get an entity by name. * * Returns the xmlEntityPtr if found. */ @@ -300,7 +300,7 @@ typedef xmlEntityPtr (*getEntitySAXFunc) (void *ctx, * @ctx: the user data (XML parser context) * @name: The entity name * - * Get a parameter entity by name + * Get a parameter entity by name. * * Returns the xmlEntityPtr if found. */ @@ -315,7 +315,7 @@ typedef xmlEntityPtr (*getParameterEntitySAXFunc) (void *ctx, * @systemId: The system ID of the entity * @content: the entity value (without processing). * - * An entity definition has been parsed + * An entity definition has been parsed. */ typedef void (*entityDeclSAXFunc) (void *ctx, const xmlChar *name, @@ -346,7 +346,7 @@ typedef void (*notationDeclSAXFunc)(void *ctx, * @defaultValue: the attribute default value * @tree: the tree of enumerated value set * - * An attribute definition has been parsed + * An attribute definition has been parsed. */ typedef void (*attributeDeclSAXFunc)(void *ctx, const xmlChar *elem, @@ -362,7 +362,7 @@ typedef void (*attributeDeclSAXFunc)(void *ctx, * @type: the element type * @content: the element value tree * - * An element definition has been parsed + * An element definition has been parsed. */ typedef void (*elementDeclSAXFunc)(void *ctx, const xmlChar *name, @@ -376,7 +376,7 @@ typedef void (*elementDeclSAXFunc)(void *ctx, * @systemId: The system ID of the entity * @notationName: the name of the notation * - * What to do when an unparsed entity declaration is parsed + * What to do when an unparsed entity declaration is parsed. */ typedef void (*unparsedEntityDeclSAXFunc)(void *ctx, const xmlChar *name, @@ -388,7 +388,7 @@ typedef void (*unparsedEntityDeclSAXFunc)(void *ctx, * @ctx: the user data (XML parser context) * @loc: A SAX Locator * - * Receive the document locator at startup, actually xmlDefaultSAXLocator + * Receive the document locator at startup, actually xmlDefaultSAXLocator. * Everything is available on the context, so this is useless in our case. */ typedef void (*setDocumentLocatorSAXFunc) (void *ctx, @@ -397,14 +397,14 @@ typedef void (*setDocumentLocatorSAXFunc) (void *ctx, * startDocumentSAXFunc: * @ctx: the user data (XML parser context) * - * called when the document start being processed. + * Called when the document start being processed. */ typedef void (*startDocumentSAXFunc) (void *ctx); /** * endDocumentSAXFunc: * @ctx: the user data (XML parser context) * - * called when the document end has been detected. + * Called when the document end has been detected. */ typedef void (*endDocumentSAXFunc) (void *ctx); /** @@ -413,7 +413,7 @@ typedef void (*endDocumentSAXFunc) (void *ctx); * @name: The element name, including namespace prefix * @atts: An array of name/value attributes pairs, NULL terminated * - * called when an opening tag has been processed. + * Called when an opening tag has been processed. */ typedef void (*startElementSAXFunc) (void *ctx, const xmlChar *name, @@ -423,7 +423,7 @@ typedef void (*startElementSAXFunc) (void *ctx, * @ctx: the user data (XML parser context) * @name: The element name * - * called when the end of an element has been detected. + * Called when the end of an element has been detected. */ typedef void (*endElementSAXFunc) (void *ctx, const xmlChar *name); @@ -446,7 +446,7 @@ typedef void (*attributeSAXFunc) (void *ctx, * @ctx: the user data (XML parser context) * @name: The entity name * - * called when an entity reference is detected. + * Called when an entity reference is detected. */ typedef void (*referenceSAXFunc) (void *ctx, const xmlChar *name); @@ -456,7 +456,7 @@ typedef void (*referenceSAXFunc) (void *ctx, * @ch: a xmlChar string * @len: the number of xmlChar * - * receiving some chars from the parser. + * Receiving some chars from the parser. */ typedef void (*charactersSAXFunc) (void *ctx, const xmlChar *ch, @@ -467,8 +467,8 @@ typedef void (*charactersSAXFunc) (void *ctx, * @ch: a xmlChar string * @len: the number of xmlChar * - * receiving some ignorable whitespaces from the parser. - * UNUSED: by default the DOM building will use characters + * Receiving some ignorable whitespaces from the parser. + * UNUSED: by default the DOM building will use characters. */ typedef void (*ignorableWhitespaceSAXFunc) (void *ctx, const xmlChar *ch, @@ -499,7 +499,7 @@ typedef void (*commentSAXFunc) (void *ctx, * @value: The pcdata content * @len: the block length * - * called when a pcdata block has been parsed + * Called when a pcdata block has been parsed. */ typedef void (*cdataBlockSAXFunc) ( void *ctx, @@ -511,7 +511,7 @@ typedef void (*cdataBlockSAXFunc) ( * @msg: the message to display/transmit * @...: extra parameters for the message display * - * Display and format a warning messages, callback + * Display and format a warning messages, callback. */ typedef void (*warningSAXFunc) (void *ctx, const char *msg, ...); @@ -521,7 +521,7 @@ typedef void (*warningSAXFunc) (void *ctx, * @msg: the message to display/transmit * @...: extra parameters for the message display * - * Display and format an error messages, callback + * Display and format an error messages, callback. */ typedef void (*errorSAXFunc) (void *ctx, const char *msg, ...); @@ -531,7 +531,7 @@ typedef void (*errorSAXFunc) (void *ctx, * @msg: the message to display/transmit * @...: extra parameters for the message display * - * Display and format fatal error messages, callback + * Display and format fatal error messages, callback. */ typedef void (*fatalErrorSAXFunc) (void *ctx, const char *msg, ...); @@ -539,7 +539,7 @@ typedef void (*fatalErrorSAXFunc) (void *ctx, * isStandaloneSAXFunc: * @ctx: the user data (XML parser context) * - * Is this document tagged standalone ? + * Is this document tagged standalone? * * Returns 1 if true */ @@ -548,7 +548,7 @@ typedef int (*isStandaloneSAXFunc) (void *ctx); * hasInternalSubsetSAXFunc: * @ctx: the user data (XML parser context) * - * Does this document has an internal subset + * Does this document has an internal subset. * * Returns 1 if true */ @@ -557,7 +557,7 @@ typedef int (*hasInternalSubsetSAXFunc) (void *ctx); * hasExternalSubsetSAXFunc: * @ctx: the user data (XML parser context) * - * Does this document has an external subset + * Does this document has an external subset? * * Returns 1 if true */ @@ -600,9 +600,9 @@ struct _xmlSAXHandler { * @ID: The Public ID of the resource requested * @context: the XML parser context * - * External entity loaders types + * External entity loaders types. * - * Returns the entity input parser + * Returns the entity input parser. */ typedef xmlParserInputPtr (*xmlExternalEntityLoader) (const char *URL, const char *ID, @@ -624,14 +624,14 @@ LIBXML_DLL_IMPORT extern xmlSAXHandler docbDefaultSAXHandler; */ /* - * entity substitution default behavior. + * Entity substitution default behavior. */ #ifdef VMS /** * xmlSubstituteEntitiesDefaultValue: * - * global variable controlling the entity substitution default behavior + * Global variable controlling the entity substitution default behavior. */ LIBXML_DLL_IMPORT extern int xmlSubstituteEntitiesDefaultVal; #define xmlSubstituteEntitiesDefaultValue xmlSubstituteEntitiesDefaultVal @@ -804,7 +804,7 @@ int xmlSetFeature (xmlParserCtxtPtr ctxt, void *value); /* - * Interfaces for the Push mode + * Interfaces for the Push mode. */ xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax, void *user_data, @@ -817,7 +817,7 @@ int xmlParseChunk (xmlParserCtxtPtr ctxt, int terminate); /* - * Special I/O mode + * Special I/O mode. */ xmlParserCtxtPtr xmlCreateIOParserCtxt (xmlSAXHandlerPtr sax, @@ -832,7 +832,7 @@ xmlParserInputPtr xmlNewIOInputStream (xmlParserCtxtPtr ctxt, xmlCharEncoding enc); /* - * Node infos + * Node infos. */ const xmlParserNodeInfo* xmlParserFindNodeInfo (const xmlParserCtxtPtr ctxt, @@ -845,7 +845,7 @@ void xmlParserAddNodeInfo (xmlParserCtxtPtr ctxt, const xmlParserNodeInfoPtr info); /* - * External entities handling actually implemented in xmlIO + * External entities handling actually implemented in xmlIO. */ void xmlSetExternalEntityLoader(xmlExternalEntityLoader f); diff --git a/include/libxml/parserInternals.h b/include/libxml/parserInternals.h index df90be4b..823dae89 100644 --- a/include/libxml/parserInternals.h +++ b/include/libxml/parserInternals.h @@ -31,8 +31,8 @@ extern "C" { /** * INPUT_CHUNK: * - * The parser tries to always have that amount of input ready - * one of the point is providing context when reporting errors + * The parser tries to always have that amount of input ready. + * One of the point is providing context when reporting errors. */ #define INPUT_CHUNK 250 @@ -45,7 +45,7 @@ extern "C" { * IS_CHAR: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * [2] Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] * | [#x10000-#x10FFFF] @@ -61,7 +61,7 @@ extern "C" { * IS_BLANK: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * [3] S ::= (#x20 | #x9 | #xD | #xA)+ */ @@ -72,7 +72,7 @@ extern "C" { * IS_BASECHAR: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * [85] BaseChar ::= ... long list see REC ... */ @@ -82,7 +82,7 @@ extern "C" { * IS_DIGIT: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * [88] Digit ::= ... long list see REC ... */ @@ -92,7 +92,7 @@ extern "C" { * IS_COMBINING: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * [87] CombiningChar ::= ... long list see REC ... */ @@ -102,7 +102,7 @@ extern "C" { * IS_EXTENDER: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * * [89] Extender ::= #x00B7 | #x02D0 | #x02D1 | #x0387 | #x0640 | @@ -115,7 +115,7 @@ extern "C" { * IS_IDEOGRAPHIC: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * * [86] Ideographic ::= [#x4E00-#x9FA5] | #x3007 | [#x3021-#x3029] @@ -126,7 +126,7 @@ extern "C" { * IS_LETTER: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * * [84] Letter ::= BaseChar | Ideographic @@ -138,7 +138,7 @@ extern "C" { * IS_PUBIDCHAR: * @c: an UNICODE value (int) * - * Macro to check the following production in the XML spec + * Macro to check the following production in the XML spec: * * * [13] PubidChar ::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%] @@ -149,7 +149,7 @@ extern "C" { * SKIP_EOL: * @p: and UTF8 string pointer * - * Skips the end of line chars + * Skips the end of line chars. */ #define SKIP_EOL(p) \ if (*(p) == 0x13) { p++ ; if (*(p) == 0x10) p++; } \ @@ -159,7 +159,7 @@ extern "C" { * MOVETO_ENDTAG: * @p: and UTF8 string pointer * - * Skips to the next '>' char + * Skips to the next '>' char. */ #define MOVETO_ENDTAG(p) \ while ((*p) && (*(p) != '>')) (p)++ @@ -168,20 +168,20 @@ extern "C" { * MOVETO_STARTTAG: * @p: and UTF8 string pointer * - * Skips to the next '<' char + * Skips to the next '<' char. */ #define MOVETO_STARTTAG(p) \ while ((*p) && (*(p) != '<')) (p)++ /** - * Global variables used for predefined strings + * Global variables used for predefined strings. */ LIBXML_DLL_IMPORT extern const xmlChar xmlStringText[]; LIBXML_DLL_IMPORT extern const xmlChar xmlStringTextNoenc[]; LIBXML_DLL_IMPORT extern const xmlChar xmlStringComment[]; /* - * Function to finish the work of the macros where needed + * Function to finish the work of the macros where needed. */ int xmlIsBaseChar (int c); int xmlIsBlank (int c); @@ -194,7 +194,7 @@ int xmlIsCombining (int c); int xmlIsChar (int c); /** - * Parser context + * Parser context. */ xmlParserCtxtPtr xmlCreateFileParserCtxt (const char *filename); xmlParserCtxtPtr xmlCreateMemoryParserCtxt(const char *buffer, @@ -215,7 +215,7 @@ void xmlHandleEntity (xmlParserCtxtPtr ctxt, xmlEntityPtr entity); /** - * Input Streams + * Input Streams. */ xmlParserInputPtr xmlNewStringInputStream (xmlParserCtxtPtr ctxt, const xmlChar *buffer); @@ -243,7 +243,7 @@ xmlChar * xmlParseQuotedString (xmlParserCtxtPtr ctxt); void xmlParseNamespace (xmlParserCtxtPtr ctxt); /** - * Generic production rules + * Generic production rules. */ xmlChar * xmlScanName (xmlParserCtxtPtr ctxt); xmlChar * xmlParseName (xmlParserCtxtPtr ctxt); @@ -315,25 +315,25 @@ void xmlParseExternalSubset (xmlParserCtxtPtr ctxt, /** * XML_SUBSTITUTE_NONE: * - * If no entities need to be substituted + * If no entities need to be substituted. */ #define XML_SUBSTITUTE_NONE 0 /** * XML_SUBSTITUTE_REF: * - * Whether general entities need to be substituted + * Whether general entities need to be substituted. */ #define XML_SUBSTITUTE_REF 1 /** * XML_SUBSTITUTE_PEREF: * - * Whether parameter entities need to be substituted + * Whether parameter entities need to be substituted. */ #define XML_SUBSTITUTE_PEREF 2 /** * XML_SUBSTITUTE_BOTH: * - * Both general and parameter entities need to be substituted + * Both general and parameter entities need to be substituted. */ #define XML_SUBSTITUTE_BOTH 3 @@ -351,7 +351,7 @@ xmlChar * xmlStringDecodeEntities (xmlParserCtxtPtr ctxt, xmlChar end3); /* - * Generated by MACROS on top of parser.c c.f. PUSH_AND_POP + * Generated by MACROS on top of parser.c c.f. PUSH_AND_POP. */ int nodePush (xmlParserCtxtPtr ctxt, xmlNodePtr value); @@ -364,7 +364,7 @@ int namePush (xmlParserCtxtPtr ctxt, xmlChar *value); /* - * other commodities shared between parser.c and parserInternals + * other commodities shared between parser.c and parserInternals. */ int xmlSkipBlankChars (xmlParserCtxtPtr ctxt); int xmlStringCurrentChar (xmlParserCtxtPtr ctxt, @@ -375,7 +375,7 @@ void xmlParserHandleReference(xmlParserCtxtPtr ctxt); int xmlCheckLanguageID (const xmlChar *lang); /* - * Really core function shared with HTML parser + * Really core function shared with HTML parser. */ int xmlCurrentChar (xmlParserCtxtPtr ctxt, int *len); @@ -389,7 +389,7 @@ void xmlParserInputShrink (xmlParserInputPtr in); #ifdef LIBXML_HTML_ENABLED /* - * Actually comes from the HTML parser but launched from the init stuff + * Actually comes from the HTML parser but launched from the init stuff. */ void htmlInitAutoClose (void); htmlParserCtxtPtr htmlCreateFileParserCtxt(const char *filename, @@ -398,7 +398,7 @@ htmlParserCtxtPtr htmlCreateFileParserCtxt(const char *filename, /* * Specific function to keep track of entities references - * and used by the XSLT debugger + * and used by the XSLT debugger. */ /** * xmlEntityReferenceFunc: @@ -406,8 +406,8 @@ htmlParserCtxtPtr htmlCreateFileParserCtxt(const char *filename, * @firstNode: the fist node in the chunk * @lastNode: the last nod in the chunk * - * Callback function used when one need to be able to track back the - * provenance of a chunk of nodes inherited from an entity replacement + * Callback function used when one needs to be able to track back the + * provenance of a chunk of nodes inherited from an entity replacement. */ typedef void (*xmlEntityReferenceFunc) (xmlEntityPtr ent, xmlNodePtr firstNode, diff --git a/include/libxml/threads.h b/include/libxml/threads.h index b38e48af..afca78ff 100644 --- a/include/libxml/threads.h +++ b/include/libxml/threads.h @@ -14,13 +14,13 @@ extern "C" { #endif /* - * xmlMutex are a simple mutual exception locks + * xmlMutex are a simple mutual exception locks. */ typedef struct _xmlMutex xmlMutex; typedef xmlMutex *xmlMutexPtr; /* - * xmlRMutex are reentrant mutual exception locks + * xmlRMutex are reentrant mutual exception locks. */ typedef struct _xmlRMutex xmlRMutex; typedef xmlRMutex *xmlRMutexPtr; @@ -44,7 +44,7 @@ void xmlRMutexUnlock (xmlRMutexPtr tok); void xmlFreeRMutex (xmlRMutexPtr tok); /* - * Library wide APIs + * Library wide APIs. */ void xmlInitThreads (void); void xmlLockLibrary (void); diff --git a/include/libxml/tree.h b/include/libxml/tree.h index 29b0a532..940426dd 100644 --- a/include/libxml/tree.h +++ b/include/libxml/tree.h @@ -53,7 +53,7 @@ typedef xmlEntity *xmlEntityPtr; /** * BASE_BUFFER_SIZE: * - * default buffer size 4000 + * default buffer size 4000. */ #define BASE_BUFFER_SIZE 4000 @@ -61,13 +61,13 @@ typedef xmlEntity *xmlEntityPtr; * XML_XML_NAMESPACE: * * This is the namespace for the special xml: prefix predefined in the - * XML Namespace specification + * XML Namespace specification. */ #define XML_XML_NAMESPACE \ (const xmlChar *) "http://www.w3.org/XML/1998/namespace" /* - * The different element types carried by an XML tree + * The different element types carried by an XML tree. * * NOTE: This is synchronized with DOM Level1 values * See http://www.w3.org/TR/REC-DOM-Level-1/ @@ -121,7 +121,7 @@ typedef unsigned char xmlChar; /** * xmlNotation: * - * a DTD Notation definition + * A DTD Notation definition. */ typedef struct _xmlNotation xmlNotation; @@ -135,7 +135,7 @@ struct _xmlNotation { /** * xmlAttributeType: * - * a DTD Attribute type definition + * A DTD Attribute type definition. */ typedef enum { @@ -154,7 +154,7 @@ typedef enum { /** * xmlAttributeDefault: * - * a DTD Attribute default definition + * A DTD Attribute default definition. */ typedef enum { @@ -167,7 +167,7 @@ typedef enum { /** * xmlEnumeration: * - * list structure used when there is an enumeration in DTDs + * List structure used when there is an enumeration in DTDs. */ typedef struct _xmlEnumeration xmlEnumeration; @@ -180,7 +180,7 @@ struct _xmlEnumeration { /** * xmlAttribute: * - * an Attribute declaration in a DTD + * An Attribute declaration in a DTD. */ typedef struct _xmlAttribute xmlAttribute; @@ -208,7 +208,7 @@ struct _xmlAttribute { /** * xmlElementContentType: * - * Possible definitions of element content types + * Possible definitions of element content types. */ typedef enum { XML_ELEMENT_CONTENT_PCDATA = 1, @@ -220,7 +220,7 @@ typedef enum { /** * xmlElementContentOccur: * - * Possible definitions of element content occurrences + * Possible definitions of element content occurrences. */ typedef enum { XML_ELEMENT_CONTENT_ONCE = 1, @@ -232,7 +232,7 @@ typedef enum { /** * xmlElementContent: * - * an XML Element content as stored after parsing an element definition + * An XML Element content as stored after parsing an element definition * in a DTD. */ @@ -251,7 +251,7 @@ struct _xmlElementContent { /** * xmlElementTypeVal: * - * the different possibilities for an element content type + * The different possibilities for an element content type. */ typedef enum { @@ -265,7 +265,7 @@ typedef enum { /** * xmlElement: * - * an XML Element declaration from a DTD + * An XML Element declaration from a DTD. */ typedef struct _xmlElement xmlElement; @@ -291,7 +291,7 @@ struct _xmlElement { /** * XML_LOCAL_NAMESPACE: * - * A namespace declaration node + * A namespace declaration node. */ #define XML_LOCAL_NAMESPACE XML_NAMESPACE_DECL typedef xmlElementType xmlNsType; @@ -303,7 +303,7 @@ typedef xmlElementType xmlNsType; * Note that prefix == NULL is valid, it defines the default namespace * within the subtree (until overridden). * - * xmlNsType is unified with xmlElementType + * xmlNsType is unified with xmlElementType. */ typedef struct _xmlNs xmlNs; @@ -319,7 +319,7 @@ struct _xmlNs { * xmlDtd: * * An XML DTD, as defined by type == XML_ELEMENT_NODE ? NULL : (n)->content) @@ -455,9 +455,9 @@ struct _xmlNode { /** * XML_GET_LINE: * - * macro to extract the line number of an element node. + * Macro to extract the line number of an element node. * This will work only if line numbering is activated by - * calling xmlLineNumbersDefault(1) before parsing + * calling xmlLineNumbersDefault(1) before parsing. */ #define XML_GET_LINE(n) \ ((n)->type == XML_ELEMENT_NODE ? (int) (n)->content : 0) @@ -498,7 +498,7 @@ struct _xmlDoc { /** * xmlChildrenNode: * - * Macro for compatibility naming layer with libxml1 + * Macro for compatibility naming layer with libxml1. */ #ifndef xmlChildrenNode #define xmlChildrenNode children @@ -507,7 +507,7 @@ struct _xmlDoc { /** * xmlRootNode: * - * Macro for compatibility naming layer with libxml1 + * Macro for compatibility naming layer with libxml1. */ #ifndef xmlRootNode #define xmlRootNode children @@ -559,7 +559,7 @@ void xmlBufferSetAllocationScheme(xmlBufferPtr buf, int xmlBufferLength (const xmlBufferPtr buf); /* - * Creating/freeing new structures + * Creating/freeing new structures. */ xmlDtdPtr xmlCreateIntSubset (xmlDocPtr doc, const xmlChar *name, @@ -602,7 +602,7 @@ xmlDocPtr xmlCopyDoc (xmlDocPtr doc, int recursive); /* - * Creating new nodes + * Creating new nodes. */ xmlNodePtr xmlNewDocNode (xmlDocPtr doc, xmlNsPtr ns, @@ -651,7 +651,7 @@ xmlNodePtr xmlCopyNodeList (xmlNodePtr node); xmlNodePtr xmlNewDocFragment (xmlDocPtr doc); /* - * Navigating + * Navigating. */ long xmlGetLineNo (xmlNodePtr node); xmlChar * xmlGetNodePath (xmlNodePtr node); @@ -661,7 +661,7 @@ int xmlNodeIsText (xmlNodePtr node); int xmlIsBlankNode (xmlNodePtr node); /* - * Changing the structure + * Changing the structure. */ xmlNodePtr xmlDocSetRootElement (xmlDocPtr doc, xmlNodePtr root); @@ -693,7 +693,7 @@ void xmlSetListDoc (xmlNodePtr list, xmlDocPtr doc); /* - * Namespaces + * Namespaces. */ xmlNsPtr xmlSearchNs (xmlDocPtr doc, xmlNodePtr node, @@ -772,7 +772,7 @@ int xmlUnsetNsProp (xmlNodePtr node, const xmlChar *name); /* - * Internal, don't use + * Internal, don't use. */ #ifdef VMS void xmlBufferWriteXmlCHAR (xmlBufferPtr buf, @@ -788,13 +788,13 @@ void xmlBufferWriteQuotedString(xmlBufferPtr buf, const xmlChar *string); /* - * Namespace handling + * Namespace handling. */ int xmlReconciliateNs (xmlDocPtr doc, xmlNodePtr tree); /* - * Saving + * Saving. */ void xmlDocDumpFormatMemory (xmlDocPtr cur, xmlChar **mem, @@ -852,7 +852,7 @@ int xmlSaveFileEnc (const char *filename, const char *encoding); /* - * Compression + * Compression. */ int xmlGetDocCompressMode (xmlDocPtr doc); void xmlSetDocCompressMode (xmlDocPtr doc, diff --git a/include/libxml/uri.h b/include/libxml/uri.h index 80713533..8ca7dad9 100644 --- a/include/libxml/uri.h +++ b/include/libxml/uri.h @@ -21,7 +21,7 @@ extern "C" { * xmlURI: * * A parsed URI reference. This is a struct containing the various fields - * as described in RFC 2396 but separated for further processing + * as described in RFC 2396 but separated for further processing. */ typedef struct _xmlURI xmlURI; typedef xmlURI *xmlURIPtr; diff --git a/include/libxml/valid.h b/include/libxml/valid.h index db427ff3..68a3c850 100644 --- a/include/libxml/valid.h +++ b/include/libxml/valid.h @@ -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, diff --git a/include/libxml/xlink.h b/include/libxml/xlink.h index e8fdf555..c7f48c85 100644 --- a/include/libxml/xlink.h +++ b/include/libxml/xlink.h @@ -22,9 +22,9 @@ extern "C" { * Various defines for the various Link properties. * * NOTE: the link detection layer will try to resolve QName expansion - * of namespaces, if "foo" is the prefix for "http://foo.com/" + * of namespaces. If "foo" is the prefix for "http://foo.com/" * then the link detection layer will expand role="foo:myrole" - * to "http://foo.com/:myrole" + * to "http://foo.com/:myrole". * NOTE: the link detection layer will expand URI-Refences found on * href attributes by using the base mechanism if found. */ @@ -57,7 +57,7 @@ typedef enum { * @ctx: user data pointer * @node: the node to check * - * This is the prototype for the link detection routine + * This is the prototype for the link detection routine. * It calls the default link detection callbacks upon link detection. */ typedef void (*xlinkNodeDetectFunc) (void *ctx, xmlNodePtr node); @@ -141,7 +141,7 @@ typedef void const xmlChar **langs); /** - * This is the structure containing a set of Links detection callbacks + * This is the structure containing a set of Links detection callbacks. * * There is no default xlink callbacks, if one want to get link * recognition activated, those call backs must be provided before parsing. @@ -155,7 +155,7 @@ struct _xlinkHandler { }; /* - * the default detection routine, can be overridden, they call the default + * The default detection routine, can be overridden, they call the default * detection callbacks. */ diff --git a/include/libxml/xmlerror.h b/include/libxml/xmlerror.h index e7edb5c7..33e22759 100644 --- a/include/libxml/xmlerror.h +++ b/include/libxml/xmlerror.h @@ -145,7 +145,7 @@ typedef enum { * @...: the extra arguments of the varags to format the message * * Signature of the function to use when there is an error and - * no parsing or validity context available + * no parsing or validity context available . */ typedef void (*xmlGenericErrorFunc) (void *ctx, const char *msg, @@ -161,7 +161,7 @@ void initGenericErrorDefaultFunc(xmlGenericErrorFunc *handler); /* * Default message routines used by SAX and Valid context for error - * and warning reporting + * and warning reporting. */ void xmlParserError (void *ctx, const char *msg, diff --git a/include/libxml/xmlmemory.h b/include/libxml/xmlmemory.h index 14c43834..babe57be 100644 --- a/include/libxml/xmlmemory.h +++ b/include/libxml/xmlmemory.h @@ -18,10 +18,10 @@ /** * DEBUG_MEMORY: * - * should be activated only done when debugging libxml. It replaces the - * allocator with a collect and debug shell to the libc allocator. - * DEBUG_MEMORY should be activated only when debugging - * libxml i.e. if libxml has been configured with --with-debug-mem too + * DEBUG_MEMORY replaces the allocator with a collect and debug + * shell to the libc allocator. + * DEBUG_MEMORY should only be activated when debugging + * libxml i.e. if libxml has been configured with --with-debug-mem too. */ /* #define DEBUG_MEMORY_FREED */ /* #define DEBUG_MEMORY_LOCATION */ @@ -36,7 +36,7 @@ * DEBUG_MEMORY_LOCATION: * * DEBUG_MEMORY_LOCATION should be activated only when debugging - * libxml i.e. if libxml has been configured with --with-debug-mem too + * libxml i.e. if libxml has been configured with --with-debug-mem too. */ #ifdef DEBUG_MEMORY_LOCATION #endif @@ -46,22 +46,22 @@ extern "C" { #endif /* - * The XML memory wrapper support 4 basic overloadable functions + * The XML memory wrapper support 4 basic overloadable functions. */ /** * xmlFreeFunc: * @mem: an already allocated block of memory * - * Signature for a free() implementation + * Signature for a free() implementation. */ typedef void (*xmlFreeFunc)(void *mem); /** * xmlMallocFunc: * @size: the size requested in bytes * - * Signature for a malloc() implementation + * Signature for a malloc() implementation. * - * Returns a pointer to the newly allocated block or NULL in case of error + * Returns a pointer to the newly allocated block or NULL in case of error. */ typedef void *(*xmlMallocFunc)(size_t size); @@ -70,9 +70,9 @@ typedef void *(*xmlMallocFunc)(size_t size); * @mem: an already allocated block of memory * @size: the new size requested in bytes * - * Signature for a realloc() implementation + * Signature for a realloc() implementation. * - * Returns a pointer to the newly reallocated block or NULL in case of error + * Returns a pointer to the newly reallocated block or NULL in case of error. */ typedef void *(*xmlReallocFunc)(void *mem, size_t size); @@ -80,14 +80,14 @@ typedef void *(*xmlReallocFunc)(void *mem, size_t size); * xmlStrdupFunc: * @str: a zero terminated string * - * Signature for an strdup() implementation + * Signature for an strdup() implementation. * - * Returns the copy of the string or NULL in case of error + * Returns the copy of the string or NULL in case of error. */ typedef char *(*xmlStrdupFunc)(const char *str); /* - * The 4 interfaces used for all memory handling within libxml + * The 4 interfaces used for all memory handling within libxml. LIBXML_DLL_IMPORT extern xmlFreeFunc xmlFree; LIBXML_DLL_IMPORT extern xmlMallocFunc xmlMalloc; LIBXML_DLL_IMPORT extern xmlReallocFunc xmlRealloc; @@ -95,7 +95,7 @@ LIBXML_DLL_IMPORT extern xmlStrdupFunc xmlMemStrdup; */ /* - * The way to overload the existing functions + * The way to overload the existing functions. */ int xmlMemSetup (xmlFreeFunc freeFunc, xmlMallocFunc mallocFunc, @@ -107,12 +107,12 @@ int xmlMemGet (xmlFreeFunc *freeFunc, xmlStrdupFunc *strdupFunc); /* - * Initialization of the memory layer + * Initialization of the memory layer. */ int xmlInitMemory (void); /* - * Those are specific to the XML debug memory wrapper + * Those are specific to the XML debug memory wrapper. */ int xmlMemUsed (void); void xmlMemDisplay (FILE *fp); @@ -124,9 +124,9 @@ void xmlMemoryDump (void); * xmlMalloc: * @size: number of bytes to allocate * - * Wrapper for the malloc() function used in the XML library + * Wrapper for the malloc() function used in the XML library. * - * Returns the pointer to the allocated area or NULL in case of error + * Returns the pointer to the allocated area or NULL in case of error. */ #define xmlMalloc(size) xmlMallocLoc((size), __FILE__, __LINE__) /** @@ -134,18 +134,18 @@ void xmlMemoryDump (void); * @ptr: pointer to the existing allocated area * @size: number of bytes to allocate * - * Wrapper for the realloc() function used in the XML library + * Wrapper for the realloc() function used in the XML library. * - * Returns the pointer to the allocated area or NULL in case of error + * Returns the pointer to the allocated area or NULL in case of error. */ #define xmlRealloc(ptr, size) xmlReallocLoc((ptr), (size), __FILE__, __LINE__) /** * xmlMemStrdup: * @str: pointer to the existing string * - * Wrapper for the strdup() function, xmlStrdup() is usually preferred + * Wrapper for the strdup() function, xmlStrdup() is usually preferred. * - * Returns the pointer to the allocated area or NULL in case of error + * Returns the pointer to the allocated area or NULL in case of error. */ #define xmlMemStrdup(str) xmlMemStrdupLoc((str), __FILE__, __LINE__) diff --git a/include/libxml/xpath.h b/include/libxml/xpath.h index ef77e134..f36b16f9 100644 --- a/include/libxml/xpath.h +++ b/include/libxml/xpath.h @@ -25,7 +25,7 @@ typedef struct _xmlXPathParserContext xmlXPathParserContext; typedef xmlXPathParserContext *xmlXPathParserContextPtr; /** - * The set of XPath error codes + * The set of XPath error codes. */ typedef enum { @@ -54,7 +54,7 @@ typedef enum { } xmlXPathError; /* - * A node-set (an unordered collection of nodes without duplicates) + * A node-set (an unordered collection of nodes without duplicates). */ typedef struct _xmlNodeSet xmlNodeSet; typedef xmlNodeSet *xmlNodeSetPtr; @@ -142,7 +142,7 @@ struct _xmlXPathVariable { * @ctxt: an XPath parser context * @nargs: the number of arguments passed to the function * - * an XPath evaluation function, the parameters are on the XPath context stack + * An XPath evaluation function, the parameters are on the XPath context stack. */ typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt, @@ -168,7 +168,7 @@ struct _xmlXPathFunct { * the first time with cur == NULL and repeat until the function returns * NULL indicating the end of the axis traversal. * - * Returns the next node in that axis or NULL if at the end of the axis + * Returns the next node in that axis or NULL if at the end of the axis. */ typedef xmlXPathObjectPtr (*xmlXPathAxisFunc) (xmlXPathParserContextPtr ctxt, @@ -255,7 +255,7 @@ struct _xmlXPathContext { }; /* - * The structure of a compiled expression form is not public + * The structure of a compiled expression form is not public. */ typedef struct _xmlXPathCompExpr xmlXPathCompExpr; @@ -264,7 +264,7 @@ typedef xmlXPathCompExpr *xmlXPathCompExprPtr; /** * xmlXPathParserContext: * - * An XPath parser context, it contains pure parsing informations, + * An XPath parser context. It contains pure parsing informations, * an xmlXPathContext, and the stack of objects. */ struct _xmlXPathParserContext { @@ -289,7 +289,7 @@ struct _xmlXPathParserContext { * @ctxt: the XPath interprestation context * @nargs: the number of arguments * - * An XPath function + * An XPath function. * The arguments (if any) are popped out from the context stack * and the result is pushed on the stack. */ @@ -318,7 +318,7 @@ int xmlXPathIsInf (double val); * xmlXPathNodeSetGetLength: * @ns: a node-set * - * Implement a functionality similar to the DOM NodeList.length + * Implement a functionality similar to the DOM NodeList.length. * * Returns the number of nodes in the node-set. */ @@ -328,7 +328,7 @@ int xmlXPathIsInf (double val); * @ns: a node-set * @index: index of a node in the set * - * Implements a functionality similar to the DOM NodeList.item() + * Implements a functionality similar to the DOM NodeList.item(). * * Returns the xmlNodePtr at the given @index in @ns or NULL if * @index is out of range (0 to length-1) @@ -342,9 +342,9 @@ int xmlXPathIsInf (double val); * xmlXPathNodeSetIsEmpty: * @ns: a node-set * - * Checks whether @ns is empty or not + * Checks whether @ns is empty or not. * - * Returns %TRUE if @ns is an empty node-set + * Returns %TRUE if @ns is an empty node-set. */ #define xmlXPathNodeSetIsEmpty(ns) \ (((ns) == NULL) || ((ns)->nodeNr == 0) || ((ns)->nodeTab == NULL)) @@ -358,7 +358,7 @@ xmlXPathObjectPtr xmlXPathObjectCopy (xmlXPathObjectPtr val); int xmlXPathCmpNodes (xmlNodePtr node1, xmlNodePtr node2); /** - * Conversion functions to basic types + * Conversion functions to basic types. */ int xmlXPathCastNumberToBoolean (double val); int xmlXPathCastStringToBoolean (const xmlChar * val); @@ -382,7 +382,7 @@ xmlXPathObjectPtr xmlXPathConvertNumber (xmlXPathObjectPtr val); xmlXPathObjectPtr xmlXPathConvertString (xmlXPathObjectPtr val); /** - * Context handling + * Context handling. */ void xmlXPathInit (void); xmlXPathContextPtr xmlXPathNewContext (xmlDocPtr doc); @@ -398,7 +398,7 @@ xmlXPathObjectPtr xmlXPathEvalExpression (const xmlChar *str, int xmlXPathEvalPredicate (xmlXPathContextPtr ctxt, xmlXPathObjectPtr res); /** - * Separate compilation/evaluation entry points + * Separate compilation/evaluation entry points. */ xmlXPathCompExprPtr xmlXPathCompile (const xmlChar *str); xmlXPathObjectPtr xmlXPathCompiledEval (xmlXPathCompExprPtr comp, diff --git a/include/libxml/xpathInternals.h b/include/libxml/xpathInternals.h index 19255b0c..a75862e8 100644 --- a/include/libxml/xpathInternals.h +++ b/include/libxml/xpathInternals.h @@ -46,7 +46,7 @@ extern "C" { * xmlXPathSetArityError: * @ctxt: an XPath parser context * - * Raises an XPATH_INVALID_ARITY error + * Raises an XPATH_INVALID_ARITY error. */ #define xmlXPathSetArityError(ctxt) \ xmlXPathSetError((ctxt), XPATH_INVALID_ARITY) @@ -55,7 +55,7 @@ extern "C" { * xmlXPathSetTypeError: * @ctxt: an XPath parser context * - * Raises an XPATH_INVALID_TYPE error + * Raises an XPATH_INVALID_TYPE error. */ #define xmlXPathSetTypeError(ctxt) \ xmlXPathSetError((ctxt), XPATH_INVALID_TYPE) @@ -64,9 +64,9 @@ extern "C" { * xmlXPathGetError: * @ctxt: an XPath parser context * - * Get the error code of an XPath context + * Get the error code of an XPath context. * - * Returns the context error + * Returns the context error. */ #define xmlXPathGetError(ctxt) ((ctxt)->error) @@ -74,7 +74,7 @@ extern "C" { * xmlXPathCheckError: * @ctxt: an XPath parser context * - * Check if an XPath error was raised + * Check if an XPath error was raised. * * Returns true if an error has been raised, false otherwise. */ @@ -84,9 +84,9 @@ extern "C" { * xmlXPathGetDocument: * @ctxt: an XPath parser context * - * Get the document of an XPath context + * Get the document of an XPath context. * - * Returns the context document + * Returns the context document. */ #define xmlXPathGetDocument(ctxt) ((ctxt)->context->doc) @@ -94,9 +94,9 @@ extern "C" { * xmlXPathGetContextNode: * @ctxt: an XPath parser context * - * Get the context node of an XPath context + * Get the context node of an XPath context. * - * Returns the context node + * Returns the context node. */ #define xmlXPathGetContextNode(ctxt) ((ctxt)->context->node) @@ -111,7 +111,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ctxt: an XPath parser context * @val: a boolean * - * Pushes the boolean @val on the context stack + * Pushes the boolean @val on the context stack. */ #define xmlXPathReturnBoolean(ctxt, val) \ valuePush((ctxt), xmlXPathNewBoolean(val)) @@ -120,7 +120,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * xmlXPathReturnTrue: * @ctxt: an XPath parser context * - * Pushes true on the context stack + * Pushes true on the context stack. */ #define xmlXPathReturnTrue(ctxt) xmlXPathReturnBoolean((ctxt), 1) @@ -128,7 +128,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * xmlXPathReturnFalse: * @ctxt: an XPath parser context * - * Pushes false on the context stack + * Pushes false on the context stack. */ #define xmlXPathReturnFalse(ctxt) xmlXPathReturnBoolean((ctxt), 0) @@ -137,7 +137,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ctxt: an XPath parser context * @val: a double * - * Pushes the double @val on the context stack + * Pushes the double @val on the context stack. */ #define xmlXPathReturnNumber(ctxt, val) \ valuePush((ctxt), xmlXPathNewFloat(val)) @@ -147,7 +147,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ctxt: an XPath parser context * @str: a string * - * Pushes the string @str on the context stack + * Pushes the string @str on the context stack. */ #define xmlXPathReturnString(ctxt, str) \ valuePush((ctxt), xmlXPathWrapString(str)) @@ -156,7 +156,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * xmlXPathReturnEmptyString: * @ctxt: an XPath parser context * - * Pushes an empty string on the stack + * Pushes an empty string on the stack. */ #define xmlXPathReturnEmptyString(ctxt) \ valuePush((ctxt), xmlXPathNewCString("")) @@ -166,7 +166,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ctxt: an XPath parser context * @ns: a node-set * - * Pushes the node-set @ns on the context stack + * Pushes the node-set @ns on the context stack. */ #define xmlXPathReturnNodeSet(ctxt, ns) \ valuePush((ctxt), xmlXPathWrapNodeSet(ns)) @@ -175,7 +175,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * xmlXPathReturnEmptyNodeSet: * @ctxt: an XPath parser context * - * Pushes an empty node-set on the context stack + * Pushes an empty node-set on the context stack. */ #define xmlXPathReturnEmptyNodeSet(ctxt) \ valuePush((ctxt), xmlXPathNewNodeSet(NULL)) @@ -185,7 +185,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ctxt: an XPath parser context * @val: user data * - * Pushes user data on the context stack + * Pushes user data on the context stack. */ #define xmlXPathReturnExternal(ctxt, val) \ valuePush((ctxt), xmlXPathWrapExternal(val)) @@ -195,9 +195,9 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ctxt: an XPath parser context * * Check if the current value on the XPath stack is a node set or - * an XSLT value tree + * an XSLT value tree. * - * Returns true if the current object on the stack is a node-set + * Returns true if the current object on the stack is a node-set. */ #define xmlXPathStackIsNodeSet(ctxt) \ (((ctxt)->value != NULL) \ @@ -212,7 +212,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * object. * * Returns true if the current object on the stack is an external - * object + * object. */ #define xmlXPathStackIsExternal(ctxt) \ ((ctxt->value != NULL) && (ctxt->value->type == XPATH_USERS)) @@ -221,7 +221,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * xmlXPathEmptyNodeSet: * @ns: a node-set * - * Empties a node-set + * Empties a node-set. */ #define xmlXPathEmptyNodeSet(ns) \ { while ((ns)->nodeNr > 0) (ns)->nodeTab[(ns)->nodeNr--] = NULL; } @@ -229,7 +229,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); /** * CHECK_ERROR: * - * macro to return from the function if an XPath error was detected + * Macro to return from the function if an XPath error was detected. */ #define CHECK_ERROR \ if (ctxt->error != XPATH_EXPRESSION_OK) return @@ -237,7 +237,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); /** * CHECK_ERROR0: * - * macro to return 0 from the function if an XPath error was detected + * Macro to return 0 from the function if an XPath error was detected. */ #define CHECK_ERROR0 \ if (ctxt->error != XPATH_EXPRESSION_OK) return(0) @@ -246,7 +246,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * XP_ERROR: * @X: the error code * - * Macro to raise an XPath error and return + * Macro to raise an XPath error and return. */ #define XP_ERROR(X) \ { xmlXPatherror(ctxt, __FILE__, __LINE__, X); \ @@ -256,7 +256,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * XP_ERROR0: * @X: the error code * - * Macro to raise an XPath error and return 0 + * Macro to raise an XPath error and return 0. */ #define XP_ERROR0(X) \ { xmlXPatherror(ctxt, __FILE__, __LINE__, X); \ @@ -278,7 +278,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @typeval: the XPath type * * Macro to check that the value on top of the XPath stack is of a given - * type. return(0) in case of failure + * type. Return(0) in case of failure */ #define CHECK_TYPE0(typeval) \ if ((ctxt->value == NULL) || (ctxt->value->type != typeval)) \ @@ -288,7 +288,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * CHECK_ARITY: * @x: the number of expected args * - * Macro to check that the number of args passed to an XPath function matches + * Macro to check that the number of args passed to an XPath function matches. */ #define CHECK_ARITY(x) \ if (nargs != (x)) \ @@ -297,7 +297,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); /** * CAST_TO_STRING: * - * Macro to try to cast the value on the top of the XPath stack to a string + * Macro to try to cast the value on the top of the XPath stack to a string. */ #define CAST_TO_STRING \ if ((ctxt->value != NULL) && (ctxt->value->type != XPATH_STRING)) \ @@ -306,7 +306,7 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); /** * CAST_TO_NUMBER: * - * Macro to try to cast the value on the top of the XPath stack to a number + * Macro to try to cast the value on the top of the XPath stack to a number. */ #define CAST_TO_NUMBER \ if ((ctxt->value != NULL) && (ctxt->value->type != XPATH_NUMBER)) \ @@ -315,14 +315,14 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); /** * CAST_TO_BOOLEAN: * - * Macro to try to cast the value on the top of the XPath stack to a boolean + * Macro to try to cast the value on the top of the XPath stack to a boolean. */ #define CAST_TO_BOOLEAN \ if ((ctxt->value != NULL) && (ctxt->value->type != XPATH_BOOLEAN)) \ xmlXPathBooleanFunction(ctxt, 1); /* - * Variable Lookup forwarding + * Variable Lookup forwarding. */ /** * xmlXPathVariableLookupFunc: @@ -331,9 +331,9 @@ void * xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); * @ns_uri: the namespace name hosting this variable * * Prototype for callbacks used to plug variable lookup in the XPath - * engine + * engine. * - * Returns the XPath object value or NULL if not found + * Returns the XPath object value or NULL if not found. */ typedef xmlXPathObjectPtr (*xmlXPathVariableLookupFunc) (void *ctxt, const xmlChar *name, @@ -344,7 +344,7 @@ void xmlXPathRegisterVariableLookup (xmlXPathContextPtr ctxt, void *data); /* - * Function Lookup forwarding + * Function Lookup forwarding. */ /** * xmlXPathFuncLookupFunc: @@ -353,9 +353,9 @@ void xmlXPathRegisterVariableLookup (xmlXPathContextPtr ctxt, * @ns_uri: the namespace name hosting this function * * Prototype for callbacks used to plug function lookup in the XPath - * engine + * engine. * - * Returns the XPath function or NULL if not found + * Returns the XPath function or NULL if not found. */ typedef xmlXPathFunction (*xmlXPathFuncLookupFunc) (void *ctxt, const xmlChar *name, @@ -366,7 +366,7 @@ void xmlXPathRegisterFuncLookup (xmlXPathContextPtr ctxt, void *funcCtxt); /* - * Error reporting + * Error reporting. */ void xmlXPatherror (xmlXPathParserContextPtr ctxt, const char *file, @@ -381,7 +381,7 @@ void xmlXPathDebugDumpCompExpr(FILE *output, int depth); /** - * NodeSet handling + * NodeSet handling. */ int xmlXPathNodeSetContains (xmlNodeSetPtr cur, xmlNodePtr val); @@ -416,7 +416,7 @@ xmlNodeSetPtr xmlXPathTrailing (xmlNodeSetPtr nodes1, /** - * Extending a context + * Extending a context. */ int xmlXPathRegisterNs (xmlXPathContextPtr ctxt, @@ -454,14 +454,14 @@ xmlXPathObjectPtr xmlXPathVariableLookupNS (xmlXPathContextPtr ctxt, void xmlXPathRegisteredVariablesCleanup(xmlXPathContextPtr ctxt); /** - * Utilities to extend XPath + * Utilities to extend XPath. */ xmlXPathParserContextPtr xmlXPathNewParserContext (const xmlChar *str, xmlXPathContextPtr ctxt); void xmlXPathFreeParserContext (xmlXPathParserContextPtr ctxt); -/* TODO: remap to xmlXPathValuePop and Push */ +/* TODO: remap to xmlXPathValuePop and Push. */ xmlXPathObjectPtr valuePop (xmlXPathParserContextPtr ctxt); int valuePush (xmlXPathParserContextPtr ctxt, xmlXPathObjectPtr value); @@ -486,7 +486,7 @@ xmlChar * xmlXPathParseName (xmlXPathParserContextPtr ctxt); xmlChar * xmlXPathParseNCName (xmlXPathParserContextPtr ctxt); /* - * Existing functions + * Existing functions. */ double xmlXPathStringEvalNumber(const xmlChar *str); int xmlXPathEvaluatePredicateResult(xmlXPathParserContextPtr ctxt, @@ -511,7 +511,7 @@ void xmlXPathModValues(xmlXPathParserContextPtr ctxt); int xmlXPathIsNodeType(const xmlChar *name); /* - * Some of the axis navigation routines + * Some of the axis navigation routines. */ xmlNodePtr xmlXPathNextSelf(xmlXPathParserContextPtr ctxt, xmlNodePtr cur); @@ -540,7 +540,7 @@ xmlNodePtr xmlXPathNextAncestor(xmlXPathParserContextPtr ctxt, xmlNodePtr xmlXPathNextPrecedingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur); /* - * The official core of XPath functions + * The official core of XPath functions. */ void xmlXPathLastFunction(xmlXPathParserContextPtr ctxt, int nargs); void xmlXPathPositionFunction(xmlXPathParserContextPtr ctxt, int nargs); diff --git a/include/libxml/xpointer.h b/include/libxml/xpointer.h index a81eacb6..80c465c7 100644 --- a/include/libxml/xpointer.h +++ b/include/libxml/xpointer.h @@ -31,7 +31,7 @@ struct _xmlLocationSet { }; /* - * Handling of location sets + * Handling of location sets. */ xmlLocationSetPtr xmlXPtrLocationSetCreate(xmlXPathObjectPtr val); @@ -65,7 +65,7 @@ void xmlXPtrLocationSetRemove(xmlLocationSetPtr cur, int val); /* - * Functions + * Functions. */ xmlXPathContextPtr xmlXPtrNewContext (xmlDocPtr doc, xmlNodePtr here,