diff options
| author | Alan Conway <aconway@apache.org> | 2008-04-24 17:42:59 +0000 |
|---|---|---|
| committer | Alan Conway <aconway@apache.org> | 2008-04-24 17:42:59 +0000 |
| commit | 757d86d81e811f105f72fdfce5bc18d83aaa08d4 (patch) | |
| tree | d095206cd9129f04bf77a3c59be5d5673554f2ec /cpp/src/qpid/client/Connection.h | |
| parent | 20373a2ab9e3dab3b2164e1e0409eefd2fb4cc4e (diff) | |
| download | qpid-python-757d86d81e811f105f72fdfce5bc18d83aaa08d4.tar.gz | |
Edits to doxygen comments for user documentation.
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@651321 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'cpp/src/qpid/client/Connection.h')
| -rw-r--r-- | cpp/src/qpid/client/Connection.h | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/cpp/src/qpid/client/Connection.h b/cpp/src/qpid/client/Connection.h index d24809b31e..0ddd383381 100644 --- a/cpp/src/qpid/client/Connection.h +++ b/cpp/src/qpid/client/Connection.h @@ -40,7 +40,7 @@ namespace qpid { namespace client { /** - * \defgroup clientapi Application API for an AMQP client + * \defgroup clientapi Application API for an AMQP client. */ /** @@ -66,14 +66,14 @@ class Connection * Creates a connection object, but does not open the * connection. * - * @param _version the version of the protocol to connect with + * @param _version the version of the protocol to connect with. * * @param debug turns on tracing for the connection * (i.e. prints details of the frames sent and received to std - * out). Optional and defaults to false. + * out). Optional. Defaults to false. * * @param max_frame_size the maximum frame size that the - * client will accept. Optional and defaults to 65535. + * client will accept. Optional. Defaults to 65535. */ Connection(bool debug = false, uint32_t max_frame_size = 65535, framing::ProtocolVersion=framing::highestProtocolVersion); @@ -83,15 +83,15 @@ class Connection /** * Opens a connection to a broker. * - * @param host the host on which the broker is running + * @param host the host on which the broker is running. * - * @param port the port on the which the broker is listening + * @param port the port on the which the broker is listening. * - * @param uid the userid to connect with + * @param uid the userid to connect with. * * @param pwd the password to connect with (currently SASL * PLAIN is the only authentication method supported so this - * is sent in clear text) + * is sent in clear text). * * @param virtualhost the AMQP virtual host to use (virtual * hosts, where implemented(!), provide namespace partitioning @@ -103,7 +103,7 @@ class Connection const std::string& virtualhost = "/"); /** - * Close the connection + * Close the connection. * * Any further use of this connection (without reopening it) will * not succeed. @@ -113,7 +113,7 @@ class Connection /** * Associate a Channel with this connection and open it for use. * - * In AMQP channels are like multi-plexed 'sessions' of work over + * In AMQP, channels are like multiplexed 'sessions' of work over * a connection. Almost all the interaction with AMQP is done over * a channel. * @@ -129,7 +129,7 @@ class Connection * *@param detachedLifetime: A session may be detached from its * channel, either by calling Session::suspend() or because of a - * network failure. The session state is perserved for + * network failure. The session state is preserved for * detachedLifetime seconds to allow a call to resume(). After * that the broker may discard the session state. Default is 0, * meaning the session cannot be resumed. |
