diff options
author | Ted Ross <tross@apache.org> | 2009-08-19 20:01:57 +0000 |
---|---|---|
committer | Ted Ross <tross@apache.org> | 2009-08-19 20:01:57 +0000 |
commit | 772903c9da606299524007dc65cb46333ebb2cd8 (patch) | |
tree | ee254c52b250924c2848d9f8f0235e76b5eb1faa /cpp | |
parent | 413f907caf0013942126d566113e322576759a6f (diff) | |
download | qpid-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')
-rw-r--r-- | cpp/docs/api/doxygen_mainpage.h | 2 | ||||
-rw-r--r-- | cpp/docs/api/user.doxygen.in | 4 | ||||
-rw-r--r-- | cpp/include/qmf/Agent.h | 4 | ||||
-rw-r--r-- | cpp/include/qmf/AgentObject.h | 2 | ||||
-rw-r--r-- | cpp/include/qmf/Connection.h | 5 | ||||
-rw-r--r-- | cpp/include/qmf/ConnectionSettings.h | 2 |
6 files changed, 17 insertions, 2 deletions
diff --git a/cpp/docs/api/doxygen_mainpage.h b/cpp/docs/api/doxygen_mainpage.h index cb59cfa260..83efaba31d 100644 --- a/cpp/docs/api/doxygen_mainpage.h +++ b/cpp/docs/api/doxygen_mainpage.h @@ -26,6 +26,7 @@ * <h2>Messaging Client API classes</h2> * <ul> * <li><p>\ref clientapi</p></li> + * <li><p>\ref qmfapi</p></li> * </ul> * * <h2>Code for common tasks</h2> @@ -127,5 +128,6 @@ /** * \defgroup clientapi Qpid C++ Client API + * \defgroup qmfapi Qpid Management Framework C++ API * */ diff --git a/cpp/docs/api/user.doxygen.in b/cpp/docs/api/user.doxygen.in index 6ade9ab846..f6f8c161b7 100644 --- a/cpp/docs/api/user.doxygen.in +++ b/cpp/docs/api/user.doxygen.in @@ -456,7 +456,7 @@ WARN_LOGFILE = doxygen.log # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/include @top_builddir@/include +INPUT = @top_srcdir@/docs/api @top_srcdir@/include @top_builddir@/include # If the value of the INPUT tag contains directories, you can use the @@ -471,7 +471,7 @@ FILE_PATTERNS = *.h # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. -RECURSIVE = NO +RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a 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: |