activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject svn commit: r746788 - /activemq/activemq-cpp/trunk/src/main/cms/ConnectionFactory.h
Date Sun, 22 Feb 2009 17:47:02 GMT
Author: tabish
Date: Sun Feb 22 17:47:02 2009
New Revision: 746788

URL: http://svn.apache.org/viewvc?rev=746788&view=rev
Log:
Documentation cleanup

Modified:
    activemq/activemq-cpp/trunk/src/main/cms/ConnectionFactory.h

Modified: activemq/activemq-cpp/trunk/src/main/cms/ConnectionFactory.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/src/main/cms/ConnectionFactory.h?rev=746788&r1=746787&r2=746788&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/src/main/cms/ConnectionFactory.h (original)
+++ activemq/activemq-cpp/trunk/src/main/cms/ConnectionFactory.h Sun Feb 22 17:47:02 2009
@@ -27,7 +27,14 @@
 {
 
     /**
-     * Defines the interface for a factory that creates connection objects
+     * Defines the interface for a factory that creates connection objects, the Connection
+     * objects returned implement the CMS Connection interface and hide the CMS Provider
+     * specific implementation details behind that interface.  A Client creates a new
+     * ConnectionFactory either directly by instantiating the provider specific implementation
+     * of the factory or by using the static method <code>createCMSConnectionFactory</code>
+     * which all providers are required to implement.
+     *
+     * @since 1.0
      */
     class CMS_API ConnectionFactory
     {
@@ -93,10 +100,14 @@
     public:
 
         /**
-         * Static method that is used to create a provider specfic connection
+         * Static method that is used to create a provider specific connection
          * factory.  The provider implements this method in their library and
-         * returns an instance of a ConnectionFactory dervied object.
+         * returns an instance of a ConnectionFactory derived object.  Clients can
+         * use this method to remain abstracted from the specific CMS implementation
+         * being used.
+         *
          * @param brokerURI - the address to use to connect to the broker.
+         *
          * @returns Provider specific ConnectionFactory
          * @throws CMSException if and error occurs.
          */



Mime
View raw message