You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ta...@apache.org on 2015/08/06 00:48:15 UTC
[6/9] activemq-cpp git commit: Fix some documentation generation
issues.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Float.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Float.h b/activemq-cpp/src/main/decaf/lang/Float.h
index ca57222..cf9b7d0 100644
--- a/activemq-cpp/src/main/decaf/lang/Float.h
+++ b/activemq-cpp/src/main/decaf/lang/Float.h
@@ -86,7 +86,7 @@ namespace lang {
/**
* @param f - the Float object to compare against.
- * @returns true if the two Float Objects have the same value.
+ * @return true if the two Float Objects have the same value.
*/
bool equals(const Float& f) const {
return this->value == f.value;
@@ -123,7 +123,7 @@ namespace lang {
/**
* @param f - the Float object to compare against.
- * @returns true if the two Float Objects have the same value.
+ * @return true if the two Float Objects have the same value.
*/
bool equals(const float& f) const {
return this->value == f;
@@ -149,7 +149,7 @@ namespace lang {
}
/**
- * @returns this Float Object as a String Representation
+ * @return this Float Object as a String Representation
*/
std::string toString() const;
@@ -202,12 +202,12 @@ namespace lang {
}
/**
- * @returns true if the float is equal to positive infinity.
+ * @return true if the float is equal to positive infinity.
*/
bool isInfinite() const;
/**
- * @returns true if the float is equal to NaN.
+ * @return true if the float is equal to NaN.
*/
bool isNaN() const;
@@ -220,7 +220,7 @@ namespace lang {
* call: Float( f1 ).compareTo( Float( f2) )
* @param f1 - the first double to compare
* @param f2 - the second double to compare
- * @returns the value 0 if d1 is numerically equal to f2; a value less than
+ * @return the value 0 if d1 is numerically equal to f2; a value less than
* 0 if f1 is numerically less than f2; and a value greater than 0 if f1 is
* numerically greater than f2.
*/
@@ -245,7 +245,7 @@ namespace lang {
* same as the argument to floatToIntBits (except all NaN values are
* collapsed to a single "canonical" NaN value).
* @param value - the float to convert to int bits
- * @returns the int that holds the float's value
+ * @return the int that holds the float's value
*/
static int floatToIntBits(float value);
@@ -272,7 +272,7 @@ namespace lang {
* as the argument to floatToRawIntBits.
* @param value
* The float to convert to a raw int.
- * @returns the raw int value of the float
+ * @return the raw int value of the float
*/
static int floatToRawIntBits(float value);
@@ -297,7 +297,7 @@ namespace lang {
/**
* @param value - The float to check.
- * @returns true if the float is equal to infinity.
+ * @return true if the float is equal to infinity.
*/
static bool isInfinite(float value);
@@ -307,7 +307,7 @@ namespace lang {
* @param value
* The float to check.
*
- * @returns true if the float is equal to NaN.
+ * @return true if the float is equal to NaN.
*/
static bool isNaN(float value);
@@ -318,7 +318,7 @@ namespace lang {
* @param value
* The string to parse.
*
- * @returns a float parsed from the string
+ * @return a float parsed from the string
*
* @throw NumberFormatException if an error occurs parsing the String.
*/
@@ -356,7 +356,7 @@ namespace lang {
* there must be at least one nonzero digit in a subnormal significand.
*
* @param value - The float to convert to a string
- * @returns the Hex formatted float string.
+ * @return the Hex formatted float string.
*/
static std::string toHexString(float value);
@@ -392,14 +392,14 @@ namespace lang {
* @param value
* The float to convert to a string
*
- * @returns the formatted float string.
+ * @return the formatted float string.
*/
static std::string toString(float value);
/**
* Returns a Float instance representing the specified float value.
* @param value - float to wrap
- * @returns new Float instance wrapping the primitive value
+ * @return new Float instance wrapping the primitive value
*/
static Float valueOf(float value);
@@ -408,7 +408,7 @@ namespace lang {
* from the string value passed.
*
* @param value - the string to parse
- * @returns a new Float instance wrapping the float parsed from value
+ * @return a new Float instance wrapping the float parsed from value
* @throws NumberFormatException on error.
*/
static Float valueOf(const String& value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Integer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Integer.h b/activemq-cpp/src/main/decaf/lang/Integer.h
index d74c613..6e47fb1 100644
--- a/activemq-cpp/src/main/decaf/lang/Integer.h
+++ b/activemq-cpp/src/main/decaf/lang/Integer.h
@@ -81,7 +81,7 @@ namespace lang{
/**
* @param i - the Integer object to compare against.
- * @returns true if the two Integer Objects have the same value.
+ * @return true if the two Integer Objects have the same value.
*/
bool equals(const Integer& i) const {
return this->value == i.value;
@@ -118,7 +118,7 @@ namespace lang{
/**
* @param i - the Integer object to compare against.
- * @returns true if the two Integer Objects have the same value.
+ * @return true if the two Integer Objects have the same value.
*/
bool equals(const int& i) const {
return this->value == i;
@@ -144,7 +144,7 @@ namespace lang{
}
/**
- * @returns this <code>Integer</code> Object as a String Representation
+ * @return this <code>Integer</code> Object as a String Representation
*/
std::string toString() const;
@@ -211,7 +211,7 @@ namespace lang{
* character of the specified String is the minus sign. No whitespace
* characters are permitted in the string.
* @param value - The string to decode
- * @returns a Integer object containing the decoded value
+ * @return a Integer object containing the decoded value
* @throws NumberFomatException if the string is not formatted correctly.
*/
static Integer decode(const String& value);
@@ -228,7 +228,7 @@ namespace lang{
* Returns the value obtained by reversing the order of the bits in the
* two's complement binary representation of the specified int value.
* @param value - the value whose bits are to be reversed
- * @returns the reversed bits int.
+ * @return the reversed bits int.
*/
static int reverse(int value);
@@ -268,7 +268,7 @@ namespace lang{
* @param s
* String to convert to a int
*
- * @returns the converted int value
+ * @return the converted int value
* @throws NumberFormatException if the string is not a int.
*/
static int parseInt(const String& s);
@@ -350,7 +350,7 @@ namespace lang{
*
* @param value - the int to convert to a string
* @param radix - the radix to format the string in
- * @returns an int formatted to the string value of the radix given.
+ * @return an int formatted to the string value of the radix given.
*/
static std::string toString(int value, int radix);
@@ -371,7 +371,7 @@ namespace lang{
* If uppercase letters are desired, the toUpperCase() method may be called
* on the result:
* @param value - the int to be translated to an Octal string
- * @returns the unsigned int value as a Octal string
+ * @return the unsigned int value as a Octal string
*/
static std::string toHexString(int value);
@@ -391,7 +391,7 @@ namespace lang{
* 01234567
*
* @param value - the int to be translated to an Octal string
- * @returns the unsigned int value as a Octal string
+ * @return the unsigned int value as a Octal string
*/
static std::string toOctalString(int value);
@@ -410,7 +410,7 @@ namespace lang{
* digits.
*
* @param value - the int to be translated to a binary string
- * @returns the unsigned int value as a binary string
+ * @return the unsigned int value as a binary string
*/
static std::string toBinaryString(int value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Iterable.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Iterable.h b/activemq-cpp/src/main/decaf/lang/Iterable.h
index b1e02cc..c259e5a 100644
--- a/activemq-cpp/src/main/decaf/lang/Iterable.h
+++ b/activemq-cpp/src/main/decaf/lang/Iterable.h
@@ -35,7 +35,7 @@ namespace lang {
virtual ~Iterable() {}
/**
- * @returns an iterator over a set of elements of type T.
+ * @return an iterator over a set of elements of type T.
*/
virtual decaf::util::Iterator<E>* iterator() = 0;
virtual decaf::util::Iterator<E>* iterator() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Long.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Long.h b/activemq-cpp/src/main/decaf/lang/Long.h
index b7bdee5..c8f20ee 100644
--- a/activemq-cpp/src/main/decaf/lang/Long.h
+++ b/activemq-cpp/src/main/decaf/lang/Long.h
@@ -79,7 +79,7 @@ namespace lang {
/**
* @param l - the Long object to compare against.
- * @returns true if the two Integer Objects have the same value.
+ * @return true if the two Integer Objects have the same value.
*/
bool equals(const Long& l) const {
return this->value == l.value;
@@ -116,7 +116,7 @@ namespace lang {
/**
* @param l - the Long object to compare against.
- * @returns true if the two Integer Objects have the same value.
+ * @return true if the two Integer Objects have the same value.
*/
bool equals(const long long& l) const {
return this->value == l;
@@ -142,7 +142,7 @@ namespace lang {
}
/**
- * @returns this Long Object as a String Representation
+ * @return this Long Object as a String Representation
*/
std::string toString() const;
@@ -218,7 +218,7 @@ namespace lang {
* character of the specified String is the minus sign. No whitespace
* characters are permitted in the string.
* @param value - The string to decode
- * @returns a Long object containing the decoded value
+ * @return a Long object containing the decoded value
* @throws NumberFomatException if the string is not formatted correctly.
*/
static Long decode(const String& value);
@@ -319,7 +319,7 @@ namespace lang {
* Returns the value obtained by reversing the order of the bits in the
* two's complement binary representation of the specified long long value.
* @param value - the value whose bits are to be reversed
- * @returns the reversed bits long long.
+ * @return the reversed bits long long.
*/
static long long reverse(long long value);
@@ -398,7 +398,7 @@ namespace lang {
*
* @param value - the long long to convert to a string
* @param radix - the radix to format the string in
- * @returns an long long formatted to the string value of the radix given.
+ * @return an long long formatted to the string value of the radix given.
*/
static std::string toString(long long value, int radix);
@@ -419,7 +419,7 @@ namespace lang {
* If uppercase letters are desired, the toUpperCase() method may be called
* on the result:
* @param value - the long long to be translated to an Octal string
- * @returns the unsigned long long value as a Octal string
+ * @return the unsigned long long value as a Octal string
*/
static std::string toHexString(long long value);
@@ -439,7 +439,7 @@ namespace lang {
* 01234567
*
* @param value - the long long to be translated to an Octal string
- * @returns the unsigned long long value as a Octal string
+ * @return the unsigned long long value as a Octal string
*/
static std::string toOctalString(long long value);
@@ -456,7 +456,7 @@ namespace lang {
* The characters '0' and '1' are used as binary
* digits.
* @param value - the long long to be translated to a binary string
- * @returns the unsigned long long value as a binary string
+ * @return the unsigned long long value as a binary string
*/
static std::string toBinaryString(long long value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Math.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Math.h b/activemq-cpp/src/main/decaf/lang/Math.h
index 116420f..5b5a104 100644
--- a/activemq-cpp/src/main/decaf/lang/Math.h
+++ b/activemq-cpp/src/main/decaf/lang/Math.h
@@ -50,7 +50,7 @@ namespace lang{
* negative, the argument is returned. If the argument is negative, the
* negation of the argument is returned.
* @param value - the value to return the abs of
- * @returns the value if positive, otherwise the negative of value
+ * @return the value if positive, otherwise the negative of value
*/
static int abs( int value ) {
return value < 0 ? -value : value;
@@ -61,7 +61,7 @@ namespace lang{
* negative, the argument is returned. If the argument is negative, the
* negation of the argument is returned.
* @param value - the value to return the abs of
- * @returns the value if positive, otherwise the negative of value
+ * @return the value if positive, otherwise the negative of value
*/
static long long abs( long long value ) {
return value < 0 ? -value : value;
@@ -81,7 +81,7 @@ namespace lang{
* Float::intBitsToFloat( 0x7fffffff & Float::floatToIntBits( value ) )
*
* @param value - the value to return the abs of
- * @returns the value if positive, otherwise the negative of value
+ * @return the value if positive, otherwise the negative of value
*/
static float abs( float value );
@@ -100,7 +100,7 @@ namespace lang{
* Double::doubleToLongBits( value ) )
*
* @param value - the value to return the abs of
- * @returns the value if positive, otherwise the negative of value
+ * @return the value if positive, otherwise the negative of value
*/
static double abs( double value );
@@ -112,7 +112,7 @@ namespace lang{
* the result is NaN.
*
* @param value - the value to return the arc cosine of.
- * @returns arc cosine of value in radians.
+ * @return arc cosine of value in radians.
*/
//static double acos( double value );
@@ -126,7 +126,7 @@ namespace lang{
* as the argument.
*
* @param value - the value to return the arc cosine of.
- * @returns arc cosine of value in radians.
+ * @return arc cosine of value in radians.
*/
//static double asin( double value );
@@ -139,7 +139,7 @@ namespace lang{
* as the argument.
*
* @param value - the value to return the arc cosine of.
- * @returns arc tangent of value in radians.
+ * @return arc tangent of value in radians.
*/
//static double atan( double value );
@@ -182,7 +182,7 @@ namespace lang{
*
* @param y - the ordinate coordinate
* @param x - the abscissa coordinate
- * @returns the theta component of the point (r, theta) in polar coordinates
+ * @return the theta component of the point (r, theta) in polar coordinates
* that corresponds to the point (x, y) in Cartesian coordinates.
*/
//static double atan2( double x, double y );
@@ -199,7 +199,7 @@ namespace lang{
* as the argument.
*
* @param value - the double to compute the cube root of
- * @returns the cube root of value
+ * @return the cube root of value
*/
//static double cbrt( double value );
@@ -209,7 +209,7 @@ namespace lang{
* o If the argument is NaN or an infinity, then the result is NaN.
*
* @param value - an value in radians
- * @returns the cosine of the argument.
+ * @return the cosine of the argument.
*/
//static double cos( double value );
@@ -330,7 +330,7 @@ namespace lang{
* zero, then the result is the same as the argument.
*
* @param value - the value to round to the nearest integer
- * @returns the rounded value
+ * @return the rounded value
*/
//static double rint( double value );
@@ -490,7 +490,7 @@ namespace lang{
* is negative infinity.
*
* @param value the value to compute the natural log of.
- * @returns the natural log of value.
+ * @return the natural log of value.
*/
//static double log( double value );
@@ -505,7 +505,7 @@ namespace lang{
* o If the argument is equal to 10n for integer n, then the result is n.
*
* @param value - the value to operate on
- * @returns the long base 10 of value
+ * @return the long base 10 of value
*/
//static double log10( double value );
@@ -524,7 +524,7 @@ namespace lang{
* as the argument.
*
* @param value - the value to operate on
- * @returns the the value ln(x + 1), the natural log of x + 1
+ * @return the the value ln(x + 1), the natural log of x + 1
*/
//static double log1p( double value );
@@ -542,7 +542,7 @@ namespace lang{
*
* Note that the value of Math.ceil(x) is exactly the value of -Math.floor(-x).
* @param value - the value to find the ceiling of
- * @returns the smallest (closest to negative infinity) floating-point value
+ * @return the smallest (closest to negative infinity) floating-point value
* that is greater than or equal to the argument and is equal to a
* mathematical integer.
*/
@@ -559,7 +559,7 @@ namespace lang{
* zero, then the result is the same as the argument.
*
* @param value - the value to find the floor of
- * @returns the largest (closest to positive infinity) floating-point value
+ * @return the largest (closest to positive infinity) floating-point value
* that less than or equal to the argument and is equal to a mathematical
* integer.
*/
@@ -580,7 +580,7 @@ namespace lang{
* Integer::MAX_VALUE.
*
* @param value - the value to round
- * @returns the value of the argument rounded to the nearest integral value.
+ * @return the value of the argument rounded to the nearest integral value.
*/
static int round( float value );
@@ -599,7 +599,7 @@ namespace lang{
* Long::MAX_VALUE.
*
* @param value - the value to round
- * @returns the value of the argument rounded to the nearest integral value.
+ * @return the value of the argument rounded to the nearest integral value.
*/
static long long round( double value );
@@ -637,7 +637,7 @@ namespace lang{
* one thread. However, if many threads need to generate pseudorandom numbers
* at a great rate, it may reduce contention for each thread to have its
* own pseudorandom-number generator.
- * @returns a pseudorandom double greater than or equal to 0.0 and
+ * @return a pseudorandom double greater than or equal to 0.0 and
* less than 1.0.
*/
static double random();
@@ -651,7 +651,7 @@ namespace lang{
* o If the argument is negative infinity, then the result is positive zero.
*
* @param value - the exponent to raise e to
- * @returns the value e^a, where e is the base of the natural logarithms.
+ * @return the value e^a, where e is the base of the natural logarithms.
*/
//static double exp( double value );
@@ -667,7 +667,7 @@ namespace lang{
* the argument.
*
* @param value - the value to raise e^x - 1
- * @returns the value ex - 1.
+ * @return the value ex - 1.
*/
//static double expm1( double value );
@@ -681,7 +681,7 @@ namespace lang{
*
* @param x - an argument
* @param y - another argument
- * @returns the sqrt(x^2 + y^2) without intermediate overflow or underflow
+ * @return the sqrt(x^2 + y^2) without intermediate overflow or underflow
*/
//static double hypot( double x, double y );
@@ -695,7 +695,7 @@ namespace lang{
* the same as the argument.
*
* @param value - the floating-point value whose signum is to be returned
- * @returns the signum function of the argument
+ * @return the signum function of the argument
*/
static float signum( float value );
@@ -709,7 +709,7 @@ namespace lang{
* the same as the argument.
*
* @param value - the floating-point value whose signum is to be returned
- * @returns the signum function of the argument
+ * @return the signum function of the argument
*/
static double signum( double value );
@@ -745,7 +745,7 @@ namespace lang{
* o If the argument is ±Float::MAX_VALUE, then the result is equal to 2^104.
*
* @param value - the floating-point value whose ulp is to be returned
- * @returns the size of an ulp of the argument
+ * @return the size of an ulp of the argument
*/
//static float ulp( float value );
@@ -763,7 +763,7 @@ namespace lang{
* o If the argument is ±Float::MAX_VALUE, then the result is equal to 2^971.
*
* @param value - the floating-point value whose ulp is to be returned
- * @returns the size of an ulp of the argument
+ * @return the size of an ulp of the argument
*/
//static double ulp( double value );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Pointer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Pointer.h b/activemq-cpp/src/main/decaf/lang/Pointer.h
index fc8ae7f..593a649 100644
--- a/activemq-cpp/src/main/decaf/lang/Pointer.h
+++ b/activemq-cpp/src/main/decaf/lang/Pointer.h
@@ -167,7 +167,7 @@ namespace lang {
* is not guaranteed to be safe if the Pointer is held by more than one object or this
* method is called from more than one thread.
*
- * @returns The pointer instance that was held by this Pointer object, the pointer is
+ * @return The pointer instance that was held by this Pointer object, the pointer is
* no longer owned by this Pointer and won't be freed when this Pointer goes
* out of scope.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Runtime.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Runtime.h b/activemq-cpp/src/main/decaf/lang/Runtime.h
index 2994d15..630cd91 100644
--- a/activemq-cpp/src/main/decaf/lang/Runtime.h
+++ b/activemq-cpp/src/main/decaf/lang/Runtime.h
@@ -40,7 +40,7 @@ namespace lang {
/**
* Gets the single instance of the Decaf Runtime for this Process.
*
- * @returns pointer to the single Decaf Runtime instance that exists
+ * @return pointer to the single Decaf Runtime instance that exists
* for this process
*/
static Runtime* getRuntime();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Short.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Short.h b/activemq-cpp/src/main/decaf/lang/Short.h
index d1d050b..f7e9bc8 100644
--- a/activemq-cpp/src/main/decaf/lang/Short.h
+++ b/activemq-cpp/src/main/decaf/lang/Short.h
@@ -75,7 +75,7 @@ namespace lang {
virtual int compareTo(const Short& s) const;
/**
- * @returns true if the two Short Objects have the same value.
+ * @return true if the two Short Objects have the same value.
*/
bool equals(const Short& s) const {
return this->value == s.value;
@@ -111,7 +111,7 @@ namespace lang {
virtual int compareTo(const short& s) const;
/**
- * @returns true if the two Short Objects have the same value.
+ * @return true if the two Short Objects have the same value.
*/
bool equals(const short& s) const {
return this->value == s;
@@ -137,7 +137,7 @@ namespace lang {
}
/**
- * @returns this Short Object as a String Representation
+ * @return this Short Object as a String Representation
*/
std::string toString() const;
@@ -192,7 +192,7 @@ namespace lang {
public:
/**
- * @returns a string representing the primitive value as Base 10
+ * @return a string representing the primitive value as Base 10
*/
static std::string toString(short value);
@@ -208,7 +208,7 @@ namespace lang {
* character of the specified String is the minus sign. No whitespace
* characters are permitted in the string.
* @param value - The string to decode
- * @returns a Short object containing the decoded value
+ * @return a Short object containing the decoded value
* @throws NumberFomatException if the string is not formatted correctly.
*/
static Short decode(const String& value);
@@ -261,7 +261,7 @@ namespace lang {
* @param s
* String to convert to a short
*
- * @returns the converted short value
+ * @return the converted short value
*
* @throws NumberFormatException if the string is not a short.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/String.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/String.h b/activemq-cpp/src/main/decaf/lang/String.h
index 121835c..4432558 100644
--- a/activemq-cpp/src/main/decaf/lang/String.h
+++ b/activemq-cpp/src/main/decaf/lang/String.h
@@ -176,7 +176,7 @@ namespace lang {
* @param other
* The other String to assign to this instance.
*
- * @returns a reference to this string with the new contents.
+ * @return a reference to this string with the new contents.
*/
String& operator= (const String& other);
@@ -188,7 +188,7 @@ namespace lang {
* @param other
* The other std::string to assign to this instance.
*
- * @returns a reference to this string with the new contents.
+ * @return a reference to this string with the new contents.
*/
String& operator= (const std::string& other);
@@ -200,7 +200,7 @@ namespace lang {
* @param other
* The other C string to assign to this instance.
*
- * @returns a reference to this string with the new contents.
+ * @return a reference to this string with the new contents.
*/
String& operator= (const char* other);
@@ -211,7 +211,7 @@ namespace lang {
* @param other
* The string value to compare to this one.
*
- * @returns true if the other string is equal to this one, false otherwise.
+ * @return true if the other string is equal to this one, false otherwise.
*/
bool operator==(const char* other) const;
bool operator==(const String& other) const;
@@ -224,7 +224,7 @@ namespace lang {
* @param other
* The string value to compare to this one.
*
- * @returns true if the other string is not equal to this one, false otherwise.
+ * @return true if the other string is not equal to this one, false otherwise.
*/
bool operator!=(const char* other) const;
bool operator!=(const String& other) const;
@@ -237,7 +237,7 @@ namespace lang {
* @param other
* The string value to compare to this one.
*
- * @returns true if this string is lexicographically less than the other string.
+ * @return true if this string is lexicographically less than the other string.
*/
bool operator< (const char* other) const;
bool operator< (const String& other) const;
@@ -250,7 +250,7 @@ namespace lang {
* @param other
* The string value to compare to this one.
*
- * @returns true if this string is lexicographically less than or equal to the other string.
+ * @return true if this string is lexicographically less than or equal to the other string.
*/
bool operator<=(const char* other) const;
bool operator<=(const String& other) const;
@@ -263,7 +263,7 @@ namespace lang {
* @param other
* The string value to compare to this one.
*
- * @returns true if this string is lexicographically greater than the other string.
+ * @return true if this string is lexicographically greater than the other string.
*/
bool operator> (const char* other) const;
bool operator> (const String& other) const;
@@ -276,7 +276,7 @@ namespace lang {
* @param other
* The string value to compare to this one.
*
- * @returns true if this string is lexicographically greater than the other string.
+ * @return true if this string is lexicographically greater than the other string.
*/
bool operator>=(const char* other) const;
bool operator>=(const String& other) const;
@@ -289,7 +289,7 @@ namespace lang {
* @param other
* The string whose value is to be concatenated with this one.
*
- * @returns a new String instance that is the concatenation of the two strings.
+ * @return a new String instance that is the concatenation of the two strings.
*/
String operator+ (const String& other) const;
String operator+ (const std::string& other) const;
@@ -303,7 +303,7 @@ namespace lang {
* new character array in order to return a pointer value that is guaranteed to
* be NULL terminated.
*
- * @returns a const char* value for this String.
+ * @return a const char* value for this String.
*/
const char* c_str() const;
@@ -319,7 +319,7 @@ namespace lang {
* viewing a small portion of it and the original source String is no longer also
* maintaining a reference to the backing store.
*
- * @returns a new String instance with a compacted backing store.
+ * @return a new String instance with a compacted backing store.
*/
String compact() const;
@@ -515,7 +515,7 @@ namespace lang {
* @param other
* A String instance to compare to this string.
*
- * @returns true if this String is equal to the given String instance.
+ * @return true if this String is equal to the given String instance.
*/
bool equals(const String& other) const;
@@ -525,7 +525,7 @@ namespace lang {
* @param other
* A standard string instance to compare to this String.
*
- * @returns true if this String is equal to the given std::string instance.
+ * @return true if this String is equal to the given std::string instance.
*/
bool equals(const std::string& other) const;
@@ -537,7 +537,7 @@ namespace lang {
* @param other
* A C string instance to compare to this String.
*
- * @returns true if this String is equal to the given C string instance.
+ * @return true if this String is equal to the given C string instance.
*/
bool equals(const char* other) const;
@@ -658,7 +658,7 @@ namespace lang {
* Returns a hash code for this String instance, the hash code for an empty
* String will always be zero.
*
- * @returns a hash code for this String instance.
+ * @return a hash code for this String instance.
*/
int hashCode() const;
@@ -779,7 +779,7 @@ namespace lang {
int indexOf(const char* subString, int start) const;
/**
- * @returns true if the length of this String is zero.
+ * @return true if the length of this String is zero.
*/
bool isEmpty() const;
@@ -1035,7 +1035,7 @@ namespace lang {
/**
* Returns a copy of the string, with leading and trailing whitespace omitted.
*
- * @returns a copy of the string, with leading and trailing whitespace omitted.
+ * @return a copy of the string, with leading and trailing whitespace omitted.
*/
String trim() const;
@@ -1101,7 +1101,7 @@ namespace lang {
* Given a C String pointer return true if the value is either NULL or the
* string contained is empty.
*
- * @returns true if the C string is either a NULL or an Empty string.
+ * @return true if the C string is either a NULL or an Empty string.
*/
static bool isNullOrEmpty(const char*);
@@ -1111,7 +1111,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns "true" if the boolean is true, "false" otherwise.
+ * @return "true" if the boolean is true, "false" otherwise.
*/
static String valueOf(bool value);
@@ -1121,7 +1121,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns a String that contains the single character value given.
+ * @return a String that contains the single character value given.
*/
static String valueOf(char value);
@@ -1131,7 +1131,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns a String that contains the string representation of the float value given.
+ * @return a String that contains the string representation of the float value given.
*/
static String valueOf(float value);
@@ -1141,7 +1141,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns a String that contains the string representation of the double value given.
+ * @return a String that contains the string representation of the double value given.
*/
static String valueOf(double value);
@@ -1151,7 +1151,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns a String that contains the string representation of the short value given.
+ * @return a String that contains the string representation of the short value given.
*/
static String valueOf(short value);
@@ -1161,7 +1161,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns a String that contains the string representation of the integer value given.
+ * @return a String that contains the string representation of the integer value given.
*/
static String valueOf(int value);
@@ -1171,7 +1171,7 @@ namespace lang {
* @param value
* The value whose string representation is to be returned.
*
- * @returns a String that contains the string representation of the 64 bit long value given.
+ * @return a String that contains the string representation of the 64 bit long value given.
*/
static String valueOf(long long value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/StringBuffer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/StringBuffer.h b/activemq-cpp/src/main/decaf/lang/StringBuffer.h
index 639c484..e6be692 100644
--- a/activemq-cpp/src/main/decaf/lang/StringBuffer.h
+++ b/activemq-cpp/src/main/decaf/lang/StringBuffer.h
@@ -140,7 +140,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
template<typename POINTER>
StringBuffer& append(const POINTER* pointer) {
@@ -161,7 +161,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
template<typename TYPE>
StringBuffer& append(const Pointer<TYPE> pointer) {
@@ -181,7 +181,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(bool value);
@@ -191,7 +191,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(char value);
@@ -201,7 +201,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(short value);
@@ -211,7 +211,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(int value);
@@ -221,7 +221,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(long long value);
@@ -231,7 +231,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(float value);
@@ -241,7 +241,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(double value);
@@ -251,7 +251,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(const char* value);
@@ -278,7 +278,7 @@ namespace lang {
* @param value
* The CharSequence value to be appended into this buffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(const CharSequence* value);
@@ -305,7 +305,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(const String& value);
@@ -315,7 +315,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& append(const StringBuilder& value);
@@ -330,7 +330,7 @@ namespace lang {
* @param end
* The ending index (exclusive) to delete from this buffer.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws StringIndexOutOfBoundsException
* if start is negative, greater than length(), or greater than end.
@@ -343,7 +343,7 @@ namespace lang {
* @param index
* The index in this buffer where the character to delete is located.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws StringIndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -359,7 +359,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
template<typename POINTER>
StringBuffer& insert(int index, const POINTER* pointer) {
@@ -382,7 +382,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
template<typename TYPE>
StringBuffer& insert(int index, const Pointer<TYPE> pointer) {
@@ -405,7 +405,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -421,7 +421,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -437,7 +437,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -453,7 +453,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -469,7 +469,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -485,7 +485,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -501,7 +501,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -516,7 +516,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws NullPointerException if the target C string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -532,7 +532,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws NullPointerException if the target C string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -548,7 +548,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws NullPointerException if the target std::string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -570,7 +570,7 @@ namespace lang {
* @param length
* The number of characters to copy from the given C string.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws NullPointerException if the target C string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -590,7 +590,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -612,7 +612,7 @@ namespace lang {
* @param length
* The number of characters to copy from the given CharSequence.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -634,7 +634,7 @@ namespace lang {
* @param value
* The new string value to replace the older value.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*
* @throws IndexOutOfBoundsException if start is negative, greater than end or greater than length().
*/
@@ -643,7 +643,7 @@ namespace lang {
/**
* Reverses the order of characters in this builder.
*
- * @returns a reference to this StringBuffer so that operations can be chained.
+ * @return a reference to this StringBuffer so that operations can be chained.
*/
StringBuffer& reverse();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/StringBuilder.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/StringBuilder.h b/activemq-cpp/src/main/decaf/lang/StringBuilder.h
index d5d9089..0e9c1a8 100644
--- a/activemq-cpp/src/main/decaf/lang/StringBuilder.h
+++ b/activemq-cpp/src/main/decaf/lang/StringBuilder.h
@@ -102,7 +102,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
template<typename POINTER>
StringBuilder& append(const POINTER* pointer) {
@@ -123,7 +123,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
template<typename TYPE>
StringBuilder& append(const Pointer<TYPE> pointer) {
@@ -143,7 +143,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(bool value);
@@ -153,7 +153,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(char value);
@@ -163,7 +163,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(short value);
@@ -173,7 +173,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(int value);
@@ -183,7 +183,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(long long value);
@@ -193,7 +193,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(float value);
@@ -203,7 +203,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(double value);
@@ -213,7 +213,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(const char* value);
@@ -240,7 +240,7 @@ namespace lang {
* @param value
* The CharSequence value to be appended into this buffer.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(const CharSequence* value);
@@ -267,7 +267,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(const String& value);
@@ -277,7 +277,7 @@ namespace lang {
* @param value
* The value to append to the contents of the StringBuilder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& append(const StringBuffer& value);
@@ -292,7 +292,7 @@ namespace lang {
* @param end
* The ending index (exclusive) to delete from this buffer.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws StringIndexOutOfBoundsException
* if start is negative, greater than length(), or greater than end.
@@ -305,7 +305,7 @@ namespace lang {
* @param index
* The index in this buffer where the character to delete is located.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws StringIndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -321,7 +321,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
template<typename POINTER>
StringBuilder& insert(int index, const POINTER* pointer) {
@@ -344,7 +344,7 @@ namespace lang {
* @param pointer
* A pointer to some object that must define a toString method.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
template<typename TYPE>
StringBuilder& insert(int index, const Pointer<TYPE> pointer) {
@@ -367,7 +367,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -383,7 +383,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -399,7 +399,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -415,7 +415,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -431,7 +431,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -447,7 +447,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -463,7 +463,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -478,7 +478,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws NullPointerException if the target C string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -494,7 +494,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws NullPointerException if the target C string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -510,7 +510,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws NullPointerException if the target std::string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -532,7 +532,7 @@ namespace lang {
* @param length
* The number of characters to copy from the given C string.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws NullPointerException if the target C string pointer is NULL.
* @throws IndexOutOfBoundsException
@@ -552,7 +552,7 @@ namespace lang {
* @param value
* The value to insert at the given index.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -574,7 +574,7 @@ namespace lang {
* @param length
* The number of characters to copy from the given CharSequence.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException
* if the index is negative or greater than or equal to length().
@@ -596,7 +596,7 @@ namespace lang {
* @param value
* The new string value to replace the older value.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*
* @throws IndexOutOfBoundsException if start is negative, greater than end or greater than length().
*/
@@ -605,7 +605,7 @@ namespace lang {
/**
* Reverses the order of characters in this builder.
*
- * @returns a reference to this StringBuilder so that operations can be chained.
+ * @return a reference to this StringBuilder so that operations can be chained.
*/
StringBuilder& reverse();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/System.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/System.h b/activemq-cpp/src/main/decaf/lang/System.h
index cdf3430..6567008 100644
--- a/activemq-cpp/src/main/decaf/lang/System.h
+++ b/activemq-cpp/src/main/decaf/lang/System.h
@@ -291,7 +291,7 @@ namespace lang{
* See the description of the class Date for a discussion of slight discrepancies
* that may arise between "computer time" and coordinated universal time (UTC).
*
- * @returns the difference, measured in milliseconds, between the current time
+ * @return the difference, measured in milliseconds, between the current time
* and midnight, January 1, 1970 UTC.
*/
static long long currentTimeMillis();
@@ -315,7 +315,7 @@ namespace lang{
* // ... the code being measured ...
* long long estimatedTime = System::nanoTime() - startTime;
*
- * @returns
+ * @return
* The current value of the system timer, in nanoseconds.
*/
static long long nanoTime();
@@ -338,7 +338,7 @@ namespace lang{
* If the Properties has not yet been created or are not yet initialized then they
* will be on the first call to a Properties accessor.
*
- * @returns a reference to the static system Properties object.
+ * @return a reference to the static system Properties object.
*/
static decaf::util::Properties& getProperties();
@@ -351,7 +351,7 @@ namespace lang{
* @param key
* The key name of the desired system property to retrieve.
*
- * @returns an empty string if the named property is not set, otherwise returns the value.
+ * @return an empty string if the named property is not set, otherwise returns the value.
*
* @throws IllegalArgumentException if key is an empty string.
*/
@@ -368,7 +368,7 @@ namespace lang{
* @param defaultValue
* The default value to return if the key is not set in the System properties.
*
- * @returns the value of the named system property or the defaultValue if the property isn't set..
+ * @return the value of the named system property or the defaultValue if the property isn't set..
*
* @throws IllegalArgumentException if key is an empty string.
*/
@@ -382,7 +382,7 @@ namespace lang{
* @param value
* The value to assign to the key.
*
- * @returns the previous value of the property named by key if there was one, otherwise
+ * @return the previous value of the property named by key if there was one, otherwise
* returns an empty string.
*
* @throws IllegalArgumentException if key is an empty string.
@@ -395,7 +395,7 @@ namespace lang{
* @param key
* The key name of the system property to clear.
*
- * @returns the previous value of the property named by key if there was one, otherwise
+ * @return the previous value of the property named by key if there was one, otherwise
* returns an empty string.
*
* @throws IllegalArgumentException if key is an empty string.
@@ -409,14 +409,14 @@ namespace lang{
* with the values. Caller owns the array. The array is terminated
* by an element that holds the value NULL
*
- * @returns a vector of environment name / value pairs.
+ * @return a vector of environment name / value pairs.
*/
static std::vector< std::string > getEnvArray();
/**
* Gets the one and only APR Pool instance
*
- * @returns a reference to the global APR Pool.
+ * @return a reference to the global APR Pool.
*/
static internal::AprPool& getAprPool();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Thread.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Thread.h b/activemq-cpp/src/main/decaf/lang/Thread.h
index ce36135..e72152e 100644
--- a/activemq-cpp/src/main/decaf/lang/Thread.h
+++ b/activemq-cpp/src/main/decaf/lang/Thread.h
@@ -261,7 +261,7 @@ namespace lang {
/**
* Returns the Thread's assigned name.
- * @returns the Name of the Thread.
+ * @return the Name of the Thread.
*/
std::string getName() const;
@@ -292,7 +292,7 @@ namespace lang {
/**
* Set the handler invoked when this thread abruptly terminates due to an uncaught exception.
*
- * @returns a pointer to the set UncaughtExceptionHandler.
+ * @return a pointer to the set UncaughtExceptionHandler.
*/
UncaughtExceptionHandler* getUncaughtExceptionHandler() const;
@@ -343,7 +343,7 @@ namespace lang {
/**
* Returns but does not clear the state of this Thread's interrupted flag.
*
- * @returns true if the thread was interrupted, false otherwise.
+ * @return true if the thread was interrupted, false otherwise.
*/
bool isInterrupted() const;
@@ -398,7 +398,7 @@ namespace lang {
* such that a subsequent call will return false unless an interrupt occurs between
* the two calls.
*
- * @returns true if the thread was interrupted, false otherwise.
+ * @return true if the thread was interrupted, false otherwise.
*/
static bool interrupted();
@@ -409,7 +409,7 @@ namespace lang {
* is cleared via a call to the setDefaultUncaughtExceptionHandler method will NULL as
* the value of the handler argument.
*
- * @returns a pointer to the default UncaughtExceptionHandler for all Threads.
+ * @return a pointer to the default UncaughtExceptionHandler for all Threads.
*/
static UncaughtExceptionHandler* getDefaultUncaughtExceptionHandler();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/ThreadLocal.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/ThreadLocal.h b/activemq-cpp/src/main/decaf/lang/ThreadLocal.h
index 0a5f28a..cb59337 100644
--- a/activemq-cpp/src/main/decaf/lang/ThreadLocal.h
+++ b/activemq-cpp/src/main/decaf/lang/ThreadLocal.h
@@ -64,7 +64,7 @@ namespace lang {
* variable has no value for the current thread, it is first initialized to the value
* returned by an invocation of the initialValue() method.
*
- * @returns the current thread's value for this thread local.
+ * @return the current thread's value for this thread local.
*/
E& get() {
void* bytes = getRawValue();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Throwable.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Throwable.h b/activemq-cpp/src/main/decaf/lang/Throwable.h
index de3e534..2329a42 100644
--- a/activemq-cpp/src/main/decaf/lang/Throwable.h
+++ b/activemq-cpp/src/main/decaf/lang/Throwable.h
@@ -62,7 +62,7 @@ namespace lang{
* a particular exception but wishes to allow for the real causal
* exception to be passed only in case the caller knows about that
* type of exception and wishes to respond to it.
- * @returns a const pointer reference to the causal exception, if there
+ * @return a const pointer reference to the causal exception, if there
* was no cause associated with this exception then NULL is returned.
*/
virtual const std::exception* getCause() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/net/DatagramPacket.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/net/DatagramPacket.h b/activemq-cpp/src/main/decaf/net/DatagramPacket.h
index de3ed59..51c2e3c 100644
--- a/activemq-cpp/src/main/decaf/net/DatagramPacket.h
+++ b/activemq-cpp/src/main/decaf/net/DatagramPacket.h
@@ -195,7 +195,7 @@ namespace net {
* Gets the SocketAddress (usually IP address + port number) of the remote host that this
* packet is being sent to or is coming from.
*
- * @returns the SocketAddress for this datagram packet.
+ * @return the SocketAddress for this datagram packet.
*/
SocketAddress* getSocketAddress() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/net/InetAddress.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/net/InetAddress.h b/activemq-cpp/src/main/decaf/net/InetAddress.h
index 49d5827..f36e904 100644
--- a/activemq-cpp/src/main/decaf/net/InetAddress.h
+++ b/activemq-cpp/src/main/decaf/net/InetAddress.h
@@ -56,14 +56,14 @@ namespace net {
* Returns the Raw IP address in Network byte order. The returned address is a copy
* of the bytes contained in this InetAddress.
*
- * @returns and ArrayPointer containing the raw bytes of the network address.
+ * @return and ArrayPointer containing the raw bytes of the network address.
*/
virtual decaf::lang::ArrayPointer<unsigned char> getAddress() const;
/**
* Returns a textual representation of the IP Address.
*
- * @returns the string form of the IP Address.
+ * @return the string form of the IP Address.
*/
virtual std::string getHostAddress() const;
@@ -75,7 +75,7 @@ namespace net {
* with the set IP Address. If the host name cannot be resolved the textual representation
* of the IP Address is returned instead.
*
- * @returns the name of the host associated with this set IP Address.
+ * @return the name of the host associated with this set IP Address.
*/
virtual std::string getHostName() const;
@@ -84,7 +84,7 @@ namespace net {
*
* If the hostname is not resolved than it appears as empty.
*
- * @returns string value of this InetAddress.
+ * @return string value of this InetAddress.
*/
virtual std::string toString() const;
@@ -220,7 +220,7 @@ namespace net {
* Gets an InetAddress that is the local host address. If the localhost value cannot
* be resolved than the InetAddress for Loopback is returned.
*
- * @returns a new InetAddress object that contains the local host address.
+ * @return a new InetAddress object that contains the local host address.
*
* @throws UnknownHostException if the address for local host is not found.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/net/ServerSocket.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/net/ServerSocket.h b/activemq-cpp/src/main/decaf/net/ServerSocket.h
index aca2864..3581081 100644
--- a/activemq-cpp/src/main/decaf/net/ServerSocket.h
+++ b/activemq-cpp/src/main/decaf/net/ServerSocket.h
@@ -217,7 +217,7 @@ namespace net{
virtual void close();
/**
- * @returns true if the close method has been called on the ServerSocket.
+ * @return true if the close method has been called on the ServerSocket.
*/
virtual bool isClosed() const;
@@ -290,12 +290,12 @@ namespace net{
/**
* Gets the port number on the Local machine that this ServerSocket is bound to.
*
- * @returns the port number of this machine that is bound, if not bound returns -1.
+ * @return the port number of this machine that is bound, if not bound returns -1.
*/
virtual int getLocalPort() const;
/**
- * @returns a string representing this ServerSocket.
+ * @return a string representing this ServerSocket.
*/
virtual std::string toString() const;
@@ -330,7 +330,7 @@ namespace net{
/**
* Allows a subclass to override what is considered the default backlog.
*
- * @returns the default backlog for connections.
+ * @return the default backlog for connections.
*/
virtual int getDefaultBacklog();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/net/Socket.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/net/Socket.h b/activemq-cpp/src/main/decaf/net/Socket.h
index 5b47f03..b3e651f 100644
--- a/activemq-cpp/src/main/decaf/net/Socket.h
+++ b/activemq-cpp/src/main/decaf/net/Socket.h
@@ -229,35 +229,35 @@ namespace net{
/**
* Indicates whether or not this socket is connected to am end point.
*
- * @returns true if connected, false otherwise.
+ * @return true if connected, false otherwise.
*/
bool isConnected() const {
return connected;
}
/**
- * @returns true if the Socket has been closed.
+ * @return true if the Socket has been closed.
*/
bool isClosed() const {
return closed;
}
/**
- * @returns true if this Socket has been bound to a Local address.
+ * @return true if this Socket has been bound to a Local address.
*/
bool isBound() const {
return bound;
}
/**
- * @returns true if input on this Socket has been shutdown.
+ * @return true if input on this Socket has been shutdown.
*/
bool isInputShutdown() const {
return inputShutdown;
}
/**
- * @returns true if output on this Socket has been shutdown.
+ * @return true if output on this Socket has been shutdown.
*/
bool isOutputShutdown() const {
return outputShutdown;
@@ -310,14 +310,14 @@ namespace net{
/**
* Returns the address to which the socket is connected.
*
- * @returns the remote IP address to which this socket is connected, or null if the socket is not connected.
+ * @return the remote IP address to which this socket is connected, or null if the socket is not connected.
*/
std::string getInetAddress() const;
/**
* Gets the local address to which the socket is bound.
*
- * @returns the local address to which the socket is bound or InetAddress.anyLocalAddress() if the socket is not bound yet.
+ * @return the local address to which the socket is bound or InetAddress.anyLocalAddress() if the socket is not bound yet.
*/
std::string getLocalAddress() const;
@@ -466,7 +466,7 @@ namespace net{
/**
* Gets the Status of the TCP_NODELAY setting for this socket.
*
- * @returns true if TCP_NODELAY is enabled for the socket.
+ * @return true if TCP_NODELAY is enabled for the socket.
*
* @throws SocketException Thrown if unable to set the information.
*/
@@ -490,7 +490,7 @@ namespace net{
*
* Refer to your platforms network documentation regarding support for this setting.
*
- * @returns the bitset result of querying the traffic class setting.
+ * @return the bitset result of querying the traffic class setting.
*
* @throws SocketException if an error is encountered while performing this operation.
*/
@@ -541,7 +541,7 @@ namespace net{
virtual void sendUrgentData(int data);
/**
- * @returns a string representing this Socket.
+ * @return a string representing this Socket.
*/
virtual std::string toString() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/net/SocketFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/net/SocketFactory.h b/activemq-cpp/src/main/decaf/net/SocketFactory.h
index b65c9a3..982b065 100644
--- a/activemq-cpp/src/main/decaf/net/SocketFactory.h
+++ b/activemq-cpp/src/main/decaf/net/SocketFactory.h
@@ -141,7 +141,7 @@ namespace net{
* default SocketFactory per application, the pointer returned by this method is owned by
* the SocketFactory class and in not to be deleted by the caller.
*
- * @returns pointer to the applications default SocketFactory.
+ * @return pointer to the applications default SocketFactory.
*
* @throws SocketException if an error occurs while getting the default instance.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/net/SocketImpl.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/net/SocketImpl.h b/activemq-cpp/src/main/decaf/net/SocketImpl.h
index c3304cd..34aa432 100644
--- a/activemq-cpp/src/main/decaf/net/SocketImpl.h
+++ b/activemq-cpp/src/main/decaf/net/SocketImpl.h
@@ -138,7 +138,7 @@ namespace net {
/**
* Gets the InputStream linked to this Socket.
*
- * @returns an InputStream pointer owned by the Socket object.
+ * @return an InputStream pointer owned by the Socket object.
*
* @throws IOException if an I/O error occurs while attempting this operation.
*/
@@ -147,7 +147,7 @@ namespace net {
/**
* Gets the OutputStream linked to this Socket.
*
- * @returns an OutputStream pointer owned by the Socket object.
+ * @return an OutputStream pointer owned by the Socket object.
*
* @throws IOException if an I/O error occurs while attempting this operation.
*/
@@ -156,7 +156,7 @@ namespace net {
/**
* Gets the number of bytes that can be read from the Socket without blocking.
*
- * @returns the number of bytes that can be read from the Socket without blocking.
+ * @return the number of bytes that can be read from the Socket without blocking.
*
* @throws IOException if an I/O error occurs while attempting this operation.
*/
@@ -194,7 +194,7 @@ namespace net {
* @param option
* The Socket options whose value is to be retrieved.
*
- * @returns the value of the given socket option.
+ * @return the value of the given socket option.
*
* @throws IOException if an I/O error occurs while performing this operation.
*/
@@ -224,7 +224,7 @@ namespace net {
/**
* Gets the value of this SocketImpl's local port field.
*
- * @returns the value of localPort.
+ * @return the value of localPort.
*/
int getLocalPort() const {
return this->localPort;
@@ -233,7 +233,7 @@ namespace net {
/**
* Gets the value of this SocketImpl's address field.
*
- * @returns the value of the address field.
+ * @return the value of the address field.
*/
std::string getInetAddress() const {
return this->address;
@@ -243,7 +243,7 @@ namespace net {
* Gets the FileDescriptor for this Socket, the Object is owned by this Socket and
* should not be deleted by the caller.
*
- * @returns a pointer to this Socket's FileDescriptor object.
+ * @return a pointer to this Socket's FileDescriptor object.
*/
const decaf::io::FileDescriptor* getFileDescriptor() const {
return this->fd;
@@ -253,19 +253,19 @@ namespace net {
* Gets the value of the local Inet address the Socket is bound to if bound, otherwise
* return the InetAddress ANY value "0.0.0.0".
*
- * @returns the local address bound to, or ANY.
+ * @return the local address bound to, or ANY.
*/
virtual std::string getLocalAddress() const = 0;
/**
* Returns a string containing the address and port of this Socket instance.
*
- * @returns a string containing the address and port of this socket.
+ * @return a string containing the address and port of this socket.
*/
std::string toString() const;
/**
- * @returns true if this SocketImpl supports sending Urgent Data. The default
+ * @return true if this SocketImpl supports sending Urgent Data. The default
* implementation always returns false.
*/
virtual bool supportsUrgentData() const {