From 792347655a42cf79f391cb9565a823ec3ff9c512 Mon Sep 17 00:00:00 2001
From: Jonathan Robie <jonathan@apache.org>
Date: Tue, 18 Nov 2008 21:33:37 +0000
Subject: Added doxygen documentation for Connection::open(ConnectionSettings)

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@718718 13f79535-47bb-0310-9956-ffa450edef68
---
 cpp/src/qpid/client/Connection.h | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

(limited to 'cpp/src')

diff --git a/cpp/src/qpid/client/Connection.h b/cpp/src/qpid/client/Connection.h
index 6d33f0af22..0a74df9206 100644
--- a/cpp/src/qpid/client/Connection.h
+++ b/cpp/src/qpid/client/Connection.h
@@ -37,9 +37,10 @@ class ConnectionImpl;
 /**
  * Represents a connection to an AMQP broker. All communication is
  * initiated by establishing a connection, then creating one or more
- * Session objecst using the connection. @see newSession()
+ * Session objects using the connection. @see newSession()
  * 
  * \ingroup clientapi
+ *
  */
 class Connection
 {
@@ -108,7 +109,31 @@ class Connection
     /**
      * Opens a connection to a broker.
      * 
-     * @param the settings to use (host, port etc) @see ConnectionSettings
+     * @param the settings to use (host, port etc)
+     *
+     * Specifying connection parameters with ConnectionSettings
+     *
+     * @code
+     * #include <qpid/client/ConnectionSettings.h>
+     * #include <qpid/client/Connection.h>
+     * #include <qpid/client/Session.h>
+     * 
+     * using namespace qpid::client;
+     * 
+     * int main(int , char** ) {
+     * 
+     *     ConnectionSettings connectionSettings;
+     *     connectionSettings.host = "localhost";
+     *     connectionSettings.port = 5672;
+     *     connectionSettings.tcpNoDelay = true;
+     *     connectionSettings.maxFrameSize = 65535;
+     *     connectionSettings.bounds = 4;
+     * 
+     *     Connection connection;
+     *     try {
+     *         connection.open(connectionSettings);
+     *         Session session =  connection.newSession();
+     * @endcode
      */
     void open(const ConnectionSettings& settings);
 
-- 
cgit v1.2.1