You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jo...@apache.org on 2010/04/29 18:36:30 UTC
svn commit: r939373 - in /qpid/trunk/qpid/cpp/include/qpid/messaging:
Address.h Connection.h Duration.h Handle.h Message.h Receiver.h Sender.h
Session.h exceptions.h
Author: jonathan
Date: Thu Apr 29 16:36:29 2010
New Revision: 939373
URL: http://svn.apache.org/viewvc?rev=939373&view=rev
Log:
Added doxygen group directives.
Modified:
qpid/trunk/qpid/cpp/include/qpid/messaging/Address.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Connection.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Duration.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Handle.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Message.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Receiver.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Sender.h
qpid/trunk/qpid/cpp/include/qpid/messaging/Session.h
qpid/trunk/qpid/cpp/include/qpid/messaging/exceptions.h
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Address.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Address.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Address.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Address.h Thu Apr 29 16:36:29 2010
@@ -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
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Connection.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Connection.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Connection.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Connection.h Thu Apr 29 16:36:29 2010
@@ -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
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Duration.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Duration.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Duration.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Duration.h Thu Apr 29 16:36:29 2010
@@ -29,7 +29,7 @@
namespace qpid {
namespace messaging {
-/**
+/** \ingroup messaging
* A duration is a time in milliseconds.
*/
class Duration
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Handle.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Handle.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Handle.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Handle.h Thu Apr 29 16:36:29 2010
@@ -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.
*
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Message.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Message.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Message.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Message.h Thu Apr 29 16:36:29 2010
@@ -36,7 +36,7 @@ class Address;
class Codec;
struct MessageImpl;
-/**
+/** \ingroup messaging
* Representation of a message.
*/
class Message
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Receiver.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Receiver.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Receiver.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Receiver.h Thu Apr 29 16:36:29 2010
@@ -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>
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Sender.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Sender.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Sender.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Sender.h Thu Apr 29 16:36:29 2010
@@ -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>
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/Session.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/Session.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/Session.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/Session.h Thu Apr 29 16:36:29 2010
@@ -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.
*/
Modified: qpid/trunk/qpid/cpp/include/qpid/messaging/exceptions.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/messaging/exceptions.h?rev=939373&r1=939372&r2=939373&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/messaging/exceptions.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/messaging/exceptions.h Thu Apr 29 16:36:29 2010
@@ -29,6 +29,9 @@
namespace qpid {
namespace messaging {
+/** \ingroup messaging
+ */
+
struct MessagingException : public qpid::types::Exception
{
QPID_CLIENT_EXTERN MessagingException(const std::string& msg);
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org