summaryrefslogtreecommitdiffstats
path: root/kdecore/Mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'kdecore/Mainpage.dox')
-rw-r--r--kdecore/Mainpage.dox44
1 files changed, 44 insertions, 0 deletions
diff --git a/kdecore/Mainpage.dox b/kdecore/Mainpage.dox
new file mode 100644
index 000000000..338b27ae5
--- /dev/null
+++ b/kdecore/Mainpage.dox
@@ -0,0 +1,44 @@
+/** \mainpage The KDE Core Library
+
+All KDE programs use this library to provide basic functionality such
+as the configuration system, IPC, internationalization and locale
+support, site-independent access to the filesystem and a large number
+of other (but no less important) things.
+<p>
+All KDE applications should link to the kdecore library. Also, using a
+KApplication derived class instead of QApplication is almost
+mandatory if you expect your application to behave nicely within the
+KDE environment.
+
+If you are unsure where to start, have a look at the
+<a href="http://techbase.kde.org/Development/Tutorials">tutorials on
+TechBase</a> to get you going.
+
+If you know what you are looking for, you should be able to find it in
+the <a href="annotated.html">class list</a> or the
+<a href="modules.html">modules list</a>.
+
+@authors
+Various: see copyrights on individual files for more information
+
+@maintainers
+See the
+<a href="http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/MAINTAINERS?view=markup">MAINTAINERS</a>
+file.
+
+@licenses
+Library: @lgpl<br>
+Some helper utilities: @gpl
+
+*/
+
+/**
+
+\defgroup KDEMacros KDE Macros
+
+*/
+
+// DOXYGEN_EXCLUDE = malloc kde_file.h
+// DOXYGEN_SET_INPUT += @topdir@/kdemacros.h.cmake
+// DOXYGEN_SET_PROJECT_NAME = KDECore
+// vim:ts=4:sw=4:expandtab:filetype=doxygen