summaryrefslogtreecommitdiffstats
path: root/konsolekalendar/Mainpage.dox
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /konsolekalendar/Mainpage.dox
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'konsolekalendar/Mainpage.dox')
-rw-r--r--konsolekalendar/Mainpage.dox28
1 files changed, 28 insertions, 0 deletions
diff --git a/konsolekalendar/Mainpage.dox b/konsolekalendar/Mainpage.dox
new file mode 100644
index 000000000..5b46a4dee
--- /dev/null
+++ b/konsolekalendar/Mainpage.dox
@@ -0,0 +1,28 @@
+/** \mainpage %KonsoleKalendar API Overview
+
+\section intro Introduction
+
+%KonsoleKalendar is a command line interface to KDE calendars.
+It lets you view, insert, remove, or modify calendar events by way of
+the command line or from a scripting language.
+Additionally, %KonsoleKalendar can create a new KDE calendar,
+export a KDE calendar to a variety of other formats, and
+import another KDE calendar.
+
+\section map Road Map to the Classes
+
+KCal::KonsoleKalendar is the base class.
+
+KCal::KonsoleKalendarVariables holds all the command line arguments plus some.
+
+KCal::KonsoleKalendarEpoch is for timestamps expressed as epochs.
+
+KCal::KonsoleKalendarExports manages the export functionality.
+
+KCal::KonsoleKalendarAdd manages the event insert capability.
+
+KCal::KonsoleKalendarDelete manages the event removal capability.
+
+KCal::KonsoleKalendarChange manages the event modification capability.
+
+*/