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:18 UTC
[9/9] activemq-cpp git commit: Fix some documentation generation
issues.
Fix some documentation generation issues.
Project: http://git-wip-us.apache.org/repos/asf/activemq-cpp/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-cpp/commit/cb372c07
Tree: http://git-wip-us.apache.org/repos/asf/activemq-cpp/tree/cb372c07
Diff: http://git-wip-us.apache.org/repos/asf/activemq-cpp/diff/cb372c07
Branch: refs/heads/master
Commit: cb372c077d75899a85caf2cce8681e91256d1807
Parents: e058de2
Author: Timothy Bish <ta...@gmail.com>
Authored: Wed Aug 5 18:47:49 2015 -0400
Committer: Timothy Bish <ta...@gmail.com>
Committed: Wed Aug 5 18:47:49 2015 -0400
----------------------------------------------------------------------
.../activemq/commands/ActiveMQBlobMessage.h | 6 +-
.../activemq/commands/ActiveMQDestination.h | 12 +--
.../main/activemq/commands/ActiveMQMapMessage.h | 2 +-
.../activemq/commands/ActiveMQTempDestination.h | 4 +-
.../src/main/activemq/commands/BaseCommand.h | 2 +-
.../src/main/activemq/commands/BrokerError.h | 12 +--
.../src/main/activemq/commands/DataStructure.h | 4 +-
.../src/main/activemq/commands/Message.h | 12 +--
.../src/main/activemq/commands/WireFormatInfo.h | 4 +-
.../src/main/activemq/core/ActiveMQConnection.h | 36 +++----
.../activemq/core/ActiveMQConnectionFactory.h | 34 +++----
.../src/main/activemq/core/ActiveMQConsumer.h | 12 +--
.../activemq/core/ActiveMQDestinationEvent.h | 2 +-
.../main/activemq/core/ActiveMQMessageAudit.h | 6 +-
.../src/main/activemq/core/ActiveMQProducer.h | 4 +-
.../src/main/activemq/core/ActiveMQSession.h | 4 +-
.../activemq/core/ActiveMQSessionExecutor.h | 2 +-
.../activemq/core/ActiveMQTransactionContext.h | 4 +-
.../src/main/activemq/core/Dispatcher.h | 2 +-
.../src/main/activemq/core/PrefetchPolicy.h | 10 +-
.../src/main/activemq/core/RedeliveryPolicy.h | 4 +-
.../core/kernels/ActiveMQConsumerKernel.h | 16 +--
.../core/kernels/ActiveMQProducerKernel.h | 8 +-
.../core/kernels/ActiveMQSessionKernel.h | 18 ++--
.../main/activemq/exceptions/BrokerException.h | 2 +-
.../transport/AbstractTransportFactory.h | 2 +-
.../src/main/activemq/transport/Transport.h | 8 +-
.../main/activemq/transport/TransportRegistry.h | 4 +-
.../discovery/AbstractDiscoveryAgent.h | 18 ++--
.../discovery/AbstractDiscoveryAgentFactory.h | 4 +-
.../transport/discovery/DiscoveredBrokerData.h | 8 +-
.../transport/discovery/DiscoveryAgentFactory.h | 2 +-
.../discovery/DiscoveryAgentRegistry.h | 4 +-
.../transport/discovery/DiscoveryTransport.h | 4 +-
.../discovery/http/HttpDiscoveryAgent.h | 4 +-
.../transport/failover/BackupTransport.h | 6 +-
.../transport/failover/BackupTransportPool.h | 2 +-
.../transport/failover/FailoverTransport.h | 2 +-
.../main/activemq/transport/failover/URIPool.h | 16 +--
.../src/main/activemq/util/AdvisorySupport.h | 60 +++++------
.../src/main/activemq/util/IdGenerator.h | 8 +-
.../main/activemq/util/LongSequenceGenerator.h | 4 +-
.../src/main/activemq/util/MarshallingSupport.h | 4 +-
.../src/main/activemq/util/PrimitiveList.h | 2 +-
.../src/main/activemq/util/PrimitiveMap.h | 24 ++---
.../src/main/activemq/util/URISupport.h | 4 +-
.../src/main/activemq/wireformat/MarshalAware.h | 2 +-
.../src/main/activemq/wireformat/WireFormat.h | 8 +-
.../activemq/wireformat/WireFormatRegistry.h | 4 +-
.../wireformat/openwire/OpenWireFormat.h | 8 +-
.../openwire/marshal/BaseDataStreamMarshaller.h | 50 +++++-----
.../openwire/marshal/DataStreamMarshaller.h | 4 +-
.../wireformat/openwire/utils/BooleanStream.h | 4 +-
.../wireformat/openwire/utils/HexTable.h | 4 +-
.../activemq/wireformat/stomp/StompHelper.h | 2 +-
.../activemq/wireformat/stomp/StompWireFormat.h | 6 +-
activemq-cpp/src/main/cms/BytesMessage.h | 26 ++---
activemq-cpp/src/main/cms/CMSException.h | 4 +-
activemq-cpp/src/main/cms/CMSProperties.h | 8 +-
activemq-cpp/src/main/cms/Connection.h | 4 +-
activemq-cpp/src/main/cms/ConnectionFactory.h | 4 +-
activemq-cpp/src/main/cms/ConnectionMetaData.h | 16 +--
activemq-cpp/src/main/cms/Destination.h | 2 +-
activemq-cpp/src/main/cms/DestinationEvent.h | 6 +-
activemq-cpp/src/main/cms/DestinationSource.h | 10 +-
activemq-cpp/src/main/cms/MapMessage.h | 4 +-
activemq-cpp/src/main/cms/Message.h | 2 +-
activemq-cpp/src/main/cms/MessageConsumer.h | 2 +-
activemq-cpp/src/main/cms/MessageProducer.h | 2 +-
activemq-cpp/src/main/cms/MessageTransformer.h | 4 +-
activemq-cpp/src/main/cms/ObjectMessage.h | 2 +-
activemq-cpp/src/main/cms/QueueBrowser.h | 6 +-
activemq-cpp/src/main/cms/Session.h | 2 +-
activemq-cpp/src/main/cms/StreamMessage.h | 26 ++---
activemq-cpp/src/main/cms/XAConnection.h | 2 +-
activemq-cpp/src/main/cms/XAConnectionFactory.h | 4 +-
activemq-cpp/src/main/cms/XAException.h | 2 +-
activemq-cpp/src/main/cms/XASession.h | 2 +-
activemq-cpp/src/main/cms/Xid.h | 4 +-
activemq-cpp/src/main/decaf/internal/AprPool.h | 2 +-
.../src/main/decaf/internal/DecafRuntime.h | 2 +-
.../src/main/decaf/internal/net/Network.h | 2 +-
.../src/main/decaf/internal/net/URIHelper.h | 4 +-
.../src/main/decaf/internal/net/URIType.h | 6 +-
.../internal/net/URLStreamHandlerManager.h | 4 +-
.../src/main/decaf/internal/net/URLType.h | 2 +-
.../src/main/decaf/internal/net/URLUtils.h | 10 +-
.../internal/net/ssl/openssl/OpenSSLSocket.h | 2 +-
.../net/ssl/openssl/OpenSSLSocketException.h | 2 +-
.../src/main/decaf/internal/net/tcp/TcpSocket.h | 4 +-
.../src/main/decaf/internal/nio/BufferFactory.h | 42 ++++----
.../src/main/decaf/internal/security/Engine.h | 4 +-
.../decaf/internal/security/SecurityRuntime.h | 4 +-
.../decaf/internal/security/ServiceRegistry.h | 2 +-
.../main/decaf/internal/util/ByteArrayAdapter.h | 62 ++++++------
.../main/decaf/internal/util/HexStringParser.h | 8 +-
.../src/main/decaf/internal/util/StringUtils.h | 6 +-
.../main/decaf/internal/util/TimerTaskHeap.h | 6 +-
.../internal/util/concurrent/ThreadLocalImpl.h | 2 +-
.../decaf/internal/util/concurrent/Threading.h | 18 ++--
.../src/main/decaf/io/ByteArrayOutputStream.h | 2 +-
activemq-cpp/src/main/decaf/io/DataInput.h | 24 ++---
.../src/main/decaf/io/DataInputStream.h | 24 ++---
.../src/main/decaf/io/FilterInputStream.h | 2 +-
.../src/main/decaf/io/FilterOutputStream.h | 2 +-
activemq-cpp/src/main/decaf/io/InputStream.h | 4 +-
.../src/main/decaf/lang/AbstractStringBuilder.h | 18 ++--
activemq-cpp/src/main/decaf/lang/Appendable.h | 6 +-
activemq-cpp/src/main/decaf/lang/ArrayPointer.h | 4 +-
activemq-cpp/src/main/decaf/lang/Boolean.h | 12 +--
activemq-cpp/src/main/decaf/lang/Byte.h | 14 +--
activemq-cpp/src/main/decaf/lang/CharSequence.h | 8 +-
activemq-cpp/src/main/decaf/lang/Character.h | 22 ++--
activemq-cpp/src/main/decaf/lang/Comparable.h | 2 +-
activemq-cpp/src/main/decaf/lang/Double.h | 30 +++---
activemq-cpp/src/main/decaf/lang/Exception.h | 2 +-
activemq-cpp/src/main/decaf/lang/Float.h | 30 +++---
activemq-cpp/src/main/decaf/lang/Integer.h | 20 ++--
activemq-cpp/src/main/decaf/lang/Iterable.h | 2 +-
activemq-cpp/src/main/decaf/lang/Long.h | 18 ++--
activemq-cpp/src/main/decaf/lang/Math.h | 52 +++++-----
activemq-cpp/src/main/decaf/lang/Pointer.h | 2 +-
activemq-cpp/src/main/decaf/lang/Runtime.h | 2 +-
activemq-cpp/src/main/decaf/lang/Short.h | 12 +--
activemq-cpp/src/main/decaf/lang/String.h | 52 +++++-----
activemq-cpp/src/main/decaf/lang/StringBuffer.h | 64 ++++++------
.../src/main/decaf/lang/StringBuilder.h | 64 ++++++------
activemq-cpp/src/main/decaf/lang/System.h | 18 ++--
activemq-cpp/src/main/decaf/lang/Thread.h | 10 +-
activemq-cpp/src/main/decaf/lang/ThreadLocal.h | 2 +-
activemq-cpp/src/main/decaf/lang/Throwable.h | 2 +-
.../src/main/decaf/net/DatagramPacket.h | 2 +-
activemq-cpp/src/main/decaf/net/InetAddress.h | 10 +-
activemq-cpp/src/main/decaf/net/ServerSocket.h | 8 +-
activemq-cpp/src/main/decaf/net/Socket.h | 20 ++--
activemq-cpp/src/main/decaf/net/SocketFactory.h | 2 +-
activemq-cpp/src/main/decaf/net/SocketImpl.h | 20 ++--
activemq-cpp/src/main/decaf/net/URI.h | 50 +++++-----
.../src/main/decaf/net/URISyntaxException.h | 6 +-
activemq-cpp/src/main/decaf/net/URL.h | 38 +++----
activemq-cpp/src/main/decaf/net/URLEncoder.h | 2 +-
.../src/main/decaf/net/URLStreamHandler.h | 10 +-
.../src/main/decaf/net/ssl/SSLContext.h | 6 +-
.../src/main/decaf/net/ssl/SSLContextSpi.h | 8 +-
.../src/main/decaf/net/ssl/SSLParameters.h | 10 +-
.../src/main/decaf/net/ssl/SSLServerSocket.h | 8 +-
.../main/decaf/net/ssl/SSLServerSocketFactory.h | 6 +-
activemq-cpp/src/main/decaf/net/ssl/SSLSocket.h | 6 +-
.../src/main/decaf/net/ssl/SSLSocketFactory.h | 8 +-
activemq-cpp/src/main/decaf/nio/Buffer.h | 26 ++---
activemq-cpp/src/main/decaf/nio/ByteBuffer.h | 100 +++++++++----------
activemq-cpp/src/main/decaf/nio/CharBuffer.h | 60 +++++------
activemq-cpp/src/main/decaf/nio/DoubleBuffer.h | 38 +++----
activemq-cpp/src/main/decaf/nio/FloatBuffer.h | 38 +++----
activemq-cpp/src/main/decaf/nio/IntBuffer.h | 38 +++----
activemq-cpp/src/main/decaf/nio/LongBuffer.h | 38 +++----
activemq-cpp/src/main/decaf/nio/ShortBuffer.h | 38 +++----
.../src/main/decaf/security/MessageDigest.h | 18 ++--
.../src/main/decaf/security/MessageDigestSpi.h | 10 +-
.../src/main/decaf/security/ProviderService.h | 4 +-
.../src/main/decaf/util/AbstractCollection.h | 2 +-
activemq-cpp/src/main/decaf/util/BitSet.h | 22 ++--
activemq-cpp/src/main/decaf/util/Collection.h | 18 ++--
activemq-cpp/src/main/decaf/util/Comparator.h | 2 +-
activemq-cpp/src/main/decaf/util/Deque.h | 26 ++---
activemq-cpp/src/main/decaf/util/Iterator.h | 4 +-
activemq-cpp/src/main/decaf/util/LRUCache.h | 2 +-
activemq-cpp/src/main/decaf/util/Map.h | 8 +-
activemq-cpp/src/main/decaf/util/Properties.h | 10 +-
activemq-cpp/src/main/decaf/util/Timer.h | 2 +-
activemq-cpp/src/main/decaf/util/TimerTask.h | 4 +-
activemq-cpp/src/main/decaf/util/UUID.h | 18 ++--
.../util/concurrent/BrokenBarrierException.h | 2 +-
.../src/main/decaf/util/concurrent/Callable.h | 2 +-
.../util/concurrent/CancellationException.h | 2 +-
.../util/concurrent/CopyOnWriteArrayList.h | 8 +-
.../main/decaf/util/concurrent/CountDownLatch.h | 4 +-
.../src/main/decaf/util/concurrent/Delayed.h | 2 +-
.../decaf/util/concurrent/ExecutionException.h | 2 +-
.../decaf/util/concurrent/ExecutorService.h | 2 +-
.../src/main/decaf/util/concurrent/Executors.h | 16 +--
.../src/main/decaf/util/concurrent/Future.h | 10 +-
.../src/main/decaf/util/concurrent/Semaphore.h | 22 ++--
.../main/decaf/util/concurrent/ThreadFactory.h | 2 +-
.../decaf/util/concurrent/ThreadPoolExecutor.h | 14 +--
.../src/main/decaf/util/concurrent/TimeUnit.h | 4 +-
.../util/concurrent/atomic/AtomicBoolean.h | 8 +-
.../util/concurrent/atomic/AtomicInteger.h | 28 +++---
.../util/concurrent/atomic/AtomicReference.h | 2 +-
.../locks/AbstractQueuedSynchronizer.h | 48 ++++-----
.../decaf/util/concurrent/locks/Condition.h | 6 +-
.../src/main/decaf/util/concurrent/locks/Lock.h | 8 +-
.../decaf/util/concurrent/locks/ReadWriteLock.h | 4 +-
.../decaf/util/concurrent/locks/ReentrantLock.h | 28 +++---
.../concurrent/locks/ReentrantReadWriteLock.h | 6 +-
.../src/main/decaf/util/logging/Filter.h | 2 +-
.../src/main/decaf/util/logging/Formatter.h | 4 +-
.../src/main/decaf/util/logging/Handler.h | 8 +-
.../src/main/decaf/util/logging/LogManager.h | 2 +-
.../src/main/decaf/util/logging/Logger.h | 4 +-
activemq-cpp/src/main/decaf/util/zip/Adler32.h | 2 +-
.../main/decaf/util/zip/CheckedOutputStream.h | 2 +-
activemq-cpp/src/main/decaf/util/zip/Checksum.h | 2 +-
activemq-cpp/src/main/decaf/util/zip/Deflater.h | 10 +-
activemq-cpp/src/main/decaf/util/zip/Inflater.h | 8 +-
.../benchmark/PerformanceTimer.h | 4 +-
.../activemq/test/CMSTestFixture.h | 2 +-
207 files changed, 1197 insertions(+), 1197 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/ActiveMQBlobMessage.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/ActiveMQBlobMessage.h b/activemq-cpp/src/main/activemq/commands/ActiveMQBlobMessage.h
index 2b6e5b7..0bc960d 100644
--- a/activemq-cpp/src/main/activemq/commands/ActiveMQBlobMessage.h
+++ b/activemq-cpp/src/main/activemq/commands/ActiveMQBlobMessage.h
@@ -69,7 +69,7 @@ namespace commands {
/**
* Get the Remote URL of the Blob.
- * @returns string from of the Remote Blob URL.
+ * @return string from of the Remote Blob URL.
*/
std::string getRemoteBlobUrl() const {
return this->remoteBlobUrl;
@@ -85,7 +85,7 @@ namespace commands {
/**
* Get the Mime Type of the Blob.
- * @returns string holding the MIME Type.
+ * @return string holding the MIME Type.
*/
std::string getMimeType() const {
return this->mimeType;
@@ -101,7 +101,7 @@ namespace commands {
/**
* Gets the Name of the Blob.
- * @returns string name of the Blob.
+ * @return string name of the Blob.
*/
std::string getName() const {
return this->name;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/ActiveMQDestination.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/ActiveMQDestination.h b/activemq-cpp/src/main/activemq/commands/ActiveMQDestination.h
index ba6d9d8..3a78912 100644
--- a/activemq-cpp/src/main/activemq/commands/ActiveMQDestination.h
+++ b/activemq-cpp/src/main/activemq/commands/ActiveMQDestination.h
@@ -110,7 +110,7 @@ namespace commands {
/**
* Fetch this destination's physical name
- * @returns const string containing the name
+ * @return const string containing the name
*/
virtual std::string getPhysicalName() const {
return this->physicalName;
@@ -118,7 +118,7 @@ namespace commands {
/**
* Set this destination's physical name
- * @returns const string containing the name
+ * @return const string containing the name
*/
virtual void setPhysicalName(const std::string& physicalName);
@@ -180,7 +180,7 @@ namespace commands {
/**
* Returns the Type of Destination that this object represents
- * @returns int type qualifier.
+ * @return int type qualifier.
*/
virtual cms::Destination::DestinationType getDestinationType() const = 0;
@@ -188,7 +188,7 @@ namespace commands {
* Returns the type of Destination that this object represents as a string, the
* available string values are, "Queue", "Topic", "TempQueue" and "TempTopic".
*
- * @returns The string value that represents the type of this destination.
+ * @return The string value that represents the type of this destination.
*/
std::string getDestinationTypeAsString() const;
@@ -246,14 +246,14 @@ namespace commands {
}
/**
- * @returns a reference (const) to the options properties for this Destination.
+ * @return a reference (const) to the options properties for this Destination.
*/
const activemq::util::ActiveMQProperties& getOptions() const {
return options;
}
/**
- * @returns the cms::Destination interface pointer that the
+ * @return the cms::Destination interface pointer that the
* objects that derive from this class implement.
*/
virtual const cms::Destination* getCMSDestination() const {
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/ActiveMQMapMessage.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/ActiveMQMapMessage.h b/activemq-cpp/src/main/activemq/commands/ActiveMQMapMessage.h
index f30ddbe..7064342 100644
--- a/activemq-cpp/src/main/activemq/commands/ActiveMQMapMessage.h
+++ b/activemq-cpp/src/main/activemq/commands/ActiveMQMapMessage.h
@@ -129,7 +129,7 @@ namespace commands {
* Fetches a reference to this objects PrimitiveMap, if one needs
* to be created or unmarshaled, this will perform the correct steps.
*
- * @returns reference to a PrimtiveMap;
+ * @return reference to a PrimtiveMap;
*
* @throws NullPointerException if the internal Map is Null.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/ActiveMQTempDestination.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/ActiveMQTempDestination.h b/activemq-cpp/src/main/activemq/commands/ActiveMQTempDestination.h
index 11cfe18..c89e25b 100644
--- a/activemq-cpp/src/main/activemq/commands/ActiveMQTempDestination.h
+++ b/activemq-cpp/src/main/activemq/commands/ActiveMQTempDestination.h
@@ -121,14 +121,14 @@ namespace commands{
/**
* Retrieves the Parent Connection that created this Connection.
*
- * @returns pointer to a Connection if one was set, false otherwise.
+ * @return pointer to a Connection if one was set, false otherwise.
*/
core::ActiveMQConnection* getConnection() const {
return this->connection;
}
/**
- * @returns the connection Id of the Connection that created this temporary destination.
+ * @return the connection Id of the Connection that created this temporary destination.
*/
std::string getConnectionId() const {
return this->connectionId;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/BaseCommand.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/BaseCommand.h b/activemq-cpp/src/main/activemq/commands/BaseCommand.h
index 684c613..247ebb0 100644
--- a/activemq-cpp/src/main/activemq/commands/BaseCommand.h
+++ b/activemq-cpp/src/main/activemq/commands/BaseCommand.h
@@ -80,7 +80,7 @@ namespace commands {
* Compares the DataStructure passed in to this one, and returns if
* they are equivalent. Equivalent here means that they are of the
* same type, and that each element of the objects are the same.
- * @returns true if DataStructure's are Equal.
+ * @return true if DataStructure's are Equal.
*/
virtual bool equals(const DataStructure* value) const {
return BaseDataStructure::equals(value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/BrokerError.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/BrokerError.h b/activemq-cpp/src/main/activemq/commands/BrokerError.h
index c3a106e..5984e43 100644
--- a/activemq-cpp/src/main/activemq/commands/BrokerError.h
+++ b/activemq-cpp/src/main/activemq/commands/BrokerError.h
@@ -74,7 +74,7 @@ namespace commands {
/**
* Clone this object and return a new instance that the
* caller now owns, this will be an exact copy of this one
- * @returns new copy of this object.
+ * @return new copy of this object.
*/
virtual BrokerError* cloneDataStructure() const {
BrokerError* error = new BrokerError();
@@ -100,7 +100,7 @@ namespace commands {
/**
* Gets the string holding the error message
- * @returns String Message
+ * @return String Message
*/
virtual const std::string& getMessage() const {
return message;
@@ -116,7 +116,7 @@ namespace commands {
/**
* Gets the string holding the Exception Class name
- * @returns Exception Class name
+ * @return Exception Class name
*/
virtual const std::string& getExceptionClass() const {
return exceptionClass;
@@ -132,7 +132,7 @@ namespace commands {
/**
* Gets the Broker Error that caused this exception
- * @returns Broker Error Pointer
+ * @return Broker Error Pointer
*/
virtual const decaf::lang::Pointer<BrokerError>& getCause() const {
return cause;
@@ -148,7 +148,7 @@ namespace commands {
/**
* Gets the Stack Trace Elements for the Exception
- * @returns Stack Trace Elements
+ * @return Stack Trace Elements
*/
virtual const std::vector<decaf::lang::Pointer<StackTraceElement> >& getStackTraceElements() const {
return stackTraceElements;
@@ -163,7 +163,7 @@ namespace commands {
}
/**
- * @returns the local Exception that was the source of this BrokerError instance
+ * @return the local Exception that was the source of this BrokerError instance
*/
decaf::lang::Pointer<decaf::lang::Exception> getLocalException() const {
return this->exCause;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/DataStructure.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/DataStructure.h b/activemq-cpp/src/main/activemq/commands/DataStructure.h
index a2cd544..b3319e1 100644
--- a/activemq-cpp/src/main/activemq/commands/DataStructure.h
+++ b/activemq-cpp/src/main/activemq/commands/DataStructure.h
@@ -38,7 +38,7 @@ namespace commands{
/**
* Clone this obbject and return a new instance that the
* caller now owns, this will be an exact copy of this one
- * @returns new copy of this object.
+ * @return new copy of this object.
*/
virtual DataStructure* cloneDataStructure() const = 0;
@@ -60,7 +60,7 @@ namespace commands{
* Compares the DataStructure passed in to this one, and returns if
* they are equivalent. Equivalent here means that they are of the
* same type, and that each element of the objects are the same.
- * @returns true if DataStructure's are Equal.
+ * @return true if DataStructure's are Equal.
*/
virtual bool equals( const DataStructure* value ) const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/Message.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/Message.h b/activemq-cpp/src/main/activemq/commands/Message.h
index bc5de7f..611f232 100644
--- a/activemq-cpp/src/main/activemq/commands/Message.h
+++ b/activemq-cpp/src/main/activemq/commands/Message.h
@@ -143,7 +143,7 @@ namespace commands{
*
* Pointer<cms::Message> cmsMsg = message->copy().dynamic_cast<cms::Message>();
*
- * @returns a Pointer<Message> which is a duplicate of this object.
+ * @return a Pointer<Message> which is a duplicate of this object.
*/
Pointer<Message> copy() const {
return Pointer<Message>(this->cloneDataStructure());
@@ -167,7 +167,7 @@ namespace commands{
/**
* Indicates that this command is aware of Marshaling, and needs
* to have its Marshaling methods invoked.
- * @returns boolean indicating desire to be in marshaling stages
+ * @return boolean indicating desire to be in marshaling stages
*/
virtual bool isMarshalAware() const {
return true;
@@ -185,7 +185,7 @@ namespace commands{
/**
* Gets the Acknowledgment Handler that this Message will use
* when the Acknowledge method is called.
- * @returns handler ActiveMQAckHandler to call or NULL if not set
+ * @return handler ActiveMQAckHandler to call or NULL if not set
*/
virtual Pointer<core::ActiveMQAckHandler> getAckHandler() const {
return this->ackHandler;
@@ -203,7 +203,7 @@ namespace commands{
/**
* Gets the ActiveMQConnection instance that this Command was created from
* when the session create methods are called to create a Message..
- * @returns the ActiveMQConnection parent for this Message or NULL if not set.
+ * @return the ActiveMQConnection parent for this Message or NULL if not set.
*/
core::ActiveMQConnection* getConnection() const {
return this->connection;
@@ -211,14 +211,14 @@ namespace commands{
/**
* Returns the Size of this message in Bytes.
- * @returns number of bytes this message equates to.
+ * @return number of bytes this message equates to.
*/
virtual unsigned int getSize() const;
/**
* Returns if this message has expired, meaning that its
* Expiration time has elapsed.
- * @returns true if message is expired.
+ * @return true if message is expired.
*/
virtual bool isExpired() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/commands/WireFormatInfo.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/commands/WireFormatInfo.h b/activemq-cpp/src/main/activemq/commands/WireFormatInfo.h
index 3fffc4a..05f9898 100644
--- a/activemq-cpp/src/main/activemq/commands/WireFormatInfo.h
+++ b/activemq-cpp/src/main/activemq/commands/WireFormatInfo.h
@@ -244,12 +244,12 @@ namespace commands{
/**
* Determines if we think this is a Valid WireFormatInfo command
- * @returns true if its valid.
+ * @return true if its valid.
*/
bool isValid() const;
/**
- * @returns answers true to the isWireFormatInfo query
+ * @return answers true to the isWireFormatInfo query
*/
virtual bool isWireFormatInfo() const {
return true;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h b/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
index 573a44f..cf30c0e 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
@@ -247,7 +247,7 @@ namespace core {
* @param message
* The Message that should be checked.
*
- * @returns true if the Message was seen before.
+ * @return true if the Message was seen before.
*/
bool isDuplicate(Dispatcher* dispatcher, Pointer<commands::Message> message);
@@ -399,7 +399,7 @@ namespace core {
/**
* Gets the pointer to the current PrefetchPolicy that is in use by this ConnectionFactory.
*
- * @returns a pointer to this objects PrefetchPolicy.
+ * @return a pointer to this objects PrefetchPolicy.
*/
PrefetchPolicy* getPrefetchPolicy() const;
@@ -416,7 +416,7 @@ namespace core {
/**
* Gets the pointer to the current RedeliveryPolicy that is in use by this ConnectionFactory.
*
- * @returns a pointer to this objects RedeliveryPolicy.
+ * @return a pointer to this objects RedeliveryPolicy.
*/
RedeliveryPolicy* getRedeliveryPolicy() const;
@@ -451,7 +451,7 @@ namespace core {
/**
* Gets if the useAsyncSend option is set
- * @returns true if on false if not.
+ * @return true if on false if not.
*/
bool isUseAsyncSend() const;
@@ -463,7 +463,7 @@ namespace core {
/**
* Gets if the Connection is configured for Message body compression.
- * @returns if the Message body will be Compressed or not.
+ * @return if the Message body will be Compressed or not.
*/
bool isUseCompression() const;
@@ -536,7 +536,7 @@ namespace core {
void setProducerWindowSize(unsigned int windowSize);
/**
- * @returns true if the Connections that this factory creates should support the
+ * @return true if the Connections that this factory creates should support the
* message based priority settings.
*/
bool isMessagePrioritySupported() const;
@@ -585,7 +585,7 @@ namespace core {
* for duplication, and the larger the performance impact of duplicate
* detection will be.
*
- * @returns the configured audit depth.
+ * @return the configured audit depth.
*/
int getAuditDepth() const;
@@ -603,7 +603,7 @@ namespace core {
/**
* The number of Producers that will be audited.
*
- * @returns the configured number of producers to include in the audit.
+ * @return the configured number of producers to include in the audit.
*/
int getAuditMaximumProducerNumber() const;
@@ -649,7 +649,7 @@ namespace core {
* completion. This allows the acks to represent delivery status which can be persisted on
* rollback Used in conjunction with KahaDB set to Rewrite On Redelivery.
*
- * @returns true if this option is enabled.
+ * @return true if this option is enabled.
*/
bool isTransactedIndividualAck() const;
@@ -684,7 +684,7 @@ namespace core {
/**
* Gets the delay period for a consumer redelivery.
*
- * @returns configured time delay in milliseconds.
+ * @return configured time delay in milliseconds.
*/
long long getConsumerFailoverRedeliveryWaitPeriod() const;
@@ -712,7 +712,7 @@ namespace core {
/**
* Gets the time between optimized ack batches in milliseconds.
*
- * @returns time between optimized ack batches in Milliseconds.
+ * @return time between optimized ack batches in Milliseconds.
*/
long long getOptimizeAcknowledgeTimeOut() const;
@@ -748,7 +748,7 @@ namespace core {
/**
* Should all created consumers be retroactive.
*
- * @returns true if consumer will be created with the retroactive flag set.
+ * @return true if consumer will be created with the retroactive flag set.
*/
bool isUseRetroactiveConsumer() const;
@@ -765,7 +765,7 @@ namespace core {
/**
* Should all created consumers be exclusive.
*
- * @returns true if consumer will be created with the exclusive flag set.
+ * @return true if consumer will be created with the exclusive flag set.
*/
bool isExclusiveConsumer() const;
@@ -823,7 +823,7 @@ namespace core {
void setConsumerExpiryCheckEnabled(bool consumerExpiryCheckEnabled);
/**
- * @returns the current connection's OpenWire protocol version.
+ * @return the current connection's OpenWire protocol version.
*/
int getProtocolVersion() const;
@@ -911,7 +911,7 @@ namespace core {
* Returns the Id of the Resource Manager that this client will use should
* it be entered into an XA Transaction.
*
- * @returns a string containing the resource manager Id for XA Transactions.
+ * @return a string containing the resource manager Id for XA Transactions.
*/
std::string getResourceManagerId() const;
@@ -942,7 +942,7 @@ namespace core {
* @param timeout
* The time in milliseconds to wait for a response, default is zero or infinite.
*
- * @returns a Pointer instance to the Response object sent from the Broker.
+ * @return a Pointer instance to the Response object sent from the Broker.
*
* @throws BrokerException if the response from the broker is of type ExceptionResponse.
* @throws ActiveMQException if any other error occurs while sending the Command.
@@ -986,7 +986,7 @@ namespace core {
/**
* Gets the pointer to the first exception that caused the Connection to become failed.
*
- * @returns pointer to an Exception instance or NULL if none is set.
+ * @return pointer to an Exception instance or NULL if none is set.
*/
decaf::lang::Exception* getFirstFailureError() const;
@@ -1026,7 +1026,7 @@ namespace core {
void ensureConnectionInfoSent();
/**
- * @returns the ExecutorService used to run jobs for this Connection
+ * @return the ExecutorService used to run jobs for this Connection
*/
decaf::util::concurrent::ExecutorService* getExecutor() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQConnectionFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQConnectionFactory.h b/activemq-cpp/src/main/activemq/core/ActiveMQConnectionFactory.h
index 97b54d9..7fd0918 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQConnectionFactory.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQConnectionFactory.h
@@ -92,7 +92,7 @@ namespace core {
* delivered until the Connection.start method is explicitly
* called.
*
- * @returns a Connection Pointer
+ * @return a Connection Pointer
*
* @throws CMSException if an error occurs.
*/
@@ -112,7 +112,7 @@ namespace core {
* @param password
* The password to authenticate with this connection.
*
- * @returns a Connection Pointer
+ * @return a Connection Pointer
*
* @throws CMSSecurityException if the user credentials are invalid.
* @throws CMSException if an error occurs.
@@ -137,7 +137,7 @@ namespace core {
* The client Id to assign to connection if "" then a random client
* Id is created for this connection.
*
- * @returns a Connection Pointer
+ * @return a Connection Pointer
*
* @throws CMSSecurityException if the user credentials are invalid.
* @throws CMSException if an error occurs.
@@ -239,7 +239,7 @@ namespace core {
/**
* Gets the currently configured MessageTransformer for this ConnectionFactory.
*
- * @returns the pointer to the currently set cms::MessageTransformer.
+ * @return the pointer to the currently set cms::MessageTransformer.
*/
virtual cms::MessageTransformer* getMessageTransformer() const;
@@ -256,7 +256,7 @@ namespace core {
/**
* Gets the pointer to the current PrefetchPolicy that is in use by this ConnectionFactory.
*
- * @returns a pointer to this objects PrefetchPolicy.
+ * @return a pointer to this objects PrefetchPolicy.
*/
PrefetchPolicy* getPrefetchPolicy() const;
@@ -273,7 +273,7 @@ namespace core {
/**
* Gets the pointer to the current RedeliveryPolicy that is in use by this ConnectionFactory.
*
- * @returns a pointer to this objects RedeliveryPolicy.
+ * @return a pointer to this objects RedeliveryPolicy.
*/
RedeliveryPolicy* getRedeliveryPolicy() const;
@@ -308,7 +308,7 @@ namespace core {
/**
* Gets if the useAsyncSend option is set
- * @returns true if on false if not.
+ * @return true if on false if not.
*/
bool isUseAsyncSend() const;
@@ -337,7 +337,7 @@ namespace core {
/**
* Gets if the Connection is configured for Message body compression.
- * @returns if the Message body will be Compressed or not.
+ * @return if the Message body will be Compressed or not.
*/
bool isUseCompression() const;
@@ -410,7 +410,7 @@ namespace core {
void setProducerWindowSize(unsigned int windowSize);
/**
- * @returns true if the Connections that this factory creates should support the
+ * @return true if the Connections that this factory creates should support the
* message based priority settings.
*/
bool isMessagePrioritySupported() const;
@@ -427,7 +427,7 @@ namespace core {
/**
* Should all created consumers be retroactive.
*
- * @returns true if consumer will be created with the retroactive flag set.
+ * @return true if consumer will be created with the retroactive flag set.
*/
bool isUseRetroactiveConsumer() const;
@@ -444,7 +444,7 @@ namespace core {
/**
* Should all created consumers be exclusive.
*
- * @returns true if consumer will be created with the exclusive flag set.
+ * @return true if consumer will be created with the exclusive flag set.
*/
bool isExclusiveConsumer() const;
@@ -480,7 +480,7 @@ namespace core {
* for duplication, and the larger the performance impact of duplicate
* detection will be.
*
- * @returns the configured audit depth.
+ * @return the configured audit depth.
*/
int getAuditDepth() const;
@@ -498,7 +498,7 @@ namespace core {
/**
* The number of Producers that will be audited.
*
- * @returns the configured number of producers to include in the audit.
+ * @return the configured number of producers to include in the audit.
*/
int getAuditMaximumProducerNumber() const;
@@ -544,7 +544,7 @@ namespace core {
* completion. This allows the acks to represent delivery status which can be persisted on
* rollback Used in conjunction with KahaDB set to Rewrite On Redelivery.
*
- * @returns true if this option is enabled.
+ * @return true if this option is enabled.
*/
bool isTransactedIndividualAck() const;
@@ -579,7 +579,7 @@ namespace core {
/**
* Gets the delay period for a consumer redelivery.
*
- * @returns configured time delay in milliseconds.
+ * @return configured time delay in milliseconds.
*/
long long getConsumerFailoverRedeliveryWaitPeriod() const;
@@ -607,7 +607,7 @@ namespace core {
/**
* Gets the time between optimized ack batches in milliseconds.
*
- * @returns time between optimized ack batches in Milliseconds.
+ * @return time between optimized ack batches in Milliseconds.
*/
long long getOptimizeAcknowledgeTimeOut() const;
@@ -705,7 +705,7 @@ namespace core {
* @param properties
* The Properties that are assigned to the new Connection instance.
*
- * @returns a new ActiveMQConnection pointer instance.
+ * @return a new ActiveMQConnection pointer instance.
*/
virtual ActiveMQConnection* createActiveMQConnection(const Pointer<transport::Transport>& transport,
const Pointer<decaf::util::Properties>& properties);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h b/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
index d845bd2..9254c8e 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
@@ -103,12 +103,12 @@ namespace core {
const Pointer<commands::ConsumerId>& getConsumerId() const;
/**
- * @returns if this Consumer has been closed.
+ * @return if this Consumer has been closed.
*/
bool isClosed() const;
/**
- * @returns the number of Message's this consumer is waiting to Dispatch.
+ * @return the number of Message's this consumer is waiting to Dispatch.
*/
int getMessageAvailableCount() const;
@@ -127,7 +127,7 @@ namespace core {
* Gets a pointer to this Consumer's Redelivery Policy object, the Consumer
* retains ownership of this pointer so the caller should not delete it.
*
- * @returns a Pointer to a RedeliveryPolicy that is in use by this Consumer.
+ * @return a Pointer to a RedeliveryPolicy that is in use by this Consumer.
*/
RedeliveryPolicy* getRedeliveryPolicy() const;
@@ -135,7 +135,7 @@ namespace core {
* Gets the error that caused this Consumer to be in a Failed state, or NULL if
* there is no Error.
*
- * @returns pointer to the error that faulted this Consumer or NULL.
+ * @return pointer to the error that faulted this Consumer or NULL.
*/
decaf::lang::Exception* getFailureError() const;
@@ -143,7 +143,7 @@ namespace core {
* Time in Milliseconds before an automatic acknowledge is done for any outstanding
* delivered Messages. A value less than one means no task is scheduled.
*
- * @returns time in milliseconds for the scheduled ack task.
+ * @return time in milliseconds for the scheduled ack task.
*/
long long getOptimizedAckScheduledAckInterval() const;
@@ -158,7 +158,7 @@ namespace core {
void setOptimizedAckScheduledAckInterval(long long value);
/**
- * @returns true if this consumer is using optimize acknowledge mode.
+ * @return true if this consumer is using optimize acknowledge mode.
*/
bool isOptimizeAcknowledge() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQDestinationEvent.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQDestinationEvent.h b/activemq-cpp/src/main/activemq/core/ActiveMQDestinationEvent.h
index 471bf1d..ffa399e 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQDestinationEvent.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQDestinationEvent.h
@@ -54,7 +54,7 @@ namespace core {
/**
* Returns the DestinationInfo object that triggered this event.
*
- * @returns the DestinationInfo object that triggered this event.
+ * @return the DestinationInfo object that triggered this event.
*/
decaf::lang::Pointer<commands::DestinationInfo> getDestinationInfo() const {
return this->destination;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQMessageAudit.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQMessageAudit.h b/activemq-cpp/src/main/activemq/core/ActiveMQMessageAudit.h
index e57f0f3..ccc6789 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQMessageAudit.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQMessageAudit.h
@@ -63,7 +63,7 @@ namespace core {
/**
* Gets the currently configured Audit Depth
*
- * @returns the current audit depth setting
+ * @return the current audit depth setting
*/
int getAuditDepth() const;
@@ -76,7 +76,7 @@ namespace core {
void setAuditDepth(int value);
/**
- * @returns the current number of producers that will be tracked.
+ * @return the current number of producers that will be tracked.
*/
int getMaximumNumberOfProducersToTrack() const;
@@ -146,7 +146,7 @@ namespace core {
bool isInOrder(decaf::lang::Pointer<commands::MessageId> msgId) const;
/**
- * @returns the last sequence Id that we've audited for the given producer.
+ * @return the last sequence Id that we've audited for the given producer.
*/
long long getLastSeqId(decaf::lang::Pointer<commands::ProducerId> id) const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h b/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h
index e69730d..5e891d0 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQProducer.h
@@ -120,7 +120,7 @@ namespace core {
/**
* Gets if Message Time Stamps are disabled for this Producer
- * @returns boolean indicating state of enable / disable (true / false)
+ * @return boolean indicating state of enable / disable (true / false)
*/
virtual bool getDisableMessageTimeStamp() const {
return this->kernel->getDisableMessageTimeStamp();
@@ -185,7 +185,7 @@ namespace core {
public:
/**
- * @returns true if this Producer has been closed.
+ * @return true if this Producer has been closed.
*/
bool isClosed() const {
return this->kernel->isClosed();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQSession.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQSession.h b/activemq-cpp/src/main/activemq/core/ActiveMQSession.h
index 626a0e8..949f6ac 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQSession.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQSession.h
@@ -142,7 +142,7 @@ namespace core {
* connection and returns it. Mainly intended for use by the objects
* that this session creates so that they can notify the client of
* exceptions that occur in the context of another thread.
- * @returns cms::ExceptionListener pointer or NULL
+ * @return cms::ExceptionListener pointer or NULL
*/
cms::ExceptionListener* getExceptionListener() {
return this->kernel->getExceptionListener();
@@ -162,7 +162,7 @@ namespace core {
/**
* Gets the currently configured MessageTransformer for this Session.
*
- * @returns the pointer to the currently set cms::MessageTransformer.
+ * @return the pointer to the currently set cms::MessageTransformer.
*/
virtual cms::MessageTransformer* getMessageTransformer() const {
return this->kernel->getMessageTransformer();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQSessionExecutor.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQSessionExecutor.h b/activemq-cpp/src/main/activemq/core/ActiveMQSessionExecutor.h
index 46fdda0..68d4e00 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQSessionExecutor.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQSessionExecutor.h
@@ -151,7 +151,7 @@ namespace kernels {
virtual bool iterate();
/**
- * @returns a vector containing all the unconsumed messages, this clears the
+ * @return a vector containing all the unconsumed messages, this clears the
* Message Dispatch Channel when called.
*/
std::vector< Pointer<MessageDispatch> > getUnconsumedMessages() {
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/ActiveMQTransactionContext.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/ActiveMQTransactionContext.h b/activemq-cpp/src/main/activemq/core/ActiveMQTransactionContext.h
index 73e6f1f..c289ef7 100644
--- a/activemq-cpp/src/main/activemq/core/ActiveMQTransactionContext.h
+++ b/activemq-cpp/src/main/activemq/core/ActiveMQTransactionContext.h
@@ -141,7 +141,7 @@ namespace kernels {
* Checks to see if there is currently an Local Transaction in progess, returns
* false if not, true otherwise.
*
- * @returns true if an Local Transaction is in progress.
+ * @return true if an Local Transaction is in progress.
*/
virtual bool isInLocalTransaction() const;
@@ -149,7 +149,7 @@ namespace kernels {
* Checks to see if there is currently an XA Transaction in progress, returns
* false if not, true otherwise.
*
- * @returns true if an XA Transaction is in progress.
+ * @return true if an XA Transaction is in progress.
*/
virtual bool isInXATransaction() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/Dispatcher.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/Dispatcher.h b/activemq-cpp/src/main/activemq/core/Dispatcher.h
index 876efc8..cd3a369 100644
--- a/activemq-cpp/src/main/activemq/core/Dispatcher.h
+++ b/activemq-cpp/src/main/activemq/core/Dispatcher.h
@@ -45,7 +45,7 @@ namespace core {
/**
* HashCode method allowing Dispatcher instances to be used in HashMap etc.
*
- * @returns hash value for this Dispatcher.
+ * @return hash value for this Dispatcher.
*/
virtual int getHashCode() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/PrefetchPolicy.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/PrefetchPolicy.h b/activemq-cpp/src/main/activemq/core/PrefetchPolicy.h
index 04552de..b69b5b9 100644
--- a/activemq-cpp/src/main/activemq/core/PrefetchPolicy.h
+++ b/activemq-cpp/src/main/activemq/core/PrefetchPolicy.h
@@ -56,7 +56,7 @@ namespace core {
/**
* Gets the amount of messages to prefetch for a Durable Topic.
*
- * @returns value of the number of messages to prefetch.
+ * @return value of the number of messages to prefetch.
*/
virtual int getDurableTopicPrefetch() const = 0;
@@ -71,7 +71,7 @@ namespace core {
/**
* Gets the amount of messages to prefetch for a Queue.
*
- * @returns value of the number of messages to prefetch.
+ * @return value of the number of messages to prefetch.
*/
virtual int getQueuePrefetch() const = 0;
@@ -86,7 +86,7 @@ namespace core {
/**
* Gets the amount of messages to prefetch for a Queue Browser.
*
- * @returns value of the number of messages to prefetch.
+ * @return value of the number of messages to prefetch.
*/
virtual int getQueueBrowserPrefetch() const = 0;
@@ -101,7 +101,7 @@ namespace core {
/**
* Gets the amount of messages to prefetch for a Topic.
*
- * @returns value of the number of messages to prefetch.
+ * @return value of the number of messages to prefetch.
*/
virtual int getTopicPrefetch() const = 0;
@@ -118,7 +118,7 @@ namespace core {
* prefetch value and return either the requested value or the maximum allowable
* value for prefetch.
*
- * @returns the allowable value for a prefetch limit, either requested or the max.
+ * @return the allowable value for a prefetch limit, either requested or the max.
*/
virtual int getMaxPrefetchLimit(int value) const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/RedeliveryPolicy.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/RedeliveryPolicy.h b/activemq-cpp/src/main/activemq/core/RedeliveryPolicy.h
index 0e52d51..6997e66 100644
--- a/activemq-cpp/src/main/activemq/core/RedeliveryPolicy.h
+++ b/activemq-cpp/src/main/activemq/core/RedeliveryPolicy.h
@@ -131,7 +131,7 @@ namespace core {
virtual long long getNextRedeliveryDelay(long long previousDelay) = 0;
/**
- * @returns whether or not collision avoidance is enabled for this Policy.
+ * @return whether or not collision avoidance is enabled for this Policy.
*/
virtual bool isUseCollisionAvoidance() const = 0;
@@ -142,7 +142,7 @@ namespace core {
virtual void setUseCollisionAvoidance(bool value) = 0;
/**
- * @returns whether or not the exponential back off option is enabled.
+ * @return whether or not the exponential back off option is enabled.
*/
virtual bool isUseExponentialBackOff() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/kernels/ActiveMQConsumerKernel.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/kernels/ActiveMQConsumerKernel.h b/activemq-cpp/src/main/activemq/core/kernels/ActiveMQConsumerKernel.h
index dc5d1c8..bb1f413 100644
--- a/activemq-cpp/src/main/activemq/core/kernels/ActiveMQConsumerKernel.h
+++ b/activemq-cpp/src/main/activemq/core/kernels/ActiveMQConsumerKernel.h
@@ -183,7 +183,7 @@ namespace kernels {
const Pointer<commands::ConsumerId>& getConsumerId() const;
/**
- * @returns if this Consumer has been closed.
+ * @return if this Consumer has been closed.
*/
bool isClosed() const;
@@ -227,7 +227,7 @@ namespace kernels {
/**
* Gets the currently set Last Delivered Sequence Id
*
- * @returns long long containing the sequence id of the last delivered Message.
+ * @return long long containing the sequence id of the last delivered Message.
*/
long long getLastDeliveredSequenceId() const;
@@ -249,7 +249,7 @@ namespace kernels {
/**
* Returns the delay after a failover before Message redelivery starts.
*
- * @returns time in milliseconds to wait after failover.
+ * @return time in milliseconds to wait after failover.
*/
long long setFailoverRedeliveryWaitPeriod() const;
@@ -271,7 +271,7 @@ namespace kernels {
void setLastDeliveredSequenceId(long long value);
/**
- * @returns the number of Message's this consumer is waiting to Dispatch.
+ * @return the number of Message's this consumer is waiting to Dispatch.
*/
int getMessageAvailableCount() const;
@@ -290,7 +290,7 @@ namespace kernels {
* Gets a pointer to this Consumer's Redelivery Policy object, the Consumer
* retains ownership of this pointer so the caller should not delete it.
*
- * @returns a Pointer to a RedeliveryPolicy that is in use by this Consumer.
+ * @return a Pointer to a RedeliveryPolicy that is in use by this Consumer.
*/
RedeliveryPolicy* getRedeliveryPolicy() const;
@@ -306,7 +306,7 @@ namespace kernels {
* Gets the error that caused this Consumer to be in a Failed state, or NULL if
* there is no Error.
*
- * @returns pointer to the error that faulted this Consumer or NULL.
+ * @return pointer to the error that faulted this Consumer or NULL.
*/
decaf::lang::Exception* getFailureError() const;
@@ -327,7 +327,7 @@ namespace kernels {
* Time in Milliseconds before an automatic acknowledge is done for any outstanding
* delivered Messages. A value less than one means no task is scheduled.
*
- * @returns time in milliseconds for the scheduled ack task.
+ * @return time in milliseconds for the scheduled ack task.
*/
long long getOptimizedAckScheduledAckInterval() const;
@@ -342,7 +342,7 @@ namespace kernels {
void setOptimizedAckScheduledAckInterval(long long value);
/**
- * @returns true if this consumer is using optimize acknowledge mode.
+ * @return true if this consumer is using optimize acknowledge mode.
*/
bool isOptimizeAcknowledge() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/kernels/ActiveMQProducerKernel.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/kernels/ActiveMQProducerKernel.h b/activemq-cpp/src/main/activemq/core/kernels/ActiveMQProducerKernel.h
index 8da574e..b0cb059 100644
--- a/activemq-cpp/src/main/activemq/core/kernels/ActiveMQProducerKernel.h
+++ b/activemq-cpp/src/main/activemq/core/kernels/ActiveMQProducerKernel.h
@@ -148,7 +148,7 @@ namespace kernels {
/**
* Gets the currently configured MessageTransformer for this MessageProducer.
*
- * @returns the pointer to the currently set cms::MessageTransformer.
+ * @return the pointer to the currently set cms::MessageTransformer.
*/
virtual cms::MessageTransformer* getMessageTransformer() const {
return this->transformer;
@@ -196,7 +196,7 @@ namespace kernels {
/**
* Gets if Message Time Stamps are disabled for this Producer
- * @returns boolean indicating state of enable / disable (true / false)
+ * @return boolean indicating state of enable / disable (true / false)
*/
virtual bool getDisableMessageTimeStamp() const {
return this->disableTimestamps;
@@ -251,7 +251,7 @@ namespace kernels {
}
/**
- * @returns true if this Producer has been closed.
+ * @return true if this Producer has been closed.
*/
bool isClosed() const {
return this->closed;
@@ -290,7 +290,7 @@ namespace kernels {
void dispose();
/**
- * @returns the next sequence number for a Message sent from this Producer.
+ * @return the next sequence number for a Message sent from this Producer.
*/
long long getNextMessageSequence() {
return this->messageSequence.getNextSequenceId();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/core/kernels/ActiveMQSessionKernel.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/core/kernels/ActiveMQSessionKernel.h b/activemq-cpp/src/main/activemq/core/kernels/ActiveMQSessionKernel.h
index 5247e7c..ee031f3 100644
--- a/activemq-cpp/src/main/activemq/core/kernels/ActiveMQSessionKernel.h
+++ b/activemq-cpp/src/main/activemq/core/kernels/ActiveMQSessionKernel.h
@@ -286,7 +286,7 @@ namespace kernels {
* that this session creates so that they can notify the client of
* exceptions that occur in the context of another thread.
*
- * @returns the registered cms::ExceptionListener pointer or NULL
+ * @return the registered cms::ExceptionListener pointer or NULL
*/
cms::ExceptionListener* getExceptionListener();
@@ -302,7 +302,7 @@ namespace kernels {
/**
* Gets the currently configured MessageTransformer for this Session.
*
- * @returns the pointer to the currently set cms::MessageTransformer.
+ * @return the pointer to the currently set cms::MessageTransformer.
*/
virtual cms::MessageTransformer* getMessageTransformer() const;
@@ -341,7 +341,7 @@ namespace kernels {
/**
* Gets the currently set Last Delivered Sequence Id
*
- * @returns long long containing the sequence id of the last delivered Message.
+ * @return long long containing the sequence id of the last delivered Message.
*/
long long getLastDeliveredSequenceId() const {
return this->lastDeliveredSequenceId;
@@ -377,7 +377,7 @@ namespace kernels {
* @param timeout
* The time to wait for a response, default is zero or infinite.
*
- * @returns Pointer to a Response object that the broker has returned for the Command sent.
+ * @return Pointer to a Response object that the broker has returned for the Command sent.
*
* @throws ActiveMQException thrown if an error response was received
* from the broker, or if any other error occurred.
@@ -527,12 +527,12 @@ namespace kernels {
bool isInUse(Pointer<commands::ActiveMQDestination> destination);
/**
- * @returns a Pointer to an ActiveMQProducerKernel using its ProducerId, or NULL.
+ * @return a Pointer to an ActiveMQProducerKernel using its ProducerId, or NULL.
*/
Pointer<ActiveMQProducerKernel> lookupProducerKernel(Pointer<commands::ProducerId> id);
/**
- * @returns a Pointer to an ActiveMQConsumerKernel using its ConsumerId, or NULL.
+ * @return a Pointer to an ActiveMQConsumerKernel using its ConsumerId, or NULL.
*/
Pointer<ActiveMQConsumerKernel> lookupConsumerKernel(Pointer<commands::ConsumerId> id);
@@ -542,7 +542,7 @@ namespace kernels {
* because a consumer requires further processing time to complete its dispatching. Once
* all consumers are done this method returns false.
*
- * @returns true if more iterations are needed false otherwise.
+ * @return true if more iterations are needed false otherwise.
*/
bool iterateConsumers();
@@ -556,7 +556,7 @@ namespace kernels {
/**
* Returns a Hash Code for this Session based on its SessionId.
*
- * @returns an int hash code based on the string balue of SessionId.
+ * @return an int hash code based on the string balue of SessionId.
*/
virtual int getHashCode() const;
@@ -619,7 +619,7 @@ namespace kernels {
// Creates a new Temporary Destination name using the connection id
// and a rolling count.
- // @returns a unique Temporary Destination name
+ // @return a unique Temporary Destination name
std::string createTemporaryDestinationName();
};
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/exceptions/BrokerException.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/exceptions/BrokerException.h b/activemq-cpp/src/main/activemq/exceptions/BrokerException.h
index 0926c94..b450a98 100644
--- a/activemq-cpp/src/main/activemq/exceptions/BrokerException.h
+++ b/activemq-cpp/src/main/activemq/exceptions/BrokerException.h
@@ -43,7 +43,7 @@ namespace exceptions {
* to preserve the type of the original exception as well as the message.
* All subclasses should override.
*
- * @returns new BrokerException instance that is a clone of this one.
+ * @return new BrokerException instance that is a clone of this one.
*/
virtual BrokerException* clone() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/AbstractTransportFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/AbstractTransportFactory.h b/activemq-cpp/src/main/activemq/transport/AbstractTransportFactory.h
index f8458f6..d606e25 100644
--- a/activemq-cpp/src/main/activemq/transport/AbstractTransportFactory.h
+++ b/activemq-cpp/src/main/activemq/transport/AbstractTransportFactory.h
@@ -52,7 +52,7 @@ namespace transport {
* @param properties
* The properties that were configured on the URI.
*
- * @returns a pointer to a WireFormat instance that the caller then owns.
+ * @return a pointer to a WireFormat instance that the caller then owns.
*
* @throws NoSuchElementException if the configured WireFormat is not found.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/Transport.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/Transport.h b/activemq-cpp/src/main/activemq/transport/Transport.h
index deb7213..a7161fb 100644
--- a/activemq-cpp/src/main/activemq/transport/Transport.h
+++ b/activemq-cpp/src/main/activemq/transport/Transport.h
@@ -142,7 +142,7 @@ namespace transport{
* nested transport this method delegates down to the lowest level transport that
* actually maintains a WireFormat info instance.
*
- * @returns The WireFormat the object used to encode / decode commands.
+ * @return The WireFormat the object used to encode / decode commands.
*/
virtual Pointer<wireformat::WireFormat> getWireFormat() const = 0;
@@ -180,21 +180,21 @@ namespace transport{
* Is this Transport fault tolerant, meaning that it will reconnect to
* a broker on disconnect.
*
- * @returns true if the Transport is fault tolerant.
+ * @return true if the Transport is fault tolerant.
*/
virtual bool isFaultTolerant() const = 0;
/**
* Is the Transport Connected to its Broker.
*
- * @returns true if a connection has been made.
+ * @return true if a connection has been made.
*/
virtual bool isConnected() const = 0;
/**
* Has the Transport been shutdown and no longer usable.
*
- * @returns true if the Transport
+ * @return true if the Transport
*/
virtual bool isClosed() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/TransportRegistry.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/TransportRegistry.h b/activemq-cpp/src/main/activemq/transport/TransportRegistry.h
index 00ba4ce..c3ad8ca 100644
--- a/activemq-cpp/src/main/activemq/transport/TransportRegistry.h
+++ b/activemq-cpp/src/main/activemq/transport/TransportRegistry.h
@@ -65,7 +65,7 @@ namespace transport {
* @param name
* The name of the Factory to find in the Registry.
*
- * @returns the Factory registered under the given name.
+ * @return the Factory registered under the given name.
*
* @throws NoSuchElementException if no factory is registered with that name.
*/
@@ -105,7 +105,7 @@ namespace transport {
* Retrieves a list of the names of all the Registered Transport's in this
* Registry.
*
- * @returns stl vector of strings with all the Transport names registered.
+ * @return stl vector of strings with all the Transport names registered.
*/
std::vector<std::string> getTransportNames() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgent.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgent.h b/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgent.h
index ba16c60..098f0aa 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgent.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgent.h
@@ -75,7 +75,7 @@ namespace discovery {
virtual decaf::net::URI getDiscoveryURI() const;
/**
- * @returns true if this agent is currently started.
+ * @return true if this agent is currently started.
*/
bool isStarted() const;
@@ -91,7 +91,7 @@ namespace discovery {
* Gets the configured service to publish, not all agents can publish so this value
* may not mean that an actual service advertisement is ever done.
*
- * @returns the configured service to publish.
+ * @return the configured service to publish.
*/
std::string getServiceName() const;
@@ -110,7 +110,7 @@ namespace discovery {
* seen is kept in the list of discovered services before being idle to long. Also this
* value controls how often this service will advertise itself if it supports that.
*
- * @returns Time in milliseconds for the keep alive interval.
+ * @return Time in milliseconds for the keep alive interval.
*/
long long getKeepAliveInterval() const;
@@ -125,7 +125,7 @@ namespace discovery {
/**
* Gets the configured backoff multiplier for calculating the next recovery time.
*
- * @returns the configured backoff multiplier for calculating the next recovery time.
+ * @return the configured backoff multiplier for calculating the next recovery time.
*/
long long getBackOffMultiplier() const;
@@ -142,7 +142,7 @@ namespace discovery {
* Gets the initial amount of time the agent should wait before attempt a reconnect on
* a discovered service.
*
- * @returns The time to wait before the initial reconnect attempt in milliseconds.
+ * @return The time to wait before the initial reconnect attempt in milliseconds.
*/
long long getInitialReconnectDelay() const;
@@ -159,7 +159,7 @@ namespace discovery {
* Returns the maximum number of reconnect attempts that will be attempted before a
* service is considered to be failed.
*
- * @returns the maximum number of allowed reconnect attempts.
+ * @return the maximum number of allowed reconnect attempts.
*/
int getMaxReconnectAttempts() const;
@@ -175,7 +175,7 @@ namespace discovery {
* Returns the maximum time allowed between reconnect attempts. This limits the amount
* of time that reconnect will wait when exponential backoff is enabled.
*
- * @returns the maximum reconnect delay in milliseconds.
+ * @return the maximum reconnect delay in milliseconds.
*/
long long getMaxReconnectDelay() const;
@@ -194,7 +194,7 @@ namespace discovery {
* Returns true if successive attempts to reconnect to a discovered service are delayed
* by an exponentially growing time factor.
*
- * @returns whether exponential back-off is enabled.
+ * @return whether exponential back-off is enabled.
*/
bool isUseExponentialBackOff() const;
@@ -210,7 +210,7 @@ namespace discovery {
/**
* Returns the assigned group for this discovery agent.
*
- * @returns the assigned group for this discovery agent.
+ * @return the assigned group for this discovery agent.
*/
std::string getGroup() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgentFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgentFactory.h b/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgentFactory.h
index 1582d3c..76dfa4a 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgentFactory.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/AbstractDiscoveryAgentFactory.h
@@ -45,7 +45,7 @@ namespace discovery {
* @param agentURI
* The URI that describes the agent and any requested configuration changes.
*
- * @returns a new DiscoveryAgent instance with all URI options applied.
+ * @return a new DiscoveryAgent instance with all URI options applied.
*/
virtual decaf::lang::Pointer<DiscoveryAgent> createAgent(const decaf::net::URI& agentURI);
@@ -57,7 +57,7 @@ namespace discovery {
* After this method is called by createAgent the configuration method will be invoked to
* allow the URI options to be applied.
*
- * @returns a Pointer to the newly created discovery agent instance.
+ * @return a Pointer to the newly created discovery agent instance.
*
* @throws ActiveMQException if an error occurs while creating the agent.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/DiscoveredBrokerData.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveredBrokerData.h b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveredBrokerData.h
index 8254a97..6aaf6e7 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveredBrokerData.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveredBrokerData.h
@@ -49,7 +49,7 @@ namespace discovery {
/**
* Gets the time of the last heart best from this Broker
*
- * @returns the time of the last received heart beat event from this Broker
+ * @return the time of the last received heart beat event from this Broker
*/
long long getLastHeartBeatTime() const {
return this->lastHeartBeatTime;
@@ -66,7 +66,7 @@ namespace discovery {
}
/**
- * @returns true is this service has been marked as failed.
+ * @return true is this service has been marked as failed.
*/
bool isFailed() const {
return failed;
@@ -85,7 +85,7 @@ namespace discovery {
/**
* Gets the number of times that there was a failure contacting this broker.
*
- * @returns count of the number of failures of this service.
+ * @return count of the number of failures of this service.
*/
int getFailureCount() const {
return failureCount;
@@ -104,7 +104,7 @@ namespace discovery {
/**
* Gets the set time for the next recovery attempt on this service.
*
- * @returns the next set time that this service can have a recovery attempt.
+ * @return the next set time that this service can have a recovery attempt.
*/
long long getNextRecoveryTime() const {
return nextRecoveryTime;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentFactory.h b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentFactory.h
index 2273e95..302e476 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentFactory.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentFactory.h
@@ -48,7 +48,7 @@ namespace discovery {
* @param agentURI
* The URI that defines the agent to create along with it configuration options.
*
- * @returns a new DiscoveryAgent instance for the given URI.
+ * @return a new DiscoveryAgent instance for the given URI.
*
* @throws IOException if an error occurs creating the given agent.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentRegistry.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentRegistry.h b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentRegistry.h
index b16be73..bf680b7 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentRegistry.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryAgentRegistry.h
@@ -64,7 +64,7 @@ namespace discovery {
* @param name
* The name of the Factory to find in the Registry.
*
- * @returns the Factory registered under the given name.
+ * @return the Factory registered under the given name.
*
* @throws NoSuchElementException if no factory is registered with that name.
*/
@@ -104,7 +104,7 @@ namespace discovery {
* Retrieves a list of the names of all the Registered Agents in this
* Registry.
*
- * @returns stl vector of strings with all the Agent names registered.
+ * @return stl vector of strings with all the Agent names registered.
*/
std::vector<std::string> getAgentNames() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryTransport.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryTransport.h b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryTransport.h
index 782d4a1..b0e47ce 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryTransport.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/DiscoveryTransport.h
@@ -67,7 +67,7 @@ namespace discovery {
/**
* Returns the currently configured Discovery Agent
*
- * @returns the pointer to the currently configured agent or NULL if not set.
+ * @return the pointer to the currently configured agent or NULL if not set.
*/
Pointer<DiscoveryAgent> getDiscoveryAgent() const;
@@ -82,7 +82,7 @@ namespace discovery {
/**
* Gets the currently set parameters that are applied to newly discovered services URIs.
*
- * @returns the currently set Properties to apply to new service URIs.
+ * @return the currently set Properties to apply to new service URIs.
*/
decaf::util::Properties getParameters() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/discovery/http/HttpDiscoveryAgent.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/discovery/http/HttpDiscoveryAgent.h b/activemq-cpp/src/main/activemq/transport/discovery/http/HttpDiscoveryAgent.h
index 80cea9e..b31b461 100644
--- a/activemq-cpp/src/main/activemq/transport/discovery/http/HttpDiscoveryAgent.h
+++ b/activemq-cpp/src/main/activemq/transport/discovery/http/HttpDiscoveryAgent.h
@@ -75,7 +75,7 @@ namespace http {
* Gets the amount of time the agent waits before attempting to fetch the list
* of registered Brokers from the configured HTTP registry service.
*
- * @returns Time in milliseconds to wait between update attempts.
+ * @return Time in milliseconds to wait between update attempts.
*/
long long getUpdateInterval() const;
@@ -90,7 +90,7 @@ namespace http {
/**
* Gets the URL for the Broker registry where the agent gets its updates.
*
- * @returns The URL to poll for registry entries.
+ * @return The URL to poll for registry entries.
*/
std::string getRegistryURL() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/failover/BackupTransport.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/failover/BackupTransport.h b/activemq-cpp/src/main/activemq/transport/failover/BackupTransport.h
index 14e676d..0a9236c 100644
--- a/activemq-cpp/src/main/activemq/transport/failover/BackupTransport.h
+++ b/activemq-cpp/src/main/activemq/transport/failover/BackupTransport.h
@@ -80,7 +80,7 @@ namespace failover {
/**
* Gets the currently held transport
- * @returns pointer to the held transport or NULL if not set.
+ * @return pointer to the held transport or NULL if not set.
*/
const Pointer<Transport>& getTransport() {
return transport;
@@ -115,7 +115,7 @@ namespace failover {
/**
* Has the Transport been shutdown and no longer usable.
*
- * @returns true if the Transport
+ * @return true if the Transport
*/
bool isClosed() const {
return this->closed;
@@ -130,7 +130,7 @@ namespace failover {
}
/**
- * @returns true if this transport was in the priority backup list.
+ * @return true if this transport was in the priority backup list.
*/
bool isPriority() const {
return this->priority;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/failover/BackupTransportPool.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/failover/BackupTransportPool.h b/activemq-cpp/src/main/activemq/transport/failover/BackupTransportPool.h
index ce9e028..940d1ed 100644
--- a/activemq-cpp/src/main/activemq/transport/failover/BackupTransportPool.h
+++ b/activemq-cpp/src/main/activemq/transport/failover/BackupTransportPool.h
@@ -138,7 +138,7 @@ namespace failover {
* Returns true if there is a Backup in the pool that's on the priority
* backups list.
*
- * @returns true if there is a priority backup available.
+ * @return true if there is a priority backup available.
*/
bool isPriorityBackupAvailable() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/failover/FailoverTransport.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/failover/FailoverTransport.h b/activemq-cpp/src/main/activemq/transport/failover/FailoverTransport.h
index fd674aa..3a18693 100644
--- a/activemq-cpp/src/main/activemq/transport/failover/FailoverTransport.h
+++ b/activemq-cpp/src/main/activemq/transport/failover/FailoverTransport.h
@@ -140,7 +140,7 @@ namespace failover {
public:
/**
- * @returns true if there is a need for the iterate method to be called by this
+ * @return true if there is a need for the iterate method to be called by this
* classes task runner.
*/
virtual bool isPending() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/activemq/transport/failover/URIPool.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/activemq/transport/failover/URIPool.h b/activemq-cpp/src/main/activemq/transport/failover/URIPool.h
index ae1c856..9a499e9 100644
--- a/activemq-cpp/src/main/activemq/transport/failover/URIPool.h
+++ b/activemq-cpp/src/main/activemq/transport/failover/URIPool.h
@@ -70,14 +70,14 @@ namespace failover {
/**
* Gets a static view of the URI List contained in this URI Pool
*
- * @returns a static reference to this Pools list of URIs.
+ * @return a static reference to this Pools list of URIs.
*/
const decaf::util::List<decaf::net::URI>& getURIList() const {
return this->uriPool;
}
/**
- * @returns true if this URI Pool is empty.
+ * @return true if this URI Pool is empty.
*/
bool isEmpty() const;
@@ -118,7 +118,7 @@ namespace failover {
*
* @param uri - a URI previously taken from the pool.
*
- * @returns true if the URI was added or false if its already in the list.
+ * @return true if the URI was added or false if its already in the list.
*/
bool addURI(const decaf::net::URI& uri);
@@ -128,7 +128,7 @@ namespace failover {
*
* @param uris - List of URIs to add into the Pool.
*
- * @returns true if any URI was added or false if they were already in the list.
+ * @return true if any URI was added or false if they were already in the list.
*/
bool addURIs(const decaf::util::List<decaf::net::URI>& uris);
@@ -138,7 +138,7 @@ namespace failover {
* @param uri
* The URI to find and remove from the free list
*
- * @returns true if the URI was removed or false if no change was made.
+ * @return true if the URI was removed or false if no change was made.
*/
bool removeURI(const decaf::net::URI& uri);
@@ -165,7 +165,7 @@ namespace failover {
/**
* Returns true if the given URI is contained in this set of URIs.
*
- * @returns true if the URI is in the list.
+ * @return true if the URI is in the list.
*/
bool contains(const decaf::net::URI& uri) const;
@@ -173,7 +173,7 @@ namespace failover {
* Returns true if the URI given is the first in the list of
* URIs contained in this pool.
*
- * @returns true if the URI is index 0 in the URI list.
+ * @return true if the URI is index 0 in the URI list.
*/
bool isPriority(const decaf::net::URI& uri) const;
@@ -185,7 +185,7 @@ namespace failover {
/**
* Compares the URIs in this set to that of another URIPool
*
- * @returns true if the URIPool instance contains the same values.
+ * @return true if the URIPool instance contains the same values.
*/
bool equals(const URIPool& other) const;