activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject [3/9] activemq-cpp git commit: Fix some documentation generation issues.
Date Wed, 05 Aug 2015 22:48:12 GMT
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicInteger.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicInteger.h b/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicInteger.h
index e0241fe..418760c 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicInteger.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicInteger.h
@@ -61,7 +61,7 @@ namespace atomic {
 
         /**
          * Gets the current value.
-         * @returns the current value.
+         * @return the current value.
          */
         int get() const {
             return this->value;
@@ -78,7 +78,7 @@ namespace atomic {
         /**
          * Atomically sets to the given value and returns the old value.
          * @param newValue - the new value.
-         * @returns the previous value.
+         * @return the previous value.
          */
         int getAndSet( int newValue );
 
@@ -88,52 +88,52 @@ namespace atomic {
          *
          * @param expect - the expected value
          * @param update - the new value
-         * @returns true if successful. False return indicates that the actual
+         * @return true if successful. False return indicates that the actual
          * value was not equal to the expected value.
          */
         bool compareAndSet( int expect, int update );
 
         /**
          * Atomically increments by one the current value.
-         * @returns the previous value.
+         * @return the previous value.
          */
         int getAndIncrement();
 
         /**
          * Atomically decrements by one the current value.
-         * @returns the previous value.
+         * @return the previous value.
          */
         int getAndDecrement();
 
         /**
          * Atomically adds the given value to the current value.
          * @param delta - The value to add.
-         * @returns the previous value.
+         * @return the previous value.
          */
         int getAndAdd( int delta );
 
         /**
          * Atomically increments by one the current value.
-         * @returns the updated value.
+         * @return the updated value.
          */
         int incrementAndGet();
 
         /**
          * Atomically decrements by one the current value.
-         * @returns the updated value.
+         * @return the updated value.
          */
         int decrementAndGet();
 
         /**
          * Atomically adds the given value to the current value.
          * @param delta - the value to add.
-         * @returns the updated value.
+         * @return the updated value.
          */
         int addAndGet( int delta );
 
         /**
          * 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;
 
@@ -141,7 +141,7 @@ namespace atomic {
          * Description copied from class: Number
          * Returns the value of the specified number as an int. This may involve
          * rounding or truncation.
-         * @returns the numeric value represented by this object after conversion
+         * @return the numeric value represented by this object after conversion
          * to type int.
          */
         int intValue() const;
@@ -150,7 +150,7 @@ namespace atomic {
          * Description copied from class: Number
          * Returns the value of the specified number as a long. This may involve
          * rounding or truncation.
-         * @returns the numeric value represented by this object after conversion
+         * @return the numeric value represented by this object after conversion
          * to type long long.
          */
         long long longValue() const;
@@ -159,7 +159,7 @@ namespace atomic {
          * Description copied from class: Number
          * Returns the value of the specified number as a float. This may involve
          * rounding.
-         * @returns the numeric value represented by this object after conversion
+         * @return the numeric value represented by this object after conversion
          * to type float.
          */
         float floatValue() const;
@@ -168,7 +168,7 @@ namespace atomic {
          * Description copied from class: Number
          * Returns the value of the specified number as a double. This may
          * involve rounding.
-         * @returns the numeric value represented by this object after conversion
+         * @return the numeric value represented by this object after conversion
          * to type double.
          */
         double doubleValue() const;

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicReference.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicReference.h b/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicReference.h
index e45f62e..78f49e0 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicReference.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/atomic/AtomicReference.h
@@ -93,7 +93,7 @@ namespace atomic {
 
         /**
          * Returns the String representation of the current value.
-         * @returns string representation of the current value.
+         * @return string representation of the current value.
          */
         std::string toString() const {
             return decaf::lang::Long::toString( (long long)this->value );

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/locks/AbstractQueuedSynchronizer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/locks/AbstractQueuedSynchronizer.h
b/activemq-cpp/src/main/decaf/util/concurrent/locks/AbstractQueuedSynchronizer.h
index 337c565..2fbdfa7 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/locks/AbstractQueuedSynchronizer.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/locks/AbstractQueuedSynchronizer.h
@@ -72,7 +72,7 @@ namespace locks {
             /**
              * Used to check on the ownership status of this ConditionObject
              *
-             * @returns true if the ConditionObject is owned by the given AbstractQueuedSynchronizer
+             * @return true if the ConditionObject is owned by the given AbstractQueuedSynchronizer
              */
             virtual bool isOwnedBy(const AbstractQueuedSynchronizer* sync) const = 0;
 
@@ -80,7 +80,7 @@ namespace locks {
              * Returns true if there are any waiters on this Condition object at the time
              * of its calling.
              *
-             * @returns true if there are currently waiters false otherwise.
+             * @return true if there are currently waiters false otherwise.
              */
             virtual bool hasWaiters() const = 0;
 
@@ -96,7 +96,7 @@ namespace locks {
              * Retrieves a new Collection object that contains Threads that may be waiting
              * on this Condition object.
              *
-             * @returns new Collection object that holds possible waiters. Caller owns.
+             * @return new Collection object that holds possible waiters. Caller owns.
              */
             virtual Collection<decaf::lang::Thread*>* getWaitingThreads() const = 0;
         };
@@ -154,7 +154,7 @@ namespace locks {
          * Creates and returns a new Collection object that contains only those threads that
may
          * be waiting to acquire this Synchronization in exclusive mode.
          *
-         * @returns a Collection pointer that contains waiting threads for exclusive acquisition.
+         * @return a Collection pointer that contains waiting threads for exclusive acquisition.
          *          The caller owns the returned pointer.
          */
         Collection<decaf::lang::Thread*>* getExclusiveQueuedThreads() const;
@@ -163,7 +163,7 @@ namespace locks {
          * Creates and returns a new Collection object that contains only those threads that
may
          * be waiting to acquire this Synchronization in shared mode.
          *
-         * @returns a Collection pointer that contains waiting threads for shared acquisition.
+         * @return a Collection pointer that contains waiting threads for shared acquisition.
          *          The caller owns the returned pointer.
          */
         Collection<decaf::lang::Thread*>* getSharedQueuedThreads() const;
@@ -172,7 +172,7 @@ namespace locks {
          * Returns the first thread queue (the thread that's been waiting the longest) if
there
          * are currently no queued threads this method returns NULL.
          *
-         * @returns the first thread in the queue or NULL if none are currently waiting.
+         * @return the first thread in the queue or NULL if none are currently waiting.
          */
         decaf::lang::Thread* getFirstQueuedThread() const;
 
@@ -180,7 +180,7 @@ namespace locks {
          * 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.
          */
         Collection<decaf::lang::Thread*>* getQueuedThreads() const;
@@ -190,7 +190,7 @@ namespace locks {
          * 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;
 
@@ -198,7 +198,7 @@ namespace locks {
          * Creates and returns a new Collection object that contains all the threads that
may be waiting
          * on the given ConditionOject instance at the time this method is called.
          *
-         * @returns a Collection pointer that contains waiting threads on given ConditionObject.
+         * @return a Collection pointer that contains waiting threads on given ConditionObject.
          *          The caller owns the returned pointer.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
@@ -213,7 +213,7 @@ namespace locks {
          * immediately after it is called.  The ConditionObject must be associated with this
          * AbstractQueuedSynchronizer or an exception will be thrown.
          *
-         * @returns an estimate of the number of waiting threads.
+         * @return an estimate of the number of waiting threads.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
          * @throws IllegalArgumentException if the ConditionObject is not associated with
this Synchronizer.
@@ -222,12 +222,12 @@ namespace locks {
         int getWaitQueueLength(const AbstractQueuedSynchronizer::ConditionObject* condition)
const;
 
         /**
-         * @returns true if there has ever been the need for the acquire method to block.
+         * @return true if there has ever been the need for the acquire method to block.
          */
         bool hasContended() const;
 
         /**
-         * @returns true if there are threads that are currently waiting to acquire.
+         * @return true if there are threads that are currently waiting to acquire.
          */
         bool hasQueuedThreads() const;
 
@@ -235,7 +235,7 @@ namespace locks {
          * Returns true if there are any threads that are currently waiting on the given
ConditionObject,
          * the condition must be associated with this synchronizer instance.
          *
-         * @returns true if the condition object has waiting threads.
+         * @return true if the condition object has waiting threads.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
          * @throws IllegalArgumentException if the ConditionObject is not associated with
this Synchronizer.
@@ -246,7 +246,7 @@ namespace locks {
         /**
          * Traverse the Queue if waiting threads to see if the given thread is present.
          *
-         * @returns true if the given thread is in the wait Queue.
+         * @return true if the given thread is in the wait Queue.
          *
          * @throws NullPointerException if the thread pointer is NULL.
          */
@@ -255,7 +255,7 @@ namespace locks {
         /**
          * Checks whether the given ConditionObject uses this Synchronizer as its lock object.
          *
-         * @returns true if the ConditionObject uses this Synchronizer as its lock.
+         * @return true if the ConditionObject uses this Synchronizer as its lock.
          *
          * @throws NullPointerException if the condition pointer is NULL.
          */
@@ -291,7 +291,7 @@ namespace locks {
          * and also contains the indicators "nonempty" or "empty" based on whether the thread
queue
          * is empty or not.
          *
-         * @returns a string value that identifies this AbstractQueuedSynchronizer.
+         * @return a string value that identifies this AbstractQueuedSynchronizer.
          */
         std::string toString() const;
 
@@ -305,7 +305,7 @@ namespace locks {
          * @param nanos
          *      Time in nanoseconds to wait before reporting the acquisition as failed.
          *
-         * @returns true if the acquire succeeded, false otherwise.
+         * @return true if the acquire succeeded, false otherwise.
          *
          * @throws InterruptedException if the calling thread is interrupted.
          */
@@ -321,7 +321,7 @@ namespace locks {
          * @param nanos
          *      Time in nanoseconds to wait before reporting the acquisition as failed.
          *
-         * @returns true if the acquire succeeded, false otherwise.
+         * @return true if the acquire succeeded, false otherwise.
          *
          * @throws InterruptedException if the calling thread is interrupted.
          */
@@ -332,7 +332,7 @@ namespace locks {
         /**
          * Gets and returns the currently set value of this object Synchronization sate.
          *
-         * @returns the value of the synchronization sate.
+         * @return the value of the synchronization sate.
          */
         virtual int getState() const;
 
@@ -353,7 +353,7 @@ namespace locks {
          * @param update
          *      The new value to assign the state if the current value matches the expected.
          *
-         * @returns true if a change is made, false otherwise.
+         * @return true if a change is made, false otherwise.
          */
         virtual bool compareAndSetState(int expect, int update);
 
@@ -382,7 +382,7 @@ namespace locks {
          * @param arg
          *      The value passed to the acquire method.
          *
-         * @returns true if the acquire succeeded, false otherwise.
+         * @return true if the acquire succeeded, false otherwise.
          *
          * @throws IllegalMonitorStateException if the acquire places the object in an invalid
state.
          * @throws UnsupportedOperationException if exclusive mode is not supported.
@@ -421,7 +421,7 @@ namespace locks {
          * @param arg
          *      The value that was passed to the release method.
          *
-         * @returns true if the synchronization is now fully released such that waiting threads
can
+         * @return true if the synchronization is now fully released such that waiting threads
can
          *          now attempt to acquire it, false if not fully released.
          *
          * @throws IllegalMonitorStateException if the release places the object in an invalid
state.
@@ -438,7 +438,7 @@ namespace locks {
          * @param arg
          *      The value that was passed to the release method.
          *
-         * @returns true if the synchronization is now fully released such that waiting threads
can
+         * @return true if the synchronization is now fully released such that waiting threads
can
          *          now attempt to acquire it, false if not fully released.
          *
          * @throws IllegalMonitorStateException if the release places the object in an invalid
state.
@@ -451,7 +451,7 @@ namespace locks {
          * logic implemented inside this class.  Can be overridden by derived classes that
wish to
          * provide their own implementation of a ConditionObject.
          *
-         * @returns a new ConditionObject that is owned by the caller.
+         * @return a new ConditionObject that is owned by the caller.
          */
         virtual ConditionObject* createDefaultConditionObject();
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/locks/Condition.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/locks/Condition.h b/activemq-cpp/src/main/decaf/util/concurrent/locks/Condition.h
index 3d21a38..926a95e 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/locks/Condition.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/locks/Condition.h
@@ -285,7 +285,7 @@ namespace locks {
          *
          * @param nanosTimeout - the maximum time to wait, in nanoseconds
          *
-         * @returns an estimate of the nanosTimeout value minus the time spent waiting upon
+         * @return an estimate of the nanosTimeout value minus the time spent waiting upon
          *          return from this method. A positive value may be used as the argument
to
          *          a subsequent call to this method to finish waiting out the desired time.
          *          A value less than or equal to zero indicates that no time remains.
@@ -311,7 +311,7 @@ namespace locks {
          * @param time - the maximum time to wait
          * @param unit - the time unit of the time argument
          *
-         * @returns false if the waiting time detectably elapsed before return from the
+         * @return false if the waiting time detectably elapsed before return from the
          *          method, else true
          *
          * @throws RuntimeException
@@ -383,7 +383,7 @@ namespace locks {
          *
          * @param deadline - the absolute time to wait until
          *
-         * @returns false if the deadline has elapsed upon return, else true
+         * @return false if the deadline has elapsed upon return, else true
          *
          * @throws RuntimeException
          *         if an unexpected error occurs while trying to wait on the Condition.

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/locks/Lock.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/locks/Lock.h b/activemq-cpp/src/main/decaf/util/concurrent/locks/Lock.h
index 75c71f8..861bd37 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/locks/Lock.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/locks/Lock.h
@@ -182,7 +182,7 @@ namespace locks {
          * This usage ensures that the lock is unlocked if it was acquired, and doesn't
          * try to unlock if the lock was not acquired.
          *
-         * @returns true if the lock was acquired and false otherwise
+         * @return true if the lock was acquired and false otherwise
          *
          * @throws RuntimeException if an error occurs while acquiring the lock.
          */
@@ -235,7 +235,7 @@ namespace locks {
          * @param unit
          *        the time unit of the time argument
          *
-         * @returns true if the lock was acquired and false if the waiting time elapsed
+         * @return true if the lock was acquired and false if the waiting time elapsed
          *          before the lock was acquired
          *
          * @throws RuntimeException if an error occurs while acquiring the lock.
@@ -272,7 +272,7 @@ namespace locks {
          * The exact operation of the Condition instance depends on the Lock implementation
          * and must be documented by that implementation.
          *
-         * @returns A new Condition instance for this Lock instance the caller must
+         * @return A new Condition instance for this Lock instance the caller must
          *          delete the returned Condition object when done with it.
          *
          * @throws RuntimeException if an error occurs while creating the Condition.
@@ -282,7 +282,7 @@ namespace locks {
         virtual Condition* newCondition() = 0;
 
         /**
-         * @returns a string representation of the Lock useful for debugging purposes.
+         * @return a string representation of the Lock useful for debugging purposes.
          */
         virtual std::string toString() const = 0;
     };

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/locks/ReadWriteLock.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/locks/ReadWriteLock.h b/activemq-cpp/src/main/decaf/util/concurrent/locks/ReadWriteLock.h
index 1834d3c..d40e4b2 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/locks/ReadWriteLock.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/locks/ReadWriteLock.h
@@ -94,13 +94,13 @@ namespace locks {
 
         /**
          * Returns the lock used for reading.
-         * @returns the lock used for reading.
+         * @return the lock used for reading.
          */
         virtual Lock& readLock() = 0;
 
         /**
          * Returns the lock used for writing.
-         * @returns the lock used for writing.
+         * @return the lock used for writing.
          */
         virtual Lock& writeLock() = 0;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantLock.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantLock.h b/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantLock.h
index 6546dcf..b8fbd2e 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantLock.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantLock.h
@@ -174,7 +174,7 @@ namespace locks {
          * If the lock is held by another thread then this method will return immediately
with the
          * value false.
          *
-         * @returns true if the lock was acquired and false otherwise
+         * @return true if the lock was acquired and false otherwise
          *
          * @throws RuntimeException if an error occurs while acquiring the lock.
          */
@@ -223,7 +223,7 @@ namespace locks {
          * @param unit
          *        the time unit of the time argument
          *
-         * @returns true if the lock was acquired and false if the waiting time elapsed
+         * @return true if the lock was acquired and false if the waiting time elapsed
          *          before the lock was acquired
          *
          * @throws RuntimeException if an error occurs while acquiring the lock.
@@ -298,7 +298,7 @@ namespace locks {
          *        }
          *    }
          *
-         * @returns the number of holds on this lock by the current thread, or zero if this
lock
+         * @return the number of holds on this lock by the current thread, or zero if this
lock
          *          is not held by the current thread
          */
         int getHoldCount() const;
@@ -341,7 +341,7 @@ namespace locks {
          *     }
          *   }
          *
-         * @returns true if current thread holds this lock and false otherwise
+         * @return true if current thread holds this lock and false otherwise
          */
         bool isHeldByCurrentThread() const;
 
@@ -349,14 +349,14 @@ namespace locks {
          * Queries if this lock is held by any thread. This method is designed for use in
          * monitoring of the system state, not for synchronization control.
          *
-         * @returns true if any thread holds this lock and false otherwise
+         * @return true if any thread holds this lock and false otherwise
          */
         bool isLocked() const;
 
         /**
          * Returns true if this lock has fairness set true.
          *
-         * @returns true if this lock has fairness set true
+         * @return true if this lock has fairness set true
          */
         bool isFair() const;
 
@@ -365,7 +365,7 @@ namespace locks {
          * brackets, includes either the String "Unlocked" or the String "Locked by" followed
          * by the name of the owning thread.
          *
-         * @returns a string identifying this lock, as well as its lock state
+         * @return a string identifying this lock, as well as its lock state
          */
         std::string toString() const;
 
@@ -374,7 +374,7 @@ namespace locks {
          * 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;
 
@@ -384,7 +384,7 @@ namespace locks {
          * immediately after it is called.  The Condition object must be associated with
this Lock
          * or an exception will be thrown.
          *
-         * @returns an estimate of the number of waiting threads.
+         * @return an estimate of the number of waiting threads.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
          * @throws IllegalArgumentException if the ConditionObject is not associated with
this Synchronizer.
@@ -396,7 +396,7 @@ namespace locks {
          * Returns true if there are any threads that are currently waiting on the given
Condition object,
          * the condition must be associated with this Lock instance.
          *
-         * @returns true if the condition object has waiting threads.
+         * @return true if the condition object has waiting threads.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
          * @throws IllegalArgumentException if the ConditionObject is not associated with
this Lock.
@@ -405,12 +405,12 @@ namespace locks {
         bool hasWaiters(Condition* condition) const;
 
         /**
-         * @returns true if there are threads that are currently waiting to acquire this
Lock.
+         * @return true if there are threads that are currently waiting to acquire this Lock.
          */
         bool hasQueuedThreads() const;
 
         /**
-         * @returns true if the given Thread is waiting to acquire this Lock object.  Because
of cancellations
+         * @return true if the given Thread is waiting to acquire this Lock object.  Because
of cancellations
          *          this method can return true but the given Thread is not in the Queue
afterwards.
          *
          * @throws NullPointerException if the given thread is NULL.
@@ -423,7 +423,7 @@ namespace locks {
          * Creates and returns a new Collection object that contains all the threads that
may be waiting
          * on the given Condition object instance at the time this method is called.
          *
-         * @returns a Collection pointer that contains waiting threads on given Condition
object.
+         * @return a Collection pointer that contains waiting threads on given Condition
object.
          *          The caller owns the returned pointer.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
@@ -448,7 +448,7 @@ namespace locks {
          * 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/locks/ReentrantReadWriteLock.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantReadWriteLock.h b/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantReadWriteLock.h
index 096466e..92b67b8 100644
--- a/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantReadWriteLock.h
+++ b/activemq-cpp/src/main/decaf/util/concurrent/locks/ReentrantReadWriteLock.h
@@ -77,7 +77,7 @@ namespace locks {
         /**
          * Returns true if this lock has fairness set true.
          *
-         * @returns true if the Lock uses a fair policy otherwise false.
+         * @return true if the Lock uses a fair policy otherwise false.
          */
         bool isFair() const;
 
@@ -147,7 +147,7 @@ namespace locks {
          * immediately after it is called.  The Condition object must be associated with
this Lock
          * or an exception will be thrown.
          *
-         * @returns an estimate of the number of waiting threads.
+         * @return an estimate of the number of waiting threads.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.
          * @throws IllegalArgumentException if the ConditionObject is not associated with
this Synchronizer.
@@ -207,7 +207,7 @@ namespace locks {
          * Creates and returns a new Collection object that contains all the threads that
may be waiting
          * on the given Condition object instance at the time this method is called.
          *
-         * @returns a Collection pointer that contains waiting threads on given Condition
object.
+         * @return a Collection pointer that contains waiting threads on given Condition
object.
          *          The caller owns the returned pointer.
          *
          * @throws NullPointerException if the ConditionObject pointer is NULL.

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/logging/Filter.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/logging/Filter.h b/activemq-cpp/src/main/decaf/util/logging/Filter.h
index c1132b8..24b2592 100644
--- a/activemq-cpp/src/main/decaf/util/logging/Filter.h
+++ b/activemq-cpp/src/main/decaf/util/logging/Filter.h
@@ -40,7 +40,7 @@ namespace logging{
         /**
          * Check if a given log record should be published.
          * @param record the <code>LogRecord</code> to check.
-         * @returns true if the record is loggable.
+         * @return true if the record is loggable.
          */
         virtual bool isLoggable( const LogRecord& record ) const = 0;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/logging/Formatter.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/logging/Formatter.h b/activemq-cpp/src/main/decaf/util/logging/Formatter.h
index 0ff79dd..b99654d 100644
--- a/activemq-cpp/src/main/decaf/util/logging/Formatter.h
+++ b/activemq-cpp/src/main/decaf/util/logging/Formatter.h
@@ -42,14 +42,14 @@ namespace logging{
         /**
          * Format the given log record and return the formatted string.
          * @param record The Log Record to Format
-         * @returns the formatted record.
+         * @return the formatted record.
          */
         virtual std::string format( const LogRecord& record ) const = 0;
 
         /**
          * Format the message string from a log record.
          * @param record The Log Record to Format
-         * @returns the formatted message
+         * @return the formatted message
          */
         virtual std::string formatMessage( const LogRecord& record ) const;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/logging/Handler.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/logging/Handler.h b/activemq-cpp/src/main/decaf/util/logging/Handler.h
index 2bde16e..44f2d35 100644
--- a/activemq-cpp/src/main/decaf/util/logging/Handler.h
+++ b/activemq-cpp/src/main/decaf/util/logging/Handler.h
@@ -112,7 +112,7 @@ namespace logging{
 
         /**
          * Gets the Filter that this Handler uses to filter Log Records
-         * @returns <code>Filter</code> derived instance
+         * @return <code>Filter</code> derived instance
          */
         virtual Filter* getFilter() {
             return this->filter;
@@ -133,7 +133,7 @@ namespace logging{
         /**
          * Get the log level specifying which message levels will be logged
          * by this Handler.
-         * @returns Level enumeration value
+         * @return Level enumeration value
          */
         virtual Level getLevel() {
             return this->level;
@@ -150,7 +150,7 @@ namespace logging{
 
         /**
          * Gets the <code>Formatter</code> used by this Handler
-         * @returns <code>Filter</code> derived instance
+         * @return <code>Filter</code> derived instance
          */
         virtual Formatter* getFormatter() {
             return this->formatter;
@@ -168,7 +168,7 @@ namespace logging{
 
         /**
          * Gets the <code>ErrorManager</code> used by this Handler.
-         * @returns <code>ErrorManager</code> derived pointer or NULL.
+         * @return <code>ErrorManager</code> derived pointer or NULL.
          */
         virtual ErrorManager* getErrorManager() {
             return this->errorManager;

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/logging/LogManager.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/logging/LogManager.h b/activemq-cpp/src/main/decaf/util/logging/LogManager.h
index 22afaad..21a94b3 100644
--- a/activemq-cpp/src/main/decaf/util/logging/LogManager.h
+++ b/activemq-cpp/src/main/decaf/util/logging/LogManager.h
@@ -203,7 +203,7 @@ namespace logging{
         /**
          * Gets a reference to the Logging Properties used by this
          * logger.
-         * @returns The Logger Properties Pointer
+         * @return The Logger Properties Pointer
          */
         const util::Properties& getProperties() const {
             return properties;

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/logging/Logger.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/logging/Logger.h b/activemq-cpp/src/main/decaf/util/logging/Logger.h
index a387f09..e0411a3 100644
--- a/activemq-cpp/src/main/decaf/util/logging/Logger.h
+++ b/activemq-cpp/src/main/decaf/util/logging/Logger.h
@@ -190,7 +190,7 @@ namespace logging{
         /**
          * Gets a vector containing all the handlers that this class
          * has been assigned to use.
-         * @returns a list of handlers that are used by this logger
+         * @return a list of handlers that are used by this logger
          */
         const std::list<Handler*>& getHandlers() const;
 
@@ -490,7 +490,7 @@ namespace logging{
          * by this logger. This check is based on the Loggers effective
          * level, which may be inherited from its parent.
          * @param level - a message logging level
-         * @returns true if the given message level is currently being logged.
+         * @return true if the given message level is currently being logged.
          */
         virtual bool isLoggable( const Level& level ) const;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/zip/Adler32.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/zip/Adler32.h b/activemq-cpp/src/main/decaf/util/zip/Adler32.h
index 1d8d2fe..677c827 100644
--- a/activemq-cpp/src/main/decaf/util/zip/Adler32.h
+++ b/activemq-cpp/src/main/decaf/util/zip/Adler32.h
@@ -43,7 +43,7 @@ namespace zip {
         virtual ~Adler32();
 
         /**
-         * @returns the current checksum value.
+         * @return the current checksum value.
          */
         virtual long long getValue() const;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/zip/CheckedOutputStream.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/zip/CheckedOutputStream.h b/activemq-cpp/src/main/decaf/util/zip/CheckedOutputStream.h
index 870ddf8..f6da719 100644
--- a/activemq-cpp/src/main/decaf/util/zip/CheckedOutputStream.h
+++ b/activemq-cpp/src/main/decaf/util/zip/CheckedOutputStream.h
@@ -63,7 +63,7 @@ namespace zip {
         virtual ~CheckedOutputStream();
 
         /**
-         * @returns a pointer to the Checksum instance in use by this object.
+         * @return a pointer to the Checksum instance in use by this object.
          */
         Checksum* getChecksum() const {
             return this->sum;

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/zip/Checksum.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/zip/Checksum.h b/activemq-cpp/src/main/decaf/util/zip/Checksum.h
index 0cb0d2a..109a4f7 100644
--- a/activemq-cpp/src/main/decaf/util/zip/Checksum.h
+++ b/activemq-cpp/src/main/decaf/util/zip/Checksum.h
@@ -40,7 +40,7 @@ namespace zip {
         virtual ~Checksum();
 
         /**
-         * @returns the current checksum value.
+         * @return the current checksum value.
          */
         virtual long long getValue() const = 0;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/zip/Deflater.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/zip/Deflater.h b/activemq-cpp/src/main/decaf/util/zip/Deflater.h
index 6e0b59e..22cb556 100644
--- a/activemq-cpp/src/main/decaf/util/zip/Deflater.h
+++ b/activemq-cpp/src/main/decaf/util/zip/Deflater.h
@@ -277,7 +277,7 @@ namespace zip {
          * @param length
          *      The maximum number of byte of data to write.
          *
-         * @returns the actual number of bytes of compressed data.
+         * @return the actual number of bytes of compressed data.
          *
          * @throws NullPointerException if buffer is NULL.
          * @throws IndexOutOfBoundsException if the offset + length > size of the buffer.
@@ -297,7 +297,7 @@ namespace zip {
          * @param length
          *      The maximum number of byte of data to write.
          *
-         * @returns the actual number of bytes of compressed data.
+         * @return the actual number of bytes of compressed data.
          *
          * @throws IndexOutOfBoundsException if the offset + length > size of the buffer.
          * @throws IllegalStateException if in the end state.
@@ -312,21 +312,21 @@ namespace zip {
          * @param buffer
          *      The Buffer to write the compressed data to.
          *
-         * @returns the actual number of bytes of compressed data.
+         * @return the actual number of bytes of compressed data.
          *
          * @throws IllegalStateException if in the end state.
          */
         int deflate(std::vector<unsigned char>& buffer);
 
         /**
-         * @returns the ADLER-32 value of the uncompressed data.
+         * @return the ADLER-32 value of the uncompressed data.
          *
          * @throws IllegalStateException if in the end state.
          */
         long long getAdler() const;
 
         /**
-         * @returns the total number of uncompressed bytes input so far.
+         * @return the total number of uncompressed bytes input so far.
          *
          * @throws IllegalStateException if in the end state.
          */

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/util/zip/Inflater.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/util/zip/Inflater.h b/activemq-cpp/src/main/decaf/util/zip/Inflater.h
index 31e0262..d1ca564 100644
--- a/activemq-cpp/src/main/decaf/util/zip/Inflater.h
+++ b/activemq-cpp/src/main/decaf/util/zip/Inflater.h
@@ -132,7 +132,7 @@ namespace zip {
          * Returns the total number of bytes remaining in the input buffer. This can be used
to
          * find out what bytes still remain in the input buffer after decompression has finished.
          *
-         * @returns the total number of bytes remaining in the input buffer
+         * @return the total number of bytes remaining in the input buffer
          */
         int getRemaining() const;
 
@@ -201,7 +201,7 @@ namespace zip {
         bool needsInput() const;
 
         /**
-         * @returns true if a preset dictionary is needed for decompression.
+         * @return true if a preset dictionary is needed for decompression.
          */
         bool needsDictionary() const;
 
@@ -272,14 +272,14 @@ namespace zip {
         int inflate(std::vector<unsigned char>& buffer);
 
         /**
-         * @returns the ADLER-32 value of the uncompressed data.
+         * @return the ADLER-32 value of the uncompressed data.
          *
          * @throws IllegalStateException if in the end state.
          */
         long long getAdler() const;
 
         /**
-         * @returns the total number of compressed bytes input so far.
+         * @return the total number of compressed bytes input so far.
          *
          * @throws IllegalStateException if in the end state.
          */

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/test-benchmarks/benchmark/PerformanceTimer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/test-benchmarks/benchmark/PerformanceTimer.h b/activemq-cpp/src/test-benchmarks/benchmark/PerformanceTimer.h
index edeafd2..00dc8b8 100644
--- a/activemq-cpp/src/test-benchmarks/benchmark/PerformanceTimer.h
+++ b/activemq-cpp/src/test-benchmarks/benchmark/PerformanceTimer.h
@@ -61,7 +61,7 @@ namespace benchmark{
 
         /**
          * Gets the number of runs made so far
-         * @returns unsigned int that counts the number of runs
+         * @return unsigned int that counts the number of runs
          */
         long long getNumberOfRuns() const {
             return numberOfRuns;
@@ -70,7 +70,7 @@ namespace benchmark{
         /**
          * Gets the overall average time that the count has recoreded
          * for all start / stop cycles.
-         * @returns the average time for all the runs times / numberOfRuns
+         * @return the average time for all the runs times / numberOfRuns
          */
         long long getAverageTime() const;
 

http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/test-integration/activemq/test/CMSTestFixture.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/test-integration/activemq/test/CMSTestFixture.h b/activemq-cpp/src/test-integration/activemq/test/CMSTestFixture.h
index f128f55..57e8c96 100644
--- a/activemq-cpp/src/test-integration/activemq/test/CMSTestFixture.h
+++ b/activemq-cpp/src/test-integration/activemq/test/CMSTestFixture.h
@@ -47,7 +47,7 @@ namespace test {
         /**
          * Return the URL for the Broker that is customized for the
          * test in question.
-         * @returns the BrokerURL string for this test.
+         * @return the BrokerURL string for this test.
          */
         virtual std::string getBrokerURL() const = 0;
 


Mime
View raw message