diff options
Diffstat (limited to 'knewstuff/Mainpage.dox')
| -rw-r--r-- | knewstuff/Mainpage.dox | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/knewstuff/Mainpage.dox b/knewstuff/Mainpage.dox new file mode 100644 index 000000000..ed863f4e2 --- /dev/null +++ b/knewstuff/Mainpage.dox @@ -0,0 +1,35 @@ +/** \mainpage Collaborative Data Sharing in KDE Applications + +The \b KNewStuff2 library adds data sharing capabilities to %KDE +applications. Technically, it implements the +<a href="http://ghns.freedesktop.org/">GHNS</a> and +DXS specifications. The library consists of three parts: the data management core +and GHNS protocol implementation, the DXS web service handler, and the user interface +classes like dialogs and buttons. + +Application authors should not use all of the classes directly, which are installed +only for the purpose of implementing functionality on top of \b KNewStuff2; instead, +the high-level KNS::Engine class provides everything an application needs. +Both upload and download scenarios are handled by the engine. There are only two +preparation steps necessary before this class can be used: the setup of a GHNS repository, +and the creation of a <b>*.knsrc</b> file which will determine all aspects of the +application's \b KNewStuff2 usage. + +All of the related information such as <b>*.knsrc</b> files, repositories and security +can be found in the <a href="http://techbase.kde.org/Development/Tutorials/K_Hot_New_Stuff2">KNewStuff2 tutorial</a>. + +@authors +Josef Spillner \<spillner@kde.org\> +Jeremy Whiting \<jeremy@scitools.com\> + +@maintainers +Jeremy Whiting \<jeremy@scitools.com\> + +@licenses +@lgpl + +*/ + +// DOXYGEN_REFERENCES = kdecore kdeui kio +// DOXYGEN_SET_PROJECT_NAME = KNewStuff +// vim:ts=4:sw=4:expandtab:filetype=doxygen |