summaryrefslogtreecommitdiff
path: root/kpimutils/Mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'kpimutils/Mainpage.dox')
-rw-r--r--kpimutils/Mainpage.dox16
1 files changed, 16 insertions, 0 deletions
diff --git a/kpimutils/Mainpage.dox b/kpimutils/Mainpage.dox
new file mode 100644
index 0000000..a45f8b9
--- /dev/null
+++ b/kpimutils/Mainpage.dox
@@ -0,0 +1,16 @@
+/** @mainpage kpimutils
+
+This library contains utility functions for dealing with email addresses.
+This includes parsing, splitting, and munging email addresses represented
+as strings (e.g. in email headers); some additional functions handle
+non-latin1 upper- and lower-case conversions.
+
+Everything lives in the KPIMUtils namespace.
+
+ - @ref emailvalidation
+ - @ref emailextraction
+ - @ref emailidn
+
+*/
+
+// DOXYGEN_TOOLTIP = "A library for general purpose email handling."