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:13 UTC
[4/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/nio/IntBuffer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/nio/IntBuffer.h b/activemq-cpp/src/main/decaf/nio/IntBuffer.h
index b03cd93..096e5ab 100644
--- a/activemq-cpp/src/main/decaf/nio/IntBuffer.h
+++ b/activemq-cpp/src/main/decaf/nio/IntBuffer.h
@@ -68,7 +68,7 @@ namespace nio{
virtual ~IntBuffer() {}
/**
- * @returns a std::string describing this object
+ * @return a std::string describing this object
*/
virtual std::string toString() const;
@@ -81,7 +81,7 @@ namespace nio{
* Invoke the hasArray method before invoking this method in order to ensure that
* this buffer has an accessible backing array.
*
- * @returns the array that backs this Buffer.
+ * @return the array that backs this Buffer.
*
* @throws ReadOnlyBufferException if this Buffer is read only.
* @throws UnsupportedOperationException if the underlying store has no array.
@@ -95,7 +95,7 @@ namespace nio{
* Invoke the hasArray method before invoking this method in order to ensure that
* this buffer has an accessible backing array.
*
- * @returns The offset into the backing array where index zero starts.
+ * @return The offset into the backing array where index zero starts.
*
* @throws ReadOnlyBufferException if this Buffer is read only.
* @throws UnsupportedOperationException if the underlying store has no array.
@@ -135,7 +135,7 @@ namespace nio{
* zero, so that an invocation of this method can be followed immediately by
* an invocation of another relative put method.
*
- * @returns a reference to this IntBuffer
+ * @return a reference to this IntBuffer
*
* @throws ReadOnlyBufferException if this buffer is read-only.
*/
@@ -152,7 +152,7 @@ namespace nio{
* to those of this buffer. The new buffer will be read-only if, and only if,
* this buffer is read-only.
*
- * @returns a new int Buffer which the caller owns.
+ * @return a new int Buffer which the caller owns.
*/
virtual IntBuffer* duplicate() = 0;
@@ -160,7 +160,7 @@ namespace nio{
* Relative get method. Reads the value at this buffer's current position,
* and then increments the position.
*
- * @returns the int at the current position.
+ * @return the int at the current position.
*
* @throws BufferUnderflowException if there no more data to return.
*/
@@ -172,7 +172,7 @@ namespace nio{
* @param index
* The index in the Buffer where the int is to be read.
*
- * @returns the int that is located at the given index.
+ * @return the int that is located at the given index.
*
* @throws IndexOutOfBoundsException if index is not smaller than the
* buffer's limit, or index is negative.
@@ -188,7 +188,7 @@ namespace nio{
* amount of data that is to be read, that is to say, the caller should call
* buffer.resize( N ) before calling this get method.
*
- * @returns a reference to this Buffer.
+ * @return a reference to this Buffer.
*
* @throws BufferUnderflowException if there are fewer than length ints
* remaining in this buffer.
@@ -216,7 +216,7 @@ namespace nio{
* @param length
* The amount of data to put in the passed buffer.
*
- * @returns a reference to this Buffer.
+ * @return a reference to this Buffer.
*
* @throws BufferUnderflowException if there are fewer than length ints
* remaining in this buffer.
@@ -232,7 +232,7 @@ namespace nio{
* be invoked. Subclasses should override this method if they do not have a
* backing array as this class always returns true.
*
- * @returns true if, and only if, this buffer is backed by an array and is not
+ * @return true if, and only if, this buffer is backed by an array and is not
* read-only.
*/
virtual bool hasArray() const = 0;
@@ -250,7 +250,7 @@ namespace nio{
* @param src
* The buffer to take ints from an place in this one.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this
* buffer for the remaining ints in the source buffer.
@@ -278,7 +278,7 @@ namespace nio{
* @param length
* The number of integers to be read from the given array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this buffer.
* @throws ReadOnlyBufferException if this buffer is read-only.
@@ -295,7 +295,7 @@ namespace nio{
* @param buffer
* The buffer whose contents are copied to this IntBuffer.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this buffer.
* @throws ReadOnlyBufferException if this buffer is read-only.
@@ -309,7 +309,7 @@ namespace nio{
* @param value
* The integer value to be written.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if this buffer's current position is not
* smaller than its limit.
@@ -325,7 +325,7 @@ namespace nio{
* @param value
* The ints to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws IndexOutOfBoundsException - If index greater than the buffer's limit
* minus the size of the type being written, or the index is negative.
@@ -344,7 +344,7 @@ namespace nio{
* number of bytes remaining in this buffer, and its mark will be undefined. The
* new buffer will be read-only if, and only if, this buffer is read-only.
*
- * @returns the newly create IntBuffer which the caller owns.
+ * @return the newly create IntBuffer which the caller owns.
*/
virtual IntBuffer* slice() const = 0;
@@ -382,7 +382,7 @@ namespace nio{
* @param capacity
* The size of the Double buffer in integers.
*
- * @returns the IntBuffer that was allocated, caller owns.
+ * @return the IntBuffer that was allocated, caller owns.
*/
static IntBuffer* allocate( int capacity );
@@ -404,7 +404,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new IntBuffer that is backed by buffer, caller owns.
+ * @return a new IntBuffer that is backed by buffer, caller owns.
*
* @throws NullPointerException if the array pointer is NULL.
* @throws IndexOutOfBoundsException if the preconditions of size, offset, or length
@@ -425,7 +425,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been sized
* to the desired size already by calling vector.resize( N ).
*
- * @returns a new IntBuffer that is backed by buffer, caller owns.
+ * @return a new IntBuffer that is backed by buffer, caller owns.
*/
static IntBuffer* wrap( std::vector<int>& buffer );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/nio/LongBuffer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/nio/LongBuffer.h b/activemq-cpp/src/main/decaf/nio/LongBuffer.h
index fe1f83f..6f6df6d 100644
--- a/activemq-cpp/src/main/decaf/nio/LongBuffer.h
+++ b/activemq-cpp/src/main/decaf/nio/LongBuffer.h
@@ -68,7 +68,7 @@ namespace nio{
virtual ~LongBuffer() {}
/**
- * @returns a std::string describing this object
+ * @return a std::string describing this object
*/
virtual std::string toString() const;
@@ -81,7 +81,7 @@ namespace nio{
* Invoke the hasArray method before invoking this method in order to ensure that
* this buffer has an accessible backing array.
*
- * @returns the array that backs this Buffer.
+ * @return the array that backs this Buffer.
*
* @throws ReadOnlyBufferException if this Buffer is read only.
* @throws UnsupportedOperationException if the underlying store has no array.
@@ -95,7 +95,7 @@ namespace nio{
* Invoke the hasArray method before invoking this method in order to ensure that
* this buffer has an accessible backing array.
*
- * @returns The offset long longo the backing array where index zero starts.
+ * @return The offset long longo the backing array where index zero starts.
*
* @throws ReadOnlyBufferException if this Buffer is read only.
* @throws UnsupportedOperationException if the underlying store has no array.
@@ -135,7 +135,7 @@ namespace nio{
* zero, so that an invocation of this method can be followed immediately by
* an invocation of another relative put method.
*
- * @returns a reference to this LongBuffer.
+ * @return a reference to this LongBuffer.
*
* @throws ReadOnlyBufferException if this buffer is read-only.
*/
@@ -152,7 +152,7 @@ namespace nio{
* to those of this buffer. The new buffer will be read-only if, and only if,
* this buffer is read-only.
*
- * @returns a new long long Buffer which the caller owns.
+ * @return a new long long Buffer which the caller owns.
*/
virtual LongBuffer* duplicate() = 0;
@@ -160,7 +160,7 @@ namespace nio{
* Relative get method. Reads the value at this buffer's current position,
* and then increments the position.
*
- * @returns the long long at the current position.
+ * @return the long long at the current position.
*
* @throws BufferUnderflowException if there no more data to return.
*/
@@ -172,7 +172,7 @@ namespace nio{
* @param index
* The index in the Buffer where the long long is to be read.
*
- * @returns the long long that is located at the given index.
+ * @return the long long that is located at the given index.
*
* @throws IndexOutOfBoundsException if index is not smaller than the
* buffer's limit, or index is negative.
@@ -188,7 +188,7 @@ namespace nio{
* amount of data that is to be read, that is to say, the caller should call
* buffer.resize( N ) before calling this get method.
*
- * @returns a reference to this Buffer.
+ * @return a reference to this Buffer.
*
* @throws BufferUnderflowException if there are fewer than length long longs
* remaining in this buffer.
@@ -216,7 +216,7 @@ namespace nio{
* @param length
* The amount of data to put in the passed buffer.
*
- * @returns a reference to this Buffer.
+ * @return a reference to this Buffer.
*
* @throws BufferUnderflowException if there are fewer than length long longs
* remaining in this buffer
@@ -232,7 +232,7 @@ namespace nio{
* be invoked. Subclasses should override this method if they do not have a
* backing array as this class always returns true.
*
- * @returns true if, and only if, this buffer is backed by an array and is not
+ * @return true if, and only if, this buffer is backed by an array and is not
* read-only.
*/
virtual bool hasArray() const = 0;
@@ -250,7 +250,7 @@ namespace nio{
* @param src
* The buffer to take long longs from an place in this one.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this
* buffer for the remaining long longs in the source buffer
@@ -278,7 +278,7 @@ namespace nio{
* @param length
* The number of long longs to be read from the given array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this buffer
* @throws ReadOnlyBufferException if this buffer is read-only
@@ -295,7 +295,7 @@ namespace nio{
* @param buffer
* The buffer whose contents are copied to this LongBuffer.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this buffer.
* @throws ReadOnlyBufferException if this buffer is read-only.
@@ -309,7 +309,7 @@ namespace nio{
* @param value
* The long longs value to be written.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if this buffer's current position is not
* smaller than its limit
@@ -325,7 +325,7 @@ namespace nio{
* @param value
* The long longs to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written.
@@ -344,7 +344,7 @@ namespace nio{
* number of bytes remaining in this buffer, and its mark will be undefined. The
* new buffer will be read-only if, and only if, this buffer is read-only.
*
- * @returns the newly create LongBuffer which the caller owns.
+ * @return the newly create LongBuffer which the caller owns.
*/
virtual LongBuffer* slice() const = 0;
@@ -382,7 +382,7 @@ namespace nio{
* @param capacity
* The size of the Double buffer in long longs.
*
- * @returns the LongBuffer that was allocated, caller owns.
+ * @return the LongBuffer that was allocated, caller owns.
*/
static LongBuffer* allocate( int capacity );
@@ -404,7 +404,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new LongBuffer that is backed by buffer, caller owns.
+ * @return a new LongBuffer that is backed by buffer, caller owns.
*
* @throws NullPointerException if the array pointer is NULL.
* @throws IndexOutOfBoundsException if the preconditions of size, offset, or length
@@ -425,7 +425,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been sized
* to the desired size already by calling vector.resize( N ).
*
- * @returns a new LongBuffer that is backed by buffer, caller owns.
+ * @return a new LongBuffer that is backed by buffer, caller owns.
*/
static LongBuffer* wrap( std::vector<long long>& buffer );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/nio/ShortBuffer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/nio/ShortBuffer.h b/activemq-cpp/src/main/decaf/nio/ShortBuffer.h
index 168730c..b211303 100644
--- a/activemq-cpp/src/main/decaf/nio/ShortBuffer.h
+++ b/activemq-cpp/src/main/decaf/nio/ShortBuffer.h
@@ -68,7 +68,7 @@ namespace nio{
virtual ~ShortBuffer() {}
/**
- * @returns a std::string describing this object
+ * @return a std::string describing this object
*/
virtual std::string toString() const;
@@ -81,7 +81,7 @@ namespace nio{
* Invoke the hasArray method before invoking this method in order to ensure that
* this buffer has an accessible backing array.
*
- * @returns the array that backs this Buffer
+ * @return the array that backs this Buffer
*
* @throws ReadOnlyBufferException if this Buffer is read only.
* @throws UnsupportedOperationException if the underlying store has no array.
@@ -95,7 +95,7 @@ namespace nio{
* Invoke the hasArray method before invoking this method in order to ensure that
* this buffer has an accessible backing array.
*
- * @returns The offset into the backing array where index zero starts.
+ * @return The offset into the backing array where index zero starts.
*
* @throws ReadOnlyBufferException if this Buffer is read only.
* @throws UnsupportedOperationException if the underlying store has no array.
@@ -135,7 +135,7 @@ namespace nio{
* zero, so that an invocation of this method can be followed immediately by
* an invocation of another relative put method.
*
- * @returns a reference to this ShortBuffer.
+ * @return a reference to this ShortBuffer.
*
* @throws ReadOnlyBufferException if this buffer is read-only.
*/
@@ -152,7 +152,7 @@ namespace nio{
* to those of this buffer. The new buffer will be read-only if, and only if,
* this buffer is read-only.
*
- * @returns a new short Buffer which the caller owns.
+ * @return a new short Buffer which the caller owns.
*/
virtual ShortBuffer* duplicate() = 0;
@@ -160,7 +160,7 @@ namespace nio{
* Relative get method. Reads the value at this buffer's current position,
* and then increments the position.
*
- * @returns the short at the current position.
+ * @return the short at the current position.
*
* @throws BufferUnderflowException if there no more data to return.
*/
@@ -172,7 +172,7 @@ namespace nio{
* @param index
* The index in the Buffer where the short is to be read.
*
- * @returns the short that is located at the given index.
+ * @return the short that is located at the given index.
*
* @throws IndexOutOfBoundsException if index is not smaller than the
* buffer's limit, or the index is negative.
@@ -188,7 +188,7 @@ namespace nio{
* amount of data that is to be read, that is to say, the caller should call
* buffer.resize( N ) before calling this get method.
*
- * @returns a reference to this Buffer.
+ * @return a reference to this Buffer.
*
* @throws BufferUnderflowException if there are fewer than length shorts
* remaining in this buffer.
@@ -216,7 +216,7 @@ namespace nio{
* @param length
* The amount of data to put in the passed buffer.
*
- * @returns a reference to this Buffer.
+ * @return a reference to this Buffer.
*
* @throws BufferUnderflowException if there are fewer than length shorts
* remaining in this buffer
@@ -232,7 +232,7 @@ namespace nio{
* be invoked. Subclasses should override this method if they do not have a
* backing array as this class always returns true.
*
- * @returns true if, and only if, this buffer is backed by an array and is not
+ * @return true if, and only if, this buffer is backed by an array and is not
* read-only.
*/
virtual bool hasArray() const = 0;
@@ -250,7 +250,7 @@ namespace nio{
* @param src
* The buffer to take shorts from an place in this one.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this
* buffer for the remaining shorts in the source buffer.
@@ -278,7 +278,7 @@ namespace nio{
* @param length
* The number of shorts to be read from the given array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this buffer
* @throws ReadOnlyBufferException if this buffer is read-only
@@ -295,7 +295,7 @@ namespace nio{
* @param buffer
* The buffer whose contents are copied to this ShortBuffer.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if there is insufficient space in this buffer.
* @throws ReadOnlyBufferException if this buffer is read-only.
@@ -309,7 +309,7 @@ namespace nio{
* @param value
* The shorts value to be written.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws BufferOverflowException if this buffer's current position is not
* smaller than its limit.
@@ -325,7 +325,7 @@ namespace nio{
* @param value
* The shorts to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throws IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written.
@@ -344,7 +344,7 @@ namespace nio{
* number of bytes remaining in this buffer, and its mark will be undefined. The
* new buffer will be read-only if, and only if, this buffer is read-only.
*
- * @returns the newly create ShortBuffer which the caller owns.
+ * @return the newly create ShortBuffer which the caller owns.
*/
virtual ShortBuffer* slice() const = 0;
@@ -382,7 +382,7 @@ namespace nio{
* @param capacity
* The size of the Double buffer in shorts.
*
- * @returns the ShortBuffer that was allocated, caller owns.
+ * @return the ShortBuffer that was allocated, caller owns.
*/
static ShortBuffer* allocate( int capacity );
@@ -404,7 +404,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new ShortBuffer that is backed by buffer, caller owns.
+ * @return a new ShortBuffer that is backed by buffer, caller owns.
*
* @throws NullPointerException if the array pointer is NULL.
* @throws IndexOutOfBoundsException if the preconditions of size, offset, or length
@@ -425,7 +425,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new ShortBuffer that is backed by buffer, caller owns.
+ * @return a new ShortBuffer that is backed by buffer, caller owns.
*/
static ShortBuffer* wrap( std::vector<short>& buffer );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/security/MessageDigest.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/security/MessageDigest.h b/activemq-cpp/src/main/decaf/security/MessageDigest.h
index 7df30df..47fd9c3 100644
--- a/activemq-cpp/src/main/decaf/security/MessageDigest.h
+++ b/activemq-cpp/src/main/decaf/security/MessageDigest.h
@@ -109,7 +109,7 @@ namespace security {
* @param length
* The number of bytes within buf allotted for the digest.
*
- * @returns the number of bytes placed into buffer.
+ * @return the number of bytes placed into buffer.
*
* @throws DigestException if an error occurs.
*/
@@ -125,7 +125,7 @@ namespace security {
* @param size
* The length in bytes of the input buffer.
*
- * @returns the array of bytes for the resulting hash value.
+ * @return the array of bytes for the resulting hash value.
*/
std::vector<unsigned char> digest(const unsigned char* input, int size);
@@ -137,7 +137,7 @@ namespace security {
* @param input
* The input to be updated before the digest is completed.
*
- * @returns the array of bytes for the resulting hash value.
+ * @return the array of bytes for the resulting hash value.
*/
std::vector<unsigned char> digest(const std::vector<unsigned char>& input);
@@ -145,7 +145,7 @@ namespace security {
* Returns a string that identifies the algorithm, independent of implementation
* details. The name should be a standard name (such as "SHA", "MD5", etc).
*
- * @returns the algorithm name.
+ * @return the algorithm name.
*/
std::string getAlgorithmName() const {
return this->algorithm;
@@ -167,7 +167,7 @@ namespace security {
* Returns the length of the digest in bytes, or 0 if this operation is not supported
* by the provider and the implementation is not cloneable.
*
- * @returns the digest length in bytes, or 0 if this operation is not supported by the
+ * @return the digest length in bytes, or 0 if this operation is not supported by the
* provider and the implementation is not cloneable.
*/
int getDigestLength() const;
@@ -176,7 +176,7 @@ namespace security {
* Returns a clone of this MessageDisgest instance if the MessageDigestSpi in use
* is cloneable.
*
- * @returns a clone of this MessageDigest if possible.
+ * @return a clone of this MessageDigest if possible.
*
* @throws CloneNotSupportedException if the SPI in use cannot be cloned.
*/
@@ -190,7 +190,7 @@ namespace security {
/**
* Returns a string representation of this message digest object.
*
- * @returns a string representation of this message digest object.
+ * @return a string representation of this message digest object.
*/
std::string toString() const;
@@ -249,7 +249,7 @@ namespace security {
* @param algorithm
* The name of the algorithm requested. (MD5, SHA-1, etc)
*
- * @returns a Message Digest object that implements the specified algorithm.
+ * @return a Message Digest object that implements the specified algorithm.
* @throws NoSuchAlgorithmException if no Provider supports a MessageDigestSpi implementation
* for the specified algorithm.
*/
@@ -263,7 +263,7 @@ namespace security {
* @param digesta
* The second digest for comparison.
*
- * @returns true if the two digests are equal.
+ * @return true if the two digests are equal.
*/
static bool isEqual(const std::vector<unsigned char>& digesta,
const std::vector<unsigned char>& digestb);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/security/MessageDigestSpi.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/security/MessageDigestSpi.h b/activemq-cpp/src/main/decaf/security/MessageDigestSpi.h
index 39f5069..1966cf1 100644
--- a/activemq-cpp/src/main/decaf/security/MessageDigestSpi.h
+++ b/activemq-cpp/src/main/decaf/security/MessageDigestSpi.h
@@ -55,14 +55,14 @@ namespace security {
* Queries the SPI implementation and returns true if the SPI can be
* cloned.
*
- * @returns true if the SPI is clonable.
+ * @return true if the SPI is clonable.
*/
virtual bool isCloneable() const;
/**
* Returns a clone if the implementation supports being cloned.
*
- * @returns a new pointer that is a copy of this object.
+ * @return a new pointer that is a copy of this object.
*
* @throws CloneNotSupportedException
* if this is called on an implementation that does not support cloning.
@@ -74,7 +74,7 @@ namespace security {
/**
* Returns the digest length in bytes.
*
- * @returns The digest length in bytes.
+ * @return The digest length in bytes.
*/
virtual int engineGetDigestLength() = 0;
@@ -130,7 +130,7 @@ namespace security {
* Once engineDigest has been called, the engine should be reset (see engineReset).
* Resetting is the responsibility of the engine implementor.
*
- * @returns an STL vector of bytes containing the resulting hash value.
+ * @return an STL vector of bytes containing the resulting hash value.
*/
virtual std::vector<unsigned char> engineDigest() = 0;
@@ -154,7 +154,7 @@ namespace security {
* DigestException. This parameter is ignored if its value is greater
* than or equal to the actual digest length.
*
- * @returns the length of the digest stored in the output buffer.
+ * @return the length of the digest stored in the output buffer.
*
* @throws DigestException if an error occurs.
* @throws NullPointerException if the buffer pointer is NULL.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/security/ProviderService.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/security/ProviderService.h b/activemq-cpp/src/main/decaf/security/ProviderService.h
index aef58fe..418117d 100644
--- a/activemq-cpp/src/main/decaf/security/ProviderService.h
+++ b/activemq-cpp/src/main/decaf/security/ProviderService.h
@@ -77,7 +77,7 @@ namespace security {
* security provider framework uses this method to construct implementations.
* Applications will typically not need to call it.
*
- * @returns a new instance of the SecuritySpi provided by this ProviderService.
+ * @return a new instance of the SecuritySpi provided by this ProviderService.
*/
virtual SecuritySpi* newInstance() = 0;
@@ -85,7 +85,7 @@ namespace security {
* Return a String representation of this service. The format of this string is
* always, "type.algorithm"
*
- * @returns string describing this ProviderService.
+ * @return string describing this ProviderService.
*/
std::string toString() const {
return getType() + "." + getAlgorithm();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/AbstractCollection.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/AbstractCollection.h b/activemq-cpp/src/main/decaf/util/AbstractCollection.h
index 6610aeb..51fa0ec 100644
--- a/activemq-cpp/src/main/decaf/util/AbstractCollection.h
+++ b/activemq-cpp/src/main/decaf/util/AbstractCollection.h
@@ -209,7 +209,7 @@ namespace util {
*
* This implementation returns size() == 0.
*
- * @returns true if the size method return 0.
+ * @return true if the size method return 0.
*/
virtual bool isEmpty() const {
return this->size() == 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/BitSet.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/BitSet.h b/activemq-cpp/src/main/decaf/util/BitSet.h
index 02eaf8f..cca2415 100644
--- a/activemq-cpp/src/main/decaf/util/BitSet.h
+++ b/activemq-cpp/src/main/decaf/util/BitSet.h
@@ -147,7 +147,7 @@ namespace util {
/**
* Returns the number of bits set to true in this BitSet.
*
- * @returns the number of bits set to true in this BitSet.
+ * @return the number of bits set to true in this BitSet.
*/
int cardinality();
@@ -189,7 +189,7 @@ namespace util {
*
* must be true. The current sizes of the two bit sets are not compared.
*
- * @returns true if the sets are the same, false otherwise.
+ * @return true if the sets are the same, false otherwise.
*/
bool equals(const BitSet& set) const;
@@ -224,7 +224,7 @@ namespace util {
* @param index
* The index of the bit in question.
*
- * @returns the value of the bit with the specified index.
+ * @return the value of the bit with the specified index.
*
* @throws IndexOutOfBoundsException if the index value is negative.
*/
@@ -239,7 +239,7 @@ namespace util {
* @param toIndex
* The index (exclusive) to stop at.
*
- * @returns a new BitSet containing the specified values.
+ * @return a new BitSet containing the specified values.
*
* @throws IndexOutOfBoundsException if fromIndex is negative, or toIndex is negative, or
* fromIndex is larger than toIndex.
@@ -253,14 +253,14 @@ namespace util {
* @param set
* BitSet to intersect with.
*
- * @returns boolean indicating whether this BitSet intersects the specified BitSet.
+ * @return boolean indicating whether this BitSet intersects the specified BitSet.
*/
bool intersects(const BitSet& set) const;
/**
* Returns true if this BitSet contains no bits that are set to true.
*
- * @returns true if the set is empty, false otherwise.
+ * @return true if the set is empty, false otherwise.
*/
bool isEmpty() const;
@@ -268,7 +268,7 @@ namespace util {
* Returns the "logical size" of this BitSet: the index of the highest set bit in the
* BitSet plus one. Returns zero if the BitSet contains no set bits.
*
- * @returns the logical size of the BitSet.
+ * @return the logical size of the BitSet.
*/
int length() const;
@@ -279,7 +279,7 @@ namespace util {
* @param index
* The index to start the search from (inclusive).
*
- * @returns the index of the next clear bit.
+ * @return the index of the next clear bit.
*
* @throws IndexOutOfBoundsException if the index value is negative.
*/
@@ -292,7 +292,7 @@ namespace util {
* @param index
* The index to start the search from (inclusive).
*
- * @returns the index of the next set bit.
+ * @return the index of the next set bit.
*
* @throws IndexOutOfBoundsException if the index value is negative.
*/
@@ -354,7 +354,7 @@ namespace util {
* Returns the number of bits of space actually in use by this BitSet to represent bit
* values. The maximum element in the set is the size - 1st element.
*
- * @returns the number of bits currently in this bit set.
+ * @return the number of bits currently in this bit set.
*/
int size() const;
@@ -365,7 +365,7 @@ namespace util {
* ", " (a comma and a space) and surrounded by braces, resulting in the usual mathematical
* notation for a set of integers.
*
- * @returns string representation of the BitSet.
+ * @return string representation of the BitSet.
*/
std::string toString() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Collection.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Collection.h b/activemq-cpp/src/main/decaf/util/Collection.h
index 9a8e192..34649c8 100644
--- a/activemq-cpp/src/main/decaf/util/Collection.h
+++ b/activemq-cpp/src/main/decaf/util/Collection.h
@@ -109,7 +109,7 @@ namespace util {
* @param value
* The reference to the element to add to this Collection.
*
- * @returns true if the element was added to this Collection.
+ * @return true if the element was added to this Collection.
*
* @throws UnsupportedOperationExceptio if this is an unmodifiable collection.
* @throws NullPointerException if the Collection is a container of pointers
@@ -161,7 +161,7 @@ namespace util {
* @param value
* The value to check for presence in the collection.
*
- * @returns true if there is at least one of the elements in the collection
+ * @return true if there is at least one of the elements in the collection
*
* @throws NullPointerException if the Collection contains pointers and the
* Collection does not allow for NULL elements (optional check).
@@ -185,12 +185,12 @@ namespace util {
* same elements, i.e. all their elements are equivalent, then it
* returns true.
*
- * @returns true if the Collections contain the same elements.
+ * @return true if the Collections contain the same elements.
*/
virtual bool equals(const Collection<E>& value) const = 0;
/**
- * @returns true if this collection contains no elements.
+ * @return true if this collection contains no elements.
*/
virtual bool isEmpty() const = 0;
@@ -205,7 +205,7 @@ namespace util {
* @param value
* The reference to the element to remove from this Collection.
*
- * @returns true if the collection was changed, false otherwise.
+ * @return true if the collection was changed, false otherwise.
*
* @throws UnsupportedOperationExceptio if this is an unmodifiable collection.
* @throws NullPointerException if the Collection is a container of pointers
@@ -222,7 +222,7 @@ namespace util {
* @param collection
* The Collection whose elements are to be removed from this one.
*
- * @returns true if the collection changed as a result of this call.
+ * @return true if the collection changed as a result of this call.
*
* @throws UnsupportedOperationExceptio if this is an unmodifiable collection.
* @throws NullPointerException if the Collection is a container of pointers
@@ -239,7 +239,7 @@ namespace util {
* @param collection
* The Collection whose elements are to be retained.
*
- * @returns true if the collection changed as a result of this call.
+ * @return true if the collection changed as a result of this call.
*
* @throws UnsupportedOperationExceptio if this is an unmodifiable collection.
* @throws NullPointerException if the Collection is a container of pointers
@@ -251,7 +251,7 @@ namespace util {
* Returns the number of elements in this collection. If this collection
* contains more than Integer::MAX_VALUE elements, returns Integer::MAX_VALUE.
*
- * @returns the number of elements in this collection
+ * @return the number of elements in this collection
*/
virtual int size() const = 0;
@@ -263,7 +263,7 @@ namespace util {
*
* This method acts as bridge between array-based and collection-based APIs.
*
- * @returns an array of the elements in this collection in the form of an
+ * @return an array of the elements in this collection in the form of an
* STL vector.
*/
virtual std::vector<E> toArray() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Comparator.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Comparator.h b/activemq-cpp/src/main/decaf/util/Comparator.h
index afe980e..db90566 100644
--- a/activemq-cpp/src/main/decaf/util/Comparator.h
+++ b/activemq-cpp/src/main/decaf/util/Comparator.h
@@ -82,7 +82,7 @@ namespace util{
* @param o2
* The second object to be compared
*
- * @returns a negative integer, zero, or a positive integer as the first
+ * @return a negative integer, zero, or a positive integer as the first
* argument is less than, equal to, or greater than the second.
*/
virtual int compare(const T& o1, const T& o2) const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Deque.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Deque.h b/activemq-cpp/src/main/decaf/util/Deque.h
index c8b035e..677c0ea 100644
--- a/activemq-cpp/src/main/decaf/util/Deque.h
+++ b/activemq-cpp/src/main/decaf/util/Deque.h
@@ -86,7 +86,7 @@ namespace util {
* @param element
* The element to add to this Deque.
*
- * @returns true if the element was added, false otherwise.
+ * @return true if the element was added, false otherwise.
*
* @throws NullPointerException if the specified element is NULL and this deque is a Collection
* of pointers and does not permit null elements.
@@ -103,7 +103,7 @@ namespace util {
* @param element
* The element to add to this Deque.
*
- * @returns true if the element was added, false otherwise.
+ * @return true if the element was added, false otherwise.
*
* @throws NullPointerException if the specified element is NULL and this deque is a Collection
* of pointers and does not permit null elements.
@@ -116,7 +116,7 @@ namespace util {
* Removes the topmost element from the Deque and returns it. Unlike the pollFirst
* method this method throws a NuSuchElementException if the Deque is empty.
*
- * @returns the element at the Head of the Deque.
+ * @return the element at the Head of the Deque.
*
* @throws NoSuchElementException if the Deque is empty.
*/
@@ -126,7 +126,7 @@ namespace util {
* Removes the last element from the Deque and returns it. Unlike the pollLast
* method this method throws a NuSuchElementException if the Deque is empty.
*
- * @returns the element at the Tail of the Deque.
+ * @return the element at the Tail of the Deque.
*
* @throws NoSuchElementException if the Deque is empty.
*/
@@ -138,7 +138,7 @@ namespace util {
* @param element
* Reference to an variable that can be assigned the value of the head of this Deque.
*
- * @returns true if an element was available to remove, false otherwise.
+ * @return true if an element was available to remove, false otherwise.
*/
virtual bool pollFirst(E& element) = 0;
@@ -148,7 +148,7 @@ namespace util {
* @param element
* Reference to an variable that can be assigned the value of the tail of this Deque.
*
- * @returns true if an element was available to remove, false otherwise.
+ * @return true if an element was available to remove, false otherwise.
*/
virtual bool pollLast(E& element) = 0;
@@ -156,7 +156,7 @@ namespace util {
* Attempts to fetch a reference to the first element in the Deque. This method does
* not remove the element from the Deque but simply returns a reference to it.
*
- * @returns reference to the first element in the Deque.
+ * @return reference to the first element in the Deque.
*
* @throws NoSuchElementException if the Deque is empty.
*/
@@ -167,7 +167,7 @@ namespace util {
* Attempts to fetch a reference to the last element in the Deque. This method does
* not remove the element from the Deque but simply returns a reference to it.
*
- * @returns reference to the last element in the Deque.
+ * @return reference to the last element in the Deque.
*
* @throws NoSuchElementException if the Deque is empty.
*/
@@ -180,7 +180,7 @@ namespace util {
* call is successful it returns true. Unlike getFirst this method does not throw an
* exception if the Deque is empty.
*
- * @returns true if an element was assigned to the reference passed, false otherwise.
+ * @return true if an element was assigned to the reference passed, false otherwise.
*/
virtual bool peekFirst(E& value) const = 0;
@@ -190,7 +190,7 @@ namespace util {
* call is successful it returns true. Unlike getLast this method does not throw an
* exception if the Deque is empty.
*
- * @returns true if an element was assigned to the reference passed, false otherwise.
+ * @return true if an element was assigned to the reference passed, false otherwise.
*/
virtual bool peekLast(E& value) const = 0;
@@ -201,7 +201,7 @@ namespace util {
* @param value
* The value to be removed from this Deque.
*
- * @returns true if the Deque was modified as a result of this operation.
+ * @return true if the Deque was modified as a result of this operation.
*
* @throws NullPointerException if the specified element is NULL and this deque is a Collection
* of pointers and does not permit null elements.
@@ -215,7 +215,7 @@ namespace util {
* @param value
* The value to be removed from this Deque.
*
- * @returns true if the Deque was modified as a result of this operation.
+ * @return true if the Deque was modified as a result of this operation.
*
* @throws NullPointerException if the specified element is NULL and this deque is a Collection
* of pointers and does not permit null elements.
@@ -257,7 +257,7 @@ namespace util {
/**
* Provides an Iterator over this Collection that traverses the element in reverse order.
*
- * @returns a new Iterator instance that moves from last to first.
+ * @return a new Iterator instance that moves from last to first.
*/
virtual Iterator<E>* descendingIterator() = 0;
virtual Iterator<E>* descendingIterator() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Iterator.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Iterator.h b/activemq-cpp/src/main/decaf/util/Iterator.h
index 1b72a69..9c50435 100644
--- a/activemq-cpp/src/main/decaf/util/Iterator.h
+++ b/activemq-cpp/src/main/decaf/util/Iterator.h
@@ -41,7 +41,7 @@ namespace util{
* repeatedly until the hasNext() method returns false will return
* each element in the underlying collection exactly once.
*
- * @returns the next element in the iteration of elements.
+ * @return the next element in the iteration of elements.
*
* @throws NoSuchElementException if the iteration has no more elements.
*/
@@ -52,7 +52,7 @@ namespace util{
* the next call to next would result in an NoSuchElementException to
* be thrown.
*
- * @returns true if there are more elements available for iteration.
+ * @return true if there are more elements available for iteration.
*/
virtual bool hasNext() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/LRUCache.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/LRUCache.h b/activemq-cpp/src/main/decaf/util/LRUCache.h
index 7b4961e..6e0f672 100644
--- a/activemq-cpp/src/main/decaf/util/LRUCache.h
+++ b/activemq-cpp/src/main/decaf/util/LRUCache.h
@@ -98,7 +98,7 @@ namespace util {
/**
* Gets the currently configured Max Cache Size setting.
*
- * @returns the current max cache size value.
+ * @return the current max cache size value.
*/
int getMaxCacheSize() const {
return maxCacheSize;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Map.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Map.h b/activemq-cpp/src/main/decaf/util/Map.h
index ed5acc4..e025364 100644
--- a/activemq-cpp/src/main/decaf/util/Map.h
+++ b/activemq-cpp/src/main/decaf/util/Map.h
@@ -104,7 +104,7 @@ namespace util{
* @param source
* Map to compare to this one.
*
- * @returns true if the Map passed is equal in value to this one.
+ * @return true if the Map passed is equal in value to this one.
*/
virtual bool equals(const Map& source) const = 0;
@@ -200,7 +200,7 @@ namespace util{
* @param value
* The value to be set.
*
- * @returns true if the put operation replaced a value that was associated with
+ * @return true if the put operation replaced a value that was associated with
* an existing mapping to the given key or false otherwise.
*
* @throws UnsupportedOperationException if this map is unmodifiable.
@@ -227,7 +227,7 @@ namespace util{
* @param oldValue (out)
* The value previously held in the mapping for this key. .
*
- * @returns true if the put operation replaced a value that was associated with
+ * @return true if the put operation replaced a value that was associated with
* an existing mapping to the given key or false otherwise.
*
* @throws UnsupportedOperationException if this map is unmodifiable.
@@ -276,7 +276,7 @@ namespace util{
* Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not
* support the add or addAll operations.
*
- * @returns a reference to a Set<MapEntry<K,V>> that is backed by this Map.
+ * @return a reference to a Set<MapEntry<K,V>> that is backed by this Map.
*/
virtual Set< MapEntry<K,V> >& entrySet() = 0;
virtual const Set< MapEntry<K,V> >& entrySet() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Properties.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Properties.h b/activemq-cpp/src/main/decaf/util/Properties.h
index c24cc9c..ae5cc53 100644
--- a/activemq-cpp/src/main/decaf/util/Properties.h
+++ b/activemq-cpp/src/main/decaf/util/Properties.h
@@ -126,7 +126,7 @@ namespace util{
* @param value
* The value to be written.
*
- * @returns the old value of the property or empty string if not set.
+ * @return the old value of the property or empty string if not set.
*/
std::string setProperty(const std::string& name, const std::string& value);
@@ -146,7 +146,7 @@ namespace util{
* @param name
* The name of the property to remove.
*
- * @returns the previous value of the property if set, or empty string.
+ * @return the previous value of the property if set, or empty string.
*/
std::string remove(const std::string& name);
@@ -155,7 +155,7 @@ namespace util{
* in the default property list if a key of the same name has not already been found from
* the main properties list.
*
- * @returns a set of keys in this property list where the key and its corresponding value are
+ * @return a set of keys in this property list where the key and its corresponding value are
* strings, including the keys in the default property list.
*/
std::vector<std::string> propertyNames() const;
@@ -180,7 +180,7 @@ namespace util{
/**
* Clones this object.
*
- * @returns a replica of this object.
+ * @return a replica of this object.
*/
Properties* clone() const;
@@ -206,7 +206,7 @@ namespace util{
/**
* Formats the contents of the Properties Object into a string that can be logged, etc.
*
- * @returns string value of this object.
+ * @return string value of this object.
*/
std::string toString() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/Timer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/Timer.h b/activemq-cpp/src/main/decaf/util/Timer.h
index 01a5685..ed22b8a 100644
--- a/activemq-cpp/src/main/decaf/util/Timer.h
+++ b/activemq-cpp/src/main/decaf/util/Timer.h
@@ -120,7 +120,7 @@ namespace util {
*
* This method can be called on a Timer object that has no scheduled tasks without error.
*
- * @returns the number of tasks removed from the queue.
+ * @return the number of tasks removed from the queue.
*/
int purge();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/TimerTask.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/TimerTask.h b/activemq-cpp/src/main/decaf/util/TimerTask.h
index 888e51b..1b2abdc 100644
--- a/activemq-cpp/src/main/decaf/util/TimerTask.h
+++ b/activemq-cpp/src/main/decaf/util/TimerTask.h
@@ -71,7 +71,7 @@ namespace util {
*
* This method may be called repeatedly; the second and subsequent calls have no effect.
*
- * @returns true if this task is scheduled for one-time execution and has not yet run, or this
+ * @return true if this task is scheduled for one-time execution and has not yet run, or this
* task is scheduled for repeated execution. Returns false if the task was scheduled for one-time
* execution and has already run, or if the task was never scheduled, or if the task was already
* canceled. (Loosely speaking, this method returns true if it prevents one or more scheduled
@@ -97,7 +97,7 @@ namespace util {
* This method is typically not used in conjunction with fixed-delay execution repeating tasks, as
* their scheduled execution times are allowed to drift over time, and so are not terribly significant.
*
- * @returns the time at which the most recent execution of this task was scheduled to occur, in the
+ * @return the time at which the most recent execution of this task was scheduled to occur, in the
* format returned by Date.getTime(). The return value is undefined if the task has yet to commence its
* first execution.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/UUID.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/UUID.h b/activemq-cpp/src/main/decaf/util/UUID.h
index 5937ccd..94a729d 100644
--- a/activemq-cpp/src/main/decaf/util/UUID.h
+++ b/activemq-cpp/src/main/decaf/util/UUID.h
@@ -167,7 +167,7 @@ namespace util {
/**
* Returns a Hash Code value for this UUID.
*
- * @returns a Hash Code for this UUID
+ * @return a Hash Code for this UUID
*/
int hashCode() const;
@@ -206,17 +206,17 @@ namespace util {
* | "a" | "b" | "c" | "d" | "e" | "f"
* | "A" | "B" | "C" | "D" | "E" | "F"
*
- * @returns formatted string for this UUID
+ * @return formatted string for this UUID
*/
std::string toString() const;
/**
- * @returns the most significant 64 bits of this UUID's 128 bit value.
+ * @return the most significant 64 bits of this UUID's 128 bit value.
*/
long long getLeastSignificantBits() const;
/**
- * @returns the most significant 64 bits of this UUID's 128 bit value.
+ * @return the most significant 64 bits of this UUID's 128 bit value.
*/
long long getMostSignificantBits() const;
@@ -231,7 +231,7 @@ namespace util {
* version type 1. If this UUID is not a time-based UUID then this method
* throws UnsupportedOperationException.
*
- * @returns the node value of this UUID
+ * @return the node value of this UUID
*
* @throws UnsupportedOperationException if this UUID version does not support this operation.
*/
@@ -248,7 +248,7 @@ namespace util {
* version type 1. If this UUID is not a time-based UUID then this method
* throws UnsupportedOperationException.
*
- * @returns the timestamp associated with a V1 UUID
+ * @return the timestamp associated with a V1 UUID
*
* @throws UnsupportedOperationException if this UUID version does not support this operation.
*/
@@ -265,7 +265,7 @@ namespace util {
* has version type 1. If this UUID is not a time-based UUID then this
* method throws UnsupportedOperationException.
*
- * @returns the clockSequeunce associated with a V1 UUID
+ * @return the clockSequeunce associated with a V1 UUID
*
* @throws UnsupportedOperationException if this UUID version does not support this operation.
*/
@@ -280,7 +280,7 @@ namespace util {
* * 6 Reserved, Microsoft Corporation backward compatibility
* * 7 Reserved for future definition
*
- * @returns the variant associated with a V1 UUID
+ * @return the variant associated with a V1 UUID
*
* @throws UnsupportedOperationException if this UUID version does not support this operation.
*/
@@ -295,7 +295,7 @@ namespace util {
* * 3 Name-based UUID
* * 4 Randomly generated UUID
*
- * @returns the version associated with a V1 UUID
+ * @return the version associated with a V1 UUID
*
* @throws UnsupportedOperationException if this UUID version does not support this operation.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/BrokenBarrierException.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/BrokenBarrierException.h b/activemq-cpp/src/main/decaf/util/concurrent/BrokenBarrierException.h
index c755030..2fa3505 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/BrokenBarrierException.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/BrokenBarrierException.h
@@ -117,7 +117,7 @@ namespace concurrent{
* to preserve the type of the original exception as well as the message.
* All subclasses should override.
*
- * @returns a new instance of an exception that is a clone of this one.
+ * @return a new instance of an exception that is a clone of this one.
*/
virtual BrokenBarrierException* clone() const{
return new BrokenBarrierException( *this );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/Callable.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/Callable.h b/activemq-cpp/src/main/decaf/util/concurrent/Callable.h
index 337cf92..7a65e40 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/Callable.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/Callable.h
@@ -51,7 +51,7 @@ namespace concurrent {
/**
* Computes a result, or throws an exception if unable to do so.
- * @returns
+ * @return
* Computed Result.
* @throws Exception
* If unable to compute a result.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/CancellationException.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/CancellationException.h b/activemq-cpp/src/main/decaf/util/concurrent/CancellationException.h
index 4151ac2..c9df4a8 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/CancellationException.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/CancellationException.h
@@ -88,7 +88,7 @@ namespace concurrent {
* to preserve the type of the original exception as well as the message.
* All subclasses should override.
*
- * @returns a new instance of an exception that is a clone of this one.
+ * @return a new instance of an exception that is a clone of this one.
*/
virtual CancellationException* clone() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/CopyOnWriteArrayList.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/CopyOnWriteArrayList.h b/activemq-cpp/src/main/decaf/util/concurrent/CopyOnWriteArrayList.h
index 148260b..0975cb7 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/CopyOnWriteArrayList.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/CopyOnWriteArrayList.h
@@ -781,7 +781,7 @@ namespace concurrent {
* @param value
* The element to be added if not already contained in this List.
*
- * @returns true if the element is added to this List.
+ * @return true if the element is added to this List.
*/
bool addIfAbsent(const E& value) {
this->arrayLock.writeLock().lock();
@@ -816,7 +816,7 @@ namespace concurrent {
* @param collection
* The collection whose elements are to be added if not already in this List.
*
- * @returns the number of elements that are added to this List.
+ * @return the number of elements that are added to this List.
*/
int addAllAbsent(const Collection<E>& collection) {
@@ -861,7 +861,7 @@ namespace concurrent {
* @param index
* The index in the list to begin the search from.
*
- * @returns the index in the list that matches the value given, or -1 if not found.
+ * @return the index in the list that matches the value given, or -1 if not found.
*
* @throws IndexOutOfBoundsException if the given index is greater than or equal to the List size.
*/
@@ -900,7 +900,7 @@ namespace concurrent {
* @param index
* The index in the List to begin the search from.
*
- * @returns the index in the List that matches the given element or -1 if not found.
+ * @return the index in the List that matches the given element or -1 if not found.
*
* @throws IndexOutOfBoundsException if the given index is negative.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/CountDownLatch.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/CountDownLatch.h b/activemq-cpp/src/main/decaf/util/concurrent/CountDownLatch.h
index 9eab873..8d3ab53 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/CountDownLatch.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/CountDownLatch.h
@@ -148,7 +148,7 @@ namespace concurrent{
/**
* Gets the current count
- * @returns int count value
+ * @return int count value
*/
virtual int getCount() const;
@@ -156,7 +156,7 @@ namespace concurrent{
* Returns the string representation of this latch, includes the current
* count value at the time of calling.
*
- * @returns string describing this CountDownLatch instance.
+ * @return string describing this CountDownLatch instance.
*/
virtual std::string toString() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/Delayed.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/Delayed.h b/activemq-cpp/src/main/decaf/util/concurrent/Delayed.h
index d7ae67e..d372fa8 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/Delayed.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/Delayed.h
@@ -45,7 +45,7 @@ namespace concurrent {
* @param unit
* The time unit
*
- * @returns the remaining delay; zero or negative values indicate that the delay
+ * @return the remaining delay; zero or negative values indicate that the delay
* has already elapsed
*/
virtual long long getDelay( const TimeUnit& unit ) = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/ExecutionException.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/ExecutionException.h b/activemq-cpp/src/main/decaf/util/concurrent/ExecutionException.h
index 11369fb..b4ee760 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/ExecutionException.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/ExecutionException.h
@@ -88,7 +88,7 @@ namespace concurrent {
* to preserve the type of the original exception as well as the message.
* All subclasses should override.
*
- * @returns a new instance of an exception that is a clone of this one.
+ * @return a new instance of an exception that is a clone of this one.
*/
virtual ExecutionException* clone() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/ExecutorService.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/ExecutorService.h b/activemq-cpp/src/main/decaf/util/concurrent/ExecutorService.h
index 3b2e0fd..4283674 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/ExecutorService.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/ExecutorService.h
@@ -215,7 +215,7 @@ namespace concurrent {
* @param takeOwnership
* Boolean value indicating if the Executor now owns the pointer to the task.
*
- * @returns a new Future<?> pointer that is owned by the caller.
+ * @return a new Future<?> pointer that is owned by the caller.
*
* @throws RejectedExecutionException if the task cannot be scheduled for execution
* @throws NullPointerException if the Runnable pointer passed is NULL.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/Executors.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/Executors.h b/activemq-cpp/src/main/decaf/util/concurrent/Executors.h
index 748ce15..fb34d64 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/Executors.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/Executors.h
@@ -97,7 +97,7 @@ namespace concurrent {
* pool-N-thread-M, where N is the sequence number of this factory, and M is the
* sequence number of the thread created by this factory.
*
- * @returns a new instance of the default thread factory used in Executors, the
+ * @return a new instance of the default thread factory used in Executors, the
* caller takes ownership of the returned pointer.
*/
static ThreadFactory* getDefaultThreadFactory();
@@ -114,7 +114,7 @@ namespace concurrent {
* @param nThreads
* The number of threads to assign as the max for the new ExecutorService.
*
- * @returns pointer to a new ExecutorService that is owned by the caller.
+ * @return pointer to a new ExecutorService that is owned by the caller.
*
* @throws IllegalArgumentException if nThreads is less than or equal to zero.
*/
@@ -135,7 +135,7 @@ namespace concurrent {
* Instance of a ThreadFactory that will be used by the Executor to spawn new
* worker threads. This parameter cannot be NULL.
*
- * @returns pointer to a new ExecutorService that is owned by the caller.
+ * @return pointer to a new ExecutorService that is owned by the caller.
*
* @throws NullPointerException if threadFactory is NULL.
* @throws IllegalArgumentException if nThreads is less than or equal to zero.
@@ -150,7 +150,7 @@ namespace concurrent {
* method is owned by the caller but unlike the Executor returned from the method
* newFixedThreadPool(1) this one cannot be reconfigurable to use more threads later on.
*
- * @returns a new Executor pointer that is owned by the caller.
+ * @return a new Executor pointer that is owned by the caller.
*/
static ExecutorService* newSingleThreadExecutor();
@@ -166,7 +166,7 @@ namespace concurrent {
* Instance of a ThreadFactory that will be used by the Executor to spawn new
* worker threads. This parameter cannot be NULL and ownership passes to the Executor.
*
- * @returns a new Executor pointer that is owned by the caller.
+ * @return a new Executor pointer that is owned by the caller.
*
* @throws NullPointerException if threadFactory is NULL.
*/
@@ -182,7 +182,7 @@ namespace concurrent {
* @param executor
* The ExecutorService pointer to wrap and take ownership of.
*
- * @returns a new ExecutorService pointer that is owned by the caller.
+ * @return a new ExecutorService pointer that is owned by the caller.
*
* @throws NullPointerException if ExecutorService is NULL.
*/
@@ -199,7 +199,7 @@ namespace concurrent {
* @param owns
* Does the callable instance own the given Runnable task pointer, default is true.
*
- * @returns a new Callable<E> pointer that is owned by the caller.
+ * @return a new Callable<E> pointer that is owned by the caller.
*
* @throws NullPointerException if the Runnable task is NULL
*/
@@ -225,7 +225,7 @@ namespace concurrent {
* @param owns
* Does the callable instance own the given Runnable task pointer, default is true.
*
- * @returns a new Callable<E> pointer that is owned by the caller.
+ * @return a new Callable<E> pointer that is owned by the caller.
*
* @throws NullPointerException if the Runnable task is NULL
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/Future.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/Future.h b/activemq-cpp/src/main/decaf/util/concurrent/Future.h
index bf2dcdc..6e9c920 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/Future.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/Future.h
@@ -48,14 +48,14 @@ namespace concurrent {
* True if the thread executing this task should be interrupted; otherwise,
* in-progress tasks are allowed to complete.
*
- * @returns false if the task could not be canceled, typically because it has
+ * @return false if the task could not be canceled, typically because it has
* already completed normally; true otherwise
*/
virtual bool cancel(bool mayInterruptIfRunning) = 0;
/**
* Returns true if this task was canceled before it completed normally.
- * @returns true if this task was canceled before it completed
+ * @return true if this task was canceled before it completed
*/
virtual bool isCancelled() const = 0;
@@ -63,7 +63,7 @@ namespace concurrent {
* Returns true if this task completed. Completion may be due to normal termination,
* an exception, or cancellation -- in all of these cases, this method will return
* true.
- * @returns true if this task completed
+ * @return true if this task completed
*/
virtual bool isDone() const = 0;
@@ -93,7 +93,7 @@ namespace concurrent {
/**
* Waits if necessary for the computation to complete, and then retrieves its result.
*
- * @returns the computed result.
+ * @return the computed result.
*
* @throws CancellationException if the computation was canceled
* @throws ExecutionException if the computation threw an exception
@@ -110,7 +110,7 @@ namespace concurrent {
* @param unit
* The time unit of the timeout argument.
*
- * @returns the computed result
+ * @return the computed result
*
* @throws CancellationException if the computation was canceled
* @throws ExecutionException if the computation threw an exception
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/Semaphore.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/Semaphore.h b/activemq-cpp/src/main/decaf/util/concurrent/Semaphore.h
index 97332b8..ef7de62 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/Semaphore.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/Semaphore.h
@@ -229,7 +229,7 @@ namespace concurrent {
* though it breaks fairness. If you want to honor the fairness setting, then use
* tryAcquire(0, TimeUnit.SECONDS) which is almost equivalent (it also detects interruption).
*
- * @returns true if a permit was acquired and false otherwise
+ * @return true if a permit was acquired and false otherwise
*
* @throw RuntimeException if an unexpected error occurs while acquiring the Semaphore.
*/
@@ -265,7 +265,7 @@ namespace concurrent {
* @param timeout the maximum time to wait for a permit
* @param unit the time unit of the timeout argument
*
- * @returns true if a permit was acquired and false if the waiting time elapsed before a permit
+ * @return true if a permit was acquired and false if the waiting time elapsed before a permit
* was acquired
*
* @throw InterruptedException if the current thread is interrupted.
@@ -361,7 +361,7 @@ namespace concurrent {
*
* @param permits the number of permits to acquire
*
- * @returns true if the permits were acquired and false otherwise.
+ * @return true if the permits were acquired and false otherwise.
*
* @throw IllegalArgumentException if the permits argument is negative.
* @throw RuntimeException if an unexpected error occurs while acquiring the Semaphore.
@@ -404,7 +404,7 @@ namespace concurrent {
* @param timeout the maximum amount of time to wait to acquire the permits.
* @param unit the units that the timeout param represents.
*
- * @returns true if all permits were acquired and false if the waiting time elapsed before
+ * @return true if all permits were acquired and false if the waiting time elapsed before
* all permits were acquired
*
* @throw IllegalArgumentException if the permits argument is negative.
@@ -435,21 +435,21 @@ namespace concurrent {
*
* This method is typically used for debugging and testing purposes.
*
- * @returns the number of permits available in this semaphore
+ * @return the number of permits available in this semaphore
*/
int availablePermits() const;
/**
* Acquires and returns all permits that are immediately available.
*
- * @returns the number of permits acquired
+ * @return the number of permits acquired
*
* @throw RuntimeException if an unexpected error occurs while draining the Semaphore.
*/
int drainPermits();
/**
- * @returns true if this semaphore has fairness set true
+ * @return true if this semaphore has fairness set true
*/
bool isFair() const;
@@ -457,7 +457,7 @@ namespace concurrent {
* Returns a string identifying this semaphore, as well as its state. The state, in
* brackets, includes the String "Permits =" followed by the number of permits.
*
- * @returns a string identifying this semaphore, as well as its state
+ * @return a string identifying this semaphore, as well as its state
*/
std::string toString() const;
@@ -466,12 +466,12 @@ namespace concurrent {
* value changes dynamically so the result of this method can be invalid immediately after it
* is called.
*
- * @returns an estimate of the number of waiting threads.
+ * @return an estimate of the number of waiting threads.
*/
int getQueueLength() const;
/**
- * @returns true if there are threads that are currently waiting to acquire this Semaphore.
+ * @return true if there are threads that are currently waiting to acquire this Semaphore.
*/
bool hasQueuedThreads() const;
@@ -494,7 +494,7 @@ namespace concurrent {
* Creates and returns a new Collection object that contains a best effort snapshot of the
* threads that are currently waiting to acquire.
*
- * @returns a Collection pointer that contains waiting threads for lock acquisition.
+ * @return a Collection pointer that contains waiting threads for lock acquisition.
* The caller owns the returned pointer.
*/
decaf::util::Collection<decaf::lang::Thread*>* getQueuedThreads() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h b/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
index 7f3cf43..fc21144 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
@@ -63,7 +63,7 @@ namespace concurrent {
* @param r
* A pointer to a Runnable instance to be executed by new Thread instance returned.
*
- * @returns constructed thread, or NULL if the request to create a thread is rejected
+ * @return constructed thread, or NULL if the request to create a thread is rejected
* the caller owns the returned pointer.
*/
virtual decaf::lang::Thread* newThread(decaf::lang::Runnable* r) = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/ThreadPoolExecutor.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/ThreadPoolExecutor.h b/activemq-cpp/src/main/decaf/util/concurrent/ThreadPoolExecutor.h
index e77465e..c20d4f1 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/ThreadPoolExecutor.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/ThreadPoolExecutor.h
@@ -311,7 +311,7 @@ namespace concurrent{
* for debugging and monitoring, care should be taken when using this method. The executor
* continues to execute tasks from the Queue.
*
- * @returns a pointer to the blocking queue that this executor stores future tasks in.
+ * @return a pointer to the blocking queue that this executor stores future tasks in.
*/
virtual BlockingQueue<decaf::lang::Runnable*>* getQueue();
@@ -346,7 +346,7 @@ namespace concurrent{
* that are not core threads continue to time out using the set keep alive value
* regardless of whether this option is enabled.
*
- * @returns true if core threads can timeout when idle.
+ * @return true if core threads can timeout when idle.
*/
virtual bool allowsCoreThreadTimeout() const;
@@ -357,7 +357,7 @@ namespace concurrent{
* @param unit
* The unit of time to return the results in.
*
- * @returns the configure keep alive time in the requested time units.
+ * @return the configure keep alive time in the requested time units.
*/
virtual long long getKeepAliveTime(const TimeUnit& unit) const;
@@ -393,14 +393,14 @@ namespace concurrent{
* Gets the currently configured ThreadFactory. It is considered a programming
* error to delete the pointer returned by this method.
*
- * @returns the currently configured ThreadFactory instance used by this object.
+ * @return the currently configured ThreadFactory instance used by this object.
*/
virtual ThreadFactory* getThreadFactory() const;
/**
* Gets the currently configured RejectedExecutionHandler for this Executor.
*
- * @returns a pointer to the current RejectedExecutionHandler.
+ * @return a pointer to the current RejectedExecutionHandler.
*/
virtual RejectedExecutionHandler* getRejectedExecutionHandler() const;
@@ -431,7 +431,7 @@ namespace concurrent{
* new tasks up to the set core thread limit. When the limit is reached this method returns
* zero to indicate no more core threads can be created.
*
- * @returns the number of core threads created, or zero if the limit has already been met.
+ * @return the number of core threads created, or zero if the limit has already been met.
*/
virtual int prestartAllCoreThreads();
@@ -442,7 +442,7 @@ namespace concurrent{
* @param task
* The task that is to be removed from the work queue.
*
- * @returns true if the task was removed from the Queue.
+ * @return true if the task was removed from the Queue.
*/
bool remove(decaf::lang::Runnable* task);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/TimeUnit.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/TimeUnit.h b/activemq-cpp/src/main/decaf/util/concurrent/TimeUnit.h
index 3c4fb2b..7774415 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/TimeUnit.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/TimeUnit.h
@@ -110,7 +110,7 @@ namespace concurrent {
* <p>
* @param sourceDuration - Duration value to convert.
* @param sourceUnit - Unit type of the source duration.
- * @returns the converted duration in this unit, or Long.MIN_VALUE if conversion
+ * @return the converted duration in this unit, or Long.MIN_VALUE if conversion
* would negatively overflow, or Long.MAX_VALUE if it would positively overflow.
*/
long long convert( long long sourceDuration, const TimeUnit& sourceUnit ) const;
@@ -258,7 +258,7 @@ namespace concurrent {
*
* @param name
* The Name of the TimeUnit constant to be returned.
- * @returns
+ * @return
* A constant reference to the TimeUnit Constant with the given name.
* @throws IllegalArgumentException
* if this enum type has no constant with the specified name
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicBoolean.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicBoolean.h b/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicBoolean.h
index 7c18985..7180fa0 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicBoolean.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicBoolean.h
@@ -58,7 +58,7 @@ namespace atomic {
/**
* Gets the current value of this AtomicBoolean.
- * @returns the currently set value.
+ * @return the currently set value.
*/
bool get() const {
return value == 0 ? false : true;
@@ -78,7 +78,7 @@ namespace atomic {
*
* @param expect - the expected value
* @param update - the new value
- * @returns true if successful. False return indicates that the actual value
+ * @return true if successful. False return indicates that the actual value
* was not equal to the expected value.
*/
bool compareAndSet(bool expect, bool update);
@@ -87,13 +87,13 @@ namespace atomic {
* Atomically sets to the given value and returns the previous value.
*
* @param newValue - the new value
- * @returns the previous value
+ * @return the previous value
*/
bool getAndSet(bool newValue);
/**
* Returns the String representation of the current value.
- * @returns the String representation of the current value.
+ * @return the String representation of the current value.
*/
std::string toString() const;