[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=e50eb54

The following commit has been merged in the master branch:
commit e50eb54f77e28c704914ae41d995e9050776a0f5
Author: Daniele E. Domenichelli <daniele.domenichelli at gmail.com>
Date:   Fri Jan 27 14:30:59 2012 +0100

    Add some documentation
---
 KTp/presence.h | 42 ++++++++++++++++++++++++++++++++++++++----
 1 file changed, 38 insertions(+), 4 deletions(-)

diff --git a/KTp/presence.h b/KTp/presence.h
index d88ed07..d116530 100644
--- a/KTp/presence.h
+++ b/KTp/presence.h
@@ -36,16 +36,50 @@ class KTP_EXPORT Presence : public Tp::Presence
 public:
     Presence();
     Presence(const Tp::Presence &presence);
+
+    /**
+     * rief Get the icon for the presence.
+     *
+     * \param useImIcons Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").
+     * 
eturn The icon for the current presence.
+     */
     KIcon icon(bool useImIcons = false) const;
+
+    /**
+     * rief Get the icon for the presence with the specified overlays.
+     *
+     * \param overlays The overlays to apply at the icon.
+     * \param useImIcons Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").
+     * 
eturn The icon for the current presence.
+     */
     KIcon icon(QStringList overlays, bool useImIcons = false) const;
-    QString iconName(bool useImIcons = false) const;
 
-    /** Returns which presence is "more available" */
-    bool operator <(const Presence &other) const;
+    /**
+     * rief Get the name of the icon for the presence.
+     *
+     * This is useful for example if you want to create an icon using the presence as overlay.
+     * \param useImIcons Use im-user-* icons instead of the user-* (i.e. the "pawn" icons instead of the "circles").
+     * 
eturn The name of the icon for the current presence.
+     */
+    QString iconName(bool useImIcons = false) const;
 
+    /**
+     * rief Get a i18n string representing the presence.
+     *
+     * 
eturn An i18n string representing the presence.
+     */
     QString displayString() const;
 
-    /** Returns an int representation of the presence type sorted by priority. 0 - most online, 7 - offline */
+    /**
+     * rief Returns which presence is "more available"
+     */
+    bool operator <(const Presence &other) const;
+
+    /**
+     * rief Returns an int representation of the presence type sorted by priority.
+     *
+     * 0 - most online, 7 - offline
+     */
     static int sortPriority(const Tp::ConnectionPresenceType &type);
 };
 

-- 
ktp-common-internals packaging