[SCM] ktp-common-internals packaging branch, master, updated. debian/15.12.1-2-1839-gf0635e9

[Maximiliano Curia]

Gitweb-URL: http://git.debian.org/?p=pkg-kde/applications/ktp-common-internals.git;a=commitdiff;h=5986c9f

The following commit has been merged in the master branch:
commit 5986c9fde186378b26f7a5985c97102feba191e8
Author: David Edmundson <kde at davidedmundson.co.uk>
Date:   Sat Nov 17 09:42:24 2012 +0900

    Add documentation to Error Dictionary class
    
    Reviewed-by: Martin Klapetek
---
 KTp/error-dictionary.h | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/KTp/error-dictionary.h b/KTp/error-dictionary.h
index b92a43b..d44687f 100644
--- a/KTp/error-dictionary.h
+++ b/KTp/error-dictionary.h
@@ -27,12 +27,20 @@
 
 namespace KTp
 {
+/**
+ * @short A method of turning error codes into human readable strings
+ *
+ */
 namespace ErrorDictionary
 {
-    ///Returns a verbose error message usable for displaying to the user
+    /**Returns a verbose error message suitable for displaying to the user
+        @param dbusErrorName The Telepathy error as specified in http://telepathy.freedesktop.org/spec/errors.html
+     */
     KTP_EXPORT QString displayVerboseErrorMessage(const QString& dbusErrorName);
 
-    ///Returns a short error message usable for little space
+    /**Returns a short error message suitable when there is little space
+        @param dbusErrorName The Telepathy error as specified in http://telepathy.freedesktop.org/spec/errors.html
+     */
     KTP_EXPORT QString displayShortErrorMessage(const QString& dbusErrorName);
 }
 }

-- 
ktp-common-internals packaging