diff options
author | Jonathan Robie <jonathan@apache.org> | 2010-04-29 16:36:29 +0000 |
---|---|---|
committer | Jonathan Robie <jonathan@apache.org> | 2010-04-29 16:36:29 +0000 |
commit | 72c25ca3bf1e562be206165380b687c86dd3e910 (patch) | |
tree | 9465b5d9463342c92387b4678bd3bdbc36968ca5 | |
parent | 2d9f20b8084302d379d902e2289541d7c05d5233 (diff) | |
download | qpid-python-72c25ca3bf1e562be206165380b687c86dd3e910.tar.gz |
Added doxygen group directives.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@939373 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r-- | cpp/include/qpid/messaging/Address.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Connection.h | 6 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Duration.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Handle.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Message.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Receiver.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Sender.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/Session.h | 2 | ||||
-rw-r--r-- | cpp/include/qpid/messaging/exceptions.h | 3 |
9 files changed, 15 insertions, 8 deletions
diff --git a/cpp/include/qpid/messaging/Address.h b/cpp/include/qpid/messaging/Address.h index 10d00ba18e..7bb821e644 100644 --- a/cpp/include/qpid/messaging/Address.h +++ b/cpp/include/qpid/messaging/Address.h @@ -34,7 +34,7 @@ namespace messaging { class AddressImpl; -/** +/** \ingroup messaging * Represents an address to which messages can be sent and from which * messages can be received. Often a simple name is sufficient for * this, however this can be augmented with a subject pattern and diff --git a/cpp/include/qpid/messaging/Connection.h b/cpp/include/qpid/messaging/Connection.h index ae5ed4c12e..d3db50592b 100644 --- a/cpp/include/qpid/messaging/Connection.h +++ b/cpp/include/qpid/messaging/Connection.h @@ -36,12 +36,16 @@ template <class> class PrivateImplRef; class ConnectionImpl; class Session; +/** \ingroup messaging + * A connection represents a network connection to a remote endpoint. + */ + class Connection : public qpid::messaging::Handle<ConnectionImpl> { public: QPID_CLIENT_EXTERN Connection(ConnectionImpl* impl); QPID_CLIENT_EXTERN Connection(const Connection&); - /** + /** * Current implementation supports the following options: * * username diff --git a/cpp/include/qpid/messaging/Duration.h b/cpp/include/qpid/messaging/Duration.h index 2791e188d7..3198ebe6a2 100644 --- a/cpp/include/qpid/messaging/Duration.h +++ b/cpp/include/qpid/messaging/Duration.h @@ -29,7 +29,7 @@ namespace qpid { namespace messaging { -/** +/** \ingroup messaging * A duration is a time in milliseconds. */ class Duration diff --git a/cpp/include/qpid/messaging/Handle.h b/cpp/include/qpid/messaging/Handle.h index c528c39e19..cfc6e8ebfc 100644 --- a/cpp/include/qpid/messaging/Handle.h +++ b/cpp/include/qpid/messaging/Handle.h @@ -29,7 +29,7 @@ namespace messaging { template <class> class PrivateImplRef; -/** +/** \ingroup messaging * A handle is like a pointer: refers to an underlying implementation object. * Copying the handle does not copy the object. * diff --git a/cpp/include/qpid/messaging/Message.h b/cpp/include/qpid/messaging/Message.h index 9ab98ae0ce..8e4c274734 100644 --- a/cpp/include/qpid/messaging/Message.h +++ b/cpp/include/qpid/messaging/Message.h @@ -36,7 +36,7 @@ class Address; class Codec; struct MessageImpl; -/** +/** \ingroup messaging * Representation of a message. */ class Message diff --git a/cpp/include/qpid/messaging/Receiver.h b/cpp/include/qpid/messaging/Receiver.h index 65581d06c5..a368b113c1 100644 --- a/cpp/include/qpid/messaging/Receiver.h +++ b/cpp/include/qpid/messaging/Receiver.h @@ -36,7 +36,7 @@ class Message; class ReceiverImpl; class Session; -/** +/** \ingroup messaging * Interface through which messages are received. */ class Receiver : public qpid::messaging::Handle<ReceiverImpl> diff --git a/cpp/include/qpid/messaging/Sender.h b/cpp/include/qpid/messaging/Sender.h index 4b64224596..9b5d0452e8 100644 --- a/cpp/include/qpid/messaging/Sender.h +++ b/cpp/include/qpid/messaging/Sender.h @@ -35,7 +35,7 @@ template <class> class PrivateImplRef; class Message; class SenderImpl; class Session; -/** +/** \ingroup messaging * Interface through which messages are sent. */ class Sender : public qpid::messaging::Handle<SenderImpl> diff --git a/cpp/include/qpid/messaging/Session.h b/cpp/include/qpid/messaging/Session.h index 7413417058..9fa9fe48d1 100644 --- a/cpp/include/qpid/messaging/Session.h +++ b/cpp/include/qpid/messaging/Session.h @@ -42,7 +42,7 @@ class Receiver; class SessionImpl; class Subscription; -/** +/** \ingroup messaging * A session represents a distinct 'conversation' which can involve * sending and receiving messages to and from different addresses. */ diff --git a/cpp/include/qpid/messaging/exceptions.h b/cpp/include/qpid/messaging/exceptions.h index af7959fe13..e20c1742c1 100644 --- a/cpp/include/qpid/messaging/exceptions.h +++ b/cpp/include/qpid/messaging/exceptions.h @@ -29,6 +29,9 @@ namespace qpid { namespace messaging { +/** \ingroup messaging + */ + struct MessagingException : public qpid::types::Exception { QPID_CLIENT_EXTERN MessagingException(const std::string& msg); |