diff options
| author | Andrew Stitcher <astitcher@apache.org> | 2007-04-02 11:40:48 +0000 |
|---|---|---|
| committer | Andrew Stitcher <astitcher@apache.org> | 2007-04-02 11:40:48 +0000 |
| commit | 9ecd69ebc88fb5d82a693e51eef0475c1a6b282e (patch) | |
| tree | 841ab9ff2ebf92ad57bc9189eefc7448260577d1 /qpid/cpp/src/doxygen_mainpage.h | |
| parent | 4ee7e8cbd677bd2ddf3f49d535a547e99c0aa150 (diff) | |
| download | qpid-python-9ecd69ebc88fb5d82a693e51eef0475c1a6b282e.tar.gz | |
Fix for the most disruptive items in QPID-243.
* All #include lines now use '""' rather than '<>' where appropriate.
* #include lines within the qpid project use relative includes so that
the same path will work in /usr/include when installed as part of the
client libraries.
* All the source code has now been rearranged to be under src in a directory
analogous to the namespace of the classes in it.
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@524769 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp/src/doxygen_mainpage.h')
| -rw-r--r-- | qpid/cpp/src/doxygen_mainpage.h | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/qpid/cpp/src/doxygen_mainpage.h b/qpid/cpp/src/doxygen_mainpage.h new file mode 100644 index 0000000000..b354238cd0 --- /dev/null +++ b/qpid/cpp/src/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. + */ |