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:16 UTC
[7/9] activemq-cpp git commit: Fix some documentation generation
issues.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/URIHelper.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/URIHelper.h b/activemq-cpp/src/main/decaf/internal/net/URIHelper.h
index b70c7f2..9c29d5e 100644
--- a/activemq-cpp/src/main/decaf/internal/net/URIHelper.h
+++ b/activemq-cpp/src/main/decaf/internal/net/URIHelper.h
@@ -69,7 +69,7 @@ namespace net {
* Parse the passed in URI.
* @param uri - the URI to Parse
* @param forceServer - if true invalid URI data throws an Exception
- * @returns a URIType instance containing the parsed data.
+ * @return a URIType instance containing the parsed data.
* @throws URISyntaxException if forceServer is true and the URI is invalid.
*/
URIType parseURI( const std::string& uri, bool forceServer );
@@ -147,7 +147,7 @@ namespace net {
* <p>
* @param forceServer
* @param authority
- * @returns a URIType instance containing the parsed data.
+ * @return a URIType instance containing the parsed data.
* @throw URISyntaxException
*/
URIType parseAuthority( bool forceServer, const std::string& authority );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/URIType.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/URIType.h b/activemq-cpp/src/main/decaf/internal/net/URIType.h
index cc68789..42df07d 100644
--- a/activemq-cpp/src/main/decaf/internal/net/URIType.h
+++ b/activemq-cpp/src/main/decaf/internal/net/URIType.h
@@ -57,7 +57,7 @@ namespace net {
/**
* Gets the source URI string that was parsed to obtain this URIType
* instance and the resulting data,
- * @returns the source URI string
+ * @return the source URI string
*/
std::string getSource() const {
return this->source;
@@ -269,7 +269,7 @@ namespace net {
/**
* Gets if the URI is valid, meaning that the source has been set and
* parsed and all relevant data fields have been set.
- * @returns true if the URIType contains valid data.
+ * @return true if the URIType contains valid data.
*/
bool isValid() const {
return valid;
@@ -287,7 +287,7 @@ namespace net {
/**
* Gets the computed hashCode for this URIType or return -1 if non is set
*
- * @returns the hash code for this URIType instance or -1 if not set.
+ * @return the hash code for this URIType instance or -1 if not set.
*/
int getHashCode() const {
return this->hashCode;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/URLStreamHandlerManager.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/URLStreamHandlerManager.h b/activemq-cpp/src/main/decaf/internal/net/URLStreamHandlerManager.h
index 159e9a1..a8d05d4 100644
--- a/activemq-cpp/src/main/decaf/internal/net/URLStreamHandlerManager.h
+++ b/activemq-cpp/src/main/decaf/internal/net/URLStreamHandlerManager.h
@@ -57,7 +57,7 @@ namespace net {
* application. The returned pointer should never be deleted by the
* application.
*
- * @returns a URLStreamHandlerManager instance.
+ * @return a URLStreamHandlerManager instance.
*/
static URLStreamHandlerManager* getInstance();
@@ -69,7 +69,7 @@ namespace net {
* @param protocol
* The protocol to return a URL Stream Handler instance for.
*
- * @returns a URLStreamHandler instance for the given protocol.
+ * @return a URLStreamHandler instance for the given protocol.
*/
decaf::net::URLStreamHandler* getURLStreamHandler(const decaf::lang::String& protocol);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/URLType.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/URLType.h b/activemq-cpp/src/main/decaf/internal/net/URLType.h
index e12eb3a..25cc013 100644
--- a/activemq-cpp/src/main/decaf/internal/net/URLType.h
+++ b/activemq-cpp/src/main/decaf/internal/net/URLType.h
@@ -198,7 +198,7 @@ namespace net {
/**
* Gets the computed hashCode for this URLType or return -1 if non is set
*
- * @returns the hash code for this URLType instance or -1 if not set.
+ * @return the hash code for this URLType instance or -1 if not set.
*/
int getHashCode() const {
return this->hashCode;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/URLUtils.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/URLUtils.h b/activemq-cpp/src/main/decaf/internal/net/URLUtils.h
index b75cfb7..2c99add 100644
--- a/activemq-cpp/src/main/decaf/internal/net/URLUtils.h
+++ b/activemq-cpp/src/main/decaf/internal/net/URLUtils.h
@@ -40,7 +40,7 @@ namespace net {
* @param url
* the URL whose host value is to be returned.
*
- * @returns the host value or 'localhost' for file based protocols.
+ * @return the host value or 'localhost' for file based protocols.
*/
static decaf::lang::String getHost(const decaf::net::URL& url);
@@ -53,7 +53,7 @@ namespace net {
* true to remove leading ".." segments from the path. This is appropriate
* for paths that are known to be absolute.
*
- * @returns the canonicalized Path value.
+ * @return the canonicalized Path value.
*/
static decaf::lang::String canonicalizePath(const decaf::lang::String& original, bool discardRelativePrefix);
@@ -67,7 +67,7 @@ namespace net {
* @param path
* The path value from a given URL.
*
- * @returns a safe version of the Path value.
+ * @return a safe version of the Path value.
*/
static decaf::lang::String authoritySafePath(const decaf::lang::String& authority,
const decaf::lang::String& path);
@@ -81,7 +81,7 @@ namespace net {
* @param c
* The value from the given index.
*
- * @returns true if the char value is valid for the given index.
+ * @return true if the char value is valid for the given index.
*/
static bool isValidSchemeChar(int index, char c);
@@ -110,7 +110,7 @@ namespace net {
* @param end
* The end index to stop the search at.
*
- * @returns the first index that matches one of the chars or the end value if no matches..
+ * @return the first index that matches one of the chars or the end value if no matches..
*/
static int findFirstOf(const decaf::lang::String& string,
const decaf::lang::String& chars, int start, int end);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocket.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocket.h b/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocket.h
index b5b3860..509efcb 100644
--- a/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocket.h
+++ b/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocket.h
@@ -236,7 +236,7 @@ namespace openssl {
/**
* Gets the number of bytes in the Socket buffer that can be read without blocking.
*
- * @returns the number of bytes that can be read from the Socket without blocking.
+ * @return the number of bytes that can be read from the Socket without blocking.
*
* @throws IOException if an I/O error occurs while performing this operation.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocketException.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocketException.h b/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocketException.h
index 9aa0bfb..da94033 100644
--- a/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocketException.h
+++ b/activemq-cpp/src/main/decaf/internal/net/ssl/openssl/OpenSSLSocketException.h
@@ -134,7 +134,7 @@ namespace openssl {
/**
* Gets and formats an error message string from the OpenSSL error stack.
*
- * @returns a string containing the complete OpenSSL error string.
+ * @return a string containing the complete OpenSSL error string.
*/
std::string getErrorString() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/net/tcp/TcpSocket.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/net/tcp/TcpSocket.h b/activemq-cpp/src/main/decaf/internal/net/tcp/TcpSocket.h
index 92ae876..3696869 100644
--- a/activemq-cpp/src/main/decaf/internal/net/tcp/TcpSocket.h
+++ b/activemq-cpp/src/main/decaf/internal/net/tcp/TcpSocket.h
@@ -65,12 +65,12 @@ namespace tcp {
virtual ~TcpSocket();
/**
- * @returns true if the socketHandle is not in a disconnected state.
+ * @return true if the socketHandle is not in a disconnected state.
*/
bool isConnected() const;
/**
- * @returns true if the close method has been called on this Socket.
+ * @return true if the close method has been called on this Socket.
*/
bool isClosed() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/nio/BufferFactory.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/nio/BufferFactory.h b/activemq-cpp/src/main/decaf/internal/nio/BufferFactory.h
index 1d45d3d..5056dfb 100644
--- a/activemq-cpp/src/main/decaf/internal/nio/BufferFactory.h
+++ b/activemq-cpp/src/main/decaf/internal/nio/BufferFactory.h
@@ -50,7 +50,7 @@ namespace nio{
* @param capacity
* The internal buffer's capacity.
*
- * @returns a newly allocated ByteBuffer which the caller owns.
+ * @return a newly allocated ByteBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -74,7 +74,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new ByteBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new ByteBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -95,7 +95,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new ByteBuffer that is backed by buffer, caller owns.
+ * @return a new ByteBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::ByteBuffer* createByteBuffer( std::vector<unsigned char>& buffer );
@@ -106,7 +106,7 @@ namespace nio{
* @param capacity
* The internal buffer's capacity.
*
- * @returns a newly allocated CharBuffer which the caller owns.
+ * @return a newly allocated CharBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -130,7 +130,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new CharBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new CharBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -150,7 +150,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new CharBuffer that is backed by buffer, caller owns.
+ * @return a new CharBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::CharBuffer* createCharBuffer( std::vector<char>& buffer );
@@ -161,7 +161,7 @@ namespace nio{
* @param capacity
* The internal buffer's capacity.
*
- * @returns a newly allocated DoubleBuffer which the caller owns.
+ * @return a newly allocated DoubleBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -185,7 +185,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new DoubleBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new DoubleBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -205,7 +205,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new DoubleBuffer that is backed by buffer, caller owns.
+ * @return a new DoubleBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::DoubleBuffer* createDoubleBuffer( std::vector<double>& buffer );
@@ -216,7 +216,7 @@ namespace nio{
* @param capacity
* The internal buffer's capacity.
*
- * @returns a newly allocated FloatBuffer which the caller owns.
+ * @return a newly allocated FloatBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -240,7 +240,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new FloatBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new FloatBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -260,7 +260,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new FloatBuffer that is backed by buffer, caller owns.
+ * @return a new FloatBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::FloatBuffer* createFloatBuffer( std::vector<float>& buffer );
@@ -268,7 +268,7 @@ namespace nio{
* Allocates a new long long buffer whose position will be zero its limit will
* be its capacity and its mark is not set.
* @param capacity - the internal buffer's capacity.
- * @returns a newly allocated DoubleBuffer which the caller owns.
+ * @return a newly allocated DoubleBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -292,7 +292,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new LongBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new LongBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -312,7 +312,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new LongBuffer that is backed by buffer, caller owns.
+ * @return a new LongBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::LongBuffer* createLongBuffer( std::vector<long long>& buffer );
@@ -323,7 +323,7 @@ namespace nio{
* @param capacity
* The internal buffer's capacity.
*
- * @returns a newly allocated IntBuffer which the caller owns.
+ * @return a newly allocated IntBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -347,7 +347,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new IntBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new IntBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -367,7 +367,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new IntBuffer that is backed by buffer, caller owns.
+ * @return a new IntBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::IntBuffer* createIntBuffer( std::vector<int>& buffer );
@@ -378,7 +378,7 @@ namespace nio{
* @param capacity
* The internal buffer's capacity.
*
- * @returns a newly allocated ShortBuffer which the caller owns.
+ * @return a newly allocated ShortBuffer which the caller owns.
*
* @throws IndexOutOfBoundsException if the capacity specified is negative.
*/
@@ -402,7 +402,7 @@ namespace nio{
* @param length
* The length of the subarray to be used.
*
- * @returns a new ShortBuffer that is backed by buffer, caller owns the returned pointer.
+ * @return a new ShortBuffer that is backed by buffer, caller owns the returned pointer.
*
* @throws NullPointerException if the buffer given in Null.
* @throws IndexOutOfBoundsException if the capacity specified is negative.
@@ -422,7 +422,7 @@ namespace nio{
* The vector that will back the new buffer, the vector must have been
* sized to the desired size already by calling vector.resize( N ).
*
- * @returns a new DoubleBuffer that is backed by buffer, caller owns.
+ * @return a new DoubleBuffer that is backed by buffer, caller owns.
*/
static decaf::nio::ShortBuffer* createShortBuffer( std::vector<short>& buffer );
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/security/Engine.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/security/Engine.h b/activemq-cpp/src/main/decaf/internal/security/Engine.h
index ae1432b..7aff84b 100644
--- a/activemq-cpp/src/main/decaf/internal/security/Engine.h
+++ b/activemq-cpp/src/main/decaf/internal/security/Engine.h
@@ -60,7 +60,7 @@ namespace security {
* Returns the name of the service type that this Engine will be a
* builder of SecuritySpi instances for.
*
- * @returns the service class name of this engine, e.g. MessageDigest.
+ * @return the service class name of this engine, e.g. MessageDigest.
*/
std::string getServiceName() const {
return this->serviceName;
@@ -82,7 +82,7 @@ namespace security {
* Return a new instance of the SercuritySpi implementation that is named by
* this engine's serviceName and the passed algorithmName.
*
- * @returns a new instance of the SecuritySpi provided by serviceName.algorithmName
+ * @return a new instance of the SecuritySpi provided by serviceName.algorithmName
*/
decaf::security::SecuritySpi* newInstance(const std::string& algorithmName);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/security/SecurityRuntime.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/security/SecurityRuntime.h b/activemq-cpp/src/main/decaf/internal/security/SecurityRuntime.h
index 6ef270a..492a673 100644
--- a/activemq-cpp/src/main/decaf/internal/security/SecurityRuntime.h
+++ b/activemq-cpp/src/main/decaf/internal/security/SecurityRuntime.h
@@ -58,7 +58,7 @@ namespace security {
/**
* Return the Security Framework's Service Registry.
*
- * @returns a pointer to the frameworks Service Registry.
+ * @return a pointer to the frameworks Service Registry.
*/
ServiceRegistry* getServiceRegistry();
@@ -70,7 +70,7 @@ namespace security {
* The pointer returned is owned by the Security runtime and should not be
* deleted or copied by the caller.
*
- * @returns a pointer to the Security Runtime's single Lock instance.
+ * @return a pointer to the Security Runtime's single Lock instance.
*/
decaf::util::concurrent::Mutex* getRuntimeLock();
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/security/ServiceRegistry.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/security/ServiceRegistry.h b/activemq-cpp/src/main/decaf/internal/security/ServiceRegistry.h
index c16f735..08f6237 100644
--- a/activemq-cpp/src/main/decaf/internal/security/ServiceRegistry.h
+++ b/activemq-cpp/src/main/decaf/internal/security/ServiceRegistry.h
@@ -69,7 +69,7 @@ namespace security {
* @param name
* The name of the service to find, format is "serviceName.algorithmName"
*
- * @returns a caller owned pointer to a new ProviderService for the named service.
+ * @return a caller owned pointer to a new ProviderService for the named service.
*/
decaf::security::ProviderService* getService(const std::string& name);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/util/ByteArrayAdapter.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/util/ByteArrayAdapter.h b/activemq-cpp/src/main/decaf/internal/util/ByteArrayAdapter.h
index 10d52f1..4a33b9c 100644
--- a/activemq-cpp/src/main/decaf/internal/util/ByteArrayAdapter.h
+++ b/activemq-cpp/src/main/decaf/internal/util/ByteArrayAdapter.h
@@ -251,7 +251,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an unsigned char* pointer to the array this object wraps.
+ * @return an unsigned char* pointer to the array this object wraps.
*/
virtual unsigned char* getByteArray() {
return this->array.bytes;
@@ -260,7 +260,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an char* pointer to the array this object wraps.
+ * @return an char* pointer to the array this object wraps.
*/
virtual char* getCharArray() {
return this->array.chars;
@@ -269,7 +269,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an short* pointer to the array this object wraps.
+ * @return an short* pointer to the array this object wraps.
*/
virtual short* getShortArray() {
return this->array.shorts;
@@ -278,7 +278,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an int* pointer to the array this object wraps.
+ * @return an int* pointer to the array this object wraps.
*/
virtual int* getIntArray() {
return this->array.ints;
@@ -287,7 +287,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an long long* pointer to the array this object wraps.
+ * @return an long long* pointer to the array this object wraps.
*/
virtual long long* getLongArray() {
return this->array.longs;
@@ -296,7 +296,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an double* pointer to the array this object wraps.
+ * @return an double* pointer to the array this object wraps.
*/
virtual double* getDoubleArray() {
return this->array.doubles;
@@ -305,7 +305,7 @@ namespace util {
/**
* Gets the pointer to the array we are wrapping. Changes to the data in this
* array are reflected by all ByteArrayAdapter objects that point to this array.
- * @returns an float* pointer to the array this object wraps.
+ * @return an float* pointer to the array this object wraps.
*/
virtual float* getFloatArray() {
return this->array.floats;
@@ -396,7 +396,7 @@ namespace util {
* @param index
* The index in the Buffer where the byte is to be read.
*
- * @returns the byte that is located at the given index.
+ * @return the byte that is located at the given index.
*
* @throws IndexOutOfBoundsException If index is not smaller than the
* buffer's limit or is negative.
@@ -409,7 +409,7 @@ namespace util {
* @param index
* The index in the Buffer where the byte is to be read.
*
- * @returns the byte that is located at the given index.
+ * @return the byte that is located at the given index.
*
* @throws IndexOutOfBoundsException If index is not smaller than the
* buffer's limit or is negative.
@@ -425,7 +425,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read.
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -438,7 +438,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -454,7 +454,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read.
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -467,7 +467,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -483,7 +483,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read.
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -496,7 +496,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -512,7 +512,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read.
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -525,7 +525,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -541,7 +541,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read.
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -554,7 +554,7 @@ namespace util {
* @param index
* The index in the Buffer where the bytes are to be read
*
- * @returns the value at the given index in the buffer.
+ * @return the value at the given index in the buffer.
*
* @throws IndexOutOfBoundsException if there are not enough bytes remaining
* to fill the requested Data Type, or index is negative.
@@ -572,7 +572,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -590,7 +590,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -608,7 +608,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -624,7 +624,7 @@ namespace util {
* @param value
* The value to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -642,7 +642,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -658,7 +658,7 @@ namespace util {
* @param value
* The value to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -676,7 +676,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -692,7 +692,7 @@ namespace util {
* @param value
* The value to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -710,7 +710,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -726,7 +726,7 @@ namespace util {
* @param value
* The value to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -744,7 +744,7 @@ namespace util {
* @param value
* The value to write to the array.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
@@ -760,7 +760,7 @@ namespace util {
* @param value
* The value to write.
*
- * @returns a reference to this buffer.
+ * @return a reference to this buffer.
*
* @throw IndexOutOfBoundsException if index greater than the buffer's limit
* minus the size of the type being written, or index is negative.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/util/HexStringParser.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/util/HexStringParser.h b/activemq-cpp/src/main/decaf/internal/util/HexStringParser.h
index 0399a13..8c65675 100644
--- a/activemq-cpp/src/main/decaf/internal/util/HexStringParser.h
+++ b/activemq-cpp/src/main/decaf/internal/util/HexStringParser.h
@@ -73,7 +73,7 @@ namespace util {
* and returns a long long with the bits of the parsed string, the
* caller can then convert those to a float or doulbe as needed.
* @param hexString - string to parse
- * @returns the bits parsed from the string
+ * @return the bits parsed from the string
*/
long long parse(const std::string& hexString);
@@ -156,14 +156,14 @@ namespace util {
/*
* Parses the hex string to a double number.
* @param hexString - string to parse
- * @returns the parsed double value
+ * @return the parsed double value
*/
static double parseDouble(const std::string& hexString);
/*
* Parses the hex string to a float number.
* @param hexString - string to parse
- * @returns the parsed float value
+ * @return the parsed float value
*/
static float parseFloat(const std::string& hexString);
@@ -173,7 +173,7 @@ namespace util {
/*
* Analyzes the hex string and extracts the sign and digit segments.
* @param hexString - string to parse
- * @returns array of three strings holding the segments caller owns
+ * @return array of three strings holding the segments caller owns
*/
static std::string* getSegmentsFromHexString(const std::string& hexString);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/util/StringUtils.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/util/StringUtils.h b/activemq-cpp/src/main/decaf/internal/util/StringUtils.h
index 63d0f60..e470be5 100644
--- a/activemq-cpp/src/main/decaf/internal/util/StringUtils.h
+++ b/activemq-cpp/src/main/decaf/internal/util/StringUtils.h
@@ -44,7 +44,7 @@ namespace util {
* @param string
* The C style string to check.
*
- * @returns the length of the string if the size is < Integer::MAX_VALUE.
+ * @return the length of the string if the size is < Integer::MAX_VALUE.
*
* @throws RuntimeException if the length becomes larger than
* the max value of an int.
@@ -59,7 +59,7 @@ namespace util {
* @param right
* The right-hand string of the comparison.
*
- * @returns a negative integer, zero, or a positive integer as the specified string
+ * @return a negative integer, zero, or a positive integer as the specified string
* is greater than, equal to, or less than this String, ignoring case considerations.
*/
static int compareIgnoreCase(const char* left, const char* right);
@@ -73,7 +73,7 @@ namespace util {
* @param right
* The right-hand string of the comparison.
*
- * @returns a negative integer, zero, or a positive integer as the specified string
+ * @return a negative integer, zero, or a positive integer as the specified string
* is greater than, equal to, or less than this String, ignoring case considerations.
*/
static int compare(const char* left, const char* right);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/util/TimerTaskHeap.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/util/TimerTaskHeap.h b/activemq-cpp/src/main/decaf/internal/util/TimerTaskHeap.h
index a96915d..c9e8e28 100644
--- a/activemq-cpp/src/main/decaf/internal/util/TimerTaskHeap.h
+++ b/activemq-cpp/src/main/decaf/internal/util/TimerTaskHeap.h
@@ -58,12 +58,12 @@ namespace util {
Pointer<TimerTask> peek();
/**
- * @returns true if the heap is empty.
+ * @return true if the heap is empty.
*/
bool isEmpty() const;
/**
- * @returns the size of the heap.
+ * @return the size of the heap.
*/
std::size_t size() const;
@@ -108,7 +108,7 @@ namespace util {
* Searches the heap for the specified TimerTask element and returns its position in the
* heap. Returns the unsigned equivalent of -1 if the element is not found.
*
- * @returns the position in the Heap where the Task is stored, or npos.
+ * @return the position in the Heap where the Task is stored, or npos.
*/
std::size_t find(const Pointer<TimerTask>& task) const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/util/concurrent/ThreadLocalImpl.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/util/concurrent/ThreadLocalImpl.h b/activemq-cpp/src/main/decaf/internal/util/concurrent/ThreadLocalImpl.h
index df9e93a..7750b50 100644
--- a/activemq-cpp/src/main/decaf/internal/util/concurrent/ThreadLocalImpl.h
+++ b/activemq-cpp/src/main/decaf/internal/util/concurrent/ThreadLocalImpl.h
@@ -45,7 +45,7 @@ namespace concurrent {
* Returns the current threads assigned value, but retains ownership
* to this value unless the remove method is subsequently called.
*
- * @returns the currently held value for this thread.
+ * @return the currently held value for this thread.
*/
void* getRawValue() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/internal/util/concurrent/Threading.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/internal/util/concurrent/Threading.h b/activemq-cpp/src/main/decaf/internal/util/concurrent/Threading.h
index 466e631..2cb6e50 100644
--- a/activemq-cpp/src/main/decaf/internal/util/concurrent/Threading.h
+++ b/activemq-cpp/src/main/decaf/internal/util/concurrent/Threading.h
@@ -79,7 +79,7 @@ namespace concurrent {
* initialized and ready for use. Each monitor that is taken must be returned before
* the Threading library is shutdown.
*
- * @returns handle to a Monitor instance that has been initialized.
+ * @return handle to a Monitor instance that has been initialized.
*/
static MonitorHandle* takeMonitor(bool alreadyLocked = false);
@@ -113,7 +113,7 @@ namespace concurrent {
* @param monitor
* The handle to the monitor that the current thread is attempting to lock.
*
- * @returns true if the caller obtains the lock on the Monitor, false otherwise.
+ * @return true if the caller obtains the lock on the Monitor, false otherwise.
*/
static bool tryEnterMonitor(MonitorHandle* monitor);
@@ -144,7 +144,7 @@ namespace concurrent {
* @param nanos
* The time in nanoseconds to wait for the monitor to be signaled.
*
- * @returns true if the timeout given expires before the caller was signaled.
+ * @return true if the timeout given expires before the caller was signaled.
*
* @throws IllegalMonitorStateException if the caller does not own the monitor.
*/
@@ -195,7 +195,7 @@ namespace concurrent {
* @param stackSize
* The size to allocate for the new thread's stack.
*
- * @returns a new ThreadHandle that identifies the thread and allows the parent
+ * @return a new ThreadHandle that identifies the thread and allows the parent
* to interact with it.
*/
static ThreadHandle* createNewThread(Thread* parant, const char* name,
@@ -222,7 +222,7 @@ namespace concurrent {
* @param nanos
* The number of nanoseconds to wait [0-999999].
*
- * @returns true if the timeout period expired, false otherwise.
+ * @return true if the timeout period expired, false otherwise.
*
* @throws InterruptedException if the Join was interrupted.
* @throws IllegalArgumentException if the value of mills or nanos is invalid.
@@ -265,17 +265,17 @@ namespace concurrent {
* @param name
* The name to assign to the returned ThreadHandle.
*
- * @returns a new ThreadHandle instance for the parent Decaf Thread.
+ * @return a new ThreadHandle instance for the parent Decaf Thread.
*/
static ThreadHandle* createThreadWrapper(decaf::lang::Thread* parent, const char* name);
/**
- * @returns the Decaf Thread pointer instance for the currently running thread.
+ * @return the Decaf Thread pointer instance for the currently running thread.
*/
static Thread* getCurrentThread();
/**
- * @returns the ThreadHandle instance for the currently running thread.
+ * @return the ThreadHandle instance for the currently running thread.
*/
static ThreadHandle* getCurrentThreadHandle();
@@ -324,7 +324,7 @@ namespace concurrent {
* @param threadLocal
* The ThreadLocalImpl to assign a storage slot.
*
- * @returns a new storage slot Id for the given ThreadLocalImpl's value to be assigned.
+ * @return a new storage slot Id for the given ThreadLocalImpl's value to be assigned.
*/
static int createThreadLocalSlot(ThreadLocalImpl* threadLocal);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/io/ByteArrayOutputStream.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/io/ByteArrayOutputStream.h b/activemq-cpp/src/main/decaf/io/ByteArrayOutputStream.h
index 46796c3..aa684d3 100644
--- a/activemq-cpp/src/main/decaf/io/ByteArrayOutputStream.h
+++ b/activemq-cpp/src/main/decaf/io/ByteArrayOutputStream.h
@@ -97,7 +97,7 @@ namespace io{
/**
* Converts the bytes in the buffer into a standard C++ string
- * @returns a string containing the bytes in the buffer
+ * @return a string containing the bytes in the buffer
*/
virtual std::string toString() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/io/DataInput.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/io/DataInput.h b/activemq-cpp/src/main/decaf/io/DataInput.h
index 3f2c8c4..ebb6ce9 100644
--- a/activemq-cpp/src/main/decaf/io/DataInput.h
+++ b/activemq-cpp/src/main/decaf/io/DataInput.h
@@ -57,7 +57,7 @@ namespace io {
* Reads in one byte and returns true if that byte is nonzero, false if that
* byte is zero.
*
- * @returns the boolean value of the read in byte (0=false, 1=true).
+ * @return the boolean value of the read in byte (0=false, 1=true).
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -68,7 +68,7 @@ namespace io {
* Reads and returns one input byte. The byte is treated as a
* signed value in the range -128 through 127, inclusive.
*
- * @returns the 8-bit value read.
+ * @return the 8-bit value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -79,7 +79,7 @@ namespace io {
* Reads one input byte, zero-extends it to type int, and returns
* the result, which is therefore in the range 0 through 255.
*
- * @returns the 8 bit unsigned value read.
+ * @return the 8 bit unsigned value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -91,7 +91,7 @@ namespace io {
* is made up of one bytes. This returns the same result as
* <code>readByte</code>
*
- * @returns the 8 bit char read.
+ * @return the 8 bit char read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -104,7 +104,7 @@ namespace io {
* the readlong method, then converting this long value to a double
* in exactly the manner of the method Double::longBitsToDouble.
*
- * @returns the double value read.
+ * @return the double value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -117,7 +117,7 @@ namespace io {
* readInt method, then converting this int value to a float in
* exactly the manner of the method Float::intBitsToFloat.
*
- * @returns the float value read.
+ * @return the float value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -132,7 +132,7 @@ namespace io {
* (((a & 0xff) << 24) | ((b & 0xff) << 16) |
* ((c & 0xff) << 8) | (d & 0xff))
*
- * @returns the int value read.
+ * @return the int value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -155,7 +155,7 @@ namespace io {
* ((long)(g & 0xff) << 8) |
* ((long)(h & 0xff)))
*
- * @returns the 64 bit long long read.
+ * @return the 64 bit long long read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -168,7 +168,7 @@ namespace io {
*
* (short)((a << 8) | (b & 0xff))
*
- * @returns the 16 bit short value read.
+ * @return the 16 bit short value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -182,7 +182,7 @@ namespace io {
*
* (((a & 0xff) << 8) | (b & 0xff))
*
- * @returns the 16 bit unsigned short read.
+ * @return the 16 bit unsigned short read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -193,7 +193,7 @@ namespace io {
* Reads an NULL terminated ASCII string to the stream and returns the
* string to the caller.
*
- * @returns string object containing the string read.
+ * @return string object containing the string read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -230,7 +230,7 @@ namespace io {
* encoded UTF-8 bytes is an unsigned short, which implies that the String will
* be no longer than 65535 characters.
*
- * @returns The decoded string read from stream.
+ * @return The decoded string read from stream.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/io/DataInputStream.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/io/DataInputStream.h b/activemq-cpp/src/main/decaf/io/DataInputStream.h
index 686c4d9..c6ad27a 100644
--- a/activemq-cpp/src/main/decaf/io/DataInputStream.h
+++ b/activemq-cpp/src/main/decaf/io/DataInputStream.h
@@ -75,7 +75,7 @@ namespace io{
* Reads in one byte and returns true if that byte is nonzero, false if that
* byte is zero.
*
- * @returns the boolean value of the read in byte (0=false, 1=true).
+ * @return the boolean value of the read in byte (0=false, 1=true).
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -86,7 +86,7 @@ namespace io{
* Reads and returns one input byte. The byte is treated as a
* signed value in the range -128 through 127, inclusive.
*
- * @returns the 8-bit value read.
+ * @return the 8-bit value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -97,7 +97,7 @@ namespace io{
* Reads one input byte, zero-extends it to type int, and returns
* the result, which is therefore in the range 0 through 255.
*
- * @returns the 8 bit unsigned value read.
+ * @return the 8 bit unsigned value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -109,7 +109,7 @@ namespace io{
* is made up of one bytes. This returns the same result as
* <code>readByte</code>
*
- * @returns the 8 bit char read.
+ * @return the 8 bit char read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -122,7 +122,7 @@ namespace io{
* the readlong method, then converting this long value to a double
* in exactly the manner of the method Double::longBitsToDouble.
*
- * @returns the double value read.
+ * @return the double value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -135,7 +135,7 @@ namespace io{
* readInt method, then converting this int value to a float in
* exactly the manner of the method Float::intBitsToFloat.
*
- * @returns the float value read.
+ * @return the float value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -150,7 +150,7 @@ namespace io{
* (((a & 0xff) << 24) | ((b & 0xff) << 16) |
* ((c & 0xff) << 8) | (d & 0xff))
*
- * @returns the int value read.
+ * @return the int value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -173,7 +173,7 @@ namespace io{
* ((long)(g & 0xff) << 8) |
* ((long)(h & 0xff)))
*
- * @returns the 64 bit long long read.
+ * @return the 64 bit long long read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -186,7 +186,7 @@ namespace io{
*
* (short)((a << 8) | (b & 0xff))
*
- * @returns the 16 bit short value read.
+ * @return the 16 bit short value read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -200,7 +200,7 @@ namespace io{
*
* (((a & 0xff) << 8) | (b & 0xff))
*
- * @returns the 16 bit unsigned short read.
+ * @return the 16 bit unsigned short read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -211,7 +211,7 @@ namespace io{
* Reads an NULL terminated ASCII string to the stream and returns the
* string to the caller.
*
- * @returns string object containing the string read.
+ * @return string object containing the string read.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
@@ -248,7 +248,7 @@ namespace io{
* encoded UTF-8 bytes is an unsigned short, which implies that the String will
* be no longer than 65535 characters.
*
- * @returns The decoded string read from stream.
+ * @return The decoded string read from stream.
*
* @throws IOException if an I/O Error occurs.
* @throws EOFException if the end of input is reached.
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/io/FilterInputStream.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/io/FilterInputStream.h b/activemq-cpp/src/main/decaf/io/FilterInputStream.h
index 43d04f7..c7b702b 100644
--- a/activemq-cpp/src/main/decaf/io/FilterInputStream.h
+++ b/activemq-cpp/src/main/decaf/io/FilterInputStream.h
@@ -105,7 +105,7 @@ namespace io{
virtual int doReadArrayBounded(unsigned char* buffer, int size, int offset, int length);
/**
- * @returns true if this stream has been closed.
+ * @return true if this stream has been closed.
*/
virtual bool isClosed() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/io/FilterOutputStream.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/io/FilterOutputStream.h b/activemq-cpp/src/main/decaf/io/FilterOutputStream.h
index 9f4a734..97c8119 100644
--- a/activemq-cpp/src/main/decaf/io/FilterOutputStream.h
+++ b/activemq-cpp/src/main/decaf/io/FilterOutputStream.h
@@ -110,7 +110,7 @@ namespace io{
protected:
/**
- * @returns true if this stream has been closed.
+ * @return true if this stream has been closed.
*/
virtual bool isClosed() const;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/io/InputStream.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/io/InputStream.h b/activemq-cpp/src/main/decaf/io/InputStream.h
index 4dd58b4..533491d 100644
--- a/activemq-cpp/src/main/decaf/io/InputStream.h
+++ b/activemq-cpp/src/main/decaf/io/InputStream.h
@@ -117,7 +117,7 @@ namespace io{
*
* The default implementation of this method returns false.
*
- * @returns true if this stream instance supports marks
+ * @return true if this stream instance supports marks
*/
virtual bool markSupported() const {
return false;
@@ -247,7 +247,7 @@ namespace io{
* @param num
* The number of bytes to skip.
*
- * @returns total bytes skipped
+ * @return total bytes skipped
*
* @throws IOException if an I/O error occurs.
* @throws UnsupportedOperationException if the concrete stream class does
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/AbstractStringBuilder.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/AbstractStringBuilder.h b/activemq-cpp/src/main/decaf/lang/AbstractStringBuilder.h
index 34c4cee..3b5a5d3 100644
--- a/activemq-cpp/src/main/decaf/lang/AbstractStringBuilder.h
+++ b/activemq-cpp/src/main/decaf/lang/AbstractStringBuilder.h
@@ -67,7 +67,7 @@ namespace lang {
* the internal character buffer, when the number of characters inserted exceeds the current
* capacity the internal buffer is reallocated and old contents copied to the new buffer.
*
- * @returns the current capacity value.
+ * @return the current capacity value.
*/
virtual int capacity() const;
@@ -125,7 +125,7 @@ namespace lang {
* @param value
* The String to locate within this string buffer.
*
- * @returns the index of the specified substring within this string buffer or -1 if not found.
+ * @return the index of the specified substring within this string buffer or -1 if not found.
*/
virtual int indexOf(const String& value) const;
@@ -138,7 +138,7 @@ namespace lang {
* @param start
* The index to start the search from.
*
- * @returns the index of the specified substring within this string buffer or -1 if not found.
+ * @return the index of the specified substring within this string buffer or -1 if not found.
*/
virtual int indexOf(const String& value, int start) const;
@@ -148,7 +148,7 @@ namespace lang {
* @param value
* The String to locate within this string buffer.
*
- * @returns the last index of the specified substring within this string buffer or -1
+ * @return the last index of the specified substring within this string buffer or -1
* if not found.
*/
virtual int lastIndexOf(const String& value) const;
@@ -162,7 +162,7 @@ namespace lang {
* @param start
* The index to start the search from.
*
- * @returns the last index of the specified substring within this string buffer or -1
+ * @return the last index of the specified substring within this string buffer or -1
* if not found.
*/
virtual int lastIndexOf(const String& value, int start) const;
@@ -170,7 +170,7 @@ namespace lang {
/**
* Returns the current length of the String that has been built.
*
- * @returns the current number of characters that have been inserted.
+ * @return the current number of characters that have been inserted.
*/
virtual int length() const;
@@ -208,7 +208,7 @@ namespace lang {
* @param start
* The starting index of the substring to create.
*
- * @returns a new String that is a subset of this character buffer.
+ * @return a new String that is a subset of this character buffer.
*
* @throws StringIndexOutOfBoundsException
* if start is less than zero, or greater than the length of this buffer.
@@ -225,7 +225,7 @@ namespace lang {
* @param end
* The ending index of the substring to create. (exclusive)
*
- * @returns a new String that is a subset of this character buffer.
+ * @return a new String that is a subset of this character buffer.
*
* @throws StringIndexOutOfBoundsException
* if start or end is less than zero, or end is greater than the length of this buffer
@@ -244,7 +244,7 @@ namespace lang {
* @param end
* The ending index of the substring to create. (exclusive)
*
- * @returns a new CharSequence pointer that is a subset of this character buffer.
+ * @return a new CharSequence pointer that is a subset of this character buffer.
*
* @throws StringIndexOutOfBoundsException
* if start or end is less than zero, or end is greater than the length of this buffer
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Appendable.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Appendable.h b/activemq-cpp/src/main/decaf/lang/Appendable.h
index 6109b50..226a280 100644
--- a/activemq-cpp/src/main/decaf/lang/Appendable.h
+++ b/activemq-cpp/src/main/decaf/lang/Appendable.h
@@ -50,7 +50,7 @@ namespace lang {
* @param value
* The character to append.
*
- * @returns a Reference to this Appendable
+ * @return a Reference to this Appendable
*
* @throws Exception if an error occurs.
*/
@@ -64,7 +64,7 @@ namespace lang {
* If csq is NULL, then characters will be appended as if csq contained the
* string "null".
*
- * @returns a Reference to this Appendable.
+ * @return a Reference to this Appendable.
*
* @throws Exception if an error occurs.
*/
@@ -81,7 +81,7 @@ namespace lang {
* @param end
* The index of the character following the last character in the subsequence.
*
- * @returns a Reference to this Appendable
+ * @return a Reference to this Appendable
*
* @throws Exception if an error occurs.
* @throws IndexOutOfBoundsException start is greater than end, or end is
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/ArrayPointer.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/ArrayPointer.h b/activemq-cpp/src/main/decaf/lang/ArrayPointer.h
index 6893c11..4c030ca 100755
--- a/activemq-cpp/src/main/decaf/lang/ArrayPointer.h
+++ b/activemq-cpp/src/main/decaf/lang/ArrayPointer.h
@@ -216,7 +216,7 @@ namespace lang {
*
* @param value - The new value to contain.
*
- * @returns The pointer instance that was held by this Pointer object, the pointer is
+ * @return The pointer instance that was held by this Pointer object, the pointer is
* no longer owned by this Pointer and won't be freed when this Pointer goes
* out of scope.
*/
@@ -244,7 +244,7 @@ namespace lang {
* Returns the current size of the contained array or zero if the array is
* NULL.
*
- * @returns the size of the array or zero if the array is NULL
+ * @return the size of the array or zero if the array is NULL
*/
int length() const {
return this->array->length;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Boolean.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Boolean.h b/activemq-cpp/src/main/decaf/lang/Boolean.h
index ec37b61..842612c 100644
--- a/activemq-cpp/src/main/decaf/lang/Boolean.h
+++ b/activemq-cpp/src/main/decaf/lang/Boolean.h
@@ -60,14 +60,14 @@ namespace lang{
virtual ~Boolean() {}
/**
- * @returns the primitive boolean value of this object
+ * @return the primitive boolean value of this object
*/
bool booleanValue() const {
return value;
}
/**
- * @returns the string representation of this Booleans value.
+ * @return the string representation of this Booleans value.
*/
std::string toString() const;
@@ -97,7 +97,7 @@ namespace lang{
virtual bool operator<(const Boolean& value) const;
/**
- * @returns true if the two Boolean Objects have the same value.
+ * @return true if the two Boolean Objects have the same value.
*/
bool equals(const Boolean& b) const {
return this->value == b.value;
@@ -129,7 +129,7 @@ namespace lang{
virtual bool operator<(const bool& value) const;
/**
- * @returns true if the two Boolean Objects have the same value.
+ * @return true if the two Boolean Objects have the same value.
*/
bool equals(const bool& b) const {
return this->value == b;
@@ -141,7 +141,7 @@ namespace lang{
* @param value
* The bool value to convert to a <code>Boolean</code> instance.
*
- * @returns a Boolean instance of the primitive boolean value
+ * @return a Boolean instance of the primitive boolean value
*/
static Boolean valueOf(bool value);
@@ -149,7 +149,7 @@ namespace lang{
* @param value
* The std::string value to convert to a <code>Boolean</code> instance.
*
- * @returns a Boolean instance of the string value
+ * @return a Boolean instance of the string value
*/
static Boolean valueOf(const String& value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Byte.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Byte.h b/activemq-cpp/src/main/decaf/lang/Byte.h
index 6ae606b..83bcc52 100644
--- a/activemq-cpp/src/main/decaf/lang/Byte.h
+++ b/activemq-cpp/src/main/decaf/lang/Byte.h
@@ -128,21 +128,21 @@ namespace lang {
}
/**
- * @returns true if the two Byte Objects have the same value.
+ * @return true if the two Byte Objects have the same value.
*/
bool equals(const Byte& c) const {
return this->value == c.value;
}
/**
- * @returns true if the two Bytes have the same value.
+ * @return true if the two Bytes have the same value.
*/
bool equals(const unsigned char& c) const {
return this->value == c;
}
/**
- * @returns this Byte Object as a String Representation
+ * @return this Byte Object as a String Representation
*/
std::string toString() const;
@@ -197,7 +197,7 @@ namespace lang {
public:
/**
- * @returns a string representing the primitive value as Base 10
+ * @return a string representing the primitive value as Base 10
*/
static std::string toString(unsigned char value);
@@ -216,7 +216,7 @@ namespace lang {
* @param value
* The string to decode
*
- * @returns a Byte object containing the decoded value
+ * @return a Byte object containing the decoded value
*
* @throws NumberFomatException if the string is not formatted correctly.
*/
@@ -263,7 +263,7 @@ namespace lang {
* @param s
* String to convert to a unsigned char
*
- * @returns the converted unsigned char value
+ * @return the converted unsigned char value
*
* @throws NumberFormatException if the string is not a unsigned char.
*/
@@ -275,7 +275,7 @@ namespace lang {
* @param value
* The primitive char to wrap.
*
- * @returns a new Character instance that wraps this value.
+ * @return a new Character instance that wraps this value.
*/
static Byte valueOf(unsigned char value) {
return Byte(value);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/CharSequence.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/CharSequence.h b/activemq-cpp/src/main/decaf/lang/CharSequence.h
index 507a4ec..e955469 100644
--- a/activemq-cpp/src/main/decaf/lang/CharSequence.h
+++ b/activemq-cpp/src/main/decaf/lang/CharSequence.h
@@ -39,7 +39,7 @@ namespace lang {
virtual ~CharSequence();
/**
- * @returns the length of the underlying character sequence.
+ * @return the length of the underlying character sequence.
*/
virtual int length() const = 0;
@@ -50,7 +50,7 @@ namespace lang {
* @param index
* The position to return the char at.
*
- * @returns the char at the given position.
+ * @return the char at the given position.
*
* @throws IndexOutOfBoundsException if index is > than length() or negative
*/
@@ -67,14 +67,14 @@ namespace lang {
* @param end
* The end index, exclusive.
*
- * @returns a new CharSequence
+ * @return a new CharSequence
*
* @throws IndexOutOfBoundsException if start or end > length() or start or end are negative.
*/
virtual CharSequence* subSequence(int start, int end) const = 0;
/**
- * @returns the String representation of this CharSequence
+ * @return the String representation of this CharSequence
*/
virtual std::string toString() const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Character.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Character.h b/activemq-cpp/src/main/decaf/lang/Character.h
index ad60fd1..0c666b9 100644
--- a/activemq-cpp/src/main/decaf/lang/Character.h
+++ b/activemq-cpp/src/main/decaf/lang/Character.h
@@ -139,21 +139,21 @@ namespace lang{
}
/**
- * @returns true if the two Character Objects have the same value.
+ * @return true if the two Character Objects have the same value.
*/
bool equals(const Character& c) const {
return this->value == c.value;
}
/**
- * @returns true if the two Characters have the same value.
+ * @return true if the two Characters have the same value.
*/
bool equals(const char& c) const {
return this->value == c;
}
/**
- * @returns this Character Object as a String Representation
+ * @return this Character Object as a String Representation
*/
std::string toString() const;
@@ -219,7 +219,7 @@ namespace lang{
* @param value
* the primitive char to wrap.
*
- * @returns a new Character instance that wraps this value.
+ * @return a new Character instance that wraps this value.
*/
static Character valueOf(char value) {
return Character(value);
@@ -232,7 +232,7 @@ namespace lang{
* @param c
* The character whose value is being checked.
*
- * @returns true if the character is a whitespace value.
+ * @return true if the character is a whitespace value.
*/
static bool isWhitespace(char c) {
switch (c) {
@@ -253,7 +253,7 @@ namespace lang{
* @param c
* The character whose value is being checked.
*
- * @returns true if the character is a digit value.
+ * @return true if the character is a digit value.
*/
static bool isDigit(char c) {
return c >= '0' && c <= '9';
@@ -265,7 +265,7 @@ namespace lang{
* @param c
* The character whose value is being checked.
*
- * @returns true if the character is a lower case ASCII value.
+ * @return true if the character is a lower case ASCII value.
*/
static bool isLowerCase(char c) {
return c >= 'a' && c <= 'z';
@@ -278,7 +278,7 @@ namespace lang{
* @param c
* The character whose value is being checked.
*
- * @returns true if the character is a upper case ASCII value.
+ * @return true if the character is a upper case ASCII value.
*/
static bool isUpperCase(char c) {
return c >= 'A' && c <= 'Z';
@@ -290,7 +290,7 @@ namespace lang{
* @param c
* The character whose value is being checked.
*
- * @returns true if the character is an ASCII letter value.
+ * @return true if the character is an ASCII letter value.
*/
static bool isLetter(char c) {
return isUpperCase(c) || isLowerCase(c);
@@ -303,7 +303,7 @@ namespace lang{
* @param c
* The character whose value is being checked.
*
- * @returns true if the character is an ASCII letter or numeric value.
+ * @return true if the character is an ASCII letter or numeric value.
*/
static bool isLetterOrDigit(char c) {
return isLetter(c) || isDigit(c);
@@ -344,7 +344,7 @@ namespace lang{
* @param radix
* the radix of the number
*
- * @returns the numeric value of the number represented in the given radix
+ * @return the numeric value of the number represented in the given radix
*/
static int digit(char c, int radix);
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Comparable.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Comparable.h b/activemq-cpp/src/main/decaf/lang/Comparable.h
index 18e3e0c..72c86c6 100644
--- a/activemq-cpp/src/main/decaf/lang/Comparable.h
+++ b/activemq-cpp/src/main/decaf/lang/Comparable.h
@@ -60,7 +60,7 @@ namespace lang {
* "Note: this class has a natural ordering that is inconsistent with
* equals."
* @param value - the Object to be compared.
- * @returns a negative integer, zero, or a positive integer as this
+ * @return a negative integer, zero, or a positive integer as this
* object is less than, equal to, or greater than the specified object.
*/
virtual int compareTo(const T& value) const = 0;
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Double.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Double.h b/activemq-cpp/src/main/decaf/lang/Double.h
index a296561..c762675 100644
--- a/activemq-cpp/src/main/decaf/lang/Double.h
+++ b/activemq-cpp/src/main/decaf/lang/Double.h
@@ -91,7 +91,7 @@ namespace lang {
/**
* @param d - the Double object to compare against.
- * @returns true if the two Double Objects have the same value.
+ * @return true if the two Double Objects have the same value.
*/
bool equals(const Double& d) const {
return this->value == d.value;
@@ -128,7 +128,7 @@ namespace lang {
/**
* @param d - the Double object to compare against.
- * @returns true if the two Double Objects have the same value.
+ * @return true if the two Double Objects have the same value.
*/
bool equals(const double& d) const {
return this->value == d;
@@ -154,7 +154,7 @@ namespace lang {
}
/**
- * @returns this Double Object as a String Representation
+ * @return this Double Object as a String Representation
*/
std::string toString() const;
@@ -207,12 +207,12 @@ namespace lang {
}
/**
- * @returns true if the double is equal to positive infinity.
+ * @return true if the double is equal to positive infinity.
*/
bool isInfinite() const;
/**
- * @returns true if the double is equal to NaN.
+ * @return true if the double is equal to NaN.
*/
bool isNaN() const;
@@ -225,7 +225,7 @@ namespace lang {
* new Double(d1).compareTo(new Double(d2))
* @param d1 - the first double to compare
* @param d2 - the second double to compare
- * @returns the value 0 if d1 is numerically equal to d2; a value less than
+ * @return the value 0 if d1 is numerically equal to d2; a value less than
* 0 if d1 is numerically less than d2; and a value greater than 0 if d1 is
* numerically greater than d2.
*/
@@ -251,7 +251,7 @@ namespace lang {
* same as the argument to doubleToLongBits (except all NaN values are
* collapsed to a single "canonical" NaN value).
* @param value - double to be converted
- * @returns the long long bits that make up the double
+ * @return the long long bits that make up the double
*/
static long long doubleToLongBits(double value);
@@ -278,19 +278,19 @@ namespace lang {
* longBitsToDouble(long) method, will produce a floating-point value the
* same as the argument to doubleToRawLongBits.
* @param value - double to be converted
- * @returns the long long bits that make up the double
+ * @return the long long bits that make up the double
*/
static long long doubleToRawLongBits(double value);
/**
* @param value - The double to check.
- * @returns true if the double is equal to infinity.
+ * @return true if the double is equal to infinity.
*/
static bool isInfinite(double value);
/**
* @param value - The double to check.
- * @returns true if the double is equal to NaN.
+ * @return true if the double is equal to NaN.
*/
static bool isNaN(double value);
@@ -319,7 +319,7 @@ namespace lang {
* @param value
* The string to parse to an double.
*
- * @returns a double parsed from the passed string
+ * @return a double parsed from the passed string
*
* @throws NumberFormatException
*/
@@ -357,7 +357,7 @@ namespace lang {
* there must be at least one nonzero digit in a subnormal significand.
*
* @param value - The double to convert to a string
- * @returns the Hex formatted double string.
+ * @return the Hex formatted double string.
*/
static std::string toHexString(double value);
@@ -390,7 +390,7 @@ namespace lang {
* followed by a representation of n as a decimal integer, as produced
* by the method Integer.toString(int).
* @param value - The double to convert to a string
- * @returns the formatted double string.
+ * @return the formatted double string.
*/
static std::string toString(double value);
@@ -400,7 +400,7 @@ namespace lang {
* @param value
* The double to wrap.
*
- * @returns new Double instance wrapping the primitive value
+ * @return new Double instance wrapping the primitive value
*/
static Double valueOf(double value);
@@ -411,7 +411,7 @@ namespace lang {
* @param value
* The string to parse
*
- * @returns a new Double instance wrapping the double parsed from value
+ * @return a new Double instance wrapping the double parsed from value
*
* @throws NumberFormatException on error.
*/
http://git-wip-us.apache.org/repos/asf/activemq-cpp/blob/cb372c07/activemq-cpp/src/main/decaf/lang/Exception.h
----------------------------------------------------------------------
diff --git a/activemq-cpp/src/main/decaf/lang/Exception.h b/activemq-cpp/src/main/decaf/lang/Exception.h
index 968ab4f..17c80d2 100644
--- a/activemq-cpp/src/main/decaf/lang/Exception.h
+++ b/activemq-cpp/src/main/decaf/lang/Exception.h
@@ -115,7 +115,7 @@ namespace lang {
* exception to be passed only in case the caller knows about that
* type of exception and wishes to respond to it.
*
- * @returns a const pointer reference to the causal exception, if there
+ * @return a const pointer reference to the causal exception, if there
* was no cause associated with this exception then NULL is returned.
*/
virtual const std::exception* getCause() const;