From 398d93b837e2b970ccc9f0abf6a8eab646b6b6c3 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Wed, 13 Mar 2002 14:23:40 +0000 Subject: [PATCH] applied another cleanup comment diff from Heiko W. Rupp, regenerated the * libxslt/*.h doc/* python/*: applied another cleanup comment diff from Heiko W. Rupp, regenerated the API and python Daniel --- ChangeLog | 5 +++ doc/html/libxslt-extensions.html | 8 ++-- doc/html/libxslt-functions.html | 2 +- doc/html/libxslt-imports.html | 4 +- doc/html/libxslt-pattern.html | 2 +- doc/html/libxslt-variables.html | 2 +- doc/html/libxslt-xslt.html | 8 ++-- doc/html/libxslt-xsltinternals.html | 54 ++++++++++++------------ doc/html/libxslt-xsltutils.html | 6 +-- doc/libxslt-api.xml | 64 ++++++++++++++--------------- doc/libxslt-decl.txt | 38 +++++++++-------- doc/libxslt-refs.xml | 33 +++++++-------- libxslt/extensions.h | 18 ++++---- libxslt/extra.h | 10 ++--- libxslt/functions.h | 4 +- libxslt/imports.h | 4 +- libxslt/numbersInternals.h | 4 +- libxslt/pattern.h | 6 +-- libxslt/transform.h | 4 +- libxslt/variables.h | 2 +- libxslt/xslt.h | 20 ++++----- libxslt/xsltInternals.h | 62 ++++++++++++++-------------- libxslt/xsltutils.h | 26 ++++++------ 23 files changed, 199 insertions(+), 187 deletions(-) diff --git a/ChangeLog b/ChangeLog index cc620f2d..ef4a0e8b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Wed Mar 13 15:17:51 CET 2002 Daniel Veillard + + * libxslt/*.h doc/* python/*: applied another cleanup comment + diff from Heiko W. Rupp, regenerated the API and python + Wed Mar 13 13:41:19 CET 2002 Daniel Veillard * tests/docs/Makefile.am tests/docs/bug-76.xml diff --git a/doc/html/libxslt-extensions.html b/doc/html/libxslt-extensions.html index 34fb3a82..630e9dfc 100644 --- a/doc/html/libxslt-extensions.html +++ b/doc/html/libxslt-extensions.html @@ -670,7 +670,7 @@ HREF="XMLCHAR" >

A function called at initialization time of an XSLT extension module

A function called at initialization time of an XSLT extension module.

A function called at shutdown time of an XSLT extension module

A function called at shutdown time of an XSLT extension module.

A function called at initialization time of an XSLT extension module

A function called at initialization time of an XSLT extension module.

A function called at shutdown time of an XSLT extension module

A function called at shutdown time of an XSLT extension module.

registering macro, not general purpose at all but used in different modules

Registering macro, not general purpose at all but used in different modules.

a macro to import pointers from the stylesheet cascading order

A macro to import pointers from the stylesheet cascading order.

a macro to import intergers from the stylesheet cascading order

A macro to import intergers from the stylesheet cascading order.

Data structure used for the implementation of patterns. -It is kept private (in pattern.c)

registering macro, not general purpose at all but used in different modules

Registering macro, not general purpose at all but used in different modules.

The default version of XSLT supported

The default version of XSLT supported.

The XSLT "vendor" string for this processor

The XSLT "vendor" string for this processor.

The XSLT "vendor" URL for this processor

The XSLT "vendor" URL for this processor.

The XSLT specification namespace

The XSLT specification namespace.

Max number of specified xsl:sort on an element

Max number of specified xsl:sort on an element.

specific value for pattern without priority expressed

Specific value for pattern without priority expressed.

Extra information added to the transformation context

Extra information added to the transformation context.

The in-memory structure corresponding to an XSLT Template

The in-memory structure corresponding to an XSLT Template.

Data structure of decimal-format

Data structure of decimal-format.

Data structure associated to a parsed document

Data structure associated to a parsed document.

signature of the function associated to elements part of the +>Signature of the function associated to elements part of the stylesheet language like xsl:if or xsl:apply-templates.

Deallocates an xsltElemPreComp structure

structure.

struct xsltStylesheet { /* - * The stylesheet import relation is kept as a tree + * The stylesheet import relation is kept as a tree. */ struct _xsltStylesheet *parent; struct _xsltStylesheet *next; @@ -1549,7 +1549,7 @@ CLASS="PROGRAMLISTING" xsltDocumentPtr docList; /* the include document list */ /* - * General data on the style sheet document + * General data on the style sheet document. */ xmlDocPtr doc; /* the parsed XML stylesheet */ xmlHashTablePtr stripSpaces;/* the hash table of the strip-space and @@ -1558,12 +1558,12 @@ CLASS="PROGRAMLISTING" xmlHashTablePtr cdataSection;/* the hash table of the cdata-section */ /* - * Global variable or parameters + * Global variable or parameters. */ xsltStackElemPtr variables; /* linked list of param and variables */ /* - * Template descriptions + * Template descriptions. */ xsltTemplatePtr templates; /* the ordered list of templates */ void *templatesHash; /* hash table or wherever compiled templates @@ -1578,23 +1578,23 @@ CLASS="PROGRAMLISTING" void *commentMatch; /* template based on comment() */ /* - * Namespace aliases + * Namespace aliases. */ xmlHashTablePtr nsAliases; /* the namespace alias hash tables */ /* - * Attribute sets + * Attribute sets. */ xmlHashTablePtr attributeSets;/* the attribute sets hash tables */ /* - * Namespaces + * Namespaces. */ xmlHashTablePtr nsHash; /* the set of namespaces in use */ void *nsDefs; /* the namespaces defined */ /* - * Key definitions + * Key definitions. */ void *keys; /* key definitions */ @@ -1607,7 +1607,9 @@ CLASS="PROGRAMLISTING" xmlChar *encoding; /* encoding string */ int omitXmlDeclaration; /* omit-xml-declaration = "yes" | "no" */ - /* Number formatting */ + /* + * Number formatting. + */ xsltDecimalFormatPtr decimalFormat; int standalone; /* standalone = "yes" | "no" */ xmlChar *doctypePublic; /* doctype-public string */ @@ -1616,7 +1618,7 @@ CLASS="PROGRAMLISTING" xmlChar *mediaType; /* media-type string */ /* - * Precomputed blocks + * Precomputed blocks. */ xsltElemPreCompPtr preComps;/* list of precomputed blocks */ int warnings; /* number of warnings found at compilation */ @@ -1630,7 +1632,7 @@ CLASS="PROGRAMLISTING" void *_private; /* user defined data */ /* - * Extensions + * Extensions. */ xmlHashTablePtr extInfos; /* the extension data */ int extrasNr; /* the number of extras required */ @@ -1751,8 +1753,8 @@ CLASS="PROGRAMLISTING" >

Macro to check if the XSLT processing should be stopped -will return from the function

Macro to check if the XSLT processing should be stopped. +Will return from the function.

Macro to check if the XSLT processing should be stopped -will goto the error: label

Macro to check if the XSLT processing should be stopped. +Will goto the error: label.

Macro to check if the XSLT processing should be stopped -will return from the function with a 0 value

Macro to check if the XSLT processing should be stopped. +Will return from the function with a 0 value.

Checks that the element pertains to XSLt namespace

Checks that the element pertains to XSLT namespace.

Checks the value of an element in XSLT namespace

Checks the value of an element in XSLT namespace.

check that a node is a 'real' one: document, element, text or attribute

Check that a node is a 'real' one: document, element, text or attribute.

This macro is used to flag unused function parameters to GCC, useless here - Macro to check if the XSLT processing should be stopped will return from the function + Macro to check if the XSLT processing should be stopped. Will return from the function. - Macro to check if the XSLT processing should be stopped will return from the function with a 0 value + Macro to check if the XSLT processing should be stopped. Will return from the function with a 0 value. - Macro to check if the XSLT processing should be stopped will goto the error: label + Macro to check if the XSLT processing should be stopped. Will goto the error: label. should be activated only when debugging libxslt. It replaces the allocator with a collect and debug shell to the libc allocator. Use configure --with-mem-debug to activate it on both library @@ -315,13 +315,13 @@ - Checks that the element pertains to XSLt namespace + Checks that the element pertains to XSLT namespace. - Checks the value of an element in XSLT namespace + Checks the value of an element in XSLT namespace. - check that a node is a 'real' one: document, element, text or attribute + Check that a node is a 'real' one: document, element, text or attribute. the version string like "1.2.3" @@ -352,13 +352,13 @@ - The XSLT "vendor" URL for this processor + The XSLT "vendor" URL for this processor. - The XSLT "vendor" string for this processor + The XSLT "vendor" string for this processor. - The default version of XSLT supported + The default version of XSLT supported. @@ -383,41 +383,41 @@ - a macro to import intergers from the stylesheet cascading order + A macro to import intergers from the stylesheet cascading order. - a macro to import pointers from the stylesheet cascading order + A macro to import pointers from the stylesheet cascading order. - This is the libxslt namespace for specific extensions + This is the libxslt namespace for specific extensions. - Max number of specified xsl:sort on an element + Max number of specified xsl:sort on an element. - The XSLT specification namespace + The XSLT specification namespace. - This is Nom's namespace for SAXON extensions + This is Norm's namespace for SAXON extensions. - specific value for pattern without priority expressed + Specific value for pattern without priority expressed. - registering macro, not general purpose at all but used in different modules + Registering macro, not general purpose at all but used in different modules. - registering macro, not general purpose at all but used in different modules + Registering macro, not general purpose at all but used in different modules. - This is Michael Kay's Saxon processor namespace for extensions + This is Michael Kay's Saxon processor namespace for extensions. @@ -429,10 +429,10 @@ - This is the Apache project XALAN processor namespace for extensions + This is the Apache project XALAN processor namespace for extensions. - This is James Clark's XT processor namespace for extensions + This is James Clark's XT processor namespace for extensions. Add template "call" to call stack @@ -619,7 +619,7 @@ - + Compile the XSLT pattern and generates a list of precompiled form suitable for fast matching. @@ -669,7 +669,7 @@ - + Find decimal-format by name @@ -684,7 +684,7 @@ - + Pre process an XSLT-1.1 document element @@ -717,7 +717,7 @@ - Deallocates an xsltElemPreComp structure + Deallocates an xsltElemPreComp structure. @@ -806,7 +806,7 @@ - A function called at initialization time of an XSLT extension module + A function called at initialization time of an XSLT extension module. @@ -836,7 +836,7 @@ - A function called at shutdown time of an XSLT extension module + A function called at shutdown time of an XSLT extension module. @@ -1383,7 +1383,7 @@ - + Save the profiling informations on output @@ -1463,13 +1463,13 @@ - A function called at initialization time of an XSLT extension module + A function called at initialization time of an XSLT extension module. - A function called at shutdown time of an XSLT extension module + A function called at shutdown time of an XSLT extension module. @@ -1498,7 +1498,7 @@ - + Process the given node and return the new string value. @@ -1533,7 +1533,7 @@ - signature of the function associated to elements part of the stylesheet language like xsl:if or xsl:apply-templates. + Signature of the function associated to elements part of the stylesheet language like xsl:if or xsl:apply-templates. diff --git a/doc/libxslt-decl.txt b/doc/libxslt-decl.txt index eb1147c8..dca8a50c 100644 --- a/doc/libxslt-decl.txt +++ b/doc/libxslt-decl.txt @@ -29,15 +29,15 @@ void LIBXSLT_DOTTED_VERSION -#define LIBXSLT_DOTTED_VERSION "1.0.12" +#define LIBXSLT_DOTTED_VERSION "1.0.13" LIBXSLT_VERSION -#define LIBXSLT_VERSION 10012 +#define LIBXSLT_VERSION 10013 LIBXSLT_VERSION_STRING -#define LIBXSLT_VERSION_STRING "10012" +#define LIBXSLT_VERSION_STRING "10013" WITH_XSLT_DEBUG @@ -73,15 +73,15 @@ void LIBXSLT_DOTTED_VERSION -#define LIBXSLT_DOTTED_VERSION "1.0.12" +#define LIBXSLT_DOTTED_VERSION "1.0.13" LIBXSLT_VERSION -#define LIBXSLT_VERSION 10012 +#define LIBXSLT_VERSION 10013 LIBXSLT_VERSION_STRING -#define LIBXSLT_VERSION_STRING "10012" +#define LIBXSLT_VERSION_STRING "10013" WITH_XSLT_DEBUG @@ -1255,7 +1255,7 @@ struct xsltStylePreComp { xmlNodePtr inst; /* the instruction */ /* - * Pre computed values + * Pre computed values. */ xmlChar *stype; /* sort */ @@ -1326,7 +1326,7 @@ typedef xsltStylesheet *xsltStylesheetPtr; xsltStylesheet struct xsltStylesheet { /* - * The stylesheet import relation is kept as a tree + * The stylesheet import relation is kept as a tree. */ struct _xsltStylesheet *parent; struct _xsltStylesheet *next; @@ -1335,7 +1335,7 @@ struct xsltStylesheet { xsltDocumentPtr docList; /* the include document list */ /* - * General data on the style sheet document + * General data on the style sheet document. */ xmlDocPtr doc; /* the parsed XML stylesheet */ xmlHashTablePtr stripSpaces;/* the hash table of the strip-space and @@ -1344,12 +1344,12 @@ struct xsltStylesheet { xmlHashTablePtr cdataSection;/* the hash table of the cdata-section */ /* - * Global variable or parameters + * Global variable or parameters. */ xsltStackElemPtr variables; /* linked list of param and variables */ /* - * Template descriptions + * Template descriptions. */ xsltTemplatePtr templates; /* the ordered list of templates */ void *templatesHash; /* hash table or wherever compiled templates @@ -1364,23 +1364,23 @@ struct xsltStylesheet { void *commentMatch; /* template based on comment() */ /* - * Namespace aliases + * Namespace aliases. */ xmlHashTablePtr nsAliases; /* the namespace alias hash tables */ /* - * Attribute sets + * Attribute sets. */ xmlHashTablePtr attributeSets;/* the attribute sets hash tables */ /* - * Namespaces + * Namespaces. */ xmlHashTablePtr nsHash; /* the set of namespaces in use */ void *nsDefs; /* the namespaces defined */ /* - * Key definitions + * Key definitions. */ void *keys; /* key definitions */ @@ -1393,7 +1393,9 @@ struct xsltStylesheet { xmlChar *encoding; /* encoding string */ int omitXmlDeclaration; /* omit-xml-declaration = "yes" | "no" */ - /* Number formatting */ + /* + * Number formatting. + */ xsltDecimalFormatPtr decimalFormat; int standalone; /* standalone = "yes" | "no" */ xmlChar *doctypePublic; /* doctype-public string */ @@ -1402,7 +1404,7 @@ struct xsltStylesheet { xmlChar *mediaType; /* media-type string */ /* - * Precomputed blocks + * Precomputed blocks. */ xsltElemPreCompPtr preComps;/* list of precomputed blocks */ int warnings; /* number of warnings found at compilation */ @@ -1416,7 +1418,7 @@ struct xsltStylesheet { void *_private; /* user defined data */ /* - * Extensions + * Extensions. */ xmlHashTablePtr extInfos; /* the extension data */ int extrasNr; /* the number of extras required */ diff --git a/doc/libxslt-refs.xml b/doc/libxslt-refs.xml index 97f00128..54775f07 100644 --- a/doc/libxslt-refs.xml +++ b/doc/libxslt-refs.xml @@ -1433,6 +1433,7 @@ + @@ -1636,7 +1637,7 @@ - + @@ -1711,6 +1712,10 @@ + + + + @@ -1763,9 +1768,15 @@ + + + + + + @@ -1854,6 +1865,11 @@ + + + + + @@ -1900,9 +1916,6 @@ - - - @@ -2266,7 +2279,6 @@ - @@ -3763,10 +3775,6 @@ - - - - @@ -3939,9 +3947,6 @@ - - - @@ -3977,7 +3982,6 @@ - @@ -4462,9 +4466,6 @@ - - - diff --git a/libxslt/extensions.h b/libxslt/extensions.h index 71bd719b..bad3bff7 100644 --- a/libxslt/extensions.h +++ b/libxslt/extensions.h @@ -17,7 +17,7 @@ extern "C" { #endif /** - * Extension Modules API + * Extension Modules API. */ /** @@ -25,9 +25,9 @@ extern "C" { * @ctxt: an XSLT stylesheet * @URI: the namespace URI for the extension * - * A function called at initialization time of an XSLT extension module + * A function called at initialization time of an XSLT extension module. * - * Returns a pointer to the module specific data for this transformation + * Returns a pointer to the module specific data for this transformation. */ typedef void * (*xsltStyleExtInitFunction) (xsltStylesheetPtr style, const xmlChar *URI); @@ -38,7 +38,7 @@ typedef void * (*xsltStyleExtInitFunction) (xsltStylesheetPtr style, * @URI: the namespace URI for the extension * @data: the data associated to this module * - * A function called at shutdown time of an XSLT extension module + * A function called at shutdown time of an XSLT extension module. */ typedef void (*xsltStyleExtShutdownFunction) (xsltStylesheetPtr style, const xmlChar *URI, @@ -49,9 +49,9 @@ typedef void (*xsltStyleExtShutdownFunction) (xsltStylesheetPtr style, * @ctxt: an XSLT transformation context * @URI: the namespace URI for the extension * - * A function called at initialization time of an XSLT extension module + * A function called at initialization time of an XSLT extension module. * - * Returns a pointer to the module specific data for this transformation + * Returns a pointer to the module specific data for this transformation. */ typedef void * (*xsltExtInitFunction) (xsltTransformContextPtr ctxt, const xmlChar *URI); @@ -62,7 +62,7 @@ typedef void * (*xsltExtInitFunction) (xsltTransformContextPtr ctxt, * @URI: the namespace URI for the extension * @data: the data associated to this module * - * A function called at shutdown time of an XSLT extension module + * A function called at shutdown time of an XSLT extension module. */ typedef void (*xsltExtShutdownFunction) (xsltTransformContextPtr ctxt, const xmlChar *URI, @@ -155,7 +155,7 @@ int xsltUnregisterExtModuleTopLevel (const xmlChar *name, const xmlChar *URI); -/* These 2 functions are deprecated for use within modules */ +/* These 2 functions are deprecated for use within modules. */ int xsltRegisterExtFunction (xsltTransformContextPtr ctxt, const xmlChar *name, const xmlChar *URI, @@ -166,7 +166,7 @@ int xsltRegisterExtElement (xsltTransformContextPtr ctxt, xsltTransformFunction function); /* - * Extension Prefix handling API + * Extension Prefix handling API. * Those are used by the XSLT (pre)processor. */ diff --git a/libxslt/extra.h b/libxslt/extra.h index 6db0f651..309108f6 100644 --- a/libxslt/extra.h +++ b/libxslt/extra.h @@ -19,28 +19,28 @@ extern "C" { /** * XSLT_LIBXSLT_NAMESPACE: * - * This is the libxslt namespace for specific extensions + * This is the libxslt namespace for specific extensions. */ #define XSLT_LIBXSLT_NAMESPACE ((xmlChar *) "http://xmlsoft.org/XSLT/namespace") /** * XSLT_SAXON_NAMESPACE: * - * This is Michael Kay's Saxon processor namespace for extensions + * This is Michael Kay's Saxon processor namespace for extensions. */ #define XSLT_SAXON_NAMESPACE ((xmlChar *) "http://icl.com/saxon") /** * XSLT_XT_NAMESPACE: * - * This is James Clark's XT processor namespace for extensions + * This is James Clark's XT processor namespace for extensions. */ #define XSLT_XT_NAMESPACE ((xmlChar *) "http://www.jclark.com/xt") /** * XSLT_XALAN_NAMESPACE: * - * This is the Apache project XALAN processor namespace for extensions + * This is the Apache project XALAN processor namespace for extensions. */ #define XSLT_XALAN_NAMESPACE ((xmlChar *) \ "org.apache.xalan.xslt.extensions.Redirect") @@ -48,7 +48,7 @@ extern "C" { /** * XSLT_NORM_SAXON_NAMESPACE: * - * This is Nom's namespace for SAXON extensions + * This is Norm's namespace for SAXON extensions. */ #define XSLT_NORM_SAXON_NAMESPACE ((xmlChar *) \ "http://nwalsh.com/xslt/ext/com.nwalsh.saxon.CVS") diff --git a/libxslt/functions.h b/libxslt/functions.h index 98e13e6e..bfd049ea 100644 --- a/libxslt/functions.h +++ b/libxslt/functions.h @@ -21,7 +21,7 @@ extern "C" { /** * XSLT_REGISTER_FUNCTION_LOOKUP: * - * registering macro, not general purpose at all but used in different modules + * Registering macro, not general purpose at all but used in different modules. */ #define XSLT_REGISTER_FUNCTION_LOOKUP(ctxt) \ xmlXPathRegisterFuncLookup((ctxt)->xpathCtxt, \ @@ -34,7 +34,7 @@ xmlXPathFunction const xmlChar *ns_uri); /* - * Interfaces for the functions implementations + * Interfaces for the functions implementations. */ void xsltDocumentFunction (xmlXPathParserContextPtr ctxt, diff --git a/libxslt/imports.h b/libxslt/imports.h index b8a3bbb6..b002a097 100644 --- a/libxslt/imports.h +++ b/libxslt/imports.h @@ -19,7 +19,7 @@ extern "C" { /** * XSLT_GET_IMPORT_PTR: * - * a macro to import pointers from the stylesheet cascading order + * A macro to import pointers from the stylesheet cascading order. */ #define XSLT_GET_IMPORT_PTR(res, style, name) { \ xsltStylesheetPtr st = style; \ @@ -32,7 +32,7 @@ extern "C" { /** * XSLT_GET_IMPORT_INT: * - * a macro to import intergers from the stylesheet cascading order + * A macro to import intergers from the stylesheet cascading order. */ #define XSLT_GET_IMPORT_INT(res, style, name) { \ xsltStylesheetPtr st = style; \ diff --git a/libxslt/numbersInternals.h b/libxslt/numbersInternals.h index 0cb7df4c..b4d9359e 100644 --- a/libxslt/numbersInternals.h +++ b/libxslt/numbersInternals.h @@ -19,7 +19,7 @@ extern "C" { /** * xsltNumberData: * - * This data structure is just a wrapper to pass xsl:number data in + * This data structure is just a wrapper to pass xsl:number data in. */ typedef struct _xsltNumberData { xmlChar *level; @@ -37,7 +37,7 @@ typedef struct _xsltNumberData { /** * xsltFormatNumberInfo,: * - * This data structure lists the various parameters needed to format numbers + * This data structure lists the various parameters needed to format numbers. */ typedef struct _xsltFormatNumberInfo { int integer_digits; /* Number of '0' in integer part */ diff --git a/libxslt/pattern.h b/libxslt/pattern.h index 57b7482c..52e8a17d 100644 --- a/libxslt/pattern.h +++ b/libxslt/pattern.h @@ -19,13 +19,13 @@ extern "C" { * xsltCompMatch: * * Data structure used for the implementation of patterns. - * It is kept private (in pattern.c) + * It is kept private (in pattern.c). */ typedef struct _xsltCompMatch xsltCompMatch; typedef xsltCompMatch *xsltCompMatchPtr; /* - * Pattern related interfaces + * Pattern related interfaces. */ xsltCompMatchPtr xsltCompilePattern (const xmlChar *pattern, @@ -39,7 +39,7 @@ int xsltTestCompMatchList (xsltTransformContextPtr ctxt, xsltCompMatchPtr comp); /* - * Template related interfaces + * Template related interfaces. */ int xsltAddTemplate (xsltStylesheetPtr style, xsltTemplatePtr cur, diff --git a/libxslt/transform.h b/libxslt/transform.h index 9aa7386a..7223bd6d 100644 --- a/libxslt/transform.h +++ b/libxslt/transform.h @@ -18,7 +18,7 @@ extern "C" { #endif /** - * XInclude default processing + * XInclude default processing. */ void xsltSetXIncludeDefault (int xinclude); int xsltGetXIncludeDefault (void); @@ -38,7 +38,7 @@ xmlDocPtr xsltApplyStylesheetUser (xsltStylesheetPtr style, FILE * profile, xsltTransformContextPtr userCtxt); /** - * Private Interfaces + * Private Interfaces. */ void xsltApplyStripSpaces (xsltTransformContextPtr ctxt, xmlNodePtr node); diff --git a/libxslt/variables.h b/libxslt/variables.h index d118f230..1d809f82 100644 --- a/libxslt/variables.h +++ b/libxslt/variables.h @@ -22,7 +22,7 @@ extern "C" { /** * XSLT_REGISTER_VARIABLE_LOOKUP: * - * registering macro, not general purpose at all but used in different modules + * Registering macro, not general purpose at all but used in different modules. */ #define XSLT_REGISTER_VARIABLE_LOOKUP(ctxt) \ diff --git a/libxslt/xslt.h b/libxslt/xslt.h index 0dfb6606..2d96491e 100644 --- a/libxslt/xslt.h +++ b/libxslt/xslt.h @@ -18,35 +18,35 @@ extern "C" { /** * XSLT_DEFAULT_VERSION: * - * The default version of XSLT supported + * The default version of XSLT supported. */ #define XSLT_DEFAULT_VERSION "1.0" /** * XSLT_DEFAULT_VENDOR: * - * The XSLT "vendor" string for this processor + * The XSLT "vendor" string for this processor. */ #define XSLT_DEFAULT_VENDOR "libxslt" /** * XSLT_DEFAULT_URL: * - * The XSLT "vendor" URL for this processor + * The XSLT "vendor" URL for this processor. */ #define XSLT_DEFAULT_URL "http://xmlsoft.org/XSLT/" /** * XSLT_NAMESPACE: * - * The XSLT specification namespace + * The XSLT specification namespace. */ #define XSLT_NAMESPACE ((xmlChar *) "http://www.w3.org/1999/XSL/Transform") /** * LIBXSLT_PUBLIC: * - * Macro used on Windows to tag public identifiers from shared libraries + * Macro used on Windows to tag public identifiers from shared libraries. */ #if !defined LIBXSLT_PUBLIC #if (defined (__CYGWIN__) || defined _MSC_VER) && !defined IN_LIBXSLT && !defined LIBXSLT_STATIC @@ -59,33 +59,33 @@ extern "C" { /** * xsltMaxDepth: * - * This value is used to detect templates loops + * This value is used to detect templates loops. */ LIBXSLT_PUBLIC extern int xsltMaxDepth; /** * xsltEngineVersion: * - * The version string for libxslt + * The version string for libxslt. */ LIBXSLT_PUBLIC extern const char *xsltEngineVersion; /** * xsltLibxsltVersion: * - * The version of libxslt compiled + * The version of libxslt compiled. */ LIBXSLT_PUBLIC extern const int xsltLibxsltVersion; /** * xsltLibxmlVersion: * - * The version of libxml libxslt was compiled against + * The version of libxml libxslt was compiled against. */ LIBXSLT_PUBLIC extern const int xsltLibxmlVersion; /* - * Global cleanup function + * Global cleanup function. */ void xsltCleanupGlobals (void); diff --git a/libxslt/xsltInternals.h b/libxslt/xsltInternals.h index 7458578b..5a05570a 100644 --- a/libxslt/xsltInternals.h +++ b/libxslt/xsltInternals.h @@ -1,6 +1,6 @@ /* * xsltInternals.h: internal data structures, constants and functions used - * by the XSLT engine + * by the XSLT engine. * They are not part of the API or ABI, i.e. they can change * without prior notice, use carefully. * @@ -25,21 +25,21 @@ extern "C" { /** * XSLT_MAX_SORT: * - * Max number of specified xsl:sort on an element + * Max number of specified xsl:sort on an element. */ #define XSLT_MAX_SORT 5 /** * XSLT_PAT_NO_PRIORITY: * - * specific value for pattern without priority expressed + * Specific value for pattern without priority expressed. */ #define XSLT_PAT_NO_PRIORITY -12345789 /** * xsltRuntimeExtra: * - * Extra information added to the transformation context + * Extra information added to the transformation context. */ typedef struct _xsltRuntimeExtra xsltRuntimeExtra; typedef xsltRuntimeExtra *xsltRuntimeExtraPtr; @@ -54,7 +54,7 @@ struct _xsltRuntimeExtra { /** * xsltTemplate: * - * The in-memory structure corresponding to an XSLT Template + * The in-memory structure corresponding to an XSLT Template. */ typedef struct _xsltTemplate xsltTemplate; typedef xsltTemplate *xsltTemplatePtr; @@ -81,7 +81,7 @@ struct _xsltTemplate { /** * xsltDecimalFormat: * - * Data structure of decimal-format + * Data structure of decimal-format. */ typedef struct _xsltDecimalFormat xsltDecimalFormat; typedef xsltDecimalFormat *xsltDecimalFormatPtr; @@ -106,7 +106,7 @@ struct _xsltDecimalFormat { /** * xsltDocument: * - * Data structure associated to a parsed document + * Data structure associated to a parsed document. */ typedef struct _xsltDocument xsltDocument; @@ -137,7 +137,7 @@ typedef xsltElemPreComp *xsltElemPreCompPtr; * @inst: the stylesheet node * @comp: the compiled information from the stylesheet * - * signature of the function associated to elements part of the + * Signature of the function associated to elements part of the * stylesheet language like xsl:if or xsl:apply-templates. */ typedef void (*xsltTransformFunction) (xsltTransformContextPtr ctxt, @@ -174,7 +174,7 @@ typedef enum { * xsltElemPreCompDeallocator: * @comp: the #xsltElemPreComp to free up * - * Deallocates an #xsltElemPreComp structure + * Deallocates an #xsltElemPreComp structure. */ typedef void (*xsltElemPreCompDeallocator) (xsltElemPreCompPtr comp); @@ -211,7 +211,7 @@ struct _xsltStylePreComp { xmlNodePtr inst; /* the instruction */ /* - * Pre computed values + * Pre computed values. */ xmlChar *stype; /* sort */ @@ -253,7 +253,7 @@ struct _xsltStylePreComp { /* * The in-memory structure corresponding to an XSLT Variable - * or Param + * or Param. */ typedef struct _xsltStackElem xsltStackElem; @@ -270,7 +270,7 @@ struct _xsltStackElem { }; /* - * The in-memory structure corresponding to an XSLT Stylesheet + * The in-memory structure corresponding to an XSLT Stylesheet. * NOTE: most of the content is simply linked from the doc tree * structure, no specific allocation is made. */ @@ -278,7 +278,7 @@ typedef struct _xsltStylesheet xsltStylesheet; typedef xsltStylesheet *xsltStylesheetPtr; struct _xsltStylesheet { /* - * The stylesheet import relation is kept as a tree + * The stylesheet import relation is kept as a tree. */ struct _xsltStylesheet *parent; struct _xsltStylesheet *next; @@ -287,7 +287,7 @@ struct _xsltStylesheet { xsltDocumentPtr docList; /* the include document list */ /* - * General data on the style sheet document + * General data on the style sheet document. */ xmlDocPtr doc; /* the parsed XML stylesheet */ xmlHashTablePtr stripSpaces;/* the hash table of the strip-space and @@ -296,12 +296,12 @@ struct _xsltStylesheet { xmlHashTablePtr cdataSection;/* the hash table of the cdata-section */ /* - * Global variable or parameters + * Global variable or parameters. */ xsltStackElemPtr variables; /* linked list of param and variables */ /* - * Template descriptions + * Template descriptions. */ xsltTemplatePtr templates; /* the ordered list of templates */ void *templatesHash; /* hash table or wherever compiled templates @@ -316,23 +316,23 @@ struct _xsltStylesheet { void *commentMatch; /* template based on comment() */ /* - * Namespace aliases + * Namespace aliases. */ xmlHashTablePtr nsAliases; /* the namespace alias hash tables */ /* - * Attribute sets + * Attribute sets. */ xmlHashTablePtr attributeSets;/* the attribute sets hash tables */ /* - * Namespaces + * Namespaces. */ xmlHashTablePtr nsHash; /* the set of namespaces in use */ void *nsDefs; /* the namespaces defined */ /* - * Key definitions + * Key definitions. */ void *keys; /* key definitions */ @@ -345,7 +345,9 @@ struct _xsltStylesheet { xmlChar *encoding; /* encoding string */ int omitXmlDeclaration; /* omit-xml-declaration = "yes" | "no" */ - /* Number formatting */ + /* + * Number formatting. + */ xsltDecimalFormatPtr decimalFormat; int standalone; /* standalone = "yes" | "no" */ xmlChar *doctypePublic; /* doctype-public string */ @@ -354,7 +356,7 @@ struct _xsltStylesheet { xmlChar *mediaType; /* media-type string */ /* - * Precomputed blocks + * Precomputed blocks. */ xsltElemPreCompPtr preComps;/* list of precomputed blocks */ int warnings; /* number of warnings found at compilation */ @@ -368,14 +370,14 @@ struct _xsltStylesheet { void *_private; /* user defined data */ /* - * Extensions + * Extensions. */ xmlHashTablePtr extInfos; /* the extension data */ int extrasNr; /* the number of extras required */ }; /* - * The in-memory structure corresponding to an XSLT Transformation + * The in-memory structure corresponding to an XSLT Transformation. */ typedef enum { XSLT_OUTPUT_XML = 0, @@ -454,24 +456,24 @@ struct _xsltTransformContext { /** * CHECK_STOPPED: * - * Macro to check if the XSLT processing should be stopped - * will return from the function + * Macro to check if the XSLT processing should be stopped. + * Will return from the function. */ #define CHECK_STOPPED if (ctxt->state == XSLT_STATE_STOPPED) return; /** * CHECK_STOPPEDE: * - * Macro to check if the XSLT processing should be stopped - * will goto the error: label + * Macro to check if the XSLT processing should be stopped. + * Will goto the error: label. */ #define CHECK_STOPPEDE if (ctxt->state == XSLT_STATE_STOPPED) goto error; /** * CHECK_STOPPED0: * - * Macro to check if the XSLT processing should be stopped - * will return from the function with a 0 value + * Macro to check if the XSLT processing should be stopped. + * Will return from the function with a 0 value. */ #define CHECK_STOPPED0 if (ctxt->state == XSLT_STATE_STOPPED) return(0); diff --git a/libxslt/xsltutils.h b/libxslt/xsltutils.h index 4513f4f6..178d0cb3 100644 --- a/libxslt/xsltutils.h +++ b/libxslt/xsltutils.h @@ -1,5 +1,5 @@ /* - * xsltutils.h: interfaces for the utilities module of the XSLT engine + * xsltutils.h: interfaces for the utilities module of the XSLT engine. * * See Copyright for the status of this software. * @@ -26,7 +26,7 @@ extern "C" { /** * TODO: * - * macro to flag unimplemented blocks + * Macro to flag unimplemented blocks. */ #define XSLT_TODO \ xsltGenericError(xsltGenericErrorContext, \ @@ -36,7 +36,7 @@ extern "C" { /** * STRANGE: * - * macro to flag that a problem was detected internally + * Macro to flag that a problem was detected internally. */ #define XSLT_STRANGE \ xsltGenericError(xsltGenericErrorContext, \ @@ -46,7 +46,7 @@ extern "C" { /** * IS_XSLT_ELEM: * - * Checks that the element pertains to XSLt namespace + * Checks that the element pertains to XSLT namespace. */ #define IS_XSLT_ELEM(n) \ (((n) != NULL) && ((n)->ns != NULL) && \ @@ -55,7 +55,7 @@ extern "C" { /** * IS_XSLT_NAME: * - * Checks the value of an element in XSLT namespace + * Checks the value of an element in XSLT namespace. */ #define IS_XSLT_NAME(n, val) \ (xmlStrEqual((n)->name, (const xmlChar *) (val))) @@ -63,7 +63,7 @@ extern "C" { /** * IS_XSLT_REAL_NODE: * - * check that a node is a 'real' one: document, element, text or attribute + * Check that a node is a 'real' one: document, element, text or attribute. */ #ifdef LIBXML_DOCB_ENABLED #define IS_XSLT_REAL_NODE(n) \ @@ -85,14 +85,14 @@ extern "C" { #endif /* - * Our own version of namespaced atributes lookup + * Our own version of namespaced atributes lookup. */ xmlChar * xsltGetNsProp (xmlNodePtr node, const xmlChar *name, const xmlChar *nameSpace); /* - * XSLT specific error and debug reporting functions + * XSLT specific error and debug reporting functions. */ LIBXSLT_PUBLIC extern xmlGenericErrorFunc xsltGenericError; LIBXSLT_PUBLIC extern void *xsltGenericErrorContext; @@ -111,7 +111,7 @@ void xsltSetGenericDebugFunc (void *ctx, xmlGenericErrorFunc handler); /* - * Sorting + * Sorting. */ void xsltDocumentSortFunction (xmlNodeSetPtr list); @@ -120,14 +120,14 @@ void xsltDoSortFunction (xsltTransformContextPtr ctxt, int nbsorts); /* - * QNames handling + * QNames handling. */ const xmlChar * xsltGetQNameURI (xmlNodePtr node, xmlChar **name); /* - * Output, reuse libxml I/O buffers + * Output, reuse libxml I/O buffers. */ int xsltSaveResultTo (xmlOutputBufferPtr buf, xmlDocPtr result, @@ -144,7 +144,7 @@ int xsltSaveResultToFd (int fd, xsltStylesheetPtr style); /* - * profiling + * Profiling. */ void xsltSaveProfiling (xsltTransformContextPtr ctxt, FILE *output); @@ -155,7 +155,7 @@ void xsltCalibrateAdjust (long delta); #define XSLT_TIMESTAMP_TICS_PER_SEC 100000l /* - * Hooks for the debugger + * Hooks for the debugger. */ typedef enum {