diff options
Diffstat (limited to 'konsolekalendar/Mainpage.dox')
| -rw-r--r-- | konsolekalendar/Mainpage.dox | 28 |
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. + +*/ |