diff options
Diffstat (limited to 'cpp/src/qpid/doxygen_mainpage.h')
-rw-r--r-- | cpp/src/qpid/doxygen_mainpage.h | 59 |
1 files changed, 21 insertions, 38 deletions
diff --git a/cpp/src/qpid/doxygen_mainpage.h b/cpp/src/qpid/doxygen_mainpage.h index b354238cd0..1502ef536e 100644 --- a/cpp/src/qpid/doxygen_mainpage.h +++ b/cpp/src/qpid/doxygen_mainpage.h @@ -1,45 +1,28 @@ // This header file is just for doxygen documentation purposes. -/*!\mainpage Qpid C++ Developer Kit. +/** \mainpage Qpid C++ Developer Kit. * - *\section intro_sec Introduction - * - * The <a href=http://incubator.apache.org/qpid/index.html>Qpid project</a> provides implementations of the <a href="http://amqp.org/">AMQP messaging specification</a> in several programming language. - * - * Qpidc provides APIs and libraries to implement AMQP - * clients in C++. Qpidc clients can interact with any compliant AMQP - * message broker. The Qpid project also provides an AMQP broker - * daemon called qpidd that you can use with your qpidc clients. - * - *\section install_sec Installation - * - * If you are installing from the source distribution - <pre> - > ./configure && make - > make install </pre> - * This will build and install the client development kit and the broker - * in standard places. Use - * <code>./configure --help</code> for more options. - * - * You can also install from RPMs with the <code>rpm -i</code> command. - * You will need - * - <code>qpidc</code> for core libraries. - * - <code>qpidc-devel</code> for header files and developer documentation. - * - <code>qpidd</code> for the broker daemon. - * - *\section getstart_sec Getting Started + * The <a href=http://incubator.apache.org/qpid>Qpid project</a> provides implementations of the <a href="http://amqp.org/">AMQP messaging specification</a> in several programming language. * - * If you have installed in the standard places you should use - * these compile flags: - * - *<code> -I/usr/include/qpidc -I/usr/include/qpidc/framing -I/usr/include/qpidc/sys</code> - * - * and these link flags: - * - *<code> -lqpidcommon -lqpidclient</code> + * Qpidc provides APIs and libraries to implement AMQP clients in + * C++. Qpidc clients can interact with any compliant AMQP message + * broker. The Qpid project also provides an AMQP broker daemon called + * qpidd that you can use with your qpidc clients. * - * If you have installed somewhere else you should modify the flags - * appropriately. + * See the \ref clientapi "client API reference" to get started. * - * See the \ref clientapi "client API module" for more on the client API. + */ + + +/** + * \defgroup clientapi Application API for an AMQP client. + * + * A typical client takes the following steps: + * - Connect to the broker using qpid::client::Connection::open() + * - Create a qpid::client::Session object. + * + * Once a session is created the client can work with the broker: + * - Create and bind queues using the qpid::client::Session commands. + * - Send messages using qpid::client::Session::messageTransfer. + * - Subscribe to queues using qpid::client::SubscriptionManager */ |