diff --git a/src/xercesc/dom/DOMString.hpp b/src/xercesc/dom/DOMString.hpp
index 7615c87726f4a8dcc375abd7de14bd2703516a9a..2516a250c7762194b91d8cd38d2a4e6b6f50cb03 100644
--- a/src/xercesc/dom/DOMString.hpp
+++ b/src/xercesc/dom/DOMString.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:44 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:44 peiyongz
+ * sane_include
*
* Revision 1.12 2000/06/02 00:45:42 andyh
* DOM Fixes: DOMString::rawBuffer() now returns a const XMLCh * pointer.
@@ -156,7 +159,7 @@ public:
* Constructor to build a DOMString from an XML character array.
* (XMLCh is a 16 bit UNICODE character).
*
- * @param other The null-terminated character array to be
+ * @param other The null-terminated character array to be
* that provides the initial value for the DOMString.
*/
DOMString(const XMLCh *other);
@@ -187,7 +190,7 @@ public:
* Assignment operator. Make destination DOMString refer to the same
* underlying string in memory as the source string.
*
- * @param the source DOMString.
+ * @param other the source DOMString.
*/
DOMString & operator = (const DOMString &other);
@@ -222,11 +225,11 @@ public:
//@{
/**
- * Equality operator.
+ * Equality operator.
*
* @param other The object to be compared with.
* @return True if the two DOMStrings refer to the same underlying string
- * in memory.
+ * in memory.
* <p>
* WARNING: operator == does NOT compare the contents of
* the two strings. To do this, use the <code>DOMString::equals()</code>
@@ -255,7 +258,7 @@ public:
* variable in Java.
*
* @param other must be 0 or null.
- * @return
+ * @return
*/
bool operator == (const DOM_NullPtr *other) const;
@@ -281,7 +284,7 @@ public:
*/
void reserve(unsigned int size);
-
+
/**
* Appends the content of another <code>DOMString</code> to this string.
*
@@ -292,7 +295,7 @@ public:
/**
* Append a single Unicode character to this string.
*
- * @param other The object to be appended
+ * @param ch The single character to be appended
*/
void appendData(XMLCh ch);
@@ -339,7 +342,7 @@ public:
/**
* Inserts a string within the existing <code>DOMString</code> at an arbitrary position.
*
- * @param offset The offset from the beginning at which the insertion needs to be done
+ * @param offset The offset from the beginning at which the insertion needs to be done
* in <code>this</code> object
* @param data The <code>DOMString</code> containing the data that needs to be inserted
* @return The object to be returned.
@@ -440,13 +443,13 @@ public:
/**
* Compares a DOMString with another.
*
- * This compareString does not match the semantics of the standard C strcmp.
- * All it needs to do is define some less than - equals - greater than
+ * This compareString does not match the semantics of the standard C strcmp.
+ * All it needs to do is define some less than - equals - greater than
* ordering of strings. How doesn't matter.
*
*
* @param other The object to be compared with
- * @return Either -1, 0, or 1 based on the comparison.
+ * @return Either -1, 0, or 1 based on the comparison.
*/
int compareString(const DOMString &other) const;
diff --git a/src/xercesc/dom/DOM_Attr.hpp b/src/xercesc/dom/DOM_Attr.hpp
index 5fefea91d690f038d18187572b5704541765b566..a4a151d947cfa452efc18e192414702286fd9616 100644
--- a/src/xercesc/dom/DOM_Attr.hpp
+++ b/src/xercesc/dom/DOM_Attr.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 19:57:15 tng
* Remove the phrase "Experimental".
*
@@ -167,7 +170,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Attr & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_CDATASection.hpp b/src/xercesc/dom/DOM_CDATASection.hpp
index 7339189a70555733721e82e63a0ed61cab3d1d86..955ec2df978b60707b3da88d25dc6d9f9636c2d3 100644
--- a/src/xercesc/dom/DOM_CDATASection.hpp
+++ b/src/xercesc/dom/DOM_CDATASection.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:44 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:44 peiyongz
+ * sane_include
*
* Revision 1.5 2000/03/02 19:53:52 roddey
* This checkin includes many changes done while waiting for the
@@ -91,15 +94,15 @@ class CDATASectionImpl;
/**
* <code>DOM_CDataSection</code> objects refer to the data from an
- * XML CDATA section. These are used to escape blocks of text containing characters
+ * XML CDATA section. These are used to escape blocks of text containing characters
* that would otherwise be regarded as markup.
*
- * <p>Note that the string data associated with the CDATA section may
+ * <p>Note that the string data associated with the CDATA section may
* contain characters that need to be escaped when appearing in an
- * XML document outside of a CDATA section.
- * <p> The <code>DOM_CDATASection</code> class inherits from the
- * <code>DOM_CharacterData</code> class through the <code>Text</code>
- * interface. Adjacent CDATASection nodes are not merged by use
+ * XML document outside of a CDATA section.
+ * <p> The <code>DOM_CDATASection</code> class inherits from the
+ * <code>DOM_CharacterData</code> class through the <code>Text</code>
+ * interface. Adjacent CDATASection nodes are not merged by use
* of the Element.normalize() method.
*/
class CDOM_EXPORT DOM_CDATASection: public DOM_Text {
@@ -141,7 +144,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_CDATASection & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_CharacterData.hpp b/src/xercesc/dom/DOM_CharacterData.hpp
index 24fc3da40399e6116da20953bbf9fe5ba8654683..8b4dd54d3fa0679e5d59d0ee6d098ac5b2213b32 100644
--- a/src/xercesc/dom/DOM_CharacterData.hpp
+++ b/src/xercesc/dom/DOM_CharacterData.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:44 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:44 peiyongz
+ * sane_include
*
* Revision 1.6 2000/03/02 19:53:53 roddey
* This checkin includes many changes done while waiting for the
@@ -95,13 +98,13 @@
class CharacterDataImpl;
/**
- * The <code>DOM_CharacterData</code> interface extends Node with a set of
+ * The <code>DOM_CharacterData</code> interface extends Node with a set of
* methods for accessing character data in the DOM.
*
- * For clarity this set is defined here rather than on each class that uses
- * these methods. No DOM objects correspond directly to
- * <code>CharacterData</code>, though <code>Text</code> and others do inherit
- * the interface from it. All <code>offset</code>s in this interface start
+ * For clarity this set is defined here rather than on each class that uses
+ * these methods. No DOM objects correspond directly to
+ * <code>CharacterData</code>, though <code>Text</code> and others do inherit
+ * the interface from it. All <code>offset</code>s in this interface start
* from 0, and index in terms of Unicode 16 bit storage units.
*/
class CDOM_EXPORT DOM_CharacterData: public DOM_Node {
@@ -145,7 +148,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_CharacterData & operator = (const DOM_NullPtr *val);
@@ -165,27 +168,27 @@ public:
/** @name Getter functions. */
//@{
/**
- * Returns the character data of the node that implements this interface.
+ * Returns the character data of the node that implements this interface.
*
- * The DOM implementation may not put arbitrary limits on the amount of data that
- * may be stored in a <code>CharacterData</code> node. However,
- * implementation limits may mean that the entirety of a node's data may
- * not fit into a single <code>DOMString</code>. In such cases, the user
- * may call <code>substringData</code> to retrieve the data in
+ * The DOM implementation may not put arbitrary limits on the amount of data that
+ * may be stored in a <code>CharacterData</code> node. However,
+ * implementation limits may mean that the entirety of a node's data may
+ * not fit into a single <code>DOMString</code>. In such cases, the user
+ * may call <code>substringData</code> to retrieve the data in
* appropriately sized pieces.
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
* @exception DOMException
- * DOMSTRING_SIZE_ERR: Raised when it would return more characters than
- * fit in a <code>DOMString</code> variable on the implementation
+ * DOMSTRING_SIZE_ERR: Raised when it would return more characters than
+ * fit in a <code>DOMString</code> variable on the implementation
* platform.
*/
DOMString getData() const;
/**
- * Returns the number of characters that are available through <code>data</code> and
- * the <code>substringData</code> method below.
+ * Returns the number of characters that are available through <code>data</code> and
+ * the <code>substringData</code> method below.
*
- * This may have the value
+ * This may have the value
* zero, i.e., <code>CharacterData</code> nodes may be empty.
*/
unsigned int getLength() const;
@@ -194,17 +197,17 @@ public:
*
* @param offset Start offset of substring to extract.
* @param count The number of characters to extract.
- * @return The specified substring. If the sum of <code>offset</code> and
- * <code>count</code> exceeds the <code>length</code>, then all
+ * @return The specified substring. If the sum of <code>offset</code> and
+ * <code>count</code> exceeds the <code>length</code>, then all
* characters to the end of the data are returned.
* @exception DOMException
- * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
- * than the number of characters in <code>data</code>, or if the
+ * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
+ * than the number of characters in <code>data</code>, or if the
* specified <code>count</code> is negative.
- * <br>DOMSTRING_SIZE_ERR: Raised if the specified range of text does not
+ * <br>DOMSTRING_SIZE_ERR: Raised if the specified range of text does not
* fit into a <code>DOMString</code>.
*/
- DOMString substringData(unsigned int offset,
+ DOMString substringData(unsigned int offset,
unsigned int count) const;
//@}
/** @name Functions that set or change data. */
@@ -212,7 +215,7 @@ public:
/**
* Append the string to the end of the character data of the node.
*
- * Upon success, <code>data</code> provides access to the concatenation of
+ * Upon success, <code>data</code> provides access to the concatenation of
* <code>data</code> and the <code>DOMString</code> specified.
* @param arg The <code>DOMString</code> to append.
* @exception DOMException
@@ -225,53 +228,53 @@ public:
* @param offset The character offset at which to insert.
* @param arg The <code>DOMString</code> to insert.
* @exception DOMException
- * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
+ * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
* than the number of characters in <code>data</code>.
* <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
void insertData(unsigned int offset, const DOMString &arg);
/**
- * Remove a range of characters from the node.
+ * Remove a range of characters from the node.
*
- * Upon success,
+ * Upon success,
* <code>data</code> and <code>length</code> reflect the change.
* @param offset The offset from which to remove characters.
- * @param count The number of characters to delete. If the sum of
- * <code>offset</code> and <code>count</code> exceeds <code>length</code>
- * then all characters from <code>offset</code> to the end of the data
+ * @param count The number of characters to delete. If the sum of
+ * <code>offset</code> and <code>count</code> exceeds <code>length</code>
+ * then all characters from <code>offset</code> to the end of the data
* are deleted.
* @exception DOMException
- * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
- * than the number of characters in <code>data</code>, or if the
+ * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
+ * than the number of characters in <code>data</code>, or if the
* specified <code>count</code> is negative.
* <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
- void deleteData(unsigned int offset,
+ void deleteData(unsigned int offset,
unsigned int count);
/**
- * Replace the characters starting at the specified character offset with
+ * Replace the characters starting at the specified character offset with
* the specified string.
*
* @param offset The offset from which to start replacing.
- * @param count The number of characters to replace. If the sum of
+ * @param count The number of characters to replace. If the sum of
* <code>offset</code> and <code>count</code> exceeds <code>length</code>
- * , then all characters to the end of the data are replaced (i.e., the
- * effect is the same as a <code>remove</code> method call with the same
+ * , then all characters to the end of the data are replaced (i.e., the
+ * effect is the same as a <code>remove</code> method call with the same
* range, followed by an <code>append</code> method invocation).
- * @param arg The <code>DOMString</code> with which the range must be
+ * @param arg The <code>DOMString</code> with which the range must be
* replaced.
* @exception DOMException
- * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
- * than the number of characters in <code>data</code>, or if the
+ * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
+ * than the number of characters in <code>data</code>, or if the
* specified <code>count</code> is negative.
* <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
- void replaceData(unsigned int offset,
- unsigned int count,
+ void replaceData(unsigned int offset,
+ unsigned int count,
const DOMString &arg);
/**
- * Sets the character data of the node that implements this interface.
+ * Sets the character data of the node that implements this interface.
*
* @param data The <code>DOMString</code> to set.
*/
diff --git a/src/xercesc/dom/DOM_Comment.hpp b/src/xercesc/dom/DOM_Comment.hpp
index 53b1b917070fe1b0b47c0f30dd4fafe6a4cd2bc6..797516bb079e78fea2df707a6b9a079785616342 100644
--- a/src/xercesc/dom/DOM_Comment.hpp
+++ b/src/xercesc/dom/DOM_Comment.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:44 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:44 peiyongz
+ * sane_include
*
* Revision 1.5 2000/03/02 19:53:54 roddey
* This checkin includes many changes done while waiting for the
@@ -92,7 +95,7 @@ class CommentImpl;
/**
* Class to refer to XML comment nodes in the DOM.
*
- * <P>The string value contains all of the characters between
+ * <P>The string value contains all of the characters between
* the starting '<code><!--</code>' and ending '<code>--></code>'.
*/
class CDOM_EXPORT DOM_Comment: public DOM_CharacterData {
@@ -138,7 +141,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Comment & operator = (const DOM_NullPtr *val);
@@ -150,7 +153,7 @@ public:
/**
* Destructor for DOM_Comment. The object being destroyed is the reference
* object, not the underlying Comment node itself.
- *
+ *
*/
~DOM_Comment();
//@}
diff --git a/src/xercesc/dom/DOM_Document.hpp b/src/xercesc/dom/DOM_Document.hpp
index e8209419c647d2c2b4b90459cd42b7318cc482bc..374698dbb6118d9eae4dc012122a83ad646d8a8b 100644
--- a/src/xercesc/dom/DOM_Document.hpp
+++ b/src/xercesc/dom/DOM_Document.hpp
@@ -138,7 +138,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Document & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_DocumentFragment.hpp b/src/xercesc/dom/DOM_DocumentFragment.hpp
index 418c07ba44e479e0ce30600f22875cb6ca4aef00..5ded5f878e38006171197b76f00868a01a144857 100644
--- a/src/xercesc/dom/DOM_DocumentFragment.hpp
+++ b/src/xercesc/dom/DOM_DocumentFragment.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -67,41 +67,41 @@
class DocumentFragmentImpl;
/**
- * <code>DocumentFragment</code> is a "lightweight" or "minimal"
- * <code>Document</code> object.
+ * <code>DocumentFragment</code> is a "lightweight" or "minimal"
+ * <code>Document</code> object.
*
- * It is very common to want to be able to
- * extract a portion of a document's tree or to create a new fragment of a
- * document. Imagine implementing a user command like cut or rearranging a
- * document by moving fragments around. It is desirable to have an object
- * which can hold such fragments and it is quite natural to use a Node for
- * this purpose. While it is true that a <code>Document</code> object could
- * fulfil this role, a <code>Document</code> object can potentially be a
- * heavyweight object, depending on the underlying implementation. What is
- * really needed for this is a very lightweight object.
+ * It is very common to want to be able to
+ * extract a portion of a document's tree or to create a new fragment of a
+ * document. Imagine implementing a user command like cut or rearranging a
+ * document by moving fragments around. It is desirable to have an object
+ * which can hold such fragments and it is quite natural to use a Node for
+ * this purpose. While it is true that a <code>Document</code> object could
+ * fulfil this role, a <code>Document</code> object can potentially be a
+ * heavyweight object, depending on the underlying implementation. What is
+ * really needed for this is a very lightweight object.
* <code>DocumentFragment</code> is such an object.
- * <p>Furthermore, various operations -- such as inserting nodes as children
- * of another <code>Node</code> -- may take <code>DocumentFragment</code>
- * objects as arguments; this results in all the child nodes of the
+ * <p>Furthermore, various operations -- such as inserting nodes as children
+ * of another <code>Node</code> -- may take <code>DocumentFragment</code>
+ * objects as arguments; this results in all the child nodes of the
* <code>DocumentFragment</code> being moved to the child list of this node.
- * <p>The children of a <code>DocumentFragment</code> node are zero or more
- * nodes representing the tops of any sub-trees defining the structure of the
- * document. <code>DocumentFragment</code> nodes do not need to be
- * well-formed XML documents (although they do need to follow the rules
- * imposed upon well-formed XML parsed entities, which can have multiple top
- * nodes). For example, a <code>DocumentFragment</code> might have only one
- * child and that child node could be a <code>Text</code> node. Such a
- * structure model represents neither an HTML document nor a well-formed XML
- * document.
- * <p>When a <code>DocumentFragment</code> is inserted into a
- * <code>Document</code> (or indeed any other <code>Node</code> that may take
- * children) the children of the <code>DocumentFragment</code> and not the
- * <code>DocumentFragment</code> itself are inserted into the
- * <code>Node</code>. This makes the <code>DocumentFragment</code> very
- * useful when the user wishes to create nodes that are siblings; the
+ * <p>The children of a <code>DocumentFragment</code> node are zero or more
+ * nodes representing the tops of any sub-trees defining the structure of the
+ * document. <code>DocumentFragment</code> nodes do not need to be
+ * well-formed XML documents (although they do need to follow the rules
+ * imposed upon well-formed XML parsed entities, which can have multiple top
+ * nodes). For example, a <code>DocumentFragment</code> might have only one
+ * child and that child node could be a <code>Text</code> node. Such a
+ * structure model represents neither an HTML document nor a well-formed XML
+ * document.
+ * <p>When a <code>DocumentFragment</code> is inserted into a
+ * <code>Document</code> (or indeed any other <code>Node</code> that may take
+ * children) the children of the <code>DocumentFragment</code> and not the
+ * <code>DocumentFragment</code> itself are inserted into the
+ * <code>Node</code>. This makes the <code>DocumentFragment</code> very
+ * useful when the user wishes to create nodes that are siblings; the
* <code>DocumentFragment</code> acts as the parent of these nodes so that the
- * user can use the standard methods from the <code>Node</code> interface,
- * such as <code>insertBefore()</code> and <code>appendChild()</code>.
+ * user can use the standard methods from the <code>Node</code> interface,
+ * such as <code>insertBefore()</code> and <code>appendChild()</code>.
*/
class CDOM_EXPORT DOM_DocumentFragment: public DOM_Node {
@@ -149,14 +149,14 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_DocumentFragment & operator = (const DOM_NullPtr *val);
//@}
/** @name Destructor */
//@{
-
+
/**
* Destructor. The object being destroyed is the reference
* object, not the underlying Comment node itself.
diff --git a/src/xercesc/dom/DOM_DocumentType.hpp b/src/xercesc/dom/DOM_DocumentType.hpp
index f532d14ebc44e7f966a510f36c9aa00e97393e05..604055aab1a547ab16e49b889a1e0bcc6b71ac5c 100644
--- a/src/xercesc/dom/DOM_DocumentType.hpp
+++ b/src/xercesc/dom/DOM_DocumentType.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 19:57:15 tng
* Remove the phrase "Experimental".
*
@@ -167,7 +170,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_DocumentType & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_Element.hpp b/src/xercesc/dom/DOM_Element.hpp
index f873f7155ef420f6d7b3385fa33a5e7fa71ec9c4..520be923c5b9135cee1858174c50558dcde962b7 100644
--- a/src/xercesc/dom/DOM_Element.hpp
+++ b/src/xercesc/dom/DOM_Element.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 20:03:48 tng
* Add DOM Level missing functions:
* 1. NodeIterator::getRoot
@@ -186,7 +189,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Element & operator = (const DOM_NullPtr *val);
@@ -461,7 +464,7 @@ public:
* Returns <code>true</code> when an attribute with a given name is
* specified on this element or has a default value, <code>false</code>
* otherwise.
- * @param nameThe name of the attribute to look for.
+ * @param name The name of the attribute to look for.
* @return <code>true</code> if an attribute with the given name is
* specified on this element or has a default value, <code>false</code>
* otherwise.
@@ -473,8 +476,8 @@ public:
* namespace URI is specified on this element or has a default value,
* <code>false</code> otherwise. HTML-only DOM implementations do not
* need to implement this method.
- * @param namespaceURIThe namespace URI of the attribute to look for.
- * @param localNameThe local name of the attribute to look for.
+ * @param namespaceURI The namespace URI of the attribute to look for.
+ * @param localName The local name of the attribute to look for.
* @return <code>true</code> if an attribute with the given local name
* and namespace URI is specified or has a default value on this
* element, <code>false</code> otherwise.
diff --git a/src/xercesc/dom/DOM_Entity.hpp b/src/xercesc/dom/DOM_Entity.hpp
index e300e56332c96fdb938976d58be6f8202f50cbe3..ab4586aa170d2e6c3e4be2f9a8e22ae608d1a648 100644
--- a/src/xercesc/dom/DOM_Entity.hpp
+++ b/src/xercesc/dom/DOM_Entity.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:45 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:45 peiyongz
+ * sane_include
*
* Revision 1.8 2000/09/09 00:11:46 andyh
* Virtual Destructor Patch, submitted by Kirk Wylie
@@ -99,16 +102,16 @@
class EntityImpl;
/**
- * This interface represents an entity, either parsed or unparsed, in an XML
- * document.
+ * This interface represents an entity, either parsed or unparsed, in an XML
+ * document.
*
- * Note that this models the entity itself not the entity
- * declaration. <code>Entity</code> declaration modeling has been left for a
+ * Note that this models the entity itself not the entity
+ * declaration. <code>Entity</code> declaration modeling has been left for a
* later Level of the DOM specification.
- * <p>The <code>nodeName</code> attribute that is inherited from
+ * <p>The <code>nodeName</code> attribute that is inherited from
* <code>Node</code> contains the name of the entity.
- * <p>An XML processor may choose to completely expand entities before the
- * structure model is passed to the DOM; in this case there will be no
+ * <p>An XML processor may choose to completely expand entities before the
+ * structure model is passed to the DOM; in this case there will be no
* <code>EntityReference</code> nodes in the document tree.
*
* <p>Note: the first release of this parser does not create entity
@@ -150,7 +153,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Entity & operator = (const DOM_NullPtr *val);
@@ -167,23 +170,23 @@ public:
/** @name Get functions. */
//@{
/**
- * The public identifier associated with the entity, if specified.
+ * The public identifier associated with the entity, if specified.
*
* If the public identifier was not specified, this is <code>null</code>.
*/
DOMString getPublicId() const;
/**
- * The system identifier associated with the entity, if specified.
+ * The system identifier associated with the entity, if specified.
*
* If the system identifier was not specified, this is <code>null</code>.
*/
DOMString getSystemId() const;
/**
- * For unparsed entities, the name of the notation for the entity.
+ * For unparsed entities, the name of the notation for the entity.
*
- * For parsed entities, this is <code>null</code>.
+ * For parsed entities, this is <code>null</code>.
*/
DOMString getNotationName() const;
diff --git a/src/xercesc/dom/DOM_EntityReference.hpp b/src/xercesc/dom/DOM_EntityReference.hpp
index cac42bd6cfd37f50fb1e609e34c9756fadf24ce0..c2e9932d38f23ba061c9f619502f7730fa73794c 100644
--- a/src/xercesc/dom/DOM_EntityReference.hpp
+++ b/src/xercesc/dom/DOM_EntityReference.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:45 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:45 peiyongz
+ * sane_include
*
* Revision 1.5 2000/03/02 19:53:56 roddey
* This checkin includes many changes done while waiting for the
@@ -90,9 +93,9 @@
class EntityReferenceImpl;
/**
- * <code>EntityReference</code> nodes will appear in the structure
- * model when an entity reference is in the source document, or when the user
- * wishes to insert an entity reference.
+ * <code>EntityReference</code> nodes will appear in the structure
+ * model when an entity reference is in the source document, or when the user
+ * wishes to insert an entity reference.
*
* The expansion of the entity will appear as child nodes of the entity
* reference node. The expansion may be just simple text, or it may
@@ -117,7 +120,7 @@ public:
/**
* Copy constructor. Creates a new <code>DOM_EntityReference</code> that refers to the
- * same underlying node as the original.
+ * same underlying node as the original.
*
* @param other The object to be copied.
*/
@@ -141,7 +144,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_EntityReference & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_NamedNodeMap.hpp b/src/xercesc/dom/DOM_NamedNodeMap.hpp
index 6b1e777b5bdc9fda686451b23ae43ea27d2956f7..556e795a84e9944f8af194a454ac1e635aae2362 100644
--- a/src/xercesc/dom/DOM_NamedNodeMap.hpp
+++ b/src/xercesc/dom/DOM_NamedNodeMap.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 19:57:15 tng
* Remove the phrase "Experimental".
*
@@ -200,7 +203,7 @@ public:
* named node map as the other reference object. This does not
* compare the contents of two different objects.
*
- * @param arg p The value to be compared
+ * @param other The value to be compared
* @return Returns true if the underlying named node map is same
*/
bool operator == (const DOM_NamedNodeMap &other) const;
@@ -210,7 +213,7 @@ public:
* named node map as the other reference object. This does not
* compare the contents of two different objects.
*
- * @param arg p The value to be compared
+ * @param other The value to be compared
* @return Returns true if the underlying named node map is different
*/
bool operator != (const DOM_NamedNodeMap &other) const;
@@ -220,7 +223,7 @@ public:
* Use this comparison operator to test whether a Named Node Map reference
* is null.
*
- * @param arg p The value to be compared, which must be 0 or null.
+ * @param p The value to be compared, which must be 0 or null.
* @return Returns true if the named node map is null
*/
bool operator == (const DOM_NullPtr *p) const;
@@ -229,7 +232,7 @@ public:
* Use this comparison operator to test whether a Named Node Map reference
* is not null.
*
- * @param arg p The value to be compared, which must not be 0 or null.
+ * @param p The value to be compared, which must not be 0 or null.
* @return Returns true if the named node map is not null
*/
bool operator != (const DOM_NullPtr *p) const;
diff --git a/src/xercesc/dom/DOM_Node.hpp b/src/xercesc/dom/DOM_Node.hpp
index 1e099bd0d4340cebedc267f8cb7b5018aa991c44..cde82fdd569a8c4024fae5be9dd66c029941e59e 100644
--- a/src/xercesc/dom/DOM_Node.hpp
+++ b/src/xercesc/dom/DOM_Node.hpp
@@ -132,7 +132,7 @@ class CDOM_EXPORT DOM_Node {
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Node & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_NodeIterator.hpp b/src/xercesc/dom/DOM_NodeIterator.hpp
index 22ff18e555bc56ee93591567d72d0803ca5a5d76..1e17ee8dc74e708bf1980f671570a818f57e6fe3 100644
--- a/src/xercesc/dom/DOM_NodeIterator.hpp
+++ b/src/xercesc/dom/DOM_NodeIterator.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 20:03:48 tng
* Add DOM Level missing functions:
* 1. NodeIterator::getRoot
@@ -151,7 +154,7 @@ class CDOM_EXPORT DOM_NodeIterator
* Assignment operator. This overloaded variant is provided for
* the sole purpose of setting a DOM_NodeIterator to null.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_NodeIterator & operator = (const DOM_NullPtr *val);
//@}
diff --git a/src/xercesc/dom/DOM_NodeList.hpp b/src/xercesc/dom/DOM_NodeList.hpp
index cc027e3fb2ffc85b692d4e3e79d3b9128c281ace..9cb3a519720aa77d7bbfd6663358486b6320379b 100644
--- a/src/xercesc/dom/DOM_NodeList.hpp
+++ b/src/xercesc/dom/DOM_NodeList.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:46 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:46 peiyongz
+ * sane_include
*
* Revision 1.9 2000/04/19 02:26:16 aruna1
* Full support for DOM_EntityReference, DOM_Entity and DOM_DocumentType introduced
@@ -102,12 +105,12 @@
class NodeListImpl;
/**
- * The <code>NodeList</code> interface provides the abstraction of an ordered
- * collection of nodes. NodeLists are created by DOM_Document::getElementsByTagName(),
- * DOM_Node::getChildNodes(),
+ * The <code>NodeList</code> interface provides the abstraction of an ordered
+ * collection of nodes. NodeLists are created by DOM_Document::getElementsByTagName(),
+ * DOM_Node::getChildNodes(),
*
- * <p>The items in the <code>NodeList</code> are accessible via an integral
- * index, starting from 0.
+ * <p>The items in the <code>NodeList</code> are accessible via an integral
+ * index, starting from 0.
*
* NodeLists are "live", in that any changes to the document tree are immediately
* reflected in any NodeLists that may have been created for that tree.
@@ -154,7 +157,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_NodeList & operator = (const DOM_NullPtr *val);
@@ -215,29 +218,29 @@ public:
* @param nullPtr The value to be compared, which must be 0 or null.
* @return Returns true if node list reference is not null
*/
- bool operator != (const DOM_NullPtr *nullPtr) const;
+ bool operator != (const DOM_NullPtr *nullPtr) const;
//@}
/** @name Get functions. */
//@{
/**
- * Returns the <code>index</code>th item in the collection.
+ * Returns the <code>index</code>th item in the collection.
*
- * If <code>index</code> is greater than or equal to the number of nodes in
+ * If <code>index</code> is greater than or equal to the number of nodes in
* the list, this returns <code>null</code>.
*
* @param index Index into the collection.
- * @return The node at the <code>index</code>th position in the
- * <code>NodeList</code>, or <code>null</code> if that is not a valid
+ * @return The node at the <code>index</code>th position in the
+ * <code>NodeList</code>, or <code>null</code> if that is not a valid
* index.
*/
DOM_Node item(unsigned int index) const;
/**
- * Returns the number of nodes in the list.
+ * Returns the number of nodes in the list.
*
- * The range of valid child node indices is 0 to <code>length-1</code> inclusive.
+ * The range of valid child node indices is 0 to <code>length-1</code> inclusive.
*/
unsigned int getLength() const;
//@}
diff --git a/src/xercesc/dom/DOM_Notation.hpp b/src/xercesc/dom/DOM_Notation.hpp
index ea3b1672eae70e66431d4e54490fdce6de77b865..c0ecb54efcb4228d6acfb1fa4329623b8514f22b 100644
--- a/src/xercesc/dom/DOM_Notation.hpp
+++ b/src/xercesc/dom/DOM_Notation.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:46 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:46 peiyongz
+ * sane_include
*
* Revision 1.6 2000/03/11 02:58:39 chchou
* Fix bug # 18, remove set method of readonly attributes
@@ -93,13 +96,13 @@
class NotationImpl;
/**
- * This interface represents a notation declared in the DTD. A notation either
- * declares, by name, the format of an unparsed entity (see section 4.7 of
- * the XML 1.0 specification), or is used for formal declaration of
- * Processing Instruction targets (see section 2.6 of the XML 1.0
- * specification). The <code>nodeName</code> attribute inherited from
+ * This interface represents a notation declared in the DTD. A notation either
+ * declares, by name, the format of an unparsed entity (see section 4.7 of
+ * the XML 1.0 specification), or is used for formal declaration of
+ * Processing Instruction targets (see section 2.6 of the XML 1.0
+ * specification). The <code>nodeName</code> attribute inherited from
* <code>Node</code> is set to the declared name of the notation.
- * <p>The DOM Level 1 does not support editing <code>Notation</code> nodes;
+ * <p>The DOM Level 1 does not support editing <code>Notation</code> nodes;
* they are therefore readonly.
* <p>A <code>Notation</code> node does not have any parent.
*/
@@ -147,7 +150,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Notation & operator = (const DOM_NullPtr *val);
@@ -158,7 +161,7 @@ public:
/**
* Destructor for DOM_Notation. The object being destroyed is the reference
* object, not the underlying Notation node itself.
- *
+ *
*/
~DOM_Notation();
@@ -167,17 +170,17 @@ public:
//@{
/**
- * Get the public identifier of this notation.
- *
- * If the public identifier was not
+ * Get the public identifier of this notation.
+ *
+ * If the public identifier was not
* specified, this is <code>null</code>.
* @return Returns the public identifier of the notation
*/
DOMString getPublicId() const;
/**
- * Get the system identifier of this notation.
+ * Get the system identifier of this notation.
*
- * If the system identifier was not
+ * If the system identifier was not
* specified, this is <code>null</code>.
* @return Returns the system identifier of the notation
*/
diff --git a/src/xercesc/dom/DOM_ProcessingInstruction.hpp b/src/xercesc/dom/DOM_ProcessingInstruction.hpp
index 637c68fc12dd9ca55d920cbb0523688d1772e6a8..aae4b5c81f4b7d2df2dfe7c9e601cb7951e33b9e 100644
--- a/src/xercesc/dom/DOM_ProcessingInstruction.hpp
+++ b/src/xercesc/dom/DOM_ProcessingInstruction.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:46 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:46 peiyongz
+ * sane_include
*
* Revision 1.5 2000/03/02 19:53:57 roddey
* This checkin includes many changes done while waiting for the
@@ -90,8 +93,8 @@
class ProcessingInstructionImpl;
/**
- * The <code>ProcessingInstruction</code> interface represents a "processing
- * instruction", used in XML as a way to keep processor-specific information
+ * The <code>ProcessingInstruction</code> interface represents a "processing
+ * instruction", used in XML as a way to keep processor-specific information
* in the text of the document.
*/
class CDOM_EXPORT DOM_ProcessingInstruction: public DOM_Node {
@@ -138,7 +141,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_ProcessingInstruction & operator = (const DOM_NullPtr *val);
@@ -156,18 +159,18 @@ public:
/** @name Get functions. */
//@{
/**
- * The target of this processing instruction.
+ * The target of this processing instruction.
*
- * XML defines this as being the
+ * XML defines this as being the
* first token following the markup that begins the processing instruction.
*/
DOMString getTarget() const;
/**
- * The content of this processing instruction.
+ * The content of this processing instruction.
*
- * This is from the first non
- * white space character after the target to the character immediately
+ * This is from the first non
+ * white space character after the target to the character immediately
* preceding the <code>?></code>.
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
@@ -178,10 +181,10 @@ public:
/** @name Set functions. */
//@{
/**
- * Sets the content of this processing instruction.
+ * Sets the content of this processing instruction.
*
- * This is from the first non
- * white space character after the target to the character immediately
+ * This is from the first non
+ * white space character after the target to the character immediately
* preceding the <code>?></code>.
* @param data The string containing the processing instruction
*/
diff --git a/src/xercesc/dom/DOM_Text.hpp b/src/xercesc/dom/DOM_Text.hpp
index 5a010ef11b85a12b95c4f266a5e3a6f090e81747..4fc33606c8d8812b2c367879bef5f981fc82cbdc 100644
--- a/src/xercesc/dom/DOM_Text.hpp
+++ b/src/xercesc/dom/DOM_Text.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 19:57:15 tng
* Remove the phrase "Experimental".
*
@@ -164,7 +167,7 @@ class CDOM_EXPORT DOM_Text: public DOM_CharacterData {
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_Text & operator = (const DOM_NullPtr *val);
diff --git a/src/xercesc/dom/DOM_TreeWalker.hpp b/src/xercesc/dom/DOM_TreeWalker.hpp
index a52478bb86062bf1baf73b91ef719ec34a20dbe5..e6814d6127c801c9c8d2622b7150b2da256bd51b 100644
--- a/src/xercesc/dom/DOM_TreeWalker.hpp
+++ b/src/xercesc/dom/DOM_TreeWalker.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:00 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 20:03:48 tng
* Add DOM Level missing functions:
* 1. NodeIterator::getRoot
@@ -156,7 +159,7 @@ class CDOM_EXPORT DOM_TreeWalker {
* Assignment operator. This overloaded variant is provided for
* the sole purpose of setting a DOM_NodeIterator to null.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_TreeWalker & operator = (const DOM_NullPtr *val);
//@}
diff --git a/src/xercesc/dom/DOM_XMLDecl.hpp b/src/xercesc/dom/DOM_XMLDecl.hpp
index 0d3f04c347e343a8a4f4f72816ec8db9c86ac5a6..82f6d5e014d656c5c3ea7651c6d812f946c2ac84 100644
--- a/src/xercesc/dom/DOM_XMLDecl.hpp
+++ b/src/xercesc/dom/DOM_XMLDecl.hpp
@@ -77,7 +77,7 @@ public:
//@{
/**
* The default constructor for DOM_XMLDecl creates a null
- * DOM_XMLDecl object that refers to a declaration node with
+ * DOM_XMLDecl object that refers to a declaration node with
* version= 1.0, encoding=utf-8 and standalone=no
*
*/
@@ -108,7 +108,7 @@ public:
* for an extended time, when the storage belonging to the underlying
* node needs to be reclaimed.
*
- * @param val. Only a value of 0, or null, is allowed.
+ * @param val Only a value of 0, or null, is allowed.
*/
DOM_XMLDecl & operator = (const DOM_NullPtr *val);
@@ -135,24 +135,24 @@ public:
//@}
//@{
-
+
/**
* To get the version string of the xmlDeclaration statement
*/
DOMString getVersion() const;
-
+
/**
* To get the encoding string of the xmlDeclaration statement
*/
DOMString getEncoding() const;
-
+
/**
* To get the standalone string of the xmlDeclaration statement
*/
DOMString getStandalone() const;
//@}
-
+
protected:
DOM_XMLDecl( XMLDeclImpl *impl);
diff --git a/src/xercesc/framework/MemBufInputSource.hpp b/src/xercesc/framework/MemBufInputSource.hpp
index 1848d1e44e7acb39980bda475470ceef0373d8f1..be147241a8559177945346631be62d4e281e1bf3 100644
--- a/src/xercesc/framework/MemBufInputSource.hpp
+++ b/src/xercesc/framework/MemBufInputSource.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:50 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:50 peiyongz
+ * sane_include
*
* Revision 1.6 2000/12/14 18:49:54 tng
* Fix API document generation warning: "Warning: end of member group without matching begin"
@@ -147,8 +150,8 @@ public :
* @param srcDocBytes The actual data buffer to be parsed from.
* @param byteCount The count of bytes (not characters, bytes!)
* in the buffer.
- * @Param bufId A fake system id for the buffer.
- * @Param adoptBuffer Indicates whether this object should adopt
+ * @param bufId A fake system id for the buffer.
+ * @param adoptBuffer Indicates whether this object should adopt
* the buffer (i.e. make a copy of it) or just
* use it in place.
*/
diff --git a/src/xercesc/framework/XMLAttDef.hpp b/src/xercesc/framework/XMLAttDef.hpp
index 044e7b3de94860445618918f1e1a23fc8d21ec8c..f09d07f833749c414f37176e517fba84c14a5b8f 100644
--- a/src/xercesc/framework/XMLAttDef.hpp
+++ b/src/xercesc/framework/XMLAttDef.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:50 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:50 peiyongz
+ * sane_include
*
* Revision 1.13 2001/11/15 16:36:36 knoaman
* Re-organize constant values.
@@ -379,7 +382,7 @@ public:
* This setting controls whether the attribute is required, fixed,
* implied, etc...
*
- * @param The new default attribute to set
+ * @param newValue The new default attribute to set
*/
void setDefaultType(const XMLAttDef::DefAttTypes newValue);
@@ -389,7 +392,7 @@ public:
* called by the validator that creates the actual instance (which is of
* a derived type known only by the validator.)
*
- * @param The new pool id to set.
+ * @param newId The new pool id to set.
*/
void setId(const unsigned int newId);
@@ -399,7 +402,7 @@ public:
* by the scanner as it is scanning a start tag and marking off the
* attributes that have been explicitly provided.
*
- * @param The new provided state to set
+ * @param newValue The new provided state to set
*/
void setProvided(const bool newValue);
@@ -408,7 +411,7 @@ public:
* This method will set the type of the attribute. The type of an attribute
* controls how it is normalized and what kinds of characters it can hold.
*
- * @param The new attribute type to set
+ * @param newValue The new attribute type to set
*/
void setType(const XMLAttDef::AttTypes newValue);
@@ -420,7 +423,7 @@ public:
* type is enumeration or notation, this must be one of the valid values
* set in the setEnumeration() call.
*
- * @param The new fixed/default value to set.
+ * @param newValue The new fixed/default value to set.
*/
void setValue(const XMLCh* const newValue);
@@ -432,7 +435,7 @@ public:
* attribute. This should only be set if the setType() method is used to
* set the type to the enumeration or notation types.
*
- * @param The new enumerated/notation value list to set.
+ * @param newValue The new enumerated/notation value list to set.
*/
void setEnumeration(const XMLCh* const newValue);
@@ -440,11 +443,15 @@ public:
*
* This method will update the 'create reason' field for this attribute
* decl object.
+ *
+ * @param newReason The new create reason.
*/
void setCreateReason(const CreateReasons newReason);
/**
* Set the attribute decl to indicate external declaration
+ *
+ * @param aValue The new value to indicate external declaration.
*/
void setExternalAttDeclaration(const bool aValue);
diff --git a/src/xercesc/framework/XMLAttr.hpp b/src/xercesc/framework/XMLAttr.hpp
index 37a7a9940261ba5a979341f72f0c91783e5d2075..4925bafc829d435864df81a22230b94be5bb41d3 100644
--- a/src/xercesc/framework/XMLAttr.hpp
+++ b/src/xercesc/framework/XMLAttr.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:50 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:50 peiyongz
+ * sane_include
*
* Revision 1.9 2001/11/02 14:21:18 knoaman
* Add support for identity constraints.
@@ -271,9 +274,6 @@ public:
* the value content. Make sure that the value
* set meets the constraints!
*
- * @param specified Indicates whether the attribute was explicitly
- * specified or not. If not, then it was faulted
- * in from a FIXED or DEFAULT value.
*/
void set
(
@@ -308,7 +308,7 @@ public:
/**
* This method will update the specified state of the object.
*
- * @param specified Indicates whether the attribute was explicitly
+ * @param newValue Indicates whether the attribute was explicitly
* specified or not. If not, then it was faulted
* in from a FIXED or DEFAULT value.
*/
@@ -327,7 +327,7 @@ public:
/**
* This method will update the value field of the attribute.
*
- * @param attrValue The value string of the attribute, which should
+ * @param newValue The value string of the attribute, which should
* be fully normalized by XML rules according to the
* attribute type.
*/
@@ -337,6 +337,8 @@ public:
* This method will set the URI id field of this attribute. This is
* generally only ever called internally by the parser itself during
* the parsing process.
+ *
+ * @param uriId The uriId of the attribute.
*/
void setURIId(const unsigned int uriId);
diff --git a/src/xercesc/framework/XMLDocumentHandler.hpp b/src/xercesc/framework/XMLDocumentHandler.hpp
index 2383a555f2445eaf9820f92e01342c456e6101ec..8295d6e04c6e46e47c10e08df456e01bf678bcfc 100644
--- a/src/xercesc/framework/XMLDocumentHandler.hpp
+++ b/src/xercesc/framework/XMLDocumentHandler.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:51 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:51 peiyongz
+ * sane_include
*
* Revision 1.8 2000/03/02 19:54:24 roddey
* This checkin includes many changes done while waiting for the
@@ -104,8 +107,8 @@ class XMLEntityDecl;
/**
* This abstract class provides the interface for the scanner to return
* XML document information up to the parser as it scans through the
- * document.
- *
+ * document.
+ *
* The interface is very similar to org.sax.DocumentHandler, but
* has some extra methods required to get all the data out.
*/
@@ -141,7 +144,7 @@ public:
* @param length The number of characters to read from the array.
* @param cdataSection Indicates that this data is inside a CDATA
* section.
- * @see #ignorableWhitespace
+ * @see #ignorableWhitespace
* @see Locator
*/
virtual void docCharacters
@@ -194,9 +197,9 @@ public:
* endElement() event, but not necessarily the other way around. For
* empty tags, there is only a startElement() call.
*
- * @param elementDecl The name of the element whose end tag was just
+ * @param elemDecl The name of the element whose end tag was just
* parsed.
- * @param uriId The ID of the URI in the URI pool (only valid if
+ * @param uriId The ID of the URI in the URI pool (only valid if
* name spaces is enabled)
* @param isRoot Indicates if this is the root element.
*/
@@ -212,7 +215,7 @@ public:
* This method is called when scanner encounters the end of an entity
* reference.
*
- * @param entityName The name of the entity reference just scanned.
+ * @param entDecl The name of the entity reference just scanned.
*/
virtual void endEntityReference
(
@@ -269,9 +272,9 @@ public:
* All elements must always have a startElement() tag. Empty tags will
* only have the startElement() tag and no endElement() tag.
*
- * @param elementDecl The name of the element whose start tag was just
+ * @param elemDecl The name of the element whose start tag was just
* parsed.
- * @param uriId The ID of the URI in the URI pool (only valid if
+ * @param uriId The ID of the URI in the URI pool (only valid if
* name spaces is enabled)
* @param prefixName The string representing the prefix name
* @param attrList List of attributes in the element
@@ -296,7 +299,7 @@ public:
* This is currently useful only to DOM parser configurations as SAX
* does not provide any api to return this information.
*
- * @param entityName The name of the entity that was referenced.
+ * @param entDecl The name of the entity that was referenced.
*/
virtual void startEntityReference(const XMLEntityDecl& entDecl) = 0;
diff --git a/src/xercesc/framework/XMLErrorReporter.hpp b/src/xercesc/framework/XMLErrorReporter.hpp
index e2f29cba8dd0cf7499b773cf6b3c131aca4debb8..93704ff53baa02ca880136e5c1961cf88671ec21 100644
--- a/src/xercesc/framework/XMLErrorReporter.hpp
+++ b/src/xercesc/framework/XMLErrorReporter.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:51 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:51 peiyongz
+ * sane_include
*
* Revision 1.11 2001/05/11 13:25:32 tng
* Copyright update.
@@ -183,7 +186,7 @@ public:
* so can possibly be in the local language if a
* translation has been provided.
*
- * @param sysetmId The system id of the entity where the error occured,
+ * @param systemId The system id of the entity where the error occured,
* fully qualified.
*
* @param publicId The optional public id of the entity were the error
diff --git a/src/xercesc/framework/XMLValidator.hpp b/src/xercesc/framework/XMLValidator.hpp
index 17f96c95a6802f8064705b456ce633dbea930521..6a254801be9961cc1a4d1d470615a3d3e0e97e1d 100644
--- a/src/xercesc/framework/XMLValidator.hpp
+++ b/src/xercesc/framework/XMLValidator.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:52 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:52 peiyongz
+ * sane_include
*
* Revision 1.17 2001/11/30 22:18:18 peiyongz
* cleanUp function made member function
@@ -193,8 +196,7 @@ public:
* Note that whitespace and text content are not validated here. Those are
* handled by the scanner. So only element ids are provided here.
*
- * @param elemId The pool id of the element whose content is to be
- * checked.
+ * @param elemDecl The element whose content is to be checked.
*
* @param children An array of element QName which represent the elements
* found within the parent element, i.e. the content
@@ -385,12 +387,13 @@ public:
* in the order passed. So text1 will replace {0}, text2 will replace {1},
* and so forth.
*
+ * textX Up to four replacement parameters. They can be provided
+ * as either XMLCh strings, or local code page strings which
+ * will be transcoded internally.
+ *
* @param toEmit The error code to emit. it must be one of the defined
* validator error codes.
*
- * @param textX Up to four replacement parameters. They can be provided
- * as either XMLCh strings, or local code page strings which
- * will be transcoded internally.
*/
void emitError(const XMLValid::Codes toEmit);
void emitError
diff --git a/src/xercesc/idom/IDOM_DocumentFragment.hpp b/src/xercesc/idom/IDOM_DocumentFragment.hpp
index e3eb29756fe908f0ed9c46d9605eaf8374073fce..76105372ab4f3c77ac59cf422836275356bd0963 100644
--- a/src/xercesc/idom/IDOM_DocumentFragment.hpp
+++ b/src/xercesc/idom/IDOM_DocumentFragment.hpp
@@ -109,7 +109,6 @@ protected:
IDOM_DocumentFragment() {};
IDOM_DocumentFragment(const IDOM_DocumentFragment &other) {};
IDOM_DocumentFragment & operator = (const IDOM_DocumentFragment &other) {return *this;};
- //@}
/** @name Destructor */
//@{
diff --git a/src/xercesc/idom/IDOM_Element.hpp b/src/xercesc/idom/IDOM_Element.hpp
index d5e3941cd00e12d23729fc722e0fcd1a4ca86c21..bc84fc0022f043312d76bd32e9eb8cab9a9e580e 100644
--- a/src/xercesc/idom/IDOM_Element.hpp
+++ b/src/xercesc/idom/IDOM_Element.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
* Revision 1.2 2002/02/04 21:20:59 tng
* Add DOM 2 Level missing functions:
* 1. NodeIterator::getRoot
@@ -387,7 +390,7 @@ public:
* Returns <code>true</code> when an attribute with a given name is
* specified on this element or has a default value, <code>false</code>
* otherwise.
- * @param nameThe name of the attribute to look for.
+ * @param name The name of the attribute to look for.
* @return <code>true</code> if an attribute with the given name is
* specified on this element or has a default value, <code>false</code>
* otherwise.
@@ -399,8 +402,8 @@ public:
* namespace URI is specified on this element or has a default value,
* <code>false</code> otherwise. HTML-only DOM implementations do not
* need to implement this method.
- * @param namespaceURIThe namespace URI of the attribute to look for.
- * @param localNameThe local name of the attribute to look for.
+ * @param namespaceURI The namespace URI of the attribute to look for.
+ * @param localName The local name of the attribute to look for.
* @return <code>true</code> if an attribute with the given local name
* and namespace URI is specified or has a default value on this
* element, <code>false</code> otherwise.
diff --git a/src/xercesc/idom/IDOM_ProcessingInstruction.hpp b/src/xercesc/idom/IDOM_ProcessingInstruction.hpp
index 9c683ac8d3a674e37e4a159fa532649856d1e27d..38a2edf7a8a096b8bb1448550c1a72a1a0fad42a 100644
--- a/src/xercesc/idom/IDOM_ProcessingInstruction.hpp
+++ b/src/xercesc/idom/IDOM_ProcessingInstruction.hpp
@@ -60,8 +60,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:21:56 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:21:56 peiyongz
+ * sane_include
*
* Revision 1.2 2001/05/11 13:25:54 tng
* Copyright update.
@@ -90,7 +93,6 @@ protected:
public:
virtual ~IDOM_ProcessingInstruction() {};
- //@}
/** @name Get functions. */
//@{
/**
diff --git a/src/xercesc/parsers/DOMParser.hpp b/src/xercesc/parsers/DOMParser.hpp
index e981cfb54b0e1b32ebe8b745260fbe20efbfc8cc..529105cda90692a67005889b5c3223061f2511d5 100644
--- a/src/xercesc/parsers/DOMParser.hpp
+++ b/src/xercesc/parsers/DOMParser.hpp
@@ -577,7 +577,7 @@ public :
*
* <p>The parser's default state is: false </p>
*
- * @param newState The new to create XMLDecl type node flag
+ * @param create The new to create XMLDecl type node flag
*
*/
void setToCreateXMLDeclTypeNode(const bool create);
@@ -597,7 +597,7 @@ public :
* documents: e.g, "http://www.example.com file_name.xsd". The user can
* specify more than one XML Schema in the list.
*
- * @param the list of schemas to use
+ * @param schemaLocation the list of schemas to use
*
* @see #getExternalSchemaLocation
*/
@@ -608,7 +608,7 @@ public :
* This method is same as setExternalSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
- * @param the list of schemas to use
+ * @param schemaLocation the list of schemas to use
*
* @see #setExternalSchemaLocation(const XMLCh* const)
*/
@@ -624,7 +624,7 @@ public :
* The syntax is the same as for the noNamespaceSchemaLocation attribute
* that may occur in an instance document: e.g."file_name.xsd".
*
- * @param the XML Schema Location with no target namespace
+ * @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #getExternalNoNamespaceSchemaLocation
*/
@@ -634,7 +634,7 @@ public :
* This method is same as setExternalNoNamespaceSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
- * @param the XML Schema Location with no target namespace
+ * @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #setExternalNoNamespaceSchemaLocation(const XMLCh* const)
*/
@@ -1224,9 +1224,9 @@ public :
* the encoding string value.
* @param standaloneStr A const pointer to a Unicode string
* representing the standalone string value.
- * @param actualEncodingStr A const pointer to a Unicode string
- * representing the actual encoding string
- * value.
+ * @param actualEncStr A const pointer to a Unicode string
+ * representing the actual encoding string
+ * value.
*/
virtual void XMLDecl
(
diff --git a/src/xercesc/parsers/IDOMParser.hpp b/src/xercesc/parsers/IDOMParser.hpp
index 3ac107d64787692ef15453565d2e18c841b8f14d..a039a649430c66aa3f14f350a634ede19b47b1cd 100644
--- a/src/xercesc/parsers/IDOMParser.hpp
+++ b/src/xercesc/parsers/IDOMParser.hpp
@@ -621,7 +621,7 @@ public :
* documents: e.g, "http://www.example.com file_name.xsd". The user can
* specify more than one XML Schema in the list.
*
- * @param the list of schemas to use
+ * @param schemaLocation the list of schemas to use
*
* @see #getExternalSchemaLocation
*/
@@ -632,7 +632,7 @@ public :
* This method is same as setExternalSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
- * @param the list of schemas to use
+ * @param schemaLocation the list of schemas to use
*
* @see #setExternalSchemaLocation(const XMLCh* const)
*/
@@ -648,7 +648,7 @@ public :
* The syntax is the same as for the noNamespaceSchemaLocation attribute
* that may occur in an instance document: e.g."file_name.xsd".
*
- * @param the XML Schema Location with no target namespace
+ * @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #getExternalNoNamespaceSchemaLocation
*/
@@ -658,7 +658,7 @@ public :
* This method is same as setExternalNoNamespaceSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
- * @param the XML Schema Location with no target namespace
+ * @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #setExternalNoNamespaceSchemaLocation(const XMLCh* const)
*/
@@ -918,7 +918,7 @@ public :
* This classification is defined by the XML specification.
*
* @param errCode An integer code for the error.
- * @param msgdomain A const pointer to an Unicode string representing
+ * @param msgDomain A const pointer to an Unicode string representing
* the message domain to use.
* @param errType An enumeration classifying the severity of the error.
* @param errorText A const pointer to an Unicode string representing
@@ -1249,9 +1249,9 @@ public :
* the encoding string value.
* @param standaloneStr A const pointer to a Unicode string
* representing the standalone string value.
- * @param actualEncodingStr A const pointer to a Unicode string
- * representing the actual encoding string
- * value.
+ * @param actualEncStr A const pointer to a Unicode string
+ * representing the actual encoding string
+ * value.
*/
virtual void XMLDecl
(
diff --git a/src/xercesc/parsers/SAXParser.hpp b/src/xercesc/parsers/SAXParser.hpp
index e0546f925d2f3b427d1700f99ae3ba4a8a3f40cf..e554b57ff924d42cdaa011638561949d7aa40dc7 100644
--- a/src/xercesc/parsers/SAXParser.hpp
+++ b/src/xercesc/parsers/SAXParser.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:07 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:07 peiyongz
+ * sane_include
*
* Revision 1.22 2001/12/05 22:09:02 tng
* Update documentation for setExternalSchemaLocation and setExternalNoNamespaceSchemaLocation.
@@ -523,7 +526,7 @@ public :
* documents: e.g, "http://www.example.com file_name.xsd". The user can
* specify more than one XML Schema in the list.
*
- * @param the list of schemas to use
+ * @param schemaLocation the list of schemas to use
*
* @see #getExternalSchemaLocation
*/
@@ -534,7 +537,7 @@ public :
* This method is same as setExternalSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
- * @param the list of schemas to use
+ * @param schemaLocation the list of schemas to use
*
* @see #setExternalSchemaLocation(const XMLCh* const)
*/
@@ -550,7 +553,7 @@ public :
* The syntax is the same as for the noNamespaceSchemaLocation attribute
* that may occur in an instance document: e.g."file_name.xsd".
*
- * @param the XML Schema Location with no target namespace
+ * @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #getExternalNoNamespaceSchemaLocation
*/
@@ -560,7 +563,7 @@ public :
* This method is same as setExternalNoNamespaceSchemaLocation(const XMLCh* const).
* It takes native char string as parameter
*
- * @param the XML Schema Location with no target namespace
+ * @param noNamespaceSchemaLocation the XML Schema Location with no target namespace
*
* @see #setExternalNoNamespaceSchemaLocation(const XMLCh* const)
*/
@@ -689,9 +692,9 @@ public :
* parser. It allows applications to trap and redirect calls to
* external entities.
*
- * @param handler A pointer to the entity resolver to be called
- * when the parser comes across references to
- * entities in the XML file.
+ * @param resolver A pointer to the entity resolver to be called
+ * when the parser comes across references to
+ * entities in the XML file.
*
* @see Parser#setEntityResolver
*/
@@ -894,7 +897,7 @@ public :
(
const DTDElementDecl& elemDecl
, const DTDAttDef& attDef
- , const bool ignoring
+ , const bool ignore
);
/**
diff --git a/src/xercesc/sax/DTDHandler.hpp b/src/xercesc/sax/DTDHandler.hpp
index 2aef2678243b57f0e5d02a2eb9def49d57ca2a0d..f6e1f4b25ae030739b222cfaecb5ea0ba9ae2629 100644
--- a/src/xercesc/sax/DTDHandler.hpp
+++ b/src/xercesc/sax/DTDHandler.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:08 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:08 peiyongz
+ * sane_include
*
* Revision 1.5 2000/02/24 20:12:54 abagchi
* Swat for removing Log from API docs
@@ -87,10 +90,10 @@
* Receive notification of basic DTD-related events.
*
* <p>If a SAX application needs information about notations and
- * unparsed entities, then the application implements this
- * interface and registers an instance with the SAX parser using
- * the parser's setDTDHandler method. The parser uses the
- * instance to report notation and unparsed entity declarations to
+ * unparsed entities, then the application implements this
+ * interface and registers an instance with the SAX parser using
+ * the parser's setDTDHandler method. The parser uses the
+ * instance to report notation and unparsed entity declarations to
* the application.</p>
*
* <p>The SAX parser may report these events in any order, regardless
@@ -99,7 +102,7 @@
* document handler's startDocument event, and before the first
* startElement event.</p>
*
- * <p>It is up to the application to store the information for
+ * <p>It is up to the application to store the information for
* future use (perhaps in a hash table or object tree).
* If the application encounters attributes of type "NOTATION",
* "ENTITY", or "ENTITIES", it can use the information that it
@@ -122,7 +125,7 @@ public:
DTDHandler()
{
}
-
+
/** Destructor */
virtual ~DTDHandler()
{
@@ -177,7 +180,7 @@ public:
* was given.
* @param systemId The entity's system identifier (it must always
* have one).
- * @param notation name The name of the associated notation.
+ * @param notationName The name of the associated notation.
* @see #notationDecl
* @see AttributeList#AttributeList
*/
@@ -202,13 +205,13 @@ public:
private :
/* Unimplemented constructors and operators */
-
+
/* Copy constructor */
DTDHandler(const DTDHandler&);
/* Assignment operator */
void operator=(const DTDHandler&);
-
+
};
#endif
diff --git a/src/xercesc/sax/HandlerBase.hpp b/src/xercesc/sax/HandlerBase.hpp
index c95e298253efff62b2d13059fd398853f7b2ab82..5b9047f94e98fd029005cdc1d81626d5252b8101 100644
--- a/src/xercesc/sax/HandlerBase.hpp
+++ b/src/xercesc/sax/HandlerBase.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:08 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:08 peiyongz
+ * sane_include
*
* Revision 1.6 2000/03/02 19:54:35 roddey
* This checkin includes many changes done while waiting for the
@@ -291,7 +294,7 @@ public:
*
* @param publicId The public identifer, or null if none is
* available.
- * @param systemId The system identifier provided in the XML
+ * @param systemId The system identifier provided in the XML
* document.
* @return The new input source, or null to require the
* default behaviour.
@@ -336,7 +339,7 @@ public:
* method is invoked, since the document is no longer reliable, and
* the parser may no longer report parsing events.</p>
*
- * @param e The error information encoded as an exception.
+ * @param exception The error information encoded as an exception.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see ErrorHandler#fatalError
@@ -352,7 +355,7 @@ public:
* for each warning, such as inserting the message in a log file or
* printing it to the console.</p>
*
- * @param e The warning information encoded as an exception.
+ * @param exception The warning information encoded as an exception.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see ErrorHandler#warning
diff --git a/src/xercesc/sax/InputSource.hpp b/src/xercesc/sax/InputSource.hpp
index 7d20012c91d11fbce0642aa74a840e9dfcc557fe..288385064e590a22bc202e3fe48a2ffd4fc106f1 100644
--- a/src/xercesc/sax/InputSource.hpp
+++ b/src/xercesc/sax/InputSource.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:08 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:01 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:08 peiyongz
+ * sane_include
*
* Revision 1.10 2001/11/21 16:14:32 tng
* Schema: New method InputSource::get/setIssueFatalErrorIfNotFound to tell the parser whether to issue fatal error or not if cannot find it (the InputSource). This is required for schema processing as it shouldn't be a fatal error if the schema is not found.
@@ -270,8 +273,8 @@ public:
* Indicates if the parser should issue fatal error if this input source
* is not found. If set to false, the parser issue warning message instead.
*
- * @param True if the parser should issue fatal error if this input source is not found.
- * If set to false, the parser issue warning message instead. (Default: true)
+ * @param flag True if the parser should issue fatal error if this input source is not found.
+ * If set to false, the parser issue warning message instead. (Default: true)
*
* @see #getIssueFatalErrorIfNotFound
*/
diff --git a/src/xercesc/sax2/Attributes.hpp b/src/xercesc/sax2/Attributes.hpp
index c056de3aef7f0751acd29ec7ec6fa2b703fe3666..381e28a08293a5cff966c24dc6dd1aca7ac33500 100644
--- a/src/xercesc/sax2/Attributes.hpp
+++ b/src/xercesc/sax2/Attributes.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:08 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:08 peiyongz
+ * sane_include
*
* Revision 1.5 2001/05/11 13:26:25 tng
* Copyright update.
@@ -272,7 +275,7 @@ public:
*
* @param uri The Namespace URI, or the empty string if
* the name has no Namespace URI.
- * @param localName The attribute's local name.
+ * @param localPart The attribute's local name.
* @return The index of the attribute, or -1 if it does not
* appear in the list.
*/
@@ -294,7 +297,7 @@ public:
*
* @param uri The Namespace URI, or the empty String if the
* name has no Namespace URI.
- * @param localName The local name of the attribute.
+ * @param localPart The local name of the attribute.
* @return The attribute type as a string, or null if the
* attribute is not in the list or if Namespace
* processing is not being performed.
diff --git a/src/xercesc/sax2/DefaultHandler.hpp b/src/xercesc/sax2/DefaultHandler.hpp
index d91e67d74d14557ea82bac06844de1e54e2ef04e..fa79d6ff099bd4735f4cba01113d2e693dd4871e 100644
--- a/src/xercesc/sax2/DefaultHandler.hpp
+++ b/src/xercesc/sax2/DefaultHandler.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:09 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:09 peiyongz
+ * sane_include
*
* Revision 1.6 2002/01/28 17:08:33 knoaman
* SAX2-ext's DeclHandler support.
@@ -279,7 +282,7 @@ public:
* @param uri The URI of the asscioated namespace for this element
* @param localname the local part of the element name
* @param qname the QName of this element
- * @param attributes The specified or defaulted attributes.
+ * @param attrs The specified or defaulted attributes.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see DocumentHandler#startElement
@@ -415,7 +418,7 @@ public:
* method is invoked, since the document is no longer reliable, and
* the parser may no longer report parsing events.</p>
*
- * @param e The error information encoded as an exception.
+ * @param exception The error information encoded as an exception.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see ErrorHandler#fatalError
@@ -431,7 +434,7 @@ public:
* for each warning, such as inserting the message in a log file or
* printing it to the console.</p>
*
- * @param e The warning information encoded as an exception.
+ * @param exception The warning information encoded as an exception.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see ErrorHandler#warning
@@ -640,7 +643,7 @@ public:
* @param aName The name of the attribute.
* @param type A string representing the attribute type.
* @param mode A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
- * @param value A string representing the attribute's default value, or null if there is none.
+ * @param value A string representing the attribute's default value, or null if there is none.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
*/
@@ -656,7 +659,7 @@ public:
/**
* Report an internal entity declaration.
*
- * <p>Only the effective (first) declaration for each entity will be
+ * <p>Only the effective (first) declaration for each entity will be
* reported. All parameter entities in the value will be expanded, but
* general entities will not.</p>
*
diff --git a/src/xercesc/util/PlatformUtils.hpp b/src/xercesc/util/PlatformUtils.hpp
index 902df947ec1433bcc775074d252108a6759552b1..ef45f0e5dd4d17e6bbf8f4e4dcd3227391762e8d 100644
--- a/src/xercesc/util/PlatformUtils.hpp
+++ b/src/xercesc/util/PlatformUtils.hpp
@@ -409,7 +409,7 @@ public :
* correctly enforced on a per-thread basis or that incorrect nesting
* of lock/unlock operations will be caught.
*
- * @param mtxGandle The mutex handle that you want to unlock
+ * @param mtxHandle The mutex handle that you want to unlock
*/
static void unlockMutex(void* const mtxHandle);
diff --git a/src/xercesc/util/XMLAbstractDoubleFloat.hpp b/src/xercesc/util/XMLAbstractDoubleFloat.hpp
index a1bfd75ed55c83f582b4099433651dc092651c37..2e89bee8208c5b281902d75449e9e67da9fd3177 100644
--- a/src/xercesc/util/XMLAbstractDoubleFloat.hpp
+++ b/src/xercesc/util/XMLAbstractDoubleFloat.hpp
@@ -57,8 +57,11 @@
/*
* $Id$
* $Log$
- * Revision 1.1 2002/02/01 22:22:14 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:14 peiyongz
+ * sane_include
*
* Revision 1.4 2001/11/28 15:39:26 peiyongz
* return Type& for operator=
@@ -85,31 +88,31 @@
/***
* 3.2.5.1 Lexical representation
*
- * double values have a lexical representation consisting of a mantissa followed,
- * optionally, by the character "E" or "e", followed by an exponent.
+ * double values have a lexical representation consisting of a mantissa followed,
+ * optionally, by the character "E" or "e", followed by an exponent.
*
- * The exponent ·must· be an integer.
- * The mantissa must be a decimal number.
- * The representations for exponent and mantissa must follow the lexical rules
- * for integer and decimal.
+ * The exponent ·must· be an integer.
+ * The mantissa must be a decimal number.
+ * The representations for exponent and mantissa must follow the lexical rules
+ * for integer and decimal.
*
- * If the "E" or "e" and the following exponent are omitted,
- * an exponent value of 0 is assumed.
+ * If the "E" or "e" and the following exponent are omitted,
+ * an exponent value of 0 is assumed.
***/
/***
* 3.2.4.1 Lexical representation
*
- * float values have a lexical representation consisting of a mantissa followed,
- * optionally, by the character "E" or "e", followed by an exponent.
+ * float values have a lexical representation consisting of a mantissa followed,
+ * optionally, by the character "E" or "e", followed by an exponent.
*
- * The exponent ·must· be an integer.
- * The mantissa must be a decimal number.
- * The representations for exponent and mantissa must follow the lexical rules
- * for integer and decimal.
+ * The exponent ·must· be an integer.
+ * The mantissa must be a decimal number.
+ * The representations for exponent and mantissa must follow the lexical rules
+ * for integer and decimal.
*
- * If the "E" or "e" and the following exponent are omitted,
- * an exponent value of 0 is assumed.
+ * If the "E" or "e" and the following exponent are omitted,
+ * an exponent value of 0 is assumed.
***/
class XMLUTIL_EXPORT XMLAbstractDoubleFloat : public XMLNumber
@@ -129,7 +132,7 @@ public:
};
virtual ~XMLAbstractDoubleFloat();
-
+
virtual XMLCh* toString() const;
virtual int getSign() const;
@@ -140,7 +143,7 @@ protected:
// To be used by derived class exclusively
//
XMLAbstractDoubleFloat();
-
+
void init(const XMLCh* const strValue);
/**
@@ -149,7 +152,8 @@ protected:
* <code>null</code> and is an <code>XMLAbstractDoubleFloat</code> object that contains
* the same <code>int</code> value as this object.
*
- * @param obj the object to compare with.
+ * @param lValue the object to compare with.
+ * @param rValue the object to compare against.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
*/
@@ -192,7 +196,7 @@ private:
// -----------------------------------------------------------------------
XMLBigDecimal* fMantissa;
- XMLBigInteger* fExponent;
+ XMLBigInteger* fExponent;
LiteralType fType;
};
diff --git a/src/xercesc/util/XMLBigDecimal.hpp b/src/xercesc/util/XMLBigDecimal.hpp
index d57d1ba4b227486ac11544e9a1cd4120a0dc8ebb..1dda2809693462e61482c880725d8b45dee07875 100644
--- a/src/xercesc/util/XMLBigDecimal.hpp
+++ b/src/xercesc/util/XMLBigDecimal.hpp
@@ -73,8 +73,8 @@ public:
* Constructs a newly allocated <code>XMLBigDecimal</code> object that
* represents the value represented by the string.
*
- * @param the <code>String</code> to be converted to an
- * <code>XMLBigDecimal</code>.
+ * @param strValue the <code>String</code> to be converted to an
+ * <code>XMLBigDecimal</code>.
* @exception NumberFormatException if the <code>String</code> does not
* contain a parsable XMLBigDecimal.
*/
@@ -86,7 +86,7 @@ public:
XMLBigDecimal(const XMLBigDecimal& toCopy);
/**
- * Constructs a newly allocated <code>XMLBigDecimal</code> object
+ * Constructs a newly allocated <code>XMLBigDecimal</code> object
* from an existing XMLBigDecimal with an extra Exponent.
*/
XMLBigDecimal(const XMLBigDecimal& toCopy, const int addExponent);
@@ -120,7 +120,7 @@ public:
* <code>null</code> and is an <code>XMLBigDecimal</code> object that contains
* the same <code>int</code> value as this object.
*
- * @param obj the object to compare with.
+ * @param toCompare the object to compare with.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
*/
diff --git a/src/xercesc/util/XMLBigInteger.hpp b/src/xercesc/util/XMLBigInteger.hpp
index d0fe4b84d45ca63d97d67f4bfd56338cea010a77..8611c999971d940cf2582b7c2ad75867af460320 100644
--- a/src/xercesc/util/XMLBigInteger.hpp
+++ b/src/xercesc/util/XMLBigInteger.hpp
@@ -73,8 +73,8 @@ public:
* represents the value represented by the string. The string is
* converted to an int value as if by the <code>valueOf</code> method.
*
- * @param s the <code>String</code> to be converted to an
- * <code>XMLBigInteger</code>.
+ * @param strValue the <code>String</code> to be converted to an
+ * <code>XMLBigInteger</code>.
* @exception NumberFormatException if the <code>String</code> does not
* contain a parsable XMLBigInteger.
*/
@@ -112,7 +112,7 @@ public:
* <code>null</code> and is an <code>XMLBigInteger</code> object that contains
* the same <code>int</code> value as this object.
*
- * @param obj the object to compare with.
+ * @param toCompare the object to compare with.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
*/
diff --git a/src/xercesc/util/XMLDouble.hpp b/src/xercesc/util/XMLDouble.hpp
index 4347ae726d6267721b82e1a0203b745f772f81f2..287b5d5e857ad83bbbd6ac526ea4460ad2857715 100644
--- a/src/xercesc/util/XMLDouble.hpp
+++ b/src/xercesc/util/XMLDouble.hpp
@@ -57,8 +57,11 @@
/*
* $Id$
* $Log$
- * Revision 1.1 2002/02/01 22:22:15 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:15 peiyongz
+ * sane_include
*
* Revision 1.11 2001/11/28 15:39:26 peiyongz
* return Type& for operator=
@@ -105,7 +108,7 @@ public:
* Constructs a newly allocated <code>XMLDouble</code> object that
* represents the value represented by the string.
*
- * @param the <code>String</code> to be converted to an
+ * @param strValue the <code>String</code> to be converted to an
* <code>XMLDouble</code>.
* @exception NumberFormatException if the <code>String</code> does not
* contain a parsable XMLDouble.
@@ -114,14 +117,15 @@ public:
XMLDouble(const XMLCh* const strValue);
~XMLDouble();
-
+
/**
* Compares this object to the specified object.
* The result is <code>true</code> if and only if the argument is not
* <code>null</code> and is an <code>XMLDouble</code> object that contains
* the same <code>int</code> value as this object.
*
- * @param obj the object to compare with.
+ * @param lValue the object to compare with.
+ * @param rValue the object to compare against.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
*/
@@ -132,7 +136,7 @@ public:
// -----------------------------------------------------------------------
// Notification that lazy data has been deleted
// -----------------------------------------------------------------------
- static void reinitXMLDouble();
+ static void reinitXMLDouble();
protected:
diff --git a/src/xercesc/util/XMLFloat.hpp b/src/xercesc/util/XMLFloat.hpp
index 1edda16264f6d8277fff9afc2f4b606219f1d1d5..52c7cd62fdca6e7bd329ee5d6f5861aabfdbec07 100644
--- a/src/xercesc/util/XMLFloat.hpp
+++ b/src/xercesc/util/XMLFloat.hpp
@@ -57,8 +57,11 @@
/*
* $Id$
* $Log$
- * Revision 1.1 2002/02/01 22:22:15 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:15 peiyongz
+ * sane_include
*
* Revision 1.9 2001/11/28 15:39:26 peiyongz
* return Type& for operator=
@@ -100,8 +103,8 @@ public:
* Constructs a newly allocated <code>XMLFloat</code> object that
* represents the value represented by the string.
*
- * @param the <code>String</code> to be converted to an
- * <code>XMLFloat</code>.
+ * @param strValue the <code>String</code> to be converted to an
+ * <code>XMLFloat</code>.
* @exception NumberFormatException if the <code>String</code> does not
* contain a parsable XMLFloat.
*/
@@ -109,14 +112,14 @@ public:
XMLFloat(const XMLCh* const strValue);
~XMLFloat();
-
+
/**
- * Compares this object to the specified object.
+ * Compares the two specified XMLFloat objects.
* The result is <code>true</code> if and only if the argument is not
- * <code>null</code> and is an <code>XMLFloat</code> object that contains
- * the same <code>int</code> value as this object.
+ * <code>null</code> and that contains the same <code>int</code> value.
*
- * @param obj the object to compare with.
+ * @param lValue the object to compare with.
+ * @param rValue the object to compare against.
* @return <code>true</code> if the objects are the same;
* <code>false</code> otherwise.
*/
@@ -127,7 +130,7 @@ public:
// -----------------------------------------------------------------------
// Notification that lazy data has been deleted
// -----------------------------------------------------------------------
- static void reinitXMLFloat();
+ static void reinitXMLFloat();
protected:
diff --git a/src/xercesc/util/XMLNetAccessor.hpp b/src/xercesc/util/XMLNetAccessor.hpp
index 50fb3b75bbaab7b5abefd7e949578c321a544e0c..7777db59e7d700dedd3892a39ded54b7c82f2553 100644
--- a/src/xercesc/util/XMLNetAccessor.hpp
+++ b/src/xercesc/util/XMLNetAccessor.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -69,9 +69,6 @@
class BinInputStream;
-MakeXMLException(NetAccessorException, XMLUTIL_EXPORT)
-
-
//
// This class is an abstract interface via which the URL class accesses
@@ -125,4 +122,7 @@ private :
void operator=(const XMLNetAccessor&);
};
+MakeXMLException(NetAccessorException, XMLUTIL_EXPORT)
+
+
#endif
diff --git a/src/xercesc/util/XMLString.hpp b/src/xercesc/util/XMLString.hpp
index e5f87cf2054428d6f204bc3abaf3bc23411e0fde..ce9c61bbe17db037df1f36e561923ca656c9cf4f 100644
--- a/src/xercesc/util/XMLString.hpp
+++ b/src/xercesc/util/XMLString.hpp
@@ -56,8 +56,11 @@
/*
* $Log$
- * Revision 1.1 2002/02/01 22:22:16 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:16 peiyongz
+ * sane_include
*
* Revision 1.26 2001/08/10 16:23:06 peiyongz
* isHex(), isAlphaNum(), isAllWhiteSpace() and patternMatch() Added
@@ -588,22 +591,22 @@ public:
* A substring of <code>str1</code> is compared to a substring of
* <code>str2</code>. The result is true if these substrings represent
* identical character sequences. The substring of <code>str1</code>
- * to be compared begins at offset1 and has length charsCount. The
+ * to be compared begins at offset1 and has length charCount. The
* substring of <code>str2</code> to be compared begins at offset2 and
- * has length charsCount. The result is false if and only if at least
+ * has length charCount. The result is false if and only if at least
* one of the following is true:
* offset1 is negative.
* offset2 is negative.
- * offset1+charsCount is greater than the length of str1.
- * offset2+charsCount is greater than the length of str2.
- * There is some nonnegative integer k less than charsCount such that:
+ * offset1+charCount is greater than the length of str1.
+ * offset2+charCount is greater than the length of str2.
+ * There is some nonnegative integer k less than charCount such that:
* str1.charAt(offset1+k) != str2.charAt(offset2+k)
*
* @param str1 Null-terminated string to compare
* @param offset1 Starting offset of str1
* @param str2 Null-terminated string to compare
* @param offset2 Starting offset of str2
- * @param charsCount The number of characters to compare
+ * @param charCount The number of characters to compare
* @return true if the specified subregion of <code>str1</code> exactly
* matches the specified subregion of <code>str2></code>; false
* otherwise.
@@ -624,22 +627,22 @@ public:
* A substring of <code>str1</code> is compared to a substring of
* <code>str2</code>. The result is true if these substrings represent
* identical character sequences. The substring of <code>str1</code>
- * to be compared begins at offset1 and has length charsCount. The
+ * to be compared begins at offset1 and has length charCount. The
* substring of <code>str2</code> to be compared begins at offset2 and
- * has length charsCount. The result is false if and only if at least
+ * has length charCount. The result is false if and only if at least
* one of the following is true:
* offset1 is negative.
* offset2 is negative.
- * offset1+charsCount is greater than the length of str1.
- * offset2+charsCount is greater than the length of str2.
- * There is some nonnegative integer k less than charsCount such that:
+ * offset1+charCount is greater than the length of str1.
+ * offset2+charCount is greater than the length of str2.
+ * There is some nonnegative integer k less than charCount such that:
* str1.charAt(offset1+k) != str2.charAt(offset2+k)
*
* @param str1 Null-terminated string to compare
* @param offset1 Starting offset of str1
* @param str2 Null-terminated string to compare
* @param offset2 Starting offset of str2
- * @param charsCount The number of characters to compare
+ * @param charCount The number of characters to compare
* @return true if the specified subregion of <code>str1</code> exactly
* matches the specified subregion of <code>str2></code>; false
* otherwise.
@@ -718,7 +721,7 @@ public:
*/
static unsigned int hash
(
- const char* const tohash
+ const char* const toHash
, const unsigned int hashModulus
);
@@ -779,7 +782,7 @@ public:
* starting from a given index
*
* @param toSearch The string to search
- * @param chToFInd The character to search within the string
+ * @param chToFind The character to search within the string
* @param fromIndex The index to start earch from
* @return If found, returns the index of the character within the string,
* else returns -1.
@@ -796,7 +799,7 @@ public:
* starting from a given index
*
* @param toSearch The string to search
- * @param chToFInd The character to search within the string
+ * @param chToFind The character to search within the string
* @param fromIndex The index to start search from
* @return If found, returns the index of the character within the string,
* else returns -1.
@@ -833,7 +836,7 @@ public:
* starting backward from a given index
*
* @param toSearch The string to search
- * @param chToFInd The character to search within the string
+ * @param chToFind The character to search within the string
* @param fromIndex The index to start backward search from
* @return If found, returns the index of the character within the string,
* else returns -1.
@@ -850,7 +853,7 @@ public:
* starting backward from a given index
*
* @param toSearch The string to search
- * @param chToFInd The character to search within the string
+ * @param ch The character to search within the string
* @param fromIndex The index to start backward search from
* @return If found, returns the index of the character within the string,
* else returns -1.
@@ -995,7 +998,7 @@ public:
static bool endsWith
(
const XMLCh* const toTest
- , const XMLCh* const prefix
+ , const XMLCh* const suffix
);
@@ -1066,18 +1069,18 @@ public:
* @param name The string to check its EncName validity
* @return Returns true if name is EncName valid, otherwise false
*/
- static bool isValidEncName(const XMLCh* const name);
+ static bool isValidEncName(const XMLCh* const name);
/**
* Checks whether an name is a valid QName.
* @param name The string to check its QName validity
* @return Returns true if name is QName valid, otherwise false
*/
- static bool isValidQName(const XMLCh* const name);
+ static bool isValidQName(const XMLCh* const name);
/**
* Checks whether a character is within [a-zA-Z].
- * @param theChar: the character to check
+ * @param theChar the character to check
* @return Returns true if within the range, otherwise false
*/
@@ -1085,28 +1088,28 @@ public:
/**
* Checks whether a character is within [0-9].
- * @param theChar: the character to check
+ * @param theChar the character to check
* @return Returns true if within the range, otherwise false
*/
static bool isDigit(XMLCh const theChar);
/**
* Checks whether a character is within [0-9a-zA-Z].
- * @param theChar: the character to check
+ * @param theChar the character to check
* @return Returns true if within the range, otherwise false
*/
static bool isAlphaNum(XMLCh const theChar);
/**
* Checks whether a character is within [0-9a-fA-F].
- * @param theChar: the character to check
+ * @param theChar the character to check
* @return Returns true if within the range, otherwise false
*/
static bool isHex(XMLCh const theChar);
/**
* Checks whether a string contains only whitespace.
- * @param toCheck: the string to check
+ * @param toCheck the string to check
* @return Returns true if it is, otherwise false
*/
static bool isAllWhiteSpace(const XMLCh* const toCheck);
@@ -1118,8 +1121,8 @@ public:
/** Cut leading chars from a string
*
- * @param toCut The string to cut chars from
- * @param count The count of leading chars to cut
+ * @param toCutFrom The string to cut chars from
+ * @param count The count of leading chars to cut
*/
static void cut
(
@@ -1211,7 +1214,7 @@ public:
/** Break a string into tokens with space as delimiter, and
* stored in a string vector. The caller owns the string vector
* that is returned, and is responsible for deleting it.
- * @param tokenizeStr String to be tokenized
+ * @param tokenizeSrc String to be tokenized
* @return a vector of all the tokenized string
*/
static RefVectorOf<XMLCh>* tokenizeString(const XMLCh* const tokenizeSrc);
@@ -1289,7 +1292,7 @@ public:
static bool isWSCollapsed(const XMLCh* const toCheck);
/** Replace whitespace
- * @param toCheck The string which needs to be whitespace replaced.
+ * @param toConvert The string which needs to be whitespace replaced.
* On return , this buffer also holds the converted string
*/
static void replaceWS(XMLCh* const toConvert);
@@ -1297,7 +1300,7 @@ public:
/** Collapse whitespace
* @param toConvert The string which needs to be whitespace collapsed.
* On return , this buffer also holds the converted string
- */
+ */
static void collapseWS(XMLCh* const toConvert);
//@}
@@ -1326,7 +1329,7 @@ private :
*/
static bool validateRegion(const XMLCh* const str1, const int offset1,
const XMLCh* const str2, const int offset2,
- const unsigned int charsCount);
+ const unsigned int charCount);
friend class XMLPlatformUtils;
};
@@ -1405,12 +1408,12 @@ inline bool XMLString::validateRegion(const XMLCh* const str1,
const int offset1,
const XMLCh* const str2,
const int offset2,
- const unsigned int charsCount)
+ const unsigned int charCount)
{
if (offset1 < 0 || offset2 < 0 ||
- (offset1 + charsCount) > XMLString::stringLen(str1) ||
- (offset2 + charsCount) > XMLString::stringLen(str2) )
+ (offset1 + charCount) > XMLString::stringLen(str1) ||
+ (offset2 + charCount) > XMLString::stringLen(str2) )
return false;
return true;
diff --git a/src/xercesc/util/XMLURL.hpp b/src/xercesc/util/XMLURL.hpp
index ebdbe95b8d03d37bfdcf731daf983ea54c036ab3..161455b42e2e8d35e99f762f7f919bef11d5d2cd 100644
--- a/src/xercesc/util/XMLURL.hpp
+++ b/src/xercesc/util/XMLURL.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -66,9 +66,6 @@
class BinInputStream;
-MakeXMLException(MalformedURLException, XMLUTIL_EXPORT)
-
-
//
// This class supports file, http, and ftp style URLs. All others are
// rejected
@@ -305,4 +302,7 @@ inline const XMLCh* XMLURL::getURLText() const
return fURLText;
}
+MakeXMLException(MalformedURLException, XMLUTIL_EXPORT)
+
+
#endif
diff --git a/src/xercesc/util/XMLUri.hpp b/src/xercesc/util/XMLUri.hpp
index c1cada8b5d304d71df117b0cdbaeb7ed6b8cb08c..a81f9b39e1612f5e3a3690c509f6791399c12553 100644
--- a/src/xercesc/util/XMLUri.hpp
+++ b/src/xercesc/util/XMLUri.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -57,8 +57,11 @@
/*
* $Id$
* $Log$
- * Revision 1.1 2002/02/01 22:22:17 peiyongz
- * Initial revision
+ * Revision 1.2 2002/02/20 18:17:02 tng
+ * [Bug 5977] Warnings on generating apiDocs.
+ *
+ * Revision 1.1.1.1 2002/02/01 22:22:17 peiyongz
+ * sane_include
*
* Revision 1.3 2001/08/29 19:03:03 peiyongz
* Bugzilla# 2816:on AIX 4.2, xlC 3 r ev.1, Compilation error on inline method
@@ -81,10 +84,10 @@
#include <xercesc/util/XMLString.hpp>
/*
- * This class is a direct port of Java's URI class, to distinguish
- * itself from the XMLURL, we use the name XMLUri instead of
+ * This class is a direct port of Java's URI class, to distinguish
+ * itself from the XMLURL, we use the name XMLUri instead of
* XMLURI.
- *
+ *
* TODO: how to relate XMLUri and XMLURL since URL is part of URI.
*
*/
@@ -98,23 +101,23 @@ public:
// -----------------------------------------------------------------------
/**
- * Construct a new URI from a URI specification string.
- *
+ * Construct a new URI from a URI specification string.
+ *
* If the specification follows the "generic URI" syntax, (two slashes
* following the first colon), the specification will be parsed
- * accordingly - setting the
- * scheme,
- * userinfo,
+ * accordingly - setting the
+ * scheme,
+ * userinfo,
* host,
- * port,
- * path,
- * querystring and
- * fragment
- * fields as necessary.
- *
- * If the specification does not follow the "generic URI" syntax,
- * the specification is parsed into a
- * scheme and
+ * port,
+ * path,
+ * querystring and
+ * fragment
+ * fields as necessary.
+ *
+ * If the specification does not follow the "generic URI" syntax,
+ * the specification is parsed into a
+ * scheme and
* scheme-specific part (stored as the path) only.
*
* @param uriSpec the URI specification string (cannot be null or empty)
@@ -128,10 +131,10 @@ public:
* Construct a new URI from a base URI and a URI specification string.
* The URI specification string may be a relative URI.
*
- * @param base the base URI (cannot be null if uriSpec is null or
- * empty)
+ * @param baseURI the base URI (cannot be null if uriSpec is null or
+ * empty)
* @param uriSpec the URI specification string (cannot be null or
- * empty if base is null)
+ * empty if base is null)
*
* ctor# 7 relative ctor
*
@@ -156,7 +159,7 @@ public:
* @return the scheme for this URI
*/
const XMLCh* getScheme() const;
-
+
/**
* Get the userinfo for this URI.
*
@@ -208,7 +211,7 @@ public:
// -----------------------------------------------------------------------
// Setter methods
// -----------------------------------------------------------------------
-
+
/**
* Set the scheme for this URI. The scheme is converted to lowercase
* before it is set.
@@ -222,7 +225,7 @@ public:
* Set the userinfo for this URI. If a non-null value is passed in and
* the host value is null, then an exception is thrown.
*
- * @param newUserinfo the userinfo for this URI
+ * @param newUserInfo the userinfo for this URI
*
*/
void setUserInfo(const XMLCh* const newUserInfo);
@@ -246,19 +249,19 @@ public:
*
*/
void setPort(int newPort);
-
+
/**
- * Set the path for this URI.
+ * Set the path for this URI.
*
* If the supplied path is null, then the
- * query string and fragment are set to null as well.
+ * query string and fragment are set to null as well.
*
- * If the supplied path includes a query string and/or fragment,
- * these fields will be parsed and set as well.
+ * If the supplied path includes a query string and/or fragment,
+ * these fields will be parsed and set as well.
*
* Note:
*
- * For URIs following the "generic URI" syntax, the path
+ * For URIs following the "generic URI" syntax, the path
* specified should start with a slash.
*
* For URIs that do not follow the generic URI syntax, this method
@@ -284,7 +287,7 @@ public:
* if this is a URI conforming to the generic URI syntax and
* the path value is not null.
*
- * @param fragment the fragment for this URI
+ * @param newFragment the fragment for this URI
*
*/
void setFragment(const XMLCh* const newFragment);
@@ -303,7 +306,7 @@ private:
/**
* Unimplemented copy ctor
*/
- XMLUri(const XMLUri& toCopy);
+ XMLUri(const XMLUri& toCopy);
XMLUri& operator=(const XMLUri& toAssign);
// -----------------------------------------------------------------------
@@ -351,13 +354,13 @@ private:
/**
* Determine whether a string is syntactically capable of representing
- * a valid IPv4 address or the domain name of a network host.
+ * a valid IPv4 address or the domain name of a network host.
*
- * A valid IPv4 address consists of four decimal digit groups
- * separated by a '.'.
+ * A valid IPv4 address consists of four decimal digit groups
+ * separated by a '.'.
*
- * A hostname consists of domain labels (each of which must begin and
- * end with an alphanumeric but may contain '-') separated by a '.'.
+ * A hostname consists of domain labels (each of which must begin and
+ * end with an alphanumeric but may contain '-') separated by a '.'.
* See RFC 2396 Section 3.2.2.
*
* @return true if the string is a syntactically valid IPv4 address
@@ -409,7 +412,7 @@ private:
*
*/
void initializeScheme(const XMLCh* const uriSpec);
-
+
/**
* Initialize the authority (userinfo, host and port) for this
* URI from a URI string spec.
@@ -430,7 +433,7 @@ private:
// -----------------------------------------------------------------------
// Data members
//
- // for all the data member, we own it,
+ // for all the data member, we own it,
// responsible for the creation and/or deletion for
// the memory allocated.
//
@@ -443,7 +446,7 @@ private:
XMLCh* fPath;
XMLCh* fQueryString;
XMLCh* fFragment;
-
+
};
// ---------------------------------------------------------------------------
@@ -475,7 +478,7 @@ inline XMLUri::XMLUri(const XMLUri* const baseURI
,fFragment(0)
{
initialize(baseURI, uriSpec);
-}
+}
// ---------------------------------------------------------------------------
// XMLUri: Getter methods
@@ -521,12 +524,12 @@ inline const XMLCh* XMLUri::getFragment() const
inline bool XMLUri::isReservedCharacter(const XMLCh theChar)
{
return (XMLString::indexOf(RESERVED_CHARACTERS, theChar) != -1);
-}
+}
inline bool XMLUri::isUnreservedCharacter(const XMLCh theChar)
{
return (XMLString::isAlphaNum(theChar) ||
XMLString::indexOf(MARK_CHARACTERS, theChar) != -1);
-}
+}
#endif