src/kalarmcalendar/Mainpage.dox

0001 /*!
0002  * @mainpage The KAlarm calendar library
0003  *
0004  * @section purpose Purpose
0005  *
0006  * This library provides access to and handling of KAlarm calendar data.
0007  *
0008  * @section desc Description
0009  *
0010  * This library provides access to KAlarm calendar data, but not to the storage
0011  * of the data, which is handled separately.
0012  * The main class, KAEvent, represents a KAlarm event, and contains both the
0013  * event definition including the main alarm and optional subsidiary alarms, and
0014  * status information about the event.
0015  *
0016  * Calendar format information is accessed through the KACalendar class, which
0017  * provides read and write access to the calendar format version and
0018  * iCalendar product ID.
0019  *
0020  * Recurrence and sub-repetition information is represented by the KARecurrence
0021  * and Repetition classes respectively.
0022  *
0023  * The KADateTime class is analagous to QDateTime, but can alternatively hold
0024  * a date-only value, and its time zone definition is more flexible than
0025  * QDateTime. The DateTime class is similar to KADateTime but with a
0026  * configurable start-of-day time for date-only times.
0027  *
0028  * @authors
0029  * David Jarvie \<djarvie@kde.org\>
0030  *
0031  * @licenses
0032  * @lgpl
0033  */
0034
0035 // DOXYGEN_PROJECTNAME=KAlarm Calendar Library
0036 // DOXYGEN_REFERENCES=kdecore kcalendarcore kholidays kpimidentities akonadi