summaryrefslogtreecommitdiff
path: root/cpp/include
diff options
context:
space:
mode:
authorTed Ross <tross@apache.org>2009-08-19 20:01:57 +0000
committerTed Ross <tross@apache.org>2009-08-19 20:01:57 +0000
commit772903c9da606299524007dc65cb46333ebb2cd8 (patch)
treeee254c52b250924c2848d9f8f0235e76b5eb1faa /cpp/include
parent413f907caf0013942126d566113e322576759a6f (diff)
downloadqpid-python-772903c9da606299524007dc65cb46333ebb2cd8.tar.gz
Fixed doxygen generation for the C++ APIs
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@805955 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'cpp/include')
-rw-r--r--cpp/include/qmf/Agent.h4
-rw-r--r--cpp/include/qmf/AgentObject.h2
-rw-r--r--cpp/include/qmf/Connection.h5
-rw-r--r--cpp/include/qmf/ConnectionSettings.h2
4 files changed, 13 insertions, 0 deletions
diff --git a/cpp/include/qmf/Agent.h b/cpp/include/qmf/Agent.h
index 2ba639ca37..e61cd737d0 100644
--- a/cpp/include/qmf/Agent.h
+++ b/cpp/include/qmf/Agent.h
@@ -35,6 +35,8 @@ namespace qmf {
/**
* AgentListener is used by agents that select the internalStore=false option (see Agent
* constructor) or by agents that wish to provide access control for queries and methods.
+ *
+ * \ingroup qmfapi
*/
class AgentListener {
QMF_EXTERN virtual ~AgentListener();
@@ -143,6 +145,8 @@ namespace qmf {
/**
* The Agent class is the QMF Agent portal. It should be instantiated once and associated with a
* Connection (setConnection) to connect an agent to the QMF infrastructure.
+ *
+ * \ingroup qmfapi
*/
class Agent {
public:
diff --git a/cpp/include/qmf/AgentObject.h b/cpp/include/qmf/AgentObject.h
index d6073bca3c..a1878605eb 100644
--- a/cpp/include/qmf/AgentObject.h
+++ b/cpp/include/qmf/AgentObject.h
@@ -32,6 +32,8 @@ namespace qmf {
/**
* AgentObject is an extension of Object with agent-specific methods added.
+ *
+ * \ingroup qmfapi
*/
class AgentObject : public Object {
public:
diff --git a/cpp/include/qmf/Connection.h b/cpp/include/qmf/Connection.h
index dbe8e97cfe..b910cdad19 100644
--- a/cpp/include/qmf/Connection.h
+++ b/cpp/include/qmf/Connection.h
@@ -25,6 +25,11 @@
namespace qmf {
+ /**
+ * Operational states for Connections.
+ *
+ * \ingroup qmfapi
+ */
enum ConnectionState {
CONNECTION_UP = 1,
CONNECTION_DOWN = 2
diff --git a/cpp/include/qmf/ConnectionSettings.h b/cpp/include/qmf/ConnectionSettings.h
index b5f3be7eef..53a83dfd2a 100644
--- a/cpp/include/qmf/ConnectionSettings.h
+++ b/cpp/include/qmf/ConnectionSettings.h
@@ -29,6 +29,8 @@ namespace qmf {
/**
* Settings for AMQP connections to the broker.
+ *
+ * \ingroup qmfapi
*/
class ConnectionSettings {
public: