activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject svn commit: r776070 - in /activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang: ./ exceptions/
Date Mon, 18 May 2009 20:03:02 GMT
Author: tabish
Date: Mon May 18 20:03:01 2009
New Revision: 776070

URL: http://svn.apache.org/viewvc?rev=776070&view=rev
Log:
More Doxygen comment cleanup.

Modified:
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Boolean.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Byte.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Exception.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Float.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Integer.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Long.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Math.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Pointer.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Runtime.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Short.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/ClassCastException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalArgumentException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalMonitorStateException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalStateException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IndexOutOfBoundsException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InterruptedException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InvalidStateException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NoSuchElementException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NullPointerException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NumberFormatException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/RuntimeException.h
    activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/UnsupportedOperationException.h

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Boolean.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Boolean.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Boolean.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Boolean.h Mon May 18 20:03:01 2009
@@ -137,26 +137,36 @@
     public:  // Statics
 
         /**
+         * @param value
+         *      The bool value to convert to a <code>Boolean</code> instance.
+         *
          * @returns a Boolean instance of the primitive boolean value
          */
         static Boolean valueOf( bool value );
 
         /**
+         * @param value
+         *      The std::string value to convert to a <code>Boolean</code> instance.
+         *
          * @returns a Boolean instance of the string value
          */
         static Boolean valueOf( const std::string& value );
 
         /**
          * Parses the String passed and extracts an bool.
-         * @param String to parse
+         *
+         * @param value
+         *      The std::string value to parse
          * @return bool value
          */
         static bool parseBoolean( const std::string& value );
 
         /**
-         * Converts the bool to a String representation
-         * @param bool to convert
-         * @return string representation
+         * Converts the bool to a String representation.
+         *
+         * @param value The bool value to convert.
+         *
+         * @return std::string representation of the bool value passed.
          */
         static std::string toString( bool value );
 

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Byte.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Byte.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Byte.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Byte.h Mon May 18 20:03:01 2009
@@ -219,7 +219,7 @@
          * the second argument. The characters in the string must all be digits,
          * of the specified radix (as determined by whether
          * Character.digit(char, int) returns a nonnegative value) except that the
-         * first character may be an ASCII minus sign '-'  ('\u002D') to indicate
+         * first character may be an ASCII minus sign '-' to indicate
          * a negative value. The resulting byte value is returned.
          *
          * An exception of type NumberFormatException is thrown if any of the
@@ -245,7 +245,7 @@
         /**
          * Parses the string argument as a signed decimal unsigned char. The
          * characters in the string must all be decimal digits, except that the
-         * first character may be an ASCII minus sign '-' ('\u002D') to indicate a
+         * first character may be an ASCII minus sign '-' to indicate a
          * negative value. The resulting unsigned char value is returned, exactly as
          * if the argument and the radix 10 were given as arguments to the
          * parseByte( const std::string, int ) method.
@@ -259,7 +259,7 @@
         /**
          * Returns a Character instance representing the specified char value.
          * @param value - the primitive char to wrap.
-         * @returns a new Charactor instance that wraps this value.
+         * @returns a new Character instance that wraps this value.
          */
         static Byte valueOf( unsigned char value ) {
             return Byte( value );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Exception.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Exception.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Exception.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Exception.h Mon May 18 20:03:01 2009
@@ -60,13 +60,18 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The <code>Exception</code> instance to copy.
          */
         Exception( const Exception& ex ) throw();
 
         /**
          * Constructor
-         * @param cause Pointer to the exception that caused this one to
-         * be thrown, the object is cloned caller retains ownership.
+         *
+         * @param cause
+         *      Pointer to the exception that caused this one to
+         *      be thrown, the object is cloned caller retains ownership.
          */
         Exception( const std::exception* cause ) throw();
 
@@ -74,10 +79,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         Exception( const char* file, const int lineNumber,
                    const char* msg, ... ) throw();
@@ -86,11 +91,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         Exception( const char* file, const int lineNumber,
                    const std::exception* cause,
@@ -137,7 +142,7 @@
         /**
          * Sets the cause for this exception.
          * @param msg the format string for the msg.
-         * @param variable - params to format into the string
+         * @param ... params to format into the string
          */
         virtual void setMessage( const char* msg, ... );
 
@@ -184,7 +189,7 @@
 
         /**
          * Assignment operator.
-         * @param const reference to another Exception
+         * @param ex const reference to another Exception
          */
         virtual Exception& operator =( const Exception& ex );
 

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Float.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Float.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Float.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Float.h Mon May 18 20:03:01 2009
@@ -51,23 +51,23 @@
         /** Constant for Positive Infinity */
         static const float POSITIVE_INFINITY;
 
-        /** Constant for Negative Infinitiy */
+        /** Constant for Negative Infinity */
         static const float NEGATIVE_INFINITY;
 
     public:
 
         /**
-         * @param value - the primitve type to wrap
+         * @param value - the primitive type to wrap
          */
         Float( float value );
 
         /**
-         * @param value - the primitve type to wrap
+         * @param value - the primitive type to wrap
          */
         Float( double value );
 
         /**
-         * @param value - the string to convert to a primitve type to wrap
+         * @param value - the string to convert to a primitive type to wrap
          */
         Float( const std::string& value ) throw( exceptions::NumberFormatException );
 
@@ -78,7 +78,7 @@
          * @param f - the Float instance to be compared
          * @return zero if this object represents the same integer value as the
          * argument; a positive value if this object represents a value greater
-         * than the passed in value, and -1 if this object repesents a value
+         * than the passed in value, and -1 if this object represents a value
          * less than the passed in value.
          */
         virtual int compareTo( const Float& f ) const;
@@ -268,7 +268,8 @@
          * In all cases, the result is an integer that, when given to the
          * intBitsToFloat(int) method, will produce a floating-point value the same
          * as the argument to floatToRawIntBits.
-         * @param the float to convert to a raw int
+         * @param value
+         *      The float to convert to a raw int.
          * @returns the raw int value of the float
          */
         static int floatToRawIntBits( float value );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Integer.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Integer.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Integer.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Integer.h Mon May 18 20:03:01 2009
@@ -49,12 +49,14 @@
     public:
 
         /**
-         * @param the primitive value to wrap
+         * @param value
+         *      The primitive value to wrap in an <code>Integer</code> instance.
          */
         Integer( int value );
 
         /**
-         * @param the base 10 encoded string to decode to sn int and wrap.
+         * @param value
+         *      The base 10 encoded string to decode to an <code>Integer</code> and wrap.
          * @throws NumberFormatException
          */
         Integer( const std::string& value ) throw( exceptions::NumberFormatException );
@@ -66,7 +68,7 @@
          * @param i - the Integer instance to be compared
          * @return zero if this object represents the same integer value as the
          * argument; a positive value if this object represents a value greater
-         * than the passed in value, and -1 if this object repesents a value
+         * than the passed in value, and -1 if this object represents a value
          * less than the passed in value.
          */
         virtual int compareTo( const Integer& i ) const;
@@ -103,7 +105,7 @@
          * @param i - the Integer instance to be compared
          * @return zero if this object represents the same integer value as the
          * argument; a positive value if this object represents a value greater
-         * than the passed in value, and -1 if this object repesents a value
+         * than the passed in value, and -1 if this object represents a value
          * less than the passed in value.
          */
         virtual int compareTo( const int& i ) const;
@@ -136,7 +138,7 @@
         }
 
         /**
-         * @returns this Interger Object as a String Representation
+         * @returns this <code>Integer</code> Object as a String Representation
          */
         std::string toString() const;
 
@@ -238,8 +240,8 @@
          *  * The radix is either smaller than Character.MIN_RADIX or larger than
          *    Character.MAX_RADIX.
          *  * Any character of the string is not a digit of the specified radix,
-         *    except that the first character may be a minus sign '-' ('\u002D')
-         *    provided that the string is longer than length 1.
+         *    except that the first character may be a minus sign '-' provided
+         *    that the string is longer than length 1.
          *  * The value represented by the string is not a value of type int.
          *
          * @param s - the String containing the int representation to be parsed
@@ -253,7 +255,7 @@
         /**
          * Parses the string argument as a signed decimal int. The characters
          * in the string must all be decimal digits, except that the first
-         * character may be an ASCII minus sign '-' ('\u002D') to indicate a
+         * character may be an ASCII minus sign '-' to indicate a
          * negative value. The resulting int value is returned, exactly as if
          * the argument and the radix 10 were given as arguments to the
          * parseInteger( const std::string, int ) method.
@@ -307,13 +309,14 @@
          * referred to as the population count.
          * @param value - the int to count
          * @return the number of one-bits in the two's complement binary
-         * representation of the specified int value.
+         *         representation of the specified int value.
          */
         static int bitCount( int value );
 
         /**
          * Converts the int to a String representation
-         * @param int to convert
+         * @param value
+         *      The int to convert to a <code>std::string</code> instance.
          * @return string representation
          */
         static std::string toString( int value );
@@ -387,15 +390,17 @@
         /**
          * Returns a string representation of the integer argument as an unsigned
          * integer in base 2.
-         *
+         * <p>
          * The unsigned integer value is the argument plus 2^32 if the argument is
          * negative; otherwise it is equal to the argument. This value is converted
          * to a string of ASCII digits in binary (base 2) with no extra leading 0s.
          * If the unsigned magnitude is zero, it is represented by a single zero
-         * character '0' ('\u0030'); otherwise, the first character of the
-         * representation of the unsigned magnitude will not be the zero character.
-         * The characters '0' ('\u0030') and '1' ('\u0031') are used as binary
+         * character '0'; otherwise, the first character of the representation
+         * of the unsigned magnitude will not be the zero character.
+         * <p>
+         * The characters '0' and '1' are used as binary
          * digits.
+         *
          * @param value - the int to be translated to a binary string
          * @returns the unsigned int value as a binary string
          */

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Long.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Long.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Long.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Long.h Mon May 18 20:03:01 2009
@@ -54,7 +54,7 @@
 
         /**
          * @param value - the long long formated string to wrap
-         * @thorw NumberFormatException
+         * @throw NumberFormatException
          */
         Long( const std::string& value ) throw( exceptions::NumberFormatException );
 
@@ -368,7 +368,7 @@
 
         /**
          * Converts the long to a String representation
-         * @param long to convert
+         * @param value The long to convert to a std::string.
          * @return string representation
          */
         static std::string toString( long long value );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Math.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Math.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Math.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Math.h Mon May 18 20:03:01 2009
@@ -335,9 +335,9 @@
         //static double rint( double value );
 
         /**
-         * Returns the smaller of two <code>short</code> values. That is,
-         * the result the argument closer to the value of
-         * <code>Short::MIN_VALUE</code>.  If the arguments have the same
+         * Returns the smaller of two short values. That is, the result is
+         * the argument closer to the value of
+         * <code>decaf.lang.Short::MIN_VALUE</code>.  If the arguments have the same
          * value, the result is that same value.
          * @param a - an argument.
          * @param b - another argument.
@@ -666,7 +666,7 @@
          *  o If the argument is zero, then the result is a zero with the same sign as
          *    the argument.
          *
-         * @param the value to raise e^x - 1
+         * @param value - the value to raise e^x - 1
          * @returns the value ex - 1.
          */
         //static double expm1( double value );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Pointer.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Pointer.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Pointer.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Pointer.h Mon May 18 20:03:01 2009
@@ -50,7 +50,8 @@
          * Swaps this instance's reference counter with the one given, this allows
          * for copy-and-swap semantics of this object.
          *
-         * @param the value to swap with this one's
+         * @param other
+         *      The value to swap with this one's.
          */
         void swap( AtomicRefCounter& other ) {
             std::swap( this->counter, other.counter );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Runtime.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Runtime.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Runtime.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Runtime.h Mon May 18 20:03:01 2009
@@ -41,7 +41,7 @@
          * to the application at startup.
          *
          * @param argc - The number of args passed
-         * @param args - Array of char* values passed to the Process on start.
+         * @param argv - Array of char* values passed to the Process on start.
          *
          * @throws runtime_error if the library is already initialized or an
          *         error occurs during initialization.

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Short.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Short.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Short.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/Short.h Mon May 18 20:03:01 2009
@@ -224,16 +224,16 @@
          * the second argument. The characters in the string must all be digits,
          * of the specified radix (as determined by whether
          * Character.digit(char, int) returns a nonnegative value) except that the
-         * first character may be an ASCII minus sign '-'  ('\u002D') to indicate
-         * a negative value. The resulting byte value is returned.
-         *
+         * first character may be an ASCII minus sign '-' to indicate a negative
+         * value. The resulting byte value is returned.
+         * <p>
          * An exception of type NumberFormatException is thrown if any of the
          * following situations occurs:
          *  * The first argument is null or is a string of length zero.
          *  * The radix is either smaller than Character.MIN_RADIX or larger than
          *    Character.MAX_RADIX.
          *  * Any character of the string is not a digit of the specified radix,
-         *    except that the first character may be a minus sign '-' ('\u002D')
+         *    except that the first character may be a minus sign '-'
          *    provided that the string is longer than length 1.
          *  * The value represented by the string is not a value of type short.
          *
@@ -248,10 +248,11 @@
         /**
          * Parses the string argument as a signed decimal short. The characters
          * in the string must all be decimal digits, except that the first
-         * character may be an ASCII minus sign '-' ('\u002D') to indicate a
-         * negative value. The resulting short value is returned, exactly as if
-         * the argument and the radix 10 were given as arguments to the
-         * parseShort( const std::string, int ) method.
+         * character may be an ASCII minus sign '-' to indicate a negative value.
+         * The resulting short value is returned, exactly as if the argument and the
+         * radix 10 were given as arguments to the parseShort( const std::string, int )
+         * method.
+         *
          * @param s - String to convert to a short
          * @returns the converted short value
          * @throws NumberFormatException if the string is not a short.

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/ClassCastException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/ClassCastException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/ClassCastException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/ClassCastException.h Mon May 18 20:03:01 2009
@@ -24,10 +24,11 @@
 namespace exceptions{
 
     /*
-     * Thrown when an Dynamic Cast fails
+     * Thrown when an Dynamic Cast fails to convert a Pointer to a specified type.
+     *
+     * @since 1.0
      */
-    class DECAF_API ClassCastException : public Exception
-    {
+    class DECAF_API ClassCastException : public Exception {
     public:
 
         /**
@@ -37,20 +38,23 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         ClassCastException( const Exception& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         ClassCastException( const ClassCastException& ex ) throw()
-            : Exception()
-        {
+            : Exception() {
             *(Exception*)this = ex;
         }
 
@@ -66,10 +70,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         ClassCastException( const char* file, const int lineNumber,
                             const char* msg, ... ) throw()
@@ -87,11 +91,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         ClassCastException( const char* file, const int lineNumber,
                             const std::exception* cause,
@@ -110,14 +114,13 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual ClassCastException* clone() const{
             return new ClassCastException( *this );
         }
 
-        /**
-         * Destructor
-         */
         virtual ~ClassCastException() throw() {}
 
     };

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalArgumentException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalArgumentException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalArgumentException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalArgumentException.h Mon May 18 20:03:01 2009
@@ -25,6 +25,8 @@
 
     /*
      * Thrown when an illegal argument was passed into a method.
+     *
+     * @since 1.0
      */
     class DECAF_API IllegalArgumentException : public Exception
     {
@@ -37,20 +39,23 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         IllegalArgumentException( const Exception& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         IllegalArgumentException( const IllegalArgumentException& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
@@ -66,10 +71,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         IllegalArgumentException(const char* file, const int lineNumber,
             const char* msg, ...) throw()
@@ -88,11 +93,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         IllegalArgumentException( const char* file, const int lineNumber,
                                   const std::exception* cause,
@@ -111,14 +116,13 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual IllegalArgumentException* clone() const{
             return new IllegalArgumentException( *this );
         }
 
-        /**
-         * Destructor
-         */
         virtual ~IllegalArgumentException() throw() {}
 
     };

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalMonitorStateException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalMonitorStateException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalMonitorStateException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalMonitorStateException.h Mon May 18 20:03:01 2009
@@ -26,6 +26,8 @@
     /*
      * Thrown when an error occurs from calling a method from syncronizable
      * and the caller doesn't hold a lock on the object.
+     *
+     * @since 1.0
      */
     class DECAF_API IllegalMonitorStateException : public Exception
     {
@@ -38,7 +40,9 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         IllegalMonitorStateException(const Exception& ex) throw()
         : Exception()
@@ -48,6 +52,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         IllegalMonitorStateException(const IllegalMonitorStateException& ex) throw()
         : Exception()
@@ -59,10 +66,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         IllegalMonitorStateException( const char* file,
                                       const int lineNumber,
@@ -80,11 +87,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         IllegalMonitorStateException( const char* file, const int lineNumber,
                                       const std::exception* cause,
@@ -112,6 +119,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual IllegalMonitorStateException* clone() const{
             return new IllegalMonitorStateException(*this);

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalStateException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalStateException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalStateException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IllegalStateException.h Mon May 18 20:03:01 2009
@@ -26,6 +26,8 @@
     /*
      * Thrown when an error occurs from calling a method from syncronizable
      * and the caller doesn't hold a lock on the object.
+     *
+     * @since 1.0
      */
     class DECAF_API IllegalStateException : public Exception
     {
@@ -38,7 +40,9 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         IllegalStateException(const Exception& ex) throw()
         : Exception()
@@ -48,6 +52,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         IllegalStateException(const IllegalStateException& ex) throw()
         : Exception()
@@ -59,10 +66,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occured.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         IllegalStateException( const char* file,
                                const int lineNumber,
@@ -81,11 +88,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         IllegalStateException( const char* file, const int lineNumber,
                                const std::exception* cause,
@@ -110,6 +117,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual IllegalStateException* clone() const{
             return new IllegalStateException(*this);

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IndexOutOfBoundsException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IndexOutOfBoundsException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IndexOutOfBoundsException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/IndexOutOfBoundsException.h Mon May 18 20:03:01 2009
@@ -25,101 +25,103 @@
 
     /*
      * Thrown when an illegal argument was passed into a method.
+      *
+     * @since 1.0
      */
-    class DECAF_API IndexOutOfBoundsException : public Exception
-    {
+    class DECAF_API IndexOutOfBoundsException : public Exception {
     public:
 
-      /**
-       * Default Constructor
-       */
-      IndexOutOfBoundsException() throw() {}
-
-      /**
-       * Conversion Constructor from some other Exception
-       * @param An exception that should become this type of Exception
-       */
-      IndexOutOfBoundsException( const Exception& ex ) throw()
-      : Exception()
-      {
-         *(Exception*)this = ex;
-      }
-
-      /**
-       * Copy Constructor
-       */
-      IndexOutOfBoundsException( const IndexOutOfBoundsException& ex ) throw()
-      : Exception()
-      {
-         *(Exception*)this = ex;
-      }
-
-      /**
-       * Constructor - Initializes the file name and line number where
-       * this message occured.  Sets the message to report, using an
-       * optional list of arguments to parse into the message
-       * @param file name where exception occurs
-       * @param line number where the exception occurred.
-       * @param message to report
-       * @param list of primitives that are formatted into the message
-       */
-      IndexOutOfBoundsException(const char* file, const int lineNumber,
-         const char* msg, ...) throw()
-      : Exception()
-      {
-         va_list vargs ;
-         va_start(vargs, msg) ;
-         buildMessage(msg, vargs) ;
-
-         // Set the first mark for this exception.
-         setMark( file, lineNumber );
-      }
-
-      /**
-       * Constructor - Initializes the file name and line number where
-       * this message occurred.  Sets the message to report, using an
-       * optional list of arguments to parse into the message
-       * @param file name where exception occurs
-       * @param line number where the exception occurred.
-       * @param cause The exception that was the cause for this one to be thrown.
-       * @param message to report
-       * @param list of primitives that are formatted into the message
-       */
-      IndexOutOfBoundsException( const char* file, const int lineNumber,
-                                 const std::exception* cause,
-                                 const char* msg, ... ) throw()
-          : Exception( cause ) {
-
-          va_list vargs;
-          va_start( vargs, msg );
-          buildMessage( msg, vargs );
-
-          // Set the first mark for this exception.
-          setMark( file, lineNumber );
-      }
-
-      /**
-       * Constructor
-       * @param cause Pointer to the exception that caused this one to
-       * be thrown, the object is cloned caller retains ownership.
-       */
-      IndexOutOfBoundsException( const std::exception* cause ) throw()
-          : Exception( cause ) {
-      }
-
-      /**
-       * Clones this exception.  This is useful for cases where you need
-       * to preserve the type of the original exception as well as the message.
-       * All subclasses should override.
-       */
-      virtual IndexOutOfBoundsException* clone() const{
-         return new IndexOutOfBoundsException( *this );
-      }
-
-      /**
-       * Destructor
-       */
-      virtual ~IndexOutOfBoundsException() throw() {}
+        /**
+         * Default Constructor
+         */
+        IndexOutOfBoundsException() throw() {}
+
+        /**
+         * Conversion Constructor from some other Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
+         */
+        IndexOutOfBoundsException( const Exception& ex ) throw()
+        : Exception() {
+            *(Exception*)this = ex;
+        }
+
+        /**
+         * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
+         */
+        IndexOutOfBoundsException( const IndexOutOfBoundsException& ex ) throw()
+        : Exception() {
+            *(Exception*)this = ex;
+        }
+
+        /**
+         * Constructor - Initializes the file name and line number where
+         * this message occurred.  Sets the message to report, using an
+         * optional list of arguments to parse into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
+         */
+        IndexOutOfBoundsException( const char* file, const int lineNumber,
+                                   const char* msg, ...) throw()
+                                   : Exception()
+        {
+            va_list vargs ;
+            va_start(vargs, msg) ;
+            buildMessage(msg, vargs) ;
+
+            // Set the first mark for this exception.
+            setMark( file, lineNumber );
+        }
+
+        /**
+         * Constructor - Initializes the file name and line number where
+         * this message occurred.  Sets the message to report, using an
+         * optional list of arguments to parse into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param cause The exception that was the cause for this one to be thrown.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
+         */
+        IndexOutOfBoundsException( const char* file, const int lineNumber,
+                                   const std::exception* cause,
+                                   const char* msg, ... ) throw()
+        : Exception( cause ) {
+
+            va_list vargs;
+            va_start( vargs, msg );
+            buildMessage( msg, vargs );
+
+            // Set the first mark for this exception.
+            setMark( file, lineNumber );
+        }
+
+        /**
+         * Constructor
+         * @param cause Pointer to the exception that caused this one to
+         * be thrown, the object is cloned caller retains ownership.
+         */
+        IndexOutOfBoundsException( const std::exception* cause ) throw()
+        : Exception( cause ) {}
+
+        /**
+         * Clones this exception.  This is useful for cases where you need
+         * to preserve the type of the original exception as well as the message.
+         * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
+         */
+        virtual IndexOutOfBoundsException* clone() const{
+            return new IndexOutOfBoundsException( *this );
+        }
+
+        virtual ~IndexOutOfBoundsException() throw() {}
 
     };
 

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InterruptedException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InterruptedException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InterruptedException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InterruptedException.h Mon May 18 20:03:01 2009
@@ -25,9 +25,10 @@
 
     /*
      * Thrown when an Thread is interrupted during a wait.
+     *
+     * @since 1.0
      */
-    class DECAF_API InterruptedException : public Exception
-    {
+    class DECAF_API InterruptedException : public Exception {
     public:
 
         /**
@@ -37,7 +38,9 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         InterruptedException(const Exception& ex) throw()
         : Exception()
@@ -47,6 +50,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         InterruptedException(const InterruptedException& ex) throw()
         : Exception()
@@ -58,11 +64,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         InterruptedException( const char* file, const int lineNumber,
                               const std::exception* cause,
@@ -91,10 +97,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         InterruptedException( const char* file,
                               const int lineNumber,
@@ -113,6 +119,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual InterruptedException* clone() const{
             return new InterruptedException(*this);

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InvalidStateException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InvalidStateException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InvalidStateException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/InvalidStateException.h Mon May 18 20:03:01 2009
@@ -26,6 +26,8 @@
     /*
      * Thrown when an operation is requested, but the state of the object
      * servicing the request is not correct for that request.
+     *
+     * @since 1.0
      */
     class DECAF_API InvalidStateException : public Exception
     {
@@ -38,7 +40,9 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         InvalidStateException(const Exception& ex) throw()
         : Exception()
@@ -48,6 +52,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         InvalidStateException( const InvalidStateException& ex ) throw()
         : Exception()
@@ -59,11 +66,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         InvalidStateException( const char* file, const int lineNumber,
                                const std::exception* cause,
@@ -91,10 +98,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         InvalidStateException( const char* file,
                                const int lineNumber,
@@ -113,6 +120,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual InvalidStateException* clone() const{
             return new InvalidStateException(*this);

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NoSuchElementException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NoSuchElementException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NoSuchElementException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NoSuchElementException.h Mon May 18 20:03:01 2009
@@ -26,6 +26,8 @@
     /*
      * Thrown from an operation that attempts to access some element that does
      * not exist.
+     *
+     * @since 1.0
      */
     class DECAF_API NoSuchElementException : public Exception
     {
@@ -38,7 +40,9 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         NoSuchElementException( const Exception& ex ) throw()
         : Exception()
@@ -48,6 +52,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         NoSuchElementException( const NoSuchElementException& ex ) throw()
         : Exception()
@@ -59,11 +66,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         NoSuchElementException( const char* file, const int lineNumber,
                                 const std::exception* cause,
@@ -88,10 +95,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occured.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         NoSuchElementException( const char* file,
                                 const int lineNumber,
@@ -110,6 +117,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual NoSuchElementException* clone() const{
             return new NoSuchElementException(*this);

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NullPointerException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NullPointerException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NullPointerException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NullPointerException.h Mon May 18 20:03:01 2009
@@ -26,6 +26,8 @@
 
     /*
      * Thrown when an error occurs that involves a pointer being NULL
+     *
+     * @since 1.0
      */
     class DECAF_API NullPointerException : public Exception
     {
@@ -37,8 +39,10 @@
         NullPointerException() throw() {};
 
         /**
-         * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         * Conversion Constructor from some other Exception.
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         NullPointerException( const Exception& ex ) throw()
         : Exception()
@@ -48,6 +52,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         NullPointerException(const NullPointerException& ex) throw()
         : Exception()
@@ -59,11 +66,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         NullPointerException( const char* file, const int lineNumber,
                               const std::exception* cause,
@@ -88,10 +95,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occured.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         NullPointerException( const char* file,
                               const int lineNumber,
@@ -110,6 +117,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual NullPointerException* clone() const{
             return new NullPointerException( *this );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NumberFormatException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NumberFormatException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NumberFormatException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/NumberFormatException.h Mon May 18 20:03:01 2009
@@ -27,9 +27,10 @@
     /*
      * Thrown when an error occurs that involves a conversion to a Number from
      * a string and the string is not a valid number.
+     *
+     * @since 1.0
      */
-    class NumberFormatException : public Exception
-    {
+    class NumberFormatException : public Exception {
     public:
 
         /**
@@ -39,7 +40,9 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         NumberFormatException( const Exception& ex ) throw()
         : Exception() {
@@ -48,6 +51,9 @@
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         NumberFormatException( const NumberFormatException& ex ) throw()
         : Exception() {
@@ -58,11 +64,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         NumberFormatException( const char* file, const int lineNumber,
                                const std::exception* cause,
@@ -87,10 +93,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occured.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         NumberFormatException( const char* file,
                                const int lineNumber,
@@ -108,6 +114,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual NumberFormatException* clone() const {
             return new NumberFormatException( *this );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/RuntimeException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/RuntimeException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/RuntimeException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/RuntimeException.h Mon May 18 20:03:01 2009
@@ -27,9 +27,10 @@
      * Thrown when an error occurs that involves something in the run time
      * This could be a memory allocation exception or some other generally
      * unrecoverable exception.
+     *
+     * @since 1.0
      */
-    class DECAF_API RuntimeException : public Exception
-    {
+    class DECAF_API RuntimeException : public Exception {
     public:
 
         /**
@@ -39,20 +40,23 @@
 
         /**
          * Conversion Constructor from some other ActiveMQException
-         * @param An exception that should become this type of Exception
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         RuntimeException( const Exception& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
         /**
          * Copy Constructor
+         *
+         * @param ex
+         *      The Exception whose data is to be copied into this one.
          */
         RuntimeException( const RuntimeException& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
@@ -60,11 +64,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         RuntimeException( const char* file, const int lineNumber,
                           const std::exception* cause,
@@ -89,10 +93,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         RuntimeException( const char* file,
                           const int lineNumber,
@@ -111,6 +115,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception that is a copy of this one.
          */
         virtual RuntimeException* clone() const{
             return new RuntimeException( *this );

Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/UnsupportedOperationException.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/UnsupportedOperationException.h?rev=776070&r1=776069&r2=776070&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/UnsupportedOperationException.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/lang/exceptions/UnsupportedOperationException.h Mon May 18 20:03:01 2009
@@ -24,10 +24,12 @@
 namespace exceptions{
 
     /*
-     * Thrown when an unsupported method is called.
+     * Thrown when an unsupported method is called or an operation cannot be performed
+     * because it was not implemented.
+     *
+     * @since 1.0
      */
-    class DECAF_API UnsupportedOperationException : public lang::Exception
-    {
+    class DECAF_API UnsupportedOperationException : public lang::Exception {
     public:
 
         /**
@@ -37,20 +39,19 @@
 
         /**
          * Conversion Constructor from some other Exception
-         * @param An exception that should become this type of Exception
+         * @param ex An exception that should become this type of Exception
          */
         UnsupportedOperationException( const Exception& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
         /**
          * Copy Constructor
+         * @param ex An exception that should become this type of Exception
          */
         UnsupportedOperationException( const UnsupportedOperationException& ex ) throw()
-        : Exception()
-        {
+        : Exception() {
             *(Exception*)this = ex;
         }
 
@@ -58,11 +59,11 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
          * @param cause The exception that was the cause for this one to be thrown.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         UnsupportedOperationException( const char* file, const int lineNumber,
                                const std::exception* cause,
@@ -88,10 +89,10 @@
          * Constructor - Initializes the file name and line number where
          * this message occurred.  Sets the message to report, using an
          * optional list of arguments to parse into the message
-         * @param file name where exception occurs
-         * @param line number where the exception occurred.
-         * @param message to report
-         * @param list of primitives that are formatted into the message
+         * @param file The file name where exception occurs
+         * @param lineNumber The line number where the exception occurred.
+         * @param msg The message to report
+         * @param ... list of primitives that are formatted into the message
          */
         UnsupportedOperationException( const char* file,
                                        const int lineNumber,
@@ -110,6 +111,8 @@
          * Clones this exception.  This is useful for cases where you need
          * to preserve the type of the original exception as well as the message.
          * All subclasses should override.
+         *
+         * @return an new Exception instance that is a copy of this one.
          */
         virtual UnsupportedOperationException* clone() const{
             return new UnsupportedOperationException( *this );



Mime
View raw message