frameworks/kxmlrpcclient/Mainpage.dox

0001 /*!
0002  * @mainpage kxmlrpcclient - an XML-RPC client library for KDE.
0003  *
0004  * @section purpose Purpose
0005  *
0006  * kxmlrpclient provides client-side support for the XML-RPC protocol.
0007  *
0008  * @section desc Description
0009  *
0010  * This library contains simple XML-RPC Client support. It is used mainly
0011  * by the egroupware module of kdepim, but is a complete client and is
0012  * quite easy to use. Only one interface is exposed to the world,
0013  * kxmlrpcclient/client.h and of that interface, you only need to
0014  * use 3 methods: setUrl, setUserAgent and call.
0015  *
0016  * A small note on authentication. If you will be accessing an XML-RPC server
0017  * which uses HTTP-AUTH, simply set the user and pass in the KURL. Digest
0018  * authentication is more complicated and requires the use of three utility
0019  * methods: enableDigestAuth, disableDigestAuth and digestAuth.
0020  *
0021  * @authors
0022  * The major authors of this library are:\n
0023  * Narayan Newton  \<narayannewton@gmail.com\>,
0024  * Frerich Raabe \<raabe@kde.org\>,
0025  * Tobias Koenig \<tokoe@kde.org\>
0026  *
0027  * @maintainers Narayan Newton  \<narayannewton@gmail.com\>
0028  *
0029  * @licenses
0030  * @lgpl
0031  *
0032  * kxmlrpcclient development is discussed on the
0033  * <a href="mailto:kde-pim@kde.org">kde-pim@kde.org</a> mailing list.
0034  */
0035
0036 // DOXYGEN_PROJECTNAME=KXMLRPC Client Library