You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by tr...@apache.org on 2009/08/19 22:02:00 UTC
svn commit: r805955 - in /qpid/trunk/qpid/cpp: docs/api/doxygen_mainpage.h
docs/api/user.doxygen.in include/qmf/Agent.h include/qmf/AgentObject.h
include/qmf/Connection.h include/qmf/ConnectionSettings.h
Author: tross
Date: Wed Aug 19 20:01:57 2009
New Revision: 805955
URL: http://svn.apache.org/viewvc?rev=805955&view=rev
Log:
Fixed doxygen generation for the C++ APIs
Modified:
qpid/trunk/qpid/cpp/docs/api/doxygen_mainpage.h
qpid/trunk/qpid/cpp/docs/api/user.doxygen.in
qpid/trunk/qpid/cpp/include/qmf/Agent.h
qpid/trunk/qpid/cpp/include/qmf/AgentObject.h
qpid/trunk/qpid/cpp/include/qmf/Connection.h
qpid/trunk/qpid/cpp/include/qmf/ConnectionSettings.h
Modified: qpid/trunk/qpid/cpp/docs/api/doxygen_mainpage.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/docs/api/doxygen_mainpage.h?rev=805955&r1=805954&r2=805955&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/docs/api/doxygen_mainpage.h (original)
+++ qpid/trunk/qpid/cpp/docs/api/doxygen_mainpage.h Wed Aug 19 20:01:57 2009
@@ -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
*
*/
Modified: qpid/trunk/qpid/cpp/docs/api/user.doxygen.in
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/docs/api/user.doxygen.in?rev=805955&r1=805954&r2=805955&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/docs/api/user.doxygen.in (original)
+++ qpid/trunk/qpid/cpp/docs/api/user.doxygen.in Wed Aug 19 20:01:57 2009
@@ -456,7 +456,7 @@
# 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 @@
# 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
Modified: qpid/trunk/qpid/cpp/include/qmf/Agent.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qmf/Agent.h?rev=805955&r1=805954&r2=805955&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qmf/Agent.h (original)
+++ qpid/trunk/qpid/cpp/include/qmf/Agent.h Wed Aug 19 20:01:57 2009
@@ -35,6 +35,8 @@
/**
* 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 @@
/**
* 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:
Modified: qpid/trunk/qpid/cpp/include/qmf/AgentObject.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qmf/AgentObject.h?rev=805955&r1=805954&r2=805955&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qmf/AgentObject.h (original)
+++ qpid/trunk/qpid/cpp/include/qmf/AgentObject.h Wed Aug 19 20:01:57 2009
@@ -32,6 +32,8 @@
/**
* AgentObject is an extension of Object with agent-specific methods added.
+ *
+ * \ingroup qmfapi
*/
class AgentObject : public Object {
public:
Modified: qpid/trunk/qpid/cpp/include/qmf/Connection.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qmf/Connection.h?rev=805955&r1=805954&r2=805955&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qmf/Connection.h (original)
+++ qpid/trunk/qpid/cpp/include/qmf/Connection.h Wed Aug 19 20:01:57 2009
@@ -25,6 +25,11 @@
namespace qmf {
+ /**
+ * Operational states for Connections.
+ *
+ * \ingroup qmfapi
+ */
enum ConnectionState {
CONNECTION_UP = 1,
CONNECTION_DOWN = 2
Modified: qpid/trunk/qpid/cpp/include/qmf/ConnectionSettings.h
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qmf/ConnectionSettings.h?rev=805955&r1=805954&r2=805955&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qmf/ConnectionSettings.h (original)
+++ qpid/trunk/qpid/cpp/include/qmf/ConnectionSettings.h Wed Aug 19 20:01:57 2009
@@ -29,6 +29,8 @@
/**
* Settings for AMQP connections to the broker.
+ *
+ * \ingroup qmfapi
*/
class ConnectionSettings {
public:
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org