xerces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bor...@apache.org
Subject svn commit: r698579 - in /xerces/c/trunk: doc/ doc/html/apiDocs-3/ src/xercesc/dom/ src/xercesc/framework/ src/xercesc/parsers/ src/xercesc/util/
Date Wed, 24 Sep 2008 14:13:09 GMT
Author: borisk
Date: Wed Sep 24 07:13:08 2008
New Revision: 698579

URL: http://svn.apache.org/viewvc?rev=698579&view=rev
Log:
Doxygen documentation fixes.

Removed:
    xerces/c/trunk/doc/html/apiDocs-3/XercesApi.css
    xerces/c/trunk/doc/html/apiDocs-3/footer.html
    xerces/c/trunk/doc/html/apiDocs-3/header.html
Modified:
    xerces/c/trunk/doc/Doxyfile
    xerces/c/trunk/src/xercesc/dom/DOMXPathEvaluator.hpp
    xerces/c/trunk/src/xercesc/dom/DOMXPathExpression.hpp
    xerces/c/trunk/src/xercesc/dom/DOMXPathNSResolver.hpp
    xerces/c/trunk/src/xercesc/dom/DOMXPathResult.hpp
    xerces/c/trunk/src/xercesc/framework/XMLEntityDecl.hpp
    xerces/c/trunk/src/xercesc/framework/XMLFormatter.hpp
    xerces/c/trunk/src/xercesc/parsers/AbstractDOMParser.hpp
    xerces/c/trunk/src/xercesc/util/TransService.hpp
    xerces/c/trunk/src/xercesc/util/XMLString.hpp

Modified: xerces/c/trunk/doc/Doxyfile
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/Doxyfile?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/doc/Doxyfile (original)
+++ xerces/c/trunk/doc/Doxyfile Wed Sep 24 07:13:08 2008
@@ -23,7 +23,7 @@
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = v3.0.0
+PROJECT_NUMBER         = 3.0.0
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@@ -465,7 +465,8 @@
                          XMLUCS4Transcoder.hpp \
                          XMLUTF16Transcoder.hpp \
                          XMLUTF8Transcoder.hpp \
-                         XMLWin1252Transcoder.hpp
+                         XMLWin1252Transcoder.hpp \
+                         XercesVersion.hpp
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
@@ -594,13 +595,13 @@
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard header.
 
-HTML_HEADER            = html/apiDocs-3/header.html
+HTML_HEADER            = 
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard footer.
 
-HTML_FOOTER            = html/apiDocs-3/footer.html
+HTML_FOOTER            = 
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
 # style sheet that is used by each HTML page. It can be used to 

Modified: xerces/c/trunk/src/xercesc/dom/DOMXPathEvaluator.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/dom/DOMXPathEvaluator.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/dom/DOMXPathEvaluator.hpp (original)
+++ xerces/c/trunk/src/xercesc/dom/DOMXPathEvaluator.hpp Wed Sep 24 07:13:08 2008
@@ -146,7 +146,7 @@
      * the XPath expression into appropriate namespace URIs. If this is specified
      * as null, any namespace prefix within the expression will result in
      * <code>DOMException</code> being thrown with the code NAMESPACE_ERR.
-     * @param result type - If a specific type is specified, then
+     * @param type - If a specific type is specified, then
      * the result will be returned as the corresponding type. This must be one
      * of the codes of the <code>DOMXPathResult</code> interface.
      * @param result of type DOMXPathResult* - The result specifies a specific result object

Modified: xerces/c/trunk/src/xercesc/dom/DOMXPathExpression.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/dom/DOMXPathExpression.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/dom/DOMXPathExpression.hpp (original)
+++ xerces/c/trunk/src/xercesc/dom/DOMXPathExpression.hpp Wed Sep 24 07:13:08 2008
@@ -86,7 +86,7 @@
      * <code>DOMCDATASection</code>, then the context is interpreted as the whole
logical
      * text node as seen by XPath, unless the node is empty in which case it may not
      * serve as the XPath context.
-     * @param result type. If a specific type is specified, then the result
+     * @param type If a specific type is specified, then the result
      * will be coerced to return the specified type relying on XPath conversions and fail
      * if the desired coercion is not possible. This must be one of the type codes of <code>DOMXPathResult</code>.
      * @param result of type DOMXPathResult* The result specifies a specific result object
which

Modified: xerces/c/trunk/src/xercesc/dom/DOMXPathNSResolver.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/dom/DOMXPathNSResolver.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/dom/DOMXPathNSResolver.hpp (original)
+++ xerces/c/trunk/src/xercesc/dom/DOMXPathNSResolver.hpp Wed Sep 24 07:13:08 2008
@@ -107,7 +107,7 @@
      * Associate the given namespace prefix to the namespace URI.
      * @param prefix of type XMLCh - The namespace prefix to bind. An empty
      * or null string denotes the default namespace.
-     * @param URI of type XMLCh - The associated namespace URI. If this
+     * @param uri of type XMLCh - The associated namespace URI. If this
      * argument is null or an empty string then the existing binding for this
      * prefix is removed.
      */

Modified: xerces/c/trunk/src/xercesc/dom/DOMXPathResult.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/dom/DOMXPathResult.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/dom/DOMXPathResult.hpp (original)
+++ xerces/c/trunk/src/xercesc/dom/DOMXPathResult.hpp Wed Sep 24 07:13:08 2008
@@ -316,7 +316,7 @@
      * ORDERED_NODE_SNAPSHOT_TYPE (XPath 1.0) or if ResultType is not
      * SNAPSHOT_RESULT_TYPE (XPath 2.0).
      */
-    virtual bool snapshotItem(XMLSize_t) = 0;
+    virtual bool snapshotItem(XMLSize_t index) = 0;
 
     /**
      * The number of items in the result snapshot. Valid values for snapshotItem

Modified: xerces/c/trunk/src/xercesc/framework/XMLEntityDecl.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/framework/XMLEntityDecl.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/framework/XMLEntityDecl.hpp (original)
+++ xerces/c/trunk/src/xercesc/framework/XMLEntityDecl.hpp Wed Sep 24 07:13:08 2008
@@ -5,9 +5,9 @@
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -254,7 +254,7 @@
     /**
      *  This method will mark whether the entity is external.
      *
-     *  @param  newName   The new value for the 'is external' flag.
+     *  @param  value   The new value for the 'is external' flag.
      */
     void setIsExternal(bool value);
 

Modified: xerces/c/trunk/src/xercesc/framework/XMLFormatter.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/framework/XMLFormatter.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/framework/XMLFormatter.hpp (original)
+++ xerces/c/trunk/src/xercesc/framework/XMLFormatter.hpp Wed Sep 24 07:13:08 2008
@@ -166,11 +166,11 @@
     /** @name Constructor and Destructor */
     //@{
     /**
-     * @param outEncoding the encoding for the formatted content
-     * @param docVersion
-     * @param target      the formatTarget where the formatted content is written to
-     * @param escapeFlags the escape style for certain character
-     * @param unrepFlags  the reaction to unrepresentable character
+     * @param outEncoding the encoding for the formatted content.
+     * @param docVersion  the document version.
+     * @param target      the formatTarget where the formatted content is written to.
+     * @param escapeFlags the escape style for certain character.
+     * @param unrepFlags  the reaction to unrepresentable character.
      * @param manager     Pointer to the memory manager to be used to
      *                    allocate objects.
      */

Modified: xerces/c/trunk/src/xercesc/parsers/AbstractDOMParser.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/parsers/AbstractDOMParser.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/parsers/AbstractDOMParser.hpp (original)
+++ xerces/c/trunk/src/xercesc/parsers/AbstractDOMParser.hpp Wed Sep 24 07:13:08 2008
@@ -870,7 +870,7 @@
       * the parser should store schema informations in the element
       * and attribute nodes in the DOM tree being produced.
       *
-      * @param newValue The state to set
+      * @param newState The state to set
       * @see #getCreateSchemaInfo
       */
     void  setCreateSchemaInfo(const bool newState);
@@ -881,7 +881,7 @@
       * the parser should process XInclude nodes
       * in the DOM tree being produced.
       *
-      * @param newValue The state to set
+      * @param newState The state to set
       * @see #getDoXInclude
       */
     void  setDoXInclude(const bool newState);

Modified: xerces/c/trunk/src/xercesc/util/TransService.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/util/TransService.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/util/TransService.hpp (original)
+++ xerces/c/trunk/src/xercesc/util/TransService.hpp Wed Sep 24 07:13:08 2008
@@ -574,7 +574,7 @@
 
     /** Converts from the specified encoding to the internal XMLCh* encoding
       *
-      * @param in       the source buffer to be transcoded
+      * @param data     the source buffer to be transcoded
       * @param length   the length of the source buffer
       * @param encoding the name of the encoding to transcode to
       * @param manager  the memory manager to use
@@ -584,7 +584,7 @@
 
     /** Converts from the specified encoding to the internal XMLCh* encoding
       *
-      * @param in       the source buffer to be transcoded
+      * @param data     the source buffer to be transcoded
       * @param length   the length of the source buffer
       * @param trans    the transcoder to use
       * @param manager  the memory manager to use

Modified: xerces/c/trunk/src/xercesc/util/XMLString.hpp
URL: http://svn.apache.org/viewvc/xerces/c/trunk/src/xercesc/util/XMLString.hpp?rev=698579&r1=698578&r2=698579&view=diff
==============================================================================
--- xerces/c/trunk/src/xercesc/util/XMLString.hpp (original)
+++ xerces/c/trunk/src/xercesc/util/XMLString.hpp Wed Sep 24 07:13:08 2008
@@ -470,7 +470,6 @@
       * @param toHash The string to hash
       * @param numChars The maximum number of characters to consider for hashing
       * @param hashModulus The divisor to be used for hashing
-      * @param manager The MemoryManager to use to allocate objects
       * @return Returns the hash value
       */
     static XMLSize_t hashN



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xerces.apache.org
For additional commands, e-mail: commits-help@xerces.apache.org


Mime
View raw message