aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vrátil <dvratil@kde.org>2016-08-08 22:27:39 (GMT)
committerDaniel Vrátil <dvratil@kde.org>2016-08-08 22:27:39 (GMT)
commit01464d191e431d51b5de097068e21f0b725bccbb (patch)
tree935cd4043c52368ec1a35cda362889f29cc26f0e
parent1e2a1a2b007476231c94a90e69d1a19131ee9f46 (diff)
Enable docs generation on api.kde.org
-rw-r--r--Mainpage.dox30
-rw-r--r--README.md11
-rw-r--r--metainfo.yaml19
3 files changed, 30 insertions, 30 deletions
diff --git a/Mainpage.dox b/Mainpage.dox
deleted file mode 100644
index a3d9dfc..0000000
--- a/Mainpage.dox
+++ /dev/null
@@ -1,30 +0,0 @@
-/*!
- * @mainpage KIMAP - a job-based API for interacting with IMAP servers
- *
- * @section purpose Purpose
- *
- * This library provides a job-based API for interacting with an IMAP4rev1 server.
- * It manages connections, encryption and parameter quoting and encoding, but
- * otherwise provides quite a low-level interface to the protocol. This library
- * does not implement an IMAP client; it merely makes it easier to do so.
- *
- * Users should be familiar with
- * <a href="http://www.apps.ietf.org/rfc/rfc3501.html" title="IMAP 4rev1">RFC 3501</a>,
- * as well as <a href="http://www.iana.org/assignments/imap4-capabilities">other related RFCs</a>,
- * although the library hides some of the nastier details like the encoding and quoting of
- * strings.
- *
- * @section desc Description
- *
- * @authors
- * The major authors of this library are:\n
- * Sven Carstens \<s.carstens@gmx.de\>
- *
- * @maintainers
- * Christian Mollekopf \<chrigi_1@fastmail.fm\>
- *
- * @licenses
- * @lgpl
- */
-
-// DOXYGEN_PROJECTNAME=KIMAP Library
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c3ed38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# KIMAP
+
+This library provides a job-based API for interacting with an IMAP4rev1 server.
+It manages connections, encryption and parameter quoting and encoding, but
+otherwise provides quite a low-level interface to the protocol. This library
+does not implement an IMAP client; it merely makes it easier to do so.
+
+Users should be familiar with [RFC 3501](http://www.apps.ietf.org/rfc/rfc3501.html "IMAP 4rev1")
+as well as [other related RFCs](http://www.iana.org/assignments/imap4-capabilities)
+although the library hides some of the nastier details like the encoding and quoting of
+strings.
diff --git a/metainfo.yaml b/metainfo.yaml
new file mode 100644
index 0000000..6d8cc02
--- /dev/null
+++ b/metainfo.yaml
@@ -0,0 +1,19 @@
+fancyname: KIMAP
+maintainer: cmollekopf
+description: A job-based API for interacting with IMAP servers
+tier: 3
+type: functional
+platforms:
+ - name: All
+portingAid: false
+deprecated: false
+release: false
+libraries:
+ - qmake: KImap
+ cmake: "KF5::Imap"
+cmakename: KF5Imap
+
+public_lib: true
+group: kdepim
+platforms:
+ - name: Linux