summaryrefslogtreecommitdiffstats
path: root/tdecore/Mainpage.dox
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-06 15:56:40 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-06 15:56:40 -0600
commite16866e072f94410321d70daedbcb855ea878cac (patch)
treeee3f52eabde7da1a0e6ca845fb9c2813cf1558cf /tdecore/Mainpage.dox
parenta58c20c1a7593631a1b50213c805507ebc16adaf (diff)
downloadtdelibs-e16866e072f94410321d70daedbcb855ea878cac.tar.gz
tdelibs-e16866e072f94410321d70daedbcb855ea878cac.zip
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'tdecore/Mainpage.dox')
-rw-r--r--tdecore/Mainpage.dox42
1 files changed, 42 insertions, 0 deletions
diff --git a/tdecore/Mainpage.dox b/tdecore/Mainpage.dox
new file mode 100644
index 000000000..c0e13a339
--- /dev/null
+++ b/tdecore/Mainpage.dox
@@ -0,0 +1,42 @@
+/** \mainpage The Trinity Core Library
+
+All Trinity 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 Trinity applications should link to the tdecore library. Also, using a
+KApplication derived class instead of TQApplication is almost
+mandatory if you expect your application to behave nicely within the
+Trinity environment.
+
+If you are unsure where to start, have a look at the
+<a href="http://www.trinitydesktop.org">tutorials on
+the Trinity project site</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 MAINTAINERS file.
+
+@licenses
+Library: @lgpl<br>
+Some helper utilities: @gpl
+
+*/
+
+/**
+
+\defgroup TrinityMacros Trinity Macros
+
+*/
+
+// DOXYGEN_EXCLUDE = malloc kde_file.h
+// DOXYGEN_SET_INPUT += @topdir@/kdemacros.h.cmake
+// DOXYGEN_SET_PROJECT_NAME = TrinityCore
+// vim:ts=4:sw=4:expandtab:filetype=doxygen