activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nmitt...@apache.org
Subject svn commit: r427774 [3/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
Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Logger.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Logger.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Logger.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/Logger.h Tue Aug  1 15:30:22 2006
@@ -65,17 +65,14 @@
          * dot-separated name and should normally be based on the package 
          * name or class name of the subsystem, such as java.net or 
          * javax.swing. It may be null for anonymous Loggers.
+         * @param parent logger that is this one's parent
          */
-        Logger(const std::string& name, Logger* parent);
+        Logger( const std::string& name, Logger* parent );
         
-        /**
-         * Destructor
-         */
         virtual ~Logger(void);
         
         /**
          * Gets the name of this Logger
-         * 
          * @return logger name
          */
         virtual const std::string& getName(void) const {
@@ -89,24 +86,24 @@
          * Typically the root Logger is configured with a set of Handlers 
          * that essentially act as default handlers for all loggers.
          * 
-         * @param A Logging Handler
+         * @param handler A Logging Handler
          * #throws IllegalArgumentException
          */
-        virtual void addHandler(Handler* handler) 
+        virtual void addHandler( Handler* handler ) 
             throw ( exceptions::IllegalArgumentException );
         
         /**
          * Removes the specified Handler and destroys it
          * <p>
          * Returns silently if the given Handler is not found.
-         * 
-         * @param The Handler to remove
+         * @param handler The Handler to remove
          */
-        virtual void removeHandler(Handler* handler);
+        virtual void removeHandler( Handler* handler );
 
         /**
          * Gets a vector containing all the handlers that this class
          * has been assigned to use.
+         * @returns a list of handlers that are used by this logger
          */        
         virtual const std::list<Handler*>& getHandlers(void) const;
         
@@ -117,10 +114,9 @@
          * this Filter to check if a log record should really be published. 
          * <p>
          * The caller releases ownership of this filter to this logger
-         * 
-         * @param Filter to use, can be null
+         * @param filter to use, can be null
          */
-        virtual void setFilter(Filter* filter); 
+        virtual void setFilter( Filter* filter ); 
         
         /**
          * Gets the Filter object that this class is using.
@@ -134,6 +130,7 @@
          * Get the log Level that has been specified for this Logger. The 
          * result may be the Null level, which means that this logger's 
          * effective level will be inherited from its parent.
+         * @return the level that is currently set
          */
         virtual Level getLevel(void) const {
             return level;
@@ -148,17 +145,15 @@
          * If the new level is the Null Level, it means that this node 
          * should inherit its level from its nearest ancestor with a 
          * specific (non-null) level value. 
-         * 
-         * @param new Level value
+         * @param level new Level value
          */
-        virtual void setLevel(Level level) {
+        virtual void setLevel( Level level ) {
             this->level = level;
         }
         
         /**
          * Discover whether or not this logger is sending its output to 
          * its parent logger.
-         * 
          * @return true if using Parent Handlers
          */
         virtual bool getUseParentHandlers(void) const {
@@ -170,10 +165,9 @@
          * parent Logger. This means that any LogRecords will also be 
          * written to the parent's Handlers, and potentially to its parent, 
          * recursively up the namespace.
-         * 
-         * @param True is output is to be writen to the parent
+         * @param value True is output is to be writen to the parent
          */
-        virtual void setUseParentHandlers(bool value) {
+        virtual void setUseParentHandlers( bool value ) {
             this->useParentHandlers = value;
         }
         
@@ -183,13 +177,13 @@
          * This is a convenience method that is used to tag a block enter, a
          * log record with the class name function name and the string 
          * Entering is logged at the DEBUG log level.
-         * @param source block name
-         * @param source file name
-         * @param source line name
-         */
-        virtual void entry(const std::string& blockName,
-                           const std::string& file,
-                           const int line);
+         * @param blockName source block name
+         * @param file source file name
+         * @param line source line name
+         */
+        virtual void entry( const std::string& blockName,
+                            const std::string& file,
+                            const int line );
         
         /**
          * Logs an Block Exit message
@@ -197,13 +191,13 @@
          * This is a convenience method that is used to tag a block exit, a
          * log record with the class name function name and the string 
          * Exiting is logged at the DEBUG log level.
-         * @param source block name
-         * @param source file name
-         * @param source line name
+         * @param blockName source block name
+         * @param file source file name
+         * @param line source line name
          */
-        virtual void exit(const std::string& blockName,
-                          const std::string& file,
-                          const int line);
+        virtual void exit( const std::string& blockName,
+                           const std::string& file,
+                           const int line );
 
         /**
          * Log a Debug Level Log
@@ -211,16 +205,15 @@
          * If the logger is currently enabled for the DEBUG message level 
          * then the given message is forwarded to all the registered output
          * Handler objects.
-         * 
-         * @param file name where the log was generated
-         * @param line number where the log was generated
-         * @param name of the function that logged this
-         * @param the message to log
-         */
-        virtual void debug(const std::string& file,
-                           const int line,
-                           const std::string fnctionName,
-                           const std::string& message);
+         * @param file the file name where the log was generated
+         * @param line the line number where the log was generated
+         * @param functionName name of the function that logged this
+         * @param message the message to log
+         */
+        virtual void debug( const std::string& file,
+                            const int line,
+                            const std::string functionName,
+                            const std::string& message );
 
         /**
          * Log a info Level Log
@@ -229,15 +222,15 @@
          * then the given message is forwarded to all the registered output
          * Handler objects.
          * 
-         * @param file name where the log was generated
-         * @param line number where the log was generated
-         * @param name of the function that logged this
-         * @param the message to log
+         * @param file the file name where the log was generated
+         * @param line the line number where the log was generated
+         * @param functionName name of the function that logged this
+         * @param message the message to log
          */
-        virtual void info(const std::string& file,
-                          const int line,
-                          const std::string fnctionName,
-                          const std::string& message);
+        virtual void info( const std::string& file,
+                           const int line,
+                           const std::string functionName,
+                           const std::string& message );
 
         /**
          * Log a warn Level Log
@@ -245,16 +238,15 @@
          * If the logger is currently enabled for the warn message level 
          * then the given message is forwarded to all the registered output
          * Handler objects.
-         * 
-         * @param file name where the log was generated
-         * @param line number where the log was generated
-         * @param name of the function that logged this
-         * @param the message to log
+         * @param file the file name where the log was generated
+         * @param line the line number where the log was generated
+         * @param functionName name of the function that logged this
+         * @param message the message to log
          */
-        virtual void warn(const std::string& file,
-                          const int line,
-                          const std::string fnctionName,
-                          const std::string& message);
+        virtual void warn( const std::string& file,
+                           const int line,
+                           const std::string functionName,
+                           const std::string& message );
                         
         /**
          * Log a error Level Log
@@ -262,16 +254,15 @@
          * If the logger is currently enabled for the error message level 
          * then the given message is forwarded to all the registered output
          * Handler objects.
-         * 
-         * @param file name where the log was generated
-         * @param line number where the log was generated
-         * @param name of the function that logged this
-         * @param the message to log
-         */
-        virtual void error(const std::string& file,
-                           const int line,
-                           const std::string fnctionName,
-                           const std::string& message);
+         * @param file the file name where the log was generated
+         * @param line the line number where the log was generated
+         * @param fnctionName name of the function that logged this
+         * @param message the message to log
+         */
+        virtual void error( const std::string& file,
+                            const int line,
+                            const std::string fnctionName,
+                            const std::string& message );
 
         /**
          * Log a fatal Level Log
@@ -279,16 +270,15 @@
          * If the logger is currently enabled for the fatal message level 
          * then the given message is forwarded to all the registered output
          * Handler objects.
-         * 
-         * @param file name where the log was generated
-         * @param line number where the log was generated
-         * @param name of the function that logged this
-         * @param the message to log
-         */
-        virtual void fatal(const std::string& file,
-                           const int line,
-                           const std::string fnctionName,
-                           const std::string& message);
+         * @param file the file name where the log was generated
+         * @param line the line number where the log was generated
+         * @param fnctionName name of the function that logged this
+         * @param message the message to log
+         */
+        virtual void fatal( const std::string& file,
+                            const int line,
+                            const std::string functionName,
+                            const std::string& message );
                          
         /**
          * Log a Throw Message
@@ -296,37 +286,33 @@
          * If the logger is currently enabled for the Throwing message level 
          * then the given message is forwarded to all the registered output
          * Handler objects.
-         * 
-         * @param file name where the log was generated
-         * @param line number where the log was generated
-         * @param name of the function that logged this
-         * @param the message to log
-         */
-        virtual void throwing(const std::string& file,
-                              const int line,
-                              const std::string fnctionName,
-                              const std::string& message);
+         * @param file the file name where the log was generated
+         * @param line the line number where the log was generated
+         * @param fnctionName name of the function that logged this
+         * @param message the message to log
+         */
+        virtual void throwing( const std::string& file,
+                               const int line,
+                               const std::string fnctionName,
+                               const std::string& message );
         
         /**
          * Check if a message of the given level would actually be logged 
          * by this logger. This check is based on the Loggers effective 
          * level, which may be inherited from its parent.
-         * 
          * @param level - a message logging level 
-         * returns true if the given message level is currently being logged.
+         * @returns true if the given message level is currently being logged.
          */
-        virtual bool isLoggable(Level level) const;
+        virtual bool isLoggable( Level level ) const;
         
         /**
          * Log a LogRecord.
-         *
          * All the other logging methods in this class call through this 
          * method to actually perform any logging. Subclasses can override 
          * this single method to capture all log activity. 
-         * 
          * @param record - the LogRecord to be published
          */
-        virtual void log(LogRecord& record);
+        virtual void log( LogRecord& record );
          
         /**
          * Log a message, with no arguments.
@@ -334,11 +320,10 @@
          * If the logger is currently enabled for the given message level 
          * then the given message is forwarded to all the registered output 
          * Handler objects
-         * 
-         * @param the Level to log at
-         * @param the message to log
+         * @param level the Level to log at
+         * @param message the message to log
          */
-        virtual void log(Level level, const std::string& message);
+        virtual void log( Level level, const std::string& message );
 
         /**
          * Log a message, with the list of params that is formatted into
@@ -347,38 +332,35 @@
          * If the logger is currently enabled for the given message level 
          * then the given message is forwarded to all the registered output 
          * Handler objects
-         * 
-         * @param the Level to log at
-         * @param the message to log
+         * @param level the Level to log at
+         * @param file the message to log
+         * @param line the line in the file
          * @param variable length arguement to format the message string.
          */
-        virtual void log(Level level, 
-                         const std::string& file,
-                         const int line,
-                         const std::string& message, ...);
+        virtual void log( Level level, 
+                          const std::string& file,
+                          const int line,
+                          const std::string& message, ... );
 
         /**
          * Log a message, with associated Throwable information.
-         *
          * If the logger is currently enabled for the given message level 
          * then the given arguments are stored in a LogRecord which is 
          * forwarded to all registered output handlers.
-         *
          * Note that the thrown argument is stored in the LogRecord thrown 
          * property, rather than the LogRecord parameters property. Thus is 
          * it processed specially by output Formatters and is not treated 
          * as a formatting parameter to the LogRecord message property. 
-         * 
-         * @param the Level to log at
-         * @param File that the message was logged in
-         * @param line number where the message was logged at.
-         * @param Exception to log
-         */
-        virtual void log(Level level, 
-                         const std::string& file,
-                         const int line,
-                         const std::string& message, 
-                         cms::CMSException& ex);
+         * @param level the Level to log at
+         * @param file File that the message was logged in
+         * @param line the line number where the message was logged at.
+         * @param ex the Exception to log
+         */
+        virtual void log( Level level, 
+                          const std::string& file,
+                          const int line,
+                          const std::string& message, 
+                          cms::CMSException& ex );
 
     public:
     
@@ -394,7 +376,6 @@
          * root logger.
          * <p>
          * The caller is responsible for destroying the returned logger.
-         * 
          * @return Newly created anonymous logger
          */
         static Logger* getAnonymousLogger(void);
@@ -408,15 +389,13 @@
          * on the LogManager and it will configured to also send logging 
          * output to its parent loggers Handlers. It will be registered in 
          * the LogManager global namespace. 
-         * 
          * @param name - A name for the logger. This should be a 
          * dot-separated name and should normally be based on the package 
          * name or class name of the subsystem, such as cms or 
          * activemq.core.ActiveMQConnection
-         * 
          * @return a suitable logger.
          */
-        static Logger* getLogger(const std::string& name);
+        static Logger* getLogger( const std::string& name );
 
     };
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LoggerHierarchy.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LoggerHierarchy.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LoggerHierarchy.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/LoggerHierarchy.h Tue Aug  1 15:30:22 2006
@@ -24,14 +24,7 @@
     {
     public:
 
-        /**
-         * Default Constructor
-         */
     	LoggerHierarchy(void);
-
-        /**
-         * Destructor
-         */
     	virtual ~LoggerHierarchy(void);
 
     };

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/MarkBlockLogger.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/MarkBlockLogger.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/MarkBlockLogger.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/MarkBlockLogger.h Tue Aug  1 15:30:22 2006
@@ -22,49 +22,46 @@
 namespace activemq{
 namespace logger{
 
-   /**
-    * Defines a class that can be used to mark the entry and exit from
-    * scoped blocks.
-    * <p>
-    * Create an instance of this class at the start of a scoped block,
-    * passing it the logger to use and the name of the block.  The block
-    * entry and exit will be marked using the scope name, logger to the
-    * logger at the MARKBLOCK log level.
-    */
-   class MarkBlockLogger
-   {
-   private:
+    /**
+     * Defines a class that can be used to mark the entry and exit from
+     * scoped blocks.
+     * <p>
+     * Create an instance of this class at the start of a scoped block,
+     * passing it the logger to use and the name of the block.  The block
+     * entry and exit will be marked using the scope name, logger to the
+     * logger at the MARKBLOCK log level.
+     */
+    class MarkBlockLogger
+    {
+    private:
    
-      // Pointer to the Logger to use for Logging
-      Logger* logger;
+        // Pointer to the Logger to use for Logging
+        Logger* logger;
       
-      // Block Name to Log
-      std::string blockName;
+        // Block Name to Log
+        std::string blockName;
       
-   public:
+    public:
 
-      /**
-       * Constructor - Marks Block entry
-       * @param Logger to use
-       * @param Block name
-       */
-      MarkBlockLogger(Logger* logger, const std::string& blockName)
-      {
-         this->logger = logger;
-         this->blockName = blockName;
+        /**
+         * Constructor - Marks Block entry
+         * @param logger Logger to use
+         * @param blockName Block name
+         */
+        MarkBlockLogger(Logger* logger, const std::string& blockName)
+        {
+            this->logger = logger;
+            this->blockName = blockName;
          
-         logger.mark(blockName + " - Entered");
-      }
+            logger.mark(blockName + " - Entered");
+        }
 
-      /**
-       * Destructor - Marks Block Exit
-       */
-      virtual ~MarkBlockLogger(void)
-      {
-         logger->mark(blockName + " - Exited");
-      }
+        virtual ~MarkBlockLogger(void)
+        {
+            logger->mark(blockName + " - Exited");
+        }
 
-   };
+    };
 
 }}
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/PropertiesChangeListener.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/PropertiesChangeListener.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/PropertiesChangeListener.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/PropertiesChangeListener.h Tue Aug  1 15:30:22 2006
@@ -28,20 +28,17 @@
    {
    public:
    
-      /**
-       * Destructor
-       */
       virtual ~PropertiesChangeListener() {}
       
       /**
        * Change Event, called when a property is changed
-       * @param Name of the Property
-       * @param Old Value of the Property
-       * @param New Value of the Property
+       * @param name - Name of the Property
+       * @param oldValue - Old Value of the Property
+       * @param newValue - New Value of the Property
        */
-      virtual void onPropertyChanged(const std::string& name,
-                                     const std::string& oldValue,
-                                     const std::string& newValue) = 0;
+      virtual void onPropertyChanged( const std::string& name,
+                                      const std::string& oldValue,
+                                      const std::string& newValue ) = 0;
 
    };
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/SimpleFormatter.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/SimpleFormatter.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/SimpleFormatter.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/logger/SimpleFormatter.h Tue Aug  1 15:30:22 2006
@@ -30,53 +30,42 @@
    {
    public:
       
-      /**
-       * Constructor
-       */
       SimpleFormatter(void) {}
-
-      /** 
-       * Destructor
-       */
       virtual ~SimpleFormatter(void) {}
 
       /**
        * Format the given log record and return the formatted string.
-       * @param The Log Record to Format
+       * @param record The Log Record to Format
        */
-      virtual std::string format(const LogRecord& record) const
-      {
+      virtual std::string format( const LogRecord& record ) const {
          return "";
       }
       
       /**
        * Format the message string from a log record.
-       * @param The Log Record to Format
+       * @param record The Log Record to Format
        */
-      virtual std::string formatMessage(const LogRecord& record) const
-      {
+      virtual std::string formatMessage( const LogRecord& record ) const{
          return record.getMessage();
       }
       
       /**
        * Return the header string for a set of formatted records.  In the
        * default implementation this method should return empty string
-       * @param the target handler, can be null
+       * @param handler the target handler, can be null
        * @return empty string
        */
-      virtual std::string getHead(const Handler* handler)
-      {
+      virtual std::string getHead( const Handler* handler ) {
          return "";
       }
 
       /**
        * Return the tail string for a set of formatted records.  In the
        * default implementation this method should return empty string
-       * @param the target handler, can be null
+       * @param handler the target handler, can be null
        * @return empty string
        */
-      virtual std::string getTail(const Handler* handler)
-      {
+      virtual std::string getTail( const Handler* handler ) {
          return "";
       }
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/BufferedSocket.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/BufferedSocket.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/BufferedSocket.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/BufferedSocket.h Tue Aug  1 15:30:22 2006
@@ -53,6 +53,13 @@
 
     public:
 
+        /**
+         * Constructs a new Buffered socket object
+         * @param socket the socket to buffer
+         * @param inputBufferSize size of the input buffer
+         * @param outputBufferSize size of the output buffer
+         * @param own does this object own the passed socket
+         */
         BufferedSocket( Socket* socket, 
                         unsigned int inputBufferSize = 1000,
                         unsigned int outputBufferSize = 1000,

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketFactory.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketFactory.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketFactory.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketFactory.h Tue Aug  1 15:30:22 2006
@@ -52,7 +52,7 @@
         /**
          * Creates and returns a Socket dervied Object based on the values
          * defined in the Properties Object that is passed in.
-         * @param a IProperties pointer.
+         * @param properties a IProperties pointer.
          * @throws SocketException.
          */
         static Socket* createSocket( const util::Properties& properties )

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketInputStream.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketInputStream.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketInputStream.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketInputStream.h Tue Aug  1 15:30:22 2006
@@ -50,12 +50,17 @@
 		 */
 		virtual ~SocketInputStream();
 		
+        /**
+         * Enables socket level output of the recieved data
+         * @param debug true to turn on debugging
+         */
         virtual void setDebug( const bool debug ){
             this->debug = debug;
         }
         
         /**
          * Locks the object.
+         * @throws ActiveMQException
          */
         virtual void lock() throw( exceptions::ActiveMQException ){
             mutex.lock();
@@ -63,6 +68,7 @@
    
         /**
          * Unlocks the object.
+         * @throws ActiveMQException
          */
         virtual void unlock() throw( exceptions::ActiveMQException ){   
             mutex.unlock();
@@ -72,6 +78,7 @@
          * Waits on a signal from this object, which is generated
          * by a call to Notify.  Must have this object locked before
          * calling.
+         * @throws ActiveMQException
          */
         virtual void wait() throw( exceptions::ActiveMQException ){
             mutex.wait();
@@ -82,7 +89,7 @@
          * 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 time in millisecsonds to wait, or WAIT_INIFINITE
          * @throws ActiveMQException
          */
         virtual void wait( unsigned long millisecs ) 
@@ -95,6 +102,7 @@
          * Signals a waiter on this object that it can now wake
          * up and continue.  Must have this object locked before
          * calling.
+         * @throws ActiveMQException
          */
         virtual void notify() throw( exceptions::ActiveMQException ){
             mutex.notify();
@@ -104,6 +112,7 @@
          * Signals the waiters on this object that it can now wake
          * up and continue.  Must have this object locked before
          * calling.
+         * @throws ActiveMQException
          */
         virtual void notifyAll() throw( exceptions::ActiveMQException ){
             mutex.notifyAll();
@@ -135,6 +144,7 @@
 		/**
 		 * Close - does nothing.  It is the responsibility of the owner
 		 * of the socket object to close it.
+         * @throws CMSException
 		 */
 		virtual void close() throw( cms::CMSException ){}
         

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketOutputStream.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketOutputStream.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketOutputStream.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/SocketOutputStream.h Tue Aug  1 15:30:22 2006
@@ -50,7 +50,7 @@
 
         /**
          * Enables Debugging of Socket Data
-         * @param true to enable
+         * @param debug true to enable
          */      
         virtual void setDebug( const bool debug ){
             this->debug = debug;
@@ -87,7 +87,7 @@
          * 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 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/network/TcpSocket.cpp
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.cpp?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.cpp (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.cpp Tue Aug  1 15:30:22 2006
@@ -84,7 +84,7 @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-TcpSocket::TcpSocket( Socket::SocketHandle socketHandle ){
+TcpSocket::TcpSocket( SocketHandle socketHandle ){
     this->socketHandle = socketHandle;
    
     inputStream = new SocketInputStream( socketHandle );

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/network/TcpSocket.h Tue Aug  1 15:30:22 2006
@@ -61,6 +61,7 @@
         /** 
          * Construct a connected or bound socket based on given
          * socket handle.
+         * @param socketHandle a socket handle to wrap in the object
          */
         TcpSocket( SocketHandle socketHandle );
        

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/BrokerError.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/BrokerError.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/BrokerError.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/BrokerError.h Tue Aug  1 15:30:22 2006
@@ -31,13 +31,33 @@
     class BrokerError : public exceptions::ActiveMQException{        
     public:
   
+        /**
+         * Default Constructor
+         */
         BrokerError(){};
+
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy
+         */
         BrokerError( const exceptions::ActiveMQException& ex ){
             *(exceptions::ActiveMQException*)this = ex;
         }
+
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy, which is an instance of this type
+         */
         BrokerError( const BrokerError& 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
+         */
         BrokerError(const char* file, const int lineNumber, 
             const char* msg, ...)
         {
@@ -53,6 +73,7 @@
          * 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.
+         * @returns a cloned copy of this exception
          */
         virtual exceptions::ActiveMQException* clone() const{
             return new BrokerError( *this );

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Command.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Command.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Command.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Command.h Tue Aug  1 15:30:22 2006
@@ -28,7 +28,7 @@
         
         /**
          * Sets the Command Id of this Message
-         * @param Command Id
+         * @param id Command Id
          */
         virtual void setCommandId( const unsigned int id ) = 0;
 
@@ -40,7 +40,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 ) = 0;
 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/CommandIOException.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/CommandIOException.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/CommandIOException.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/CommandIOException.h Tue Aug  1 15:30:22 2006
@@ -27,13 +27,33 @@
     class CommandIOException : public io::IOException{
     public:
 
+        /**
+         * Default Constructor
+         */
         CommandIOException(){};
+        
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy
+         */
         CommandIOException( const exceptions::ActiveMQException& ex ){
             *(exceptions::ActiveMQException*)this = ex;
         }
+        
+        /**
+         * Copy Constructor
+         * @param ex the exception to copy, which is an instance of this type
+         */
         CommandIOException( const CommandIOException& 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
+         */
         CommandIOException( const char* file, const int lineNumber, 
                             const char* msg, ... )
         {
@@ -49,6 +69,7 @@
          * 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.
+         * @return cloned version of this exception
          */
         virtual exceptions::ActiveMQException* clone() const{
             return new CommandIOException( *this );

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ExceptionResponse.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ExceptionResponse.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ExceptionResponse.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ExceptionResponse.h Tue Aug  1 15:30:22 2006
@@ -35,6 +35,7 @@
         
         /**
          * Gets the error from the broker.
+         * @returns the error provided from the broker
          */
         virtual const BrokerError* getException() const = 0;
         

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/FutureResponse.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/FutureResponse.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/FutureResponse.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/FutureResponse.h Tue Aug  1 15:30:22 2006
@@ -49,6 +49,7 @@
         
         /**
          * Locks the object.
+         * @throws ActiveMQException
          */
         virtual void lock() throw( exceptions::ActiveMQException ){
             mutex.lock();
@@ -56,6 +57,7 @@
 
         /**
          * Unlocks the object.
+         * @throws ActiveMQException
          */
         virtual void unlock() throw( exceptions::ActiveMQException ){
             mutex.unlock();
@@ -65,6 +67,7 @@
          * Waits on a signal from this object, which is generated
          * by a call to Notify.  Must have this object locked before
          * calling.
+         * @throws ActiveMQException
          */
         virtual void wait() throw( exceptions::ActiveMQException ){
             mutex.wait();
@@ -75,7 +78,7 @@
          * 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 time in millisecsonds to wait, or WAIT_INIFINITE
          * @throws ActiveMQException
          */
         virtual void wait( unsigned long millisecs ) 
@@ -88,6 +91,7 @@
          * Signals a waiter on this object that it can now wake
          * up and continue.  Must have this object locked before
          * calling.
+         * @throws ActiveMQException
          */
         virtual void notify() throw( exceptions::ActiveMQException ){
             mutex.notify();
@@ -97,6 +101,7 @@
          * Signals the waiters on this object that it can now wake
          * up and continue.  Must have this object locked before
          * calling.
+         * @throws ActiveMQException
          */
         virtual void notifyAll() throw( exceptions::ActiveMQException ){ 
             mutex.notifyAll(); 
@@ -104,6 +109,7 @@
         
         /**
          * Getters for the response property.
+         * @return the response object for the request
          */
         virtual const Response* getResponse() const{
             return response;
@@ -114,6 +120,7 @@
         
         /**
          * Setter for the response property.
+         * @param response the response object for the request.
          */
         virtual void setResponse( Response* response ){
             this->response = response;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/IOTransport.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/IOTransport.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/IOTransport.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/IOTransport.h Tue Aug  1 15:30:22 2006
@@ -92,6 +92,7 @@
     
         /**
          * Notify the excpetion listener
+         * @param ex the exception to send
          */
         void fire( exceptions::ActiveMQException& ex ){
 
@@ -105,6 +106,7 @@
         
         /**
          * Notify the command listener.
+         * @param command the command the send
          */
         void fire( Command* command ){
             
@@ -117,14 +119,7 @@
         
     public:
   
-        /**
-         * Constructor.
-         */
         IOTransport();
-        
-        /**
-         * Destructor - calls close().
-         */
         virtual ~IOTransport();
         
         /**
@@ -140,6 +135,8 @@
         
         /**
          * Not supported by this class - throws an exception.
+         * @param command the command to be sent.
+         * @returns the response to the command sent.
          * @throws UnsupportedOperationException.
          */
         virtual Response* request( Command* command ) throw( CommandIOException, exceptions::UnsupportedOperationException ){

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Response.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Response.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Response.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/Response.h Tue Aug  1 15:30:22 2006
@@ -36,7 +36,7 @@
 
         /**
          * Sets the Correlation Id if this Command
-         * @param Id
+         * @param corrId
          */
         virtual void setCorrelationId( const unsigned int corrId ) = 0;
         

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ResponseCorrelator.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ResponseCorrelator.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ResponseCorrelator.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/ResponseCorrelator.h Tue Aug  1 15:30:22 2006
@@ -93,6 +93,8 @@
   
         /**
          * Constructor.
+         * @param next the next transport in the chain
+         * @param own indicates if this transport owns the next
          */
         ResponseCorrelator( Transport* next, const bool own = true )
         :
@@ -107,9 +109,6 @@
             closed = true;
         }
         
-        /**
-         * Destructor - calls close().
-         */
         virtual ~ResponseCorrelator(){
             
             // Close the transport and destroy it.
@@ -121,6 +120,7 @@
         
         /**
          * Gets the maximum wait time for a response in milliseconds.
+         * @return max time that a response can take
          */
         virtual unsigned long getMaxResponseWaitTime() const{
             return maxResponseWaitTime;
@@ -128,6 +128,7 @@
         
         /**
          * Sets the maximum wait time for a response in milliseconds.
+         * @param milliseconds the max time that a response can take.
          */
         virtual void setMaxResponseWaitTime( const unsigned long milliseconds ){
             maxResponseWaitTime = milliseconds;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TcpTransport.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TcpTransport.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TcpTransport.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TcpTransport.h Tue Aug  1 15:30:22 2006
@@ -42,9 +42,16 @@
 
     public:
 
+        /**
+         * Constructor
+         * @param properties the configuration properties for this transport
+         * @param next the next transport in the chain
+         * @param own indicates if this transport owns the next.
+         */
     	TcpTransport( const activemq::util::Properties& properties,
                       Transport* next, 
                       const bool own = true );
+                      
     	virtual ~TcpTransport(void);
 
     };

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactory.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactory.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactory.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactory.h Tue Aug  1 15:30:22 2006
@@ -35,7 +35,7 @@
         
         /**
          * Creates a Transport instance.
-         * @param Properties Object that will hold transport values
+         * @param properties Object that will hold transport values
          */
         virtual Transport* createTransport(
             const activemq::util::Properties& properties ) = 0;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.cpp
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.cpp?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.cpp (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.cpp Tue Aug  1 15:30:22 2006
@@ -31,20 +31,21 @@
 } 
 
 ////////////////////////////////////////////////////////////////////////////////
-void TransportFactoryMap::registerTransportFactory( const string& name, 
+void TransportFactoryMap::registerTransportFactory( 
+    const std::string& name, 
     TransportFactory* factory )
 {
     factoryMap[name] = factory;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-void TransportFactoryMap::unregisterTransportFactory( const string& name ){
+void TransportFactoryMap::unregisterTransportFactory( const std::string& name ){
     factoryMap.erase( name );
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-TransportFactory* TransportFactoryMap::lookup( const string& name ){
-    
+TransportFactory* TransportFactoryMap::lookup( const std::string& name )
+{
     map<string, TransportFactory*>::const_iterator itr = 
     factoryMap.find(name);
 
@@ -58,7 +59,9 @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-size_t TransportFactoryMap::getFactoryNames( vector< string >& factoryList ){
+size_t TransportFactoryMap::getFactoryNames( 
+    std::vector< std::string >& factoryList )
+{    
     map<string, TransportFactory*>::const_iterator itr =
     factoryMap.begin();
   

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMap.h Tue Aug  1 15:30:22 2006
@@ -76,17 +76,17 @@
         
         /**
          * 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
          */
         TransportFactory* 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 );
+        std::size_t getFactoryNames( std::vector< std::string >& factoryList );
         
     };
     

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMapRegistrar.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMapRegistrar.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMapRegistrar.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFactoryMapRegistrar.h Tue Aug  1 15:30:22 2006
@@ -34,9 +34,9 @@
         /** 
          * 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 responsible for creating the transport
+         * @param manageLifetime boolean indicating if this object manages the 
+         *        lifetime of the factory that is being registered.
          */
         TransportFactoryMapRegistrar( const std::string& name, 
                                       TransportFactory*  factory,

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFilter.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFilter.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFilter.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/transport/TransportFilter.h Tue Aug  1 15:30:22 2006
@@ -64,6 +64,7 @@
     
         /**
          * Notify the excpetion listener
+         * @param ex - the exception to send to listeners
          */
         void fire( const exceptions::ActiveMQException& ex ){
 
@@ -77,6 +78,7 @@
         
         /**
          * Notify the command listener.
+         * @param command - the command to send to the listener
          */
         void fire( Command* command ){
             
@@ -91,6 +93,8 @@
   
         /**
          * Constructor.
+         * @param next - the next Transport in the chain
+         * @param own - true if this filter owns the next and should delete it
          */
         TransportFilter( Transport* next, const bool own = true ){
             
@@ -105,9 +109,6 @@
             next->setTransportExceptionListener( this );
         }
         
-        /**
-         * Destructor - calls close().
-         */
         virtual ~TransportFilter(){
             
             if( own ){
@@ -119,7 +120,7 @@
         
         /**
          * Event handler for the receipt of a command.
-         * @param command the received command object.
+         * @param command - the received command object.
          */
         virtual void onCommand( Command* command ){
             fire( command );
@@ -149,6 +150,7 @@
         
         /**
          * Not supported by this class - throws an exception.
+         * @param command the command that is sent as a request
          * @throws UnsupportedOperationException.
          */
         virtual Response* request( Command* command ) throw(CommandIOException, exceptions::UnsupportedOperationException){

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Properties.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Properties.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Properties.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Properties.h Tue Aug  1 15:30:22 2006
@@ -71,6 +71,7 @@
       
         /**
          * Check to see if the Property exists in the set
+         * @param name the name of the property to check
          * @return true if property exists, false otherwise.
          */
         virtual bool hasProperty( const std::string& name ) const = 0;

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Queue.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Queue.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Queue.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/Queue.h Tue Aug  1 15:30:22 2006
@@ -87,7 +87,7 @@
 
         /**
          * Places a new Object at the Tail of the queue
-         * @param Queue Object Type reference.
+         * @param t - Queue Object Type reference.
          */
         void push( const T &t );
 
@@ -137,7 +137,7 @@
          * 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 time to wait, or WAIT_INIFINITE
          * @throws ActiveMQException
          */
         virtual void wait( unsigned long millisecs ) 

Modified: incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/SimpleProperties.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/SimpleProperties.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/SimpleProperties.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/activemq/util/SimpleProperties.h Tue Aug  1 15:30:22 2006
@@ -94,6 +94,7 @@
         
       /**
        * Check to see if the Property exists in the set
+       * @param name - property name to check for in this properties set.
        * @return true if property exists, false otherwise.
        */
       virtual bool hasProperty( const std::string& name ) const

Modified: incubator/activemq/trunk/activemq-cpp/src/main/cms/ConnectionFactory.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/cms/ConnectionFactory.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/cms/ConnectionFactory.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/cms/ConnectionFactory.h Tue Aug  1 15:30:22 2006
@@ -48,6 +48,9 @@
          * Creates a connection with the specified user identity. The 
          * connection is created in stopped mode. No messages will be 
          * delivered until the Connection.start method is explicitly called.
+         * @param username - name to login with
+         * @param password - password to authenticate with
+         * @param clientId - User provided Client Id 
          * @return Pointer to a connection object, caller owns the pointer
          * @throw CMSException.
          */

Modified: incubator/activemq/trunk/activemq-cpp/src/main/cms/DeliveryMode.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/cms/DeliveryMode.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/cms/DeliveryMode.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/cms/DeliveryMode.h Tue Aug  1 15:30:22 2006
@@ -1,10 +1,10 @@
 /*
- * Copyright 2006 The Apache Software Foundation or its licensors, as
- * applicable.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *

Modified: incubator/activemq/trunk/activemq-cpp/src/main/cms/Message.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/cms/Message.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/cms/Message.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/cms/Message.h Tue Aug  1 15:30:22 2006
@@ -64,19 +64,19 @@
 
         /**
          * Sets the Correlation Id used by this message
-         * @param String representing the correlation id.
+         * @param correlationId - String representing the correlation id.
          */
         virtual void setCMSCorrelationId( const std::string& correlationId ) = 0;
 
         /**
-         * Sets the DeliveryMode for this message
+         * Gets the DeliveryMode for this message
          * @return DeliveryMode enumerated value.
          */
         virtual int getCMSDeliveryMode(void) const = 0;
 
         /**
          * Sets the DeliveryMode for this message
-         * @param DeliveryMode enumerated value.
+         * @param mode - DeliveryMode enumerated value.
          */
         virtual void setCMSDeliveryMode( int mode ) = 0;
       
@@ -88,7 +88,7 @@
       
         /**
          * Sets the Destination for this message
-         * @param Destination Object
+         * @param destination - Destination Object
          */
         virtual void setCMSDestination( const Destination* destination ) = 0;
       
@@ -100,7 +100,7 @@
       
         /**
          * Sets the Expiration Time for this message
-         * @param time value
+         * @param expireTime - time value
          */
         virtual void setCMSExpiration( long expireTime ) = 0;
       
@@ -112,7 +112,7 @@
       
         /**
          * Sets the CMS Message Id for this message
-         * @param time value
+         * @param id - time value
          */
         virtual void setCMSMessageId( const std::string& id ) = 0;
       
@@ -124,7 +124,7 @@
       
         /**
          * Sets the Priority Value for this message
-         * @param priority value
+         * @param priority - priority value for this message
          */
         virtual void setCMSPriority( int priority ) = 0;
 
@@ -136,7 +136,7 @@
       
         /**
          * Sets the Redelivered Flag for this message
-         * @param redelivered value
+         * @param redelivered - boolean redelivered value
          */
         virtual void setCMSRedelivered( bool redelivered ) = 0;
 
@@ -148,7 +148,7 @@
       
         /**
          * Sets the CMS Reply To Address for this message
-         * @param Reply To value
+         * @param id - Reply To value
          */
         virtual void setCMSReplyTo( const std::string& id ) = 0;
 
@@ -160,7 +160,7 @@
       
         /**
          * Sets the Time Stamp for this message
-         * @param time stamp value
+         * @param timeStamp - integer time stamp value
          */
         virtual void setCMSTimeStamp( long timeStamp ) = 0;
 
@@ -172,7 +172,7 @@
       
         /**
          * Sets the CMS Message Type for this message
-         * @param type value
+         * @param type - message type value string
          */
         virtual void setCMSMessageType( const std::string& type ) = 0;
     };

Modified: incubator/activemq/trunk/activemq-cpp/src/main/cms/MessageProducer.h
URL: http://svn.apache.org/viewvc/incubator/activemq/trunk/activemq-cpp/src/main/cms/MessageProducer.h?rev=427774&r1=427773&r2=427774&view=diff
==============================================================================
--- incubator/activemq/trunk/activemq-cpp/src/main/cms/MessageProducer.h (original)
+++ incubator/activemq/trunk/activemq-cpp/src/main/cms/MessageProducer.h Tue Aug  1 15:30:22 2006
@@ -34,15 +34,12 @@
     {
     public:
 
-        /**
-         * Destructor
-         */
         virtual ~MessageProducer(void) {}
       
         /**
          * Sends the message to the default producer destination, but does
          * not take ownership of the message, caller must still destroy it.
-         * @param a Message Object Pointer
+         * @param message - a Message Object Pointer
          * @throws CMSException
          */
         virtual void send( Message* message ) throw ( CMSException ) = 0;
@@ -50,7 +47,8 @@
         /**
          * Sends the message to the designated destination, but does
          * not take ownership of the message, caller must still destroy it.
-         * @param a Message Object Pointer
+         * @param destination - a Message Object Pointer
+         * @param message - the message to send to the destination
          * @throws CMSException
          */
         virtual void send( const Destination* destination,
@@ -58,7 +56,7 @@
 
         /** 
          * Sets the delivery mode for this Producer
-         * @param The DeliveryMode
+         * @param mode - The DeliveryMode
          */
         virtual void setDeliveryMode( int mode ) = 0;
       
@@ -70,31 +68,31 @@
       
         /**
          * Sets if Message Ids are disbled for this Producer
-         * @param boolean indicating enable / disable (true / false)
+         * @param value - boolean indicating enable / disable (true / false)
          */
         virtual void setDisableMessageId( bool value ) = 0;
       
         /**
-         * Sets if Message Ids are disbled for this Producer
-         * @param boolean indicating enable / disable (true / false)
+         * Gets if Message Ids are disbled for this Producer
+         * @return boolean indicating enable / disable (true / false)
          */
         virtual bool getDisableMessageId(void) const = 0;
 
         /**
          * Sets if Message Time Stamps are disbled for this Producer
-         * @param boolean indicating enable / disable (true / false)
+         * @param value - boolean indicating enable / disable (true / false)
          */
         virtual void setDisableMessageTimeStamp( bool value ) = 0;
       
         /**
-         * Sets if Message Time Stamps are disbled for this Producer
-         * @param boolean indicating enable / disable (true / false)
+         * Gets if Message Time Stamps are disbled for this Producer
+         * @return boolean indicating enable / disable (true / false)
          */
         virtual bool getDisableMessageTimeStamp(void) const = 0;
       
         /**
          * Sets the Priority that this Producers sends messages at
-         * @param int value for Priority level
+         * @param priority - int value for Priority level
          */
         virtual void setPriority( int priority ) = 0;
       
@@ -106,7 +104,7 @@
       
         /**
          * Sets the Time to Live that this Producers sends messages with
-         * @param int value for time to live
+         * @param time - int value for time to live
          */
         virtual void setTimeToLive( int time ) = 0;
       



Mime
View raw message