activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nmitt...@apache.org
Subject svn commit: r427774 [1/3] - in /incubator/activemq/trunk/activemq-cpp/src/main: activemq/concurrent/ activemq/connector/ activemq/connector/stomp/ activemq/connector/stomp/commands/ activemq/connector/stomp/marshal/ activemq/core/ activemq/io/ activemq...
Date Tue, 01 Aug 2006 22:30:26 GMT
Author: nmittler
Date: Tue Aug  1 15:30:22 2006
New Revision: 427774

URL: http://svn.apache.org/viewvc?rev=427774&view=rev
Log:
patch for AMQ-854 - adding Javadoc-style comments to support autogeneration of documentation for activemq-cpp

Modified:
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Mutex.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/PooledThread.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Synchronizable.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/TaskListener.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Thread.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/ThreadPool.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/Connector.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorException.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactory.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMap.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMapRegistrar.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConsumerInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ProducerInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/SessionInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/TransactionInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.cpp
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorException.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorFactory.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConsumerInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompDestination.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompFrame.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompProducerInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompQueue.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionManager.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTopic.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTransactionInfo.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbortCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbstractCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AckCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BeginCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BytesMessageCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/CommitCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectedCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/DisconnectCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ErrorCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ReceiptCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/StompCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/StompMessage.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/SubscribeCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/UnsubscribeCommand.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/marshal/MarshalException.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/marshal/Marshaler.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQAckHandler.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnection.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionData.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConnectionFactory.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConstants.cpp
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConstants.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQConsumer.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQDestination.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQMessage.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/core/ActiveMQTransaction.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/io/BufferedInputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/io/BufferedOutputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/io/ByteArrayInputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/io/IOException.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/io/InputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/io/OutputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/ConsoleHandler.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Filter.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Formatter.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Handler.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LogManager.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LogRecord.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LogWriter.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Logger.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LoggerHierarchy.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/MarkBlockLogger.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/PropertiesChangeListener.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/SimpleFormatter.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/BufferedSocket.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketFactory.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketInputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketOutputStream.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.cpp
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/BrokerError.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Command.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/CommandIOException.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ExceptionResponse.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/FutureResponse.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/IOTransport.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Response.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ResponseCorrelator.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TcpTransport.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactory.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.cpp
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMapRegistrar.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFilter.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Properties.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Queue.h
    incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/SimpleProperties.h
    incubator/activemq/trunk/activemq-cpp/src/main/cms/ConnectionFactory.h
    incubator/activemq/trunk/activemq-cpp/src/main/cms/DeliveryMode.h
    incubator/activemq/trunk/activemq-cpp/src/main/cms/Message.h
    incubator/activemq/trunk/activemq-cpp/src/main/cms/MessageProducer.h

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Mutex.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Mutex.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Mutex.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Mutex.h Tue Aug  1 15:30:22 2006
@@ -114,6 +114,7 @@
       
         /**
          * Locks the object.
+         * @throws ActiveMQException
          */
         virtual void lock() throw( exceptions::ActiveMQException )
         {
@@ -136,6 +137,7 @@
       
         /**
          * Unlocks the object.
+         * @throws ActiveMQException
          */
         virtual void unlock() throw( exceptions::ActiveMQException )
         {
@@ -168,6 +170,7 @@
         /**
          * Waits on a signal from this object, which is generated
          * by a call to Notify.
+         * @throws ActiveMQException
          */
         virtual void wait() throw( exceptions::ActiveMQException )
         {
@@ -180,6 +183,8 @@
          * by a call to Notify.  Must have this object locked before
          * calling.  This wait will timeout after the specified time
          * interval.
+         * @param millisecs the time in milliseconds to wait.
+         * @throws ActiveMQException
          */
         virtual void wait( unsigned long millisecs ) 
             throw( exceptions::ActiveMQException )
@@ -287,6 +292,7 @@
         /**
          * Signals a waiter on this object that it can now wake
          * up and continue.
+         * @throws ActiveMQException
          */
         virtual void notify() throw( exceptions::ActiveMQException )
         {
@@ -312,6 +318,7 @@
         /**
          * Signals the waiters on this object that it can now wake
          * up and continue.
+         * @throws ActiveMQException
          */
         virtual void notifyAll() throw( exceptions::ActiveMQException )
         {
@@ -345,6 +352,7 @@
    
         /**
          * Check if the calling thread is the Lock Owner
+         * @retuns true if the caller is the lock owner
          */
         bool isLockOwner()
         {

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/PooledThread.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/PooledThread.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/PooledThread.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/PooledThread.h Tue Aug  1 15:30:22 2006
@@ -53,12 +53,10 @@
    
         /**
          * Constructor
+         * @param pool the parant ThreadPool object
          */
-        PooledThread(ThreadPool* pool);
+        PooledThread( ThreadPool* pool );
 
-        /**
-         * Destructor
-         */
         virtual ~PooledThread(void);
 
         /**
@@ -71,6 +69,7 @@
         /**
          * Stops the Thread, thread will complete its task if currently
          * running one, and then die.  Does not block.
+         * @throws CMSException
          */
         virtual void stop(void) throw ( cms::CMSException );
       
@@ -78,14 +77,16 @@
          * Checks to see if the thread is busy, if busy it means
          * that this thread has taken a task from the ThreadPool's
          * queue and is processing it.
+         * @returns true if the Thread is busy
          */
         virtual bool isBusy(void) { return busy; }
 
         /**
          * Adds a listener to this <code>PooledThread</code> to be
          * notified when this thread starts and completes a task.
+         * @param listener the listener to send notifications to.
          */
-        virtual void setPooledThreadListener(PooledThreadListener* listener)
+        virtual void setPooledThreadListener( PooledThreadListener* listener )
         {
             this->listener = listener;
         }
@@ -93,6 +94,7 @@
         /**
          * Removes a listener for this <code>PooledThread</code> to be
          * notified when this thread starts and completes a task.
+         * @return a pointer to this thread's listener or NULL
          */
         virtual PooledThreadListener* getPooledThreadListener(void)
         {

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Synchronizable.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Synchronizable.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Synchronizable.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Synchronizable.h Tue Aug  1 15:30:22 2006
@@ -58,7 +58,8 @@
          * by a call to Notify.  Must have this object locked before
          * calling.  This wait will timeout after the specified time
          * interval.
-         * @param time in millisecsonds to wait, or WAIT_INIFINITE
+         * @param millisecs the time in millisecsonds to wait, or 
+         * WAIT_INIFINITE
          * @throws ActiveMQException
          */
         virtual void wait(unsigned long millisecs) 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/TaskListener.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/TaskListener.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/TaskListener.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/TaskListener.h Tue Aug  1 15:30:22 2006
@@ -32,19 +32,19 @@
         /**
          * Called when a queued task has completed, the task that
          * finished is passed along for user consumption
-         * @param Runnable Pointer to the task that finished
+         * @param task Runnable Pointer to the task that finished
          */
-        virtual void onTaskComplete(Runnable* task) = 0;
+        virtual void onTaskComplete( Runnable* task ) = 0;
        
         /**
          * Called when a queued task has thrown an exception while
          * being run.  The Callee should assume that this was an 
          * unrecoverable exeption and that this task is now defunct.
-         * @param Runnable Pointer to the task
-         * @param The ActiveMQException that was thrown.
+         * @param task Runnable Pointer to the task
+         * @param ex The ActiveMQException that was thrown.
          */
         virtual void onTaskException( Runnable* task, 
-                                      exceptions::ActiveMQException& ex) = 0;
+                                      exceptions::ActiveMQException& ex ) = 0;
        
     };
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Thread.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Thread.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Thread.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/Thread.h Tue Aug  1 15:30:22 2006
@@ -71,8 +71,17 @@
        
     public:
       
+        /**
+         * default Constructor
+         */
         Thread();
-        Thread( Runnable* task );     
+        
+        /**
+         * Constructor
+         * @param task the Runnable that this thread manages
+         */
+        Thread( Runnable* task );    
+         
         virtual ~Thread();
    
         /** 
@@ -88,10 +97,6 @@
         /**
          * Wait til the thread exits. This is when the run()
          * method has returned or has thrown an exception.
-         * If an exception was thrown in the run() method,
-         * join() will return the thrown exception. Otherwise
-         * (if run() returned normally), join() will
-         * return NULL.
          */
         virtual void join() throw ( exceptions::ActiveMQException );
        
@@ -107,6 +112,7 @@
          *   
          * Note that this method is a static method that applies to the
          * calling thread and not to the thread object.
+         * @param millisecs time in milliseconds to sleep
          */
         static void sleep( int millisecs );
        

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/ThreadPool.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/ThreadPool.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/ThreadPool.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/concurrent/ThreadPool.h Tue Aug  1 15:30:22 2006
@@ -98,10 +98,10 @@
          * Queue a task to be completed by one of the Pooled Threads.
          * tasks are serviced as soon as a <code>PooledThread</code>
          * is available to run it.
-         * @param object that derives from Runnable
+         * @param task object that derives from Runnable
          * @throws ActiveMQException
          */
-        virtual void queueTask(Task task) 
+        virtual void queueTask( Task task ) 
             throw ( exceptions::ActiveMQException );
 
         /**
@@ -138,7 +138,7 @@
          * number of threads in the pool, then only MAX threads are 
          * reservved.  If the size is smaller than the number of threads
          * currently in the pool, than nothing is done.
-         * @param number of threads to reserve.
+         * @param size the number of threads to reserve.
          */
         virtual void reserve( unsigned long size );
       
@@ -152,6 +152,7 @@
          * Sets the Max number of threads this pool can contian. 
          * if this value is smaller than the current size of the
          * pool nothing is done.
+         * @param maxThreads total number of threads that can be pooled
          */
         virtual void setMaxThreads( unsigned long maxThreads );
       
@@ -165,7 +166,7 @@
         /**
          * Sets the Max number of Threads that can be allocated at a time
          * when the Thread Pool determines that more Threads are needed.  
-         * @param Max Thread Block Size
+         * @param blockSize Max Thread Block Size
          */
         virtual void setBlockSize( unsigned long blockSize );
       
@@ -176,7 +177,9 @@
          * after and be available again.  This is informational only.
          * @return totoal free threads
          */
-        virtual unsigned long getFreeThreadCount(void) const { return freeThreads; }
+        virtual unsigned long getFreeThreadCount(void) const { 
+            return freeThreads; 
+        }
 
     public: // PooledThreadListener Callbacks
       
@@ -185,7 +188,7 @@
          * executing a new task.  This will decrement the available
          * threads counter so that this object knows when there are
          * no more free threads and must create new ones.
-         * @param Pointer to the Pooled Thread that is making this call
+         * @param thread Pointer to the Pooled Thread that is making this call
          */
         virtual void onTaskStarted( PooledThread* thread );
        
@@ -193,7 +196,7 @@
          * Called by a pooled thread when it has completed a task
          * and is going back to waiting for another task to run,
          * this will increment the free threads counter.
-         * @param Pointer the the Pooled Thread that is making this call.
+         * @param thread Pointer the the Pooled Thread that is making this call.
          */
         virtual void onTaskCompleted( PooledThread* thread );
 
@@ -202,11 +205,11 @@
          * while running a user task, after receiving this notification
          * the callee should assume that the PooledThread is now no longer
          * running.
-         * @param Pointer to the Pooled Thread that is making this call
-         * @param The Exception that occured.
+         * @param thread Pointer to the Pooled Thread that is making this call
+         * @param ex The Exception that occured.
          */
         virtual void onTaskException( PooledThread* thread, 
-                                      exceptions::ActiveMQException& ex);
+                                      exceptions::ActiveMQException& ex );
 
     public:   // Statics
 
@@ -214,14 +217,16 @@
          * Return the one and only Thread Pool instance.
          * @return The Thread Pool Pointer
          */
-        static ThreadPool* getInstance(void) { return &instance; }
+        static ThreadPool* getInstance(void) { 
+            return &instance;
+        }
 
     private:
    
         /**
          * Allocates the requested ammount of Threads, won't exceed
          * <code>maxThreads</code>.
-         * @param the number of threads to create
+         * @param count the number of threads to create
          */
         void AllocateThreads( unsigned long count ); 
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/Connector.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/Connector.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/Connector.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/Connector.h Tue Aug  1 15:30:22 2006
@@ -324,6 +324,7 @@
          */
         virtual void setExceptionListener(
             cms::ExceptionListener* listener ) = 0;
+
     };
 
 }}

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorException.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorException.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorException.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorException.h Tue Aug  1 15:30:22 2006
@@ -29,13 +29,33 @@
     {
     public:
    
+        /**
+         * Default Constructor
+         */
         ConnectorException() {}
+
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy
+         */
         ConnectorException( const exceptions::ActiveMQException& ex ){
             *(ActiveMQException*)this = ex;
         }
+
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy, which is an instance of this type
+         */
         ConnectorException( const ConnectorException& ex ){
             *(exceptions::ActiveMQException*)this = ex;
         }
+
+        /**
+         * Consturctor
+         * @param file name of the file were the exception occured.
+         * @param lineNumber line where the exception occured
+         * @param msg the message that was generated
+         */
         ConnectorException( const char* file, 
                             const int lineNumber, 
                             const char* msg, ... )

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactory.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactory.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactory.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactory.h Tue Aug  1 15:30:22 2006
@@ -35,12 +35,12 @@
 
         /** 
          * Creates a connector
-         * @param The Properties that the new connector is configured with
-         * @param the Transport that the connector should use
+         * @param properties The Properties that the new connector is configured with
+         * @param transport the Transport that the connector should use
          */
         virtual Connector* createConnector(
             const activemq::util::Properties& properties,
-            activemq::transport::Transport*   transport ) = 0;
+            activemq::transport::Transport* transport ) = 0;
 
    };
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMap.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMap.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMap.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMap.h Tue Aug  1 15:30:22 2006
@@ -57,14 +57,14 @@
 
         /**
          * Lookup the named factory in the Map
-         * @param the factory name to lookup
+         * @param name the factory name to lookup
          * @return the factory assciated with the name, or NULL
          */
         ConnectorFactory* lookup( const std::string& name );
       
         /**
          * Fetch a list of factory names that this Map contains
-         * @param vector object to receive the list
+         * @param factoryList vector object to receive the list
          * @returns count of factories.
          */
         std::size_t getFactoryNames( std::vector< std::string >& factoryList );

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMapRegistrar.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMapRegistrar.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMapRegistrar.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConnectorFactoryMapRegistrar.h Tue Aug  1 15:30:22 2006
@@ -35,13 +35,13 @@
         /** 
          * Constructor for this class
          * @param name of the factory to register
-         * @param the factory
-         * @param boolean indicating if this object manages the lifetime of 
-         *        the factory that is being registered.
+         * @param factory the factory
+         * @param manageLifetime boolean indicating if this object manages the 
+         * lifetime of the factory that is being registered.
          */
         ConnectorFactoryMapRegistrar( const std::string& name, 
-                                      ConnectorFactory*  factory,
-                                      bool               manageLifetime = true )
+                                      ConnectorFactory* factory,
+                                      bool manageLifetime = true )
         {       
             // Register it in the map.
             ConnectorFactoryMap::getInstance()->

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConsumerInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConsumerInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConsumerInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ConsumerInfo.h Tue Aug  1 15:30:22 2006
@@ -39,7 +39,7 @@
         
         /**
          * Sets this message consumer's message selector expression.
-         * @param This Consumer's selector expression or "".
+         * @param selector This Consumer's selector expression or "".
          */
         virtual void setMessageSelector( const std::string& selector ) = 0;        
 
@@ -51,7 +51,7 @@
         
         /**
          * Sets the ID that is assigned to this consumer
-         * @return string value of the Consumer Id.
+         * @return id string value of the Consumer Id.
          */
         virtual void setConsumerId( const unsigned int id ) = 0;
         
@@ -63,7 +63,7 @@
         
         /**
          * Sets the destination that this Consumer is listening on
-         * @param Destination
+         * @param destination Destination
          */
         virtual void setDestination( const cms::Destination& destination ) = 0;
 
@@ -75,7 +75,7 @@
 
         /**
          * Gets the Session Info that this consumer is attached too
-         * @return SessionnInfo pointer
+         * @return session SessionnInfo pointer
          */
         virtual void setSessionInfo( const SessionInfo* session ) = 0;
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ProducerInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ProducerInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ProducerInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/ProducerInfo.h Tue Aug  1 15:30:22 2006
@@ -40,9 +40,9 @@
     
         /**
          * Sets the Default Destination for this Producer
-         * @param reference to a destination, copied internally
+         * @param destination reference to a destination, copied internally
          */
-        virtual void setDestination( const cms::Destination& dest ) = 0;
+        virtual void setDestination( const cms::Destination& destination ) = 0;
 
         /**
          * Gets the ID that is assigned to this Producer
@@ -52,7 +52,7 @@
         
         /**
          * Sets the ID that is assigned to this Producer
-         * @return string value of the Producer Id.
+         * @return id string value of the Producer Id.
          */
         virtual void setProducerId( const unsigned int id ) = 0;
 
@@ -64,7 +64,7 @@
 
         /**
          * Gets the Session Info that this consumer is attached too
-         * @return SessionnInfo pointer
+         * @param session SessionnInfo pointer
          */
         virtual void setSessionInfo( const SessionInfo* session ) = 0;
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/SessionInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/SessionInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/SessionInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/SessionInfo.h Tue Aug  1 15:30:22 2006
@@ -40,7 +40,7 @@
         /**
          * Sets the Connection Id of the Connection that this consumer is
          * using to receive its messages.
-         * @param string value of the connection id
+         * @param id string value of the connection id
          */
         virtual void setConnectionId( const std::string& id ) = 0;
         
@@ -52,13 +52,13 @@
 
         /**
          * Sets the Session Id for this Session
-         * @param integral id value for this session
+         * @param id integral id value for this session
          */
         virtual void setSessionId( const unsigned int id ) = 0;
 
         /**
          * Sets the Ack Mode of this Session Info object
-         * @param Ack Mode
+         * @param ackMode Ack Mode
          */
         virtual void setAckMode(cms::Session::AcknowledgeMode ackMode) = 0;
         
@@ -79,7 +79,7 @@
         /**
          * Sets the current transaction info for this session, this is nit
          * used when the session is not transacted.
-         * @param Transaction Id
+         * @param transaction Transaction Id
          */        
         virtual void setTransactionInfo( const TransactionInfo* transaction ) = 0;
         

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/TransactionInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/TransactionInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/TransactionInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/TransactionInfo.h Tue Aug  1 15:30:22 2006
@@ -38,7 +38,7 @@
 
         /**
          * Sets the Transction Id
-         * @param unsigned int Id
+         * @param id unsigned int Id
          */
         virtual void setTransactionId( const unsigned int id ) = 0;
 
@@ -50,7 +50,7 @@
 
         /**
          * Gets the Session Info that this transaction is attached too
-         * @return SessionnInfo pointer
+         * @return session SessionnInfo pointer
          */
         virtual void setSessionInfo( const SessionInfo* session ) = 0;
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.cpp
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.cpp?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.cpp (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.cpp Tue Aug  1 15:30:22 2006
@@ -419,8 +419,8 @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-void StompConnector::send(cms::Message* message, 
-                          ProducerInfo* producerInfo ) 
+void StompConnector::send( cms::Message* message, 
+                           ProducerInfo* producerInfo ) 
     throw ( ConnectorException )
 {
     try

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnector.h Tue Aug  1 15:30:22 2006
@@ -138,6 +138,8 @@
         
         /**
          * Fires a consumer message to the observer.
+         * @param consumer the consumerinfo to use to fire with
+         * @param msg the Message object to send
          */
         void fire( ConsumerInfo* consumer, core::ActiveMQMessage* msg ){
             try{
@@ -151,6 +153,7 @@
         
         /**
          * Fires an exception event to the observing object.
+         * @param ex the exception to fire
          */
         void fire( const exceptions::ActiveMQException& ex ){
             try{
@@ -166,7 +169,7 @@
          * Constructor for the stomp connector.
          * @param transport the transport object for sending/receiving
          * commands on the wire.
-         * @param props properties for configuring the connector.
+         * @param properties properties for configuring the connector.
          */
         StompConnector( transport::Transport* transport, 
                         const util::Properties& properties )
@@ -222,7 +225,7 @@
         /**
          * Gets a reference to the Transport that this connection
          * is using.
-         * @param reference to a transport
+         * @return reference to a transport
          * @throws InvalidStateException if the Transport is not set
          */
         virtual transport::Transport& getTransport(void) const 
@@ -240,7 +243,7 @@
 
         /**
          * Creates a Session Info object for this connector
-         * @param Acknowledgement Mode of the Session
+         * @param ackMode Acknowledgement Mode of the Session
          * @returns Session Info Object
          * @throws ConnectorException
          */
@@ -250,8 +253,9 @@
       
         /** 
          * Create a Consumer for the given Session
-         * @param Destination to Subscribe to.
-         * @param Session Information.
+         * @param destination Destination to Subscribe to.
+         * @param session the session this consumer is attached to
+         * @param selector the selector string for this consumer
          * @return Consumer Information
          * @throws ConnectorException
          */
@@ -263,11 +267,11 @@
          
         /** 
          * Create a Durable Consumer for the given Session
-         * @param Topic to Subscribe to.
-         * @param Session Information.
-         * @param name of the Durable Topic
-         * @param Selector
-         * @param if set, inhibits the delivery of messages 
+         * @param topic Topic to Subscribe to.
+         * @param session Session Information.
+         * @param name name of the Durable Topic
+         * @param selector Selector String
+         * @param noLocal if set, inhibits the delivery of messages 
          *        published by its own connection 
          * @return Consumer Information
          * @throws ConnectorException
@@ -282,20 +286,20 @@
 
         /** 
          * Create a Consumer for the given Session
-         * @param Destination to Subscribe to.
-         * @param Session Information.
+         * @param destination Destination to Subscribe to.
+         * @param session Session Information.
          * @return Producer Information
          * @throws ConnectorException
          */
         virtual ProducerInfo* createProducer(
             const cms::Destination* destination, 
-            SessionInfo* session)
+            SessionInfo* session )
                 throw ( ConnectorException );
 
         /**
          * Creates a Topic given a name and session info
-         * @param Topic Name
-         * @param Session Information
+         * @param name Topic Name
+         * @param session Session Information
          * @return a newly created Topic Object
          * @throws ConnectorException
          */
@@ -305,8 +309,8 @@
           
         /**
          * Creates a Queue given a name and session info
-         * @param Queue Name
-         * @param Session Information
+         * @param name Queue Name
+         * @param session Session Information
          * @return a newly created Queue Object
          * @throws ConnectorException
          */
@@ -316,8 +320,7 @@
 
         /**
          * Creates a Temporary Topic given a name and session info
-         * @param Temporary Topic Name
-         * @param Session Information
+         * @param session Session Information
          * @return a newly created Temporary Topic Object
          * @throws ConnectorException
          */
@@ -327,8 +330,7 @@
           
         /**
          * Creates a Temporary Queue given a name and session info
-         * @param Temporary Queue Name
-         * @param Session Information
+         * @param session Session Information
          * @return a newly created Temporary Queue Object
          * @throws ConnectorException
          */
@@ -338,8 +340,8 @@
 
         /**
          * Sends a Message
-         * @param The Message to send.
-         * @param Producer Info for the sender of this message
+         * @param message The Message to send.
+         * @param producerInfo Producer Info for the sender of this message
          * @throws ConnectorException
          */
         virtual void send( cms::Message* message, ProducerInfo* producerInfo ) 
@@ -347,8 +349,8 @@
       
         /**
          * Sends a set of Messages
-         * @param List of Messages to send.
-         * @param Producer Info for the sender of this message
+         * @param messages List of Messages to send.
+         * @param producerInfo Producer Info for the sender of this message
          * @throws ConnectorException
          */
         virtual void send( std::list<cms::Message*>& messages,
@@ -357,7 +359,9 @@
          
         /**
          * Acknowledges a Message
-         * @param An ActiveMQMessage to Ack.
+         * @param session An ActiveMQMessage to Ack.
+         * @param message a message to acknowledge
+         * @param ackType the type of acknowledgement mode to use
          * @throws ConnectorException
          */
         virtual void acknowledge( const SessionInfo* session,
@@ -367,7 +371,7 @@
 
         /**
          * Starts a new Transaction.
-         * @param Session Information
+         * @param session Session Information
          * @throws ConnectorException
          */
         virtual TransactionInfo* startTransaction(
@@ -376,8 +380,8 @@
          
         /**
          * Commits a Transaction.
-         * @param The Transaction information
-         * @param Session Information
+         * @param transaction The Transaction information
+         * @param session Session Information
          * @throws ConnectorException
          */
         virtual void commit( TransactionInfo* transaction, 
@@ -386,8 +390,8 @@
 
         /**
          * Rolls back a Transaction.
-         * @param The Transaction information
-         * @param Session Information
+         * @param transaction The Transaction information
+         * @param session Session Information
          * @throws ConnectorException
          */
         virtual void rollback( TransactionInfo* transaction, 
@@ -396,8 +400,8 @@
 
         /**
          * Creates a new Message.
-         * @param Session Information
-         * @param Transaction Info for this Message
+         * @param session Session Information
+         * @param transaction Transaction Info for this Message
          * @throws ConnectorException
          */
         virtual cms::Message* createMessage(
@@ -407,8 +411,8 @@
 
         /**
          * Creates a new BytesMessage.
-         * @param Session Information
-         * @param Transaction Info for this Message
+         * @param session Session Information
+         * @param transaction Transaction Info for this Message
          * @throws ConnectorException
          */
         virtual cms::BytesMessage* createBytesMessage(
@@ -418,8 +422,8 @@
 
         /**
          * Creates a new TextMessage.
-         * @param Session Information
-         * @param Transaction Info for this Message
+         * @param session Session Information
+         * @param transaction Transaction Info for this Message
          * @throws ConnectorException
          */
         virtual cms::TextMessage* createTextMessage(
@@ -429,8 +433,8 @@
 
         /**
          * Creates a new MapMessage.
-         * @param Session Information
-         * @param Transaction Info for this Message
+         * @param session Session Information
+         * @param transaction Transaction Info for this Message
          * @throws ConnectorException
          */
         virtual cms::MapMessage* createMapMessage(
@@ -440,7 +444,7 @@
 
         /** 
          * Unsubscribe from a givenDurable Subscription
-         * @param name of the Subscription
+         * @param name name of the Subscription
          * @throws ConnectorException
          */
         virtual void unsubscribe( const std::string& name )
@@ -448,7 +452,7 @@
 
         /**
          * Destroys the given connector resource.
-         * @param resource the resource to be destroyed.
+         * @param resource resource the resource to be destroyed.
          * @throws ConnectorException
          */
         virtual void destroyResource( ConnectorResource* resource )
@@ -456,7 +460,7 @@
             
         /** 
          * Sets the listener of consumer messages.
-         * @param listener the observer.
+         * @param listener listener the observer.
          */
         virtual void setConsumerMessageListener(
             ConsumerMessageListener* listener )
@@ -471,7 +475,7 @@
 
         /** 
          * Sets the Listner of exceptions for this connector
-         * @param ExceptionListener the observer.
+         * @param listener ExceptionListener the observer.
          */
         virtual void setExceptionListener(
             cms::ExceptionListener* listener )
@@ -484,7 +488,7 @@
         /**
          * Event handler for the receipt of a non-response command from the 
          * transport.
-         * @param command the received command object.
+         * @param command command the received command object.
          */
         virtual void onCommand( transport::Command* command );
         
@@ -503,7 +507,7 @@
 
         /**
          * Process the Stomp Command
-         * @param command to process
+         * @param command command to process
          * @throw ConnterException
          */
         virtual void onStompCommand( commands::StompCommand* command ) 
@@ -515,8 +519,8 @@
          * Registers a Command Listener using the CommandId specified
          * if there is already a listener for that command it will be
          * removed.
-         * @param CommandId to process
-         * @param pointer to the listener to call
+         * @param commandId CommandId to process
+         * @param listener pointer to the listener to call
          */
         virtual void addCmdListener( 
             commands::CommandConstants::CommandId commandId,
@@ -524,7 +528,7 @@
         
         /**
          * UnRegisters a Command Listener using the CommandId specified
-         * @param CommandId of the listener to remove.
+         * @param commandId CommandId of the listener to remove.
          */
         virtual void removeCmdListener( 
             commands::CommandConstants::CommandId commandId );

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorException.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorException.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorException.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorException.h Tue Aug  1 15:30:22 2006
@@ -30,34 +30,55 @@
     {
     public:
    
-      StompConnectorException() {}
-      StompConnectorException( const exceptions::ActiveMQException& ex ){
-        *(ActiveMQException*)this = ex;
-      }
-      StompConnectorException( const StompConnectorException& ex ){
-        *(exceptions::ActiveMQException*)this = ex;
-      }
-      StompConnectorException(const char* file, const int lineNumber, 
-        const char* msg, ...)
-      {
-          va_list vargs;
-          va_start( vargs, msg );
-          buildMessage( msg, vargs );
+        /**
+         * Default Constructor
+         */
+        StompConnectorException() {}
+
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy
+         */
+        StompConnectorException( const exceptions::ActiveMQException& ex ){
+            *( ActiveMQException* )this = ex;
+        }
+
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy, which is an instance of this type
+         */
+        StompConnectorException( const StompConnectorException& ex ){
+            *( exceptions::ActiveMQException* )this = ex;
+        }
+
+        /**
+         * Consturctor
+         * @param file name of the file were the exception occured.
+         * @param lineNumber line where the exception occured
+         * @param msg the message that was generated
+         */
+        StompConnectorException( const char* file, 
+                                 const int lineNumber, 
+                                 const char* msg, ... )
+        {
+            va_list vargs;
+            va_start( vargs, msg );
+            buildMessage( msg, vargs );
             
-          // Set the first mark for this exception.
-          setMark( file, lineNumber );
-      }
+            // Set the first mark for this exception.
+            setMark( file, lineNumber );
+        }
       
-      /**
-       * Clones this exception.  This is useful for cases where you need
-       * to preserve the type of the original exception as well as the message.
-       * All subclasses should override.
-       */
-      virtual exceptions::ActiveMQException* clone() const{
-          return new StompConnectorException( *this );
-      }
+        /**
+         * Clones this exception.  This is useful for cases where you need
+         * to preserve the type of the original exception as well as the message.
+         * All subclasses should override.
+         */
+        virtual exceptions::ActiveMQException* clone() const{
+            return new StompConnectorException( *this );
+        }
       
-      virtual ~StompConnectorException() {}
+        virtual ~StompConnectorException() {}
 
     };
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorFactory.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorFactory.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorFactory.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConnectorFactory.h Tue Aug  1 15:30:22 2006
@@ -32,7 +32,9 @@
    
         /** 
          * Creates a StompConnector
-         * @param The Properties that the new connector is configured with
+         * @param properties The Properties that the new connector is 
+         * configured with
+         * @param transport the Transport instance this connector uses.
          */
         virtual Connector* createConnector(
             const activemq::util::Properties& properties,

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConsumerInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConsumerInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConsumerInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompConsumerInfo.h Tue Aug  1 15:30:22 2006
@@ -58,7 +58,7 @@
         
         /**
          * Sets this message consumer's message selector expression.
-         * @param This Consumer's selector expression or "".
+         * @param selector This Consumer's selector expression or "".
          */
         virtual void setMessageSelector( const std::string& selector ) {
             this->selector = selector;
@@ -74,7 +74,7 @@
         
         /**
          * Sets the ID that is assigned to this consumer
-         * @return string value of the Consumer Id.
+         * @param id value of the Consumer Id.
          */
         virtual void setConsumerId( const unsigned int id ) {
             this->consumerId = id;
@@ -82,7 +82,7 @@
         
         /**
          * Gets the Destination that this Consumer is subscribed on
-         * @return Destination
+         * @return Destination this consumer is attached to
          */
         virtual const cms::Destination& getDestination(void) const {
             return *destination;
@@ -90,7 +90,7 @@
         
         /**
          * Sets the destination that this Consumer is listening on
-         * @param Destination
+         * @param destination Destination this consumer is attached to
          */
         virtual void setDestination( const cms::Destination& destination ) {
             this->destination = destination.clone();
@@ -106,7 +106,7 @@
         
         /**
          * Gets the Session Info that this consumer is attached too
-         * @return SessionnInfo pointer
+         * @param session SessionnInfo for this consumer
          */
         virtual void setSessionInfo( const SessionInfo* session ) {
             this->session = session;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompDestination.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompDestination.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompDestination.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompDestination.h Tue Aug  1 15:30:22 2006
@@ -38,15 +38,15 @@
 
         /**
          * Copy Consturctor
-         * @param CMS Dest to Copy, must be a compatible type
+         * @param source CMS Dest to Copy, must be a compatible type
          */
     	StompDestination( const cms::Destination* source ) :
             core::ActiveMQDestination<T>( source ) {}
         
         /**
          * Custom Constructor
-         * @param string destination name plus any params
-         * @param type of destination this represents.
+         * @param name string destination name plus any params
+         * @param type the type of destination this represents.
          */
     	StompDestination( const std::string& name,
                           cms::Destination::DestinationType type ) :
@@ -57,7 +57,7 @@
         /**
          * Retrieves the name of this destination, plus the stomp
          * destination decorator
-         * @return name
+         * @return name in a format that is used by the broker
          */
         virtual std::string toProviderString(void) const {
             return getPrefix() + core::ActiveMQDestination<T>::getName();
@@ -66,7 +66,7 @@
         /**
          * Converts the Destination Name into a String minus the 
          * stomp decorator
-         * @return string name
+         * @return string name of the desintation
          */
         virtual std::string toString(void) const {
             return core::ActiveMQDestination<T>::getName();

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompFrame.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompFrame.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompFrame.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompFrame.h Tue Aug  1 15:30:22 2006
@@ -63,7 +63,7 @@
         
         /**
          * Sets the command for this stomp frame.
-         * @param command The command to be set.
+         * @param cmd command The command to be set.
          */
         void setCommand( const std::string& cmd ){
             this->command = cmd;
@@ -78,6 +78,7 @@
         
         /**
          * Gets access to the header properties for this frame.
+         * @return the Properties object owned by this Frame
          */
         util::Properties& getProperties(void){ return properties; }
         const util::Properties& getProperties(void) const { 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompProducerInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompProducerInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompProducerInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompProducerInfo.h Tue Aug  1 15:30:22 2006
@@ -33,15 +33,15 @@
         unsigned int producerId;
 
         // Default Destination
-        cms::Destination* dest;
+        cms::Destination* destination;
         
         // Session that this producer is attached to - we do not own this
         const SessionInfo* session;
         
     public:
 
-    	StompProducerInfo(void) { dest = NULL; }
-    	virtual ~StompProducerInfo(void) { delete dest; }
+    	StompProducerInfo(void) { destination = NULL; }
+    	virtual ~StompProducerInfo(void) { delete destination; }
 
         /**
          * Retrieves the default destination that this producer
@@ -49,15 +49,15 @@
          * @return Destionation, owned by this object
          */
         virtual const cms::Destination& getDestination(void) const {
-            return *dest;
+            return *destination;
         }
 
         /**
          * Sets the Default Destination for this Producer
-         * @param reference to a destination, copied internally
+         * @param destination reference to a destination, copied internally
          */
-        virtual void setDestination( const cms::Destination& dest ) {
-            this->dest = dest.clone();
+        virtual void setDestination( const cms::Destination& destination ) {
+            this->destination = destination.clone();
         }
 
         /**
@@ -70,7 +70,7 @@
         
         /**
          * Sets the ID that is assigned to this Producer
-         * @return string value of the Producer Id.
+         * @return id string value of the Producer Id.
          */
         virtual void setProducerId( const unsigned int id ) {
             this->producerId = id;
@@ -86,7 +86,7 @@
 
         /**
          * Gets the Session Info that this consumer is attached too
-         * @return SessionnInfo pointer
+         * @return session SessionnInfo pointer
          */
         virtual void setSessionInfo( const SessionInfo* session ) {
             this->session = session;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompQueue.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompQueue.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompQueue.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompQueue.h Tue Aug  1 15:30:22 2006
@@ -32,17 +32,16 @@
 
         /**
          * Copy Consturctor
-         * @param CMS Dest to Copy, must be a compatible type
+         * @param source CMS Dest to Copy, must be a compatible type
          */
     	StompQueue( const cms::Destination* source ) : 
             StompDestination< cms::Queue >( source ) {}
 
         /**
          * Custom Constructor
-         * @param string destination name plus any params
-         * @param type of destination this represents.
+         * @param name string destination name plus any params
          */
-        StompQueue(const std::string& name) : 
+        StompQueue( const std::string& name ) : 
             StompDestination< cms::Queue >( name, cms::Destination::QUEUE )
         {}
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionInfo.h Tue Aug  1 15:30:22 2006
@@ -64,7 +64,7 @@
         /**
          * Sets the Connection Id of the Connection that this consumer is
          * using to receive its messages.
-         * @param string value of the connection id
+         * @param id string value of the connection id
          */
         virtual void setConnectionId( const std::string& id ){
             connectionId = id;
@@ -80,7 +80,7 @@
 
         /**
          * Sets the Session Id for this Session
-         * @param integral id value for this session
+         * @param id integral id value for this session
          */
         virtual void setSessionId( const unsigned int id ) {
             this->sessionId = id;
@@ -88,7 +88,7 @@
 
         /**
          * Sets the Ack Mode of this Session Info object
-         * @param Ack Mode
+         * @param ackMode Ack Mode
          */
         virtual void setAckMode(cms::Session::AcknowledgeMode ackMode) {
             this->ackMode = ackMode;
@@ -115,7 +115,7 @@
         /**
          * Sets the current transaction info for this session, this is nit
          * used when the session is not transacted.
-         * @param Transaction Id
+         * @param transaction Transaction Id
          */        
         virtual void setTransactionInfo( const TransactionInfo* transaction ) {
             this->transaction = transaction;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionManager.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionManager.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionManager.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompSessionManager.h Tue Aug  1 15:30:22 2006
@@ -82,7 +82,7 @@
         /**
          * Creates a new Session and returns a SessionInfo object whose
          * lifetime is the property of the caller.
-         * @param the ackMode of the session.
+         * @param ackMode the ackMode of the session.
          * @return new SessionInfo object
          */
         virtual connector::SessionInfo* createSession(
@@ -93,7 +93,7 @@
          * removes the specified Session from the Manager, all data that
          * is associated with session consumers is now lost.  The session
          * is not deleted here, it is the owner's responsibility.
-         * @param the session info for the session to remove.
+         * @param session the session info for the session to remove.
          */
         virtual void removeSession( connector::SessionInfo* session )
             throw ( exceptions::ActiveMQException );
@@ -119,11 +119,11 @@
          * subscribe to the destination if another consumer hasn't already 
          * been subbed to that destination.  The returned consumer is the 
          * owned by the caller and not deleted by this class.
-         * @param Topic to subscribe to
+         * @param destination Topic to subscribe to
          * @param session to associate with
-         * @param Subscription Name
+         * @param name Subscription Name
          * @param selector string
-         * @param Should we be notified of messages we send.
+         * @param noLocal Should we be notified of messages we send.
          * @return new ConsumerInfo object.
          */
         virtual connector::ConsumerInfo* createDurableConsumer(
@@ -139,7 +139,7 @@
          * consumer is the only one listeneing on this destination.  The
          * Consumer is not deleted, just unassociated from the Manager
          * caller is responsible for managing the lifetime.
-         * @param the ConsumerInfo for the consumer to remove
+         * @param consumer the ConsumerInfo for the consumer to remove
          * @throws ConnectorException
          */            
         virtual void removeConsumer( connector::ConsumerInfo* consumer )
@@ -170,10 +170,10 @@
         /**
          * Sets Subscribe Command options from the properties of a 
          * destination object.
-         * @param The destination that we are subscribing to.
-         * @param The pending Subscribe command
+         * @param destination The destination that we are subscribing to.
+         * @param command The pending Subscribe command
          */
-        virtual void setSubscribeOptions( const cms::Destination* dest,
+        virtual void setSubscribeOptions( const cms::Destination* destination,
                                           commands::SubscribeCommand& command )
             throw ( StompConnectorException );
             

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTopic.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTopic.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTopic.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTopic.h Tue Aug  1 15:30:22 2006
@@ -39,10 +39,9 @@
 
         /**
          * Custom Constructor
-         * @param string destination name plus any params
-         * @param type of destination this represents.
+         * @param name string destination name plus any params
          */
-        StompTopic(const std::string& name) : 
+        StompTopic( const std::string& name ) : 
             StompDestination< cms::Topic >( name, cms::Destination::TOPIC )
         {}
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTransactionInfo.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTransactionInfo.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTransactionInfo.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/StompTransactionInfo.h Tue Aug  1 15:30:22 2006
@@ -56,7 +56,7 @@
 
         /**
          * Sets the Transction Id
-         * @param unsigned int Id
+         * @param id unsigned int Id
          */
         virtual void setTransactionId( const unsigned int id ) {
             this->transactionId = id;
@@ -72,7 +72,7 @@
         
         /**
          * Gets the Session Info that this Transction is attached too
-         * @return SessionnInfo pointer
+         * @return session SessionnInfo pointer
          */
         virtual void setSessionInfo( const SessionInfo* session ) {
             this->session = session;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbortCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbortCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbortCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbortCommand.h Tue Aug  1 15:30:22 2006
@@ -50,7 +50,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame the Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -61,7 +61,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame the Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbstractCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbstractCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbstractCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AbstractCommand.h Tue Aug  1 15:30:22 2006
@@ -96,14 +96,14 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame the Frame to init
          */
         virtual void initialize( StompFrame& frame ) = 0;
 
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame the Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const = 0;
@@ -133,7 +133,7 @@
 
         /**
          * Sets the Command Id of this Message
-         * @param Command Id
+         * @param id Command Id
          */
         virtual void setCommandId( const unsigned int id ){
             setPropertyValue(
@@ -156,7 +156,7 @@
         
         /**
          * Set if this Message requires a Response
-         * @param true if response is required
+         * @param required true if response is required
          */
         virtual void setResponseRequired( const bool required ) {
         }
@@ -185,7 +185,7 @@
 
         /**
          * Sets the Correlation Id if this Command
-         * @param Id
+         * @param corrId Id
          */
         virtual void setCorrelationId( const unsigned int corrId ) {
             setPropertyValue(
@@ -206,7 +206,7 @@
       
         /**
          * Set the Transaction Id of this Command
-         * @param the Id of the Transaction
+         * @param id the Id of the Transaction
          */
         virtual void setTransactionId( const std::string& id ){
             setPropertyValue( 
@@ -255,7 +255,7 @@
 
         /**
          * Returns a char array of bytes that are contained in the message
-         * @param pointer to array of bytes.
+         * @return pointer to array of bytes.
          */
         virtual const char* getBytes(void) const{
             return getFrame().getBody();
@@ -266,8 +266,9 @@
          * the content length flag indicates if the Content Length header
          * should be set.
          * @param bytes to store
-         * @param number of bytes to pull from the bytes buffer
-         * @param true if the content length header should be set
+         * @param numBytes number of bytes to pull from the bytes buffer
+         * @param setContentLength true if the content length header should 
+         * be set
          */
         virtual void setBytes( const char* bytes, 
                                const unsigned long numBytes,

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AckCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AckCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AckCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/AckCommand.h Tue Aug  1 15:30:22 2006
@@ -61,9 +61,9 @@
       
         /**
          * Set the Message Id that this Ack is associated with
-         * @param the Message Id
+         * @param messageId the Message Id
          */
-        virtual void setMessageId(const std::string& messageId){
+        virtual void setMessageId( const std::string& messageId ){
             setPropertyValue( 
                 CommandConstants::toString( 
                     CommandConstants::HEADER_MESSAGEID),
@@ -75,7 +75,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -86,7 +86,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BeginCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BeginCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BeginCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BeginCommand.h Tue Aug  1 15:30:22 2006
@@ -55,7 +55,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -66,7 +66,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BytesMessageCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BytesMessageCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BytesMessageCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/BytesMessageCommand.h Tue Aug  1 15:30:22 2006
@@ -59,8 +59,8 @@
 
         /**
          * sets the bytes given to the message body.  
-         * @param Byte Buffer to copy
-         * @param Number of bytes in Buffer to copy
+         * @param buffer Byte Buffer to copy
+         * @param numBytes Number of bytes in Buffer to copy
          * @throws CMSException
          */
         virtual void setBodyBytes( const unsigned char* buffer, 
@@ -78,7 +78,8 @@
          * @return const pointer to a byte buffer
          */
         virtual const unsigned char* getBodyBytes(void) const {
-            return reinterpret_cast<const unsigned char*>( this->getBytes() );
+            return reinterpret_cast<const unsigned char*>( 
+                this->getBytes() );
         }
       
         /**

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/CommitCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/CommitCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/CommitCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/CommitCommand.h Tue Aug  1 15:30:22 2006
@@ -50,7 +50,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -61,7 +61,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectCommand.h Tue Aug  1 15:30:22 2006
@@ -56,7 +56,7 @@
       
         /**
          * Set the login
-         * @param password string value
+         * @param login username string value
          */
         virtual void setLogin( const std::string& login ){
             setPropertyValue( 
@@ -77,7 +77,7 @@
       
         /**
          * Set the password
-         * @param passwrod string value
+         * @param password the passwrod string value
          */
         virtual void setPassword( const std::string& password ){
             setPropertyValue( 
@@ -98,7 +98,7 @@
       
         /**
          * Set the Client Id
-         * @param client id string value
+         * @param clientId client id string value
          */
         virtual void setClientId( const std::string& clientId ){
             setPropertyValue( 
@@ -112,7 +112,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -123,7 +123,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectedCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectedCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectedCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ConnectedCommand.h Tue Aug  1 15:30:22 2006
@@ -47,6 +47,7 @@
 
         /**
          * Get the Session Id
+         * @return the mew Sessoin Id String
          */      
         virtual const char* getSessionId() const {
             return getPropertyValue( 
@@ -56,6 +57,7 @@
       
         /**
          * Set the Session Id
+         * @param session string containing the session id
          */
         virtual void setSessionId( const std::string& session ) {
             setPropertyValue( 
@@ -69,7 +71,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -80,7 +82,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/DisconnectCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/DisconnectCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/DisconnectCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/DisconnectCommand.h Tue Aug  1 15:30:22 2006
@@ -50,7 +50,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -61,7 +61,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ErrorCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ErrorCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ErrorCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ErrorCommand.h Tue Aug  1 15:30:22 2006
@@ -47,6 +47,7 @@
 
         /**
          * Get the error message
+         * @return the error message string
          */      
         virtual const char* getErrorMessage(void) const {
             return getPropertyValue( 
@@ -56,17 +57,18 @@
       
         /**
          * Set the error message
+         * @param message the error message string
          */
-        virtual void setErrorMessage( const std::string& title ) {
+        virtual void setErrorMessage( const std::string& message ) {
             setPropertyValue( 
                 CommandConstants::toString( 
                     CommandConstants::HEADER_MESSAGE),
-                title );
+                message );
         }
 
         /**
          * Set the Text associated with this Error
-         * @param Error Message
+         * @param text Detailed Error Message
          */
         virtual void setErrorDetails( const std::string& text ) {
             setBytes( text.c_str(), text.length() + 1 );
@@ -74,7 +76,7 @@
 
         /**
          * Get the Text associated with this Error
-         * @return Error Message
+         * @return Error Message String
          */
         virtual const char* getErrorDetails(void) const {
             return getBytes();
@@ -85,7 +87,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -96,7 +98,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ReceiptCommand.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ReceiptCommand.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ReceiptCommand.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/connector/stomp/commands/ReceiptCommand.h Tue Aug  1 15:30:22 2006
@@ -47,6 +47,7 @@
 
         /**
          * Get the receipt id
+         * @returns the message id
          */      
         virtual const char* getReceiptId(void) const{
             return getPropertyValue( 
@@ -56,6 +57,7 @@
 
         /**
          * Set the receipt id
+         * @param id the receipt id
          */
         virtual void setReceiptId( const std::string& id ){
             setPropertyValue( 
@@ -69,7 +71,7 @@
         /**
          * Inheritors are required to override this method to init the
          * frame with data appropriate for the command type.
-         * @param Frame to init
+         * @param frame Frame to init
          */
         virtual void initialize( StompFrame& frame )
         {
@@ -80,7 +82,7 @@
         /**
          * Inheritors are required to override this method to validate 
          * the passed stomp frame before it is marshalled or unmarshaled
-         * @param Frame to validate
+         * @param frame Frame to validate
          * @returns true if frame is valid
          */
         virtual bool validate( const StompFrame& frame ) const



Mime
View raw message