aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vrátil <dvratil@kde.org>2016-08-08 22:22:05 (GMT)
committerDaniel Vrátil <dvratil@kde.org>2016-08-08 22:23:24 (GMT)
commitfd1ffecba22feee25df06ec9586efdb977a0b267 (patch)
tree861cb70d76f6296e058cdc695d0cd17deb82c257
parentf02be3572d2da2eeb60b1d6491500747e0c06178 (diff)
Enable docs generation on api.kde.org
-rw-r--r--Mainpage.dox40
-rw-r--r--README.md15
-rw-r--r--metainfo.yaml6
3 files changed, 20 insertions, 41 deletions
diff --git a/Mainpage.dox b/Mainpage.dox
deleted file mode 100644
index 52ead22..0000000
--- a/Mainpage.dox
+++ /dev/null
@@ -1,40 +0,0 @@
-/*!
- * @mainpage KCalCore - the KDE calendar access library.
- *
- * @section purpose Purpose
- *
- * This library provides access to and handling of calendar data.
- * It supports the standard formats iCalendar and vCalendar and the
- * group scheduling standard iTIP.
- *
- * @section desc Description
- *
- * A calendar contains information like incidences (events, to-dos, journals),
- * alarms, time zones, and other useful information. This API provides
- * access to that calendar information via well known calendar formats
- * <a href="http://en.wikipedia.org/wiki/Icalendar">iCalendar (or iCal)</a>
- * and the older <a href="http://en.wikipedia.org/wiki/VCalendar">vCalendar</a>.
- *
- * Credit goes to Eric Bossum \<eric@softwarestudio.org\> for his libical
- * software that does most of the heavy-lifting of the iCalendar support
- * that is abstracted by this API.
- *
- * @authors
- * The major authors of this library are (in alphabetical order):\n
- * Preston Brown \<pbrown@kde.org\>,
- * Reinhold Kainhofer \<reinhold@kainhofer.com\>,
- * Sergio Martins \<iamsergio@gmail.com\>,
- * Cornelius Schumacher \<schumacher@kde.org\>,
- * Allen Winter \<winter@kde.org\>
- *
- * @maintainers
- * Allen Winter \<winter@kde.org\> and Sergio Martins \<iamsergio@gmail.com\>
- *
- * @licenses
- * @lgpl
- */
-
-// DOXYGEN_PROJECTNAME=KCalCore Library
-// DOXYGEN_EXCLUDE = libical
-// DOXYGEN_SET_EXCLUDE_PATTERNS += @topdir@/kcalcore/versit/*.h
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e083276
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# KCalCore
+
+This library provides access to and handling of calendar data.
+It supports the standard formats iCalendar and vCalendar and the
+group scheduling standard iTIP.
+
+A calendar contains information like incidences (events, to-dos, journals),
+alarms, time zones, and other useful information. This API provides
+access to that calendar information via well known calendar formats
+[iCalendar (or iCal)](http://en.wikipedia.org/wiki/Icalendar) and the oolder
+[vCalendar](http://en.wikipedia.org/wiki/VCalendar).
+
+Credit goes to Eric Bossum \<eric@softwarestudio.org\> for his libical
+software that does most of the heavy-lifting of the iCalendar support
+that is abstracted by this API.
diff --git a/metainfo.yaml b/metainfo.yaml
index 61072cb..952ca83 100644
--- a/metainfo.yaml
+++ b/metainfo.yaml
@@ -1,4 +1,4 @@
-maintainer: Sandro Knauß <sknauss@kde.org>
+maintainer: knauss
description: The KDE calendar access library
tier: 3
type: functional
@@ -12,3 +12,7 @@ libraries:
cmake: "KF5::CalendarCore"
cmakename: KF5CalendarCore
+public_lib: true
+group: kdepim
+platforms:
+ - name: Linux