Some minor changes to doc; primarily aimed at making the list of classes

listed as client API more useful.



git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@614551 13f79535-47bb-0310-9956-ffa450edef68

12 files changed, 30 insertions, 11 deletions

diff --git a/qpid/cpp/rubygen/templates/Session.rb b/qpid/cpp/rubygen/templates/Session.rb
index ff578b251c..21534b78fb 100644
--- a/qpid/cpp/rubygen/templates/Session.rb
+++ b/qpid/cpp/rubygen/templates/Session.rb
@@ -174,6 +174,7 @@ to read. You may find it easier to read the documentation for #{@base}
 which provides the same set of functions using normal non-keyword
 declarations.
 
+\\ingroup clientapi
 EOS
         }
         # Session class.
diff --git a/qpid/cpp/src/qpid/client/AckMode.h b/qpid/cpp/src/qpid/client/AckMode.h
index f565c1d36b..944fba655d 100644
--- a/qpid/cpp/src/qpid/client/AckMode.h
+++ b/qpid/cpp/src/qpid/client/AckMode.h
@@ -27,9 +27,9 @@ namespace qpid {
 namespace client {
 
 /**
- * The available acknowledgements modes.
+ * DEPRECATED
  * 
- * \ingroup clientapi
+ * The available acknowledgements modes for Channel (now also deprecated).
  */
 enum AckMode {
     /** No acknowledgement will be sent, broker can
diff --git a/qpid/cpp/src/qpid/client/AckPolicy.h b/qpid/cpp/src/qpid/client/AckPolicy.h
index 2a52a8c746..af17539ebe 100644
--- a/qpid/cpp/src/qpid/client/AckPolicy.h
+++ b/qpid/cpp/src/qpid/client/AckPolicy.h
@@ -26,6 +26,8 @@ namespace client {
 
 /**
  * Policy for automatic acknowledgement of messages.
+ *
+ * \ingroup clientapi
  */
 class AckPolicy
 {
diff --git a/qpid/cpp/src/qpid/client/Channel.h b/qpid/cpp/src/qpid/client/Channel.h
index 2907da01c6..35e306e9b5 100644
--- a/qpid/cpp/src/qpid/client/Channel.h
+++ b/qpid/cpp/src/qpid/client/Channel.h
@@ -51,11 +51,12 @@ class MessageListener;
 class ReturnedMessageHandler;
 
 /**
+ * THIS CLASS IS DEPRECATED AND WILL BE SHORTLY REMOVED  
+ *
  * Represents an AMQP channel, i.e. loosely a session of work. It
  * is through a channel that most of the AMQP 'methods' are
  * exposed.
  * 
- * \ingroup clientapi
  */
 class Channel : private sys::Runnable
 {
diff --git a/qpid/cpp/src/qpid/client/Exchange.h b/qpid/cpp/src/qpid/client/Exchange.h
index a8ac21fa9b..0640e4fe2c 100644
--- a/qpid/cpp/src/qpid/client/Exchange.h
+++ b/qpid/cpp/src/qpid/client/Exchange.h
@@ -27,6 +27,8 @@ namespace qpid {
 namespace client {
     
     /**
+     * DEPRECATED
+     * 
      * A 'handle' used to represent an AMQP exchange in the Channel
      * methods. Exchanges are the destinations to which messages are
      * published. 
@@ -45,8 +47,6 @@ namespace client {
      * (member DEFAULT_EXCHANGE) which is nameless and of type
      * 'direct' and has every declared queue bound to it by queue
      * name.
-     * 
-     * \ingroup clientapi
      */
     class Exchange{
 	const std::string name;
diff --git a/qpid/cpp/src/qpid/client/Execution.h b/qpid/cpp/src/qpid/client/Execution.h
index 66a720a699..557f7ece4a 100644
--- a/qpid/cpp/src/qpid/client/Execution.h
+++ b/qpid/cpp/src/qpid/client/Execution.h
@@ -27,6 +27,9 @@
 namespace qpid {
 namespace client {
 
+/**
+ * Provides more detailed access to the amqp 'execution layer'.
+ */
 class Execution 
 {
 public:
diff --git a/qpid/cpp/src/qpid/client/LocalQueue.h b/qpid/cpp/src/qpid/client/LocalQueue.h
index 0c958d8f24..d7e7e9dbd8 100644
--- a/qpid/cpp/src/qpid/client/LocalQueue.h
+++ b/qpid/cpp/src/qpid/client/LocalQueue.h
@@ -31,6 +31,8 @@ namespace client {
 
 /**
  * Local representation of a remote queue.
+ *
+ * \ingroup clientapi
  */
 class LocalQueue
 {
diff --git a/qpid/cpp/src/qpid/client/MessageQueue.h b/qpid/cpp/src/qpid/client/MessageQueue.h
index 8ff537701f..e9b7a9fe58 100644
--- a/qpid/cpp/src/qpid/client/MessageQueue.h
+++ b/qpid/cpp/src/qpid/client/MessageQueue.h
@@ -34,14 +34,11 @@ namespace client {
  *
  * \ingroup clientapi
  */
-class MessageQueue : public MessageListener,
-                     public sys::BlockingQueue<Message>
+class MessageQueue : public sys::BlockingQueue<Message>, public MessageListener                     
 {
-    std::queue<Message> messages;
   public:
     void received(Message& msg)
     {
-        std::cout << "Adding message to queue: " << msg.getData() << std::endl;
         push(msg);
     }
 };
diff --git a/qpid/cpp/src/qpid/client/Queue.h b/qpid/cpp/src/qpid/client/Queue.h
index 9ab8c70b08..078e04c29e 100644
--- a/qpid/cpp/src/qpid/client/Queue.h
+++ b/qpid/cpp/src/qpid/client/Queue.h
@@ -27,6 +27,8 @@ namespace qpid {
 namespace client {
 
     /**
+     * DEPRECATED
+     * 
      * A 'handle' used to represent an AMQP queue in the Channel
      * methods. Creating an instance of this class does not cause the
      * queue to be created on the broker. Rather, an instance of this
@@ -48,8 +50,6 @@ namespace client {
      * 
      * We use the term 'temporary queue' to refer to an exclusive
      * queue.
-     * 
-     * \ingroup clientapi
      */
     class Queue{
 	std::string name;
diff --git a/qpid/cpp/src/qpid/client/Session.h b/qpid/cpp/src/qpid/client/Session.h
index 6ddea470e6..11105dcd36 100644
--- a/qpid/cpp/src/qpid/client/Session.h
+++ b/qpid/cpp/src/qpid/client/Session.h
@@ -26,6 +26,11 @@
 namespace qpid {
 namespace client {
 
+/**
+ * Session is currently just an alias for Session_0_10
+ *
+ * \ingroup clientapi
+ */
 typedef Session_0_10 Session;
 
 }} // namespace qpid::client
diff --git a/qpid/cpp/src/qpid/client/SubscriptionManager.h b/qpid/cpp/src/qpid/client/SubscriptionManager.h
index 1205478bf8..73331450cf 100644
--- a/qpid/cpp/src/qpid/client/SubscriptionManager.h
+++ b/qpid/cpp/src/qpid/client/SubscriptionManager.h
@@ -35,6 +35,11 @@
 namespace qpid {
 namespace client {
 
+/**
+ * Utility to assist with creating subscriptions.
+ *  
+ * \ingroup clientapi
+ */
 class SubscriptionManager : public sys::Runnable
 {
     typedef sys::Mutex::ScopedLock Lock;
diff --git a/qpid/cpp/src/qpid/sys/BlockingQueue.h b/qpid/cpp/src/qpid/sys/BlockingQueue.h
index bcd8c84276..56d41574df 100644
--- a/qpid/cpp/src/qpid/sys/BlockingQueue.h
+++ b/qpid/cpp/src/qpid/sys/BlockingQueue.h
@@ -29,6 +29,9 @@
 namespace qpid {
 namespace sys {
 
+/**
+ * A simple blocking queue template
+ */
 template <class T>
 class BlockingQueue
 {