diff options
| author | Alan Conway <aconway@apache.org> | 2007-03-21 01:26:37 +0000 |
|---|---|---|
| committer | Alan Conway <aconway@apache.org> | 2007-03-21 01:26:37 +0000 |
| commit | 1fb29f138da337b2b318355477b271dcf2fa13ca (patch) | |
| tree | 2da3d26e35031c6e7b2587b77bc1d2a9460a9a9c /qpid/cpp-0-9/lib/common/doxygen_mainpage.h | |
| parent | 7ee9b2a933020efadcba42d6200a786321695507 (diff) | |
| download | qpid-python-1fb29f138da337b2b318355477b271dcf2fa13ca.tar.gz | |
* cpp-0-9: svn copy of 0-9 branch cpp, will rename to cpp on next update.
* cpp-0-9/gentools: independent copy of gentools for cpp.
Temporary measure till /java and /gentools are at 0-9
* python/tests_0-9: tests from 0-9 branch.
* python/qpid/testlib.py: Use tests_0-9 with 0-9 spec (default is still 0-8)
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@520690 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp-0-9/lib/common/doxygen_mainpage.h')
| -rw-r--r-- | qpid/cpp-0-9/lib/common/doxygen_mainpage.h | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/qpid/cpp-0-9/lib/common/doxygen_mainpage.h b/qpid/cpp-0-9/lib/common/doxygen_mainpage.h new file mode 100644 index 0000000000..b354238cd0 --- /dev/null +++ b/qpid/cpp-0-9/lib/common/doxygen_mainpage.h @@ -0,0 +1,45 @@ +// This header file is just for doxygen documentation purposes. + +/*!\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 + * + * 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> + * + * If you have installed somewhere else you should modify the flags + * appropriately. + * + * See the \ref clientapi "client API module" for more on the client API. + */ |