[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    playground/base/plasma/dataengines/presence
From:       Dariusz Mikulski <dariusz.mikulski () gmail ! com>
Date:       2009-01-09 23:21:44
Message-ID: 1231543304.648657.9312.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 908588 by mikulski:

update documentation

 M  +46 -10    presence.cpp  


--- trunk/playground/base/plasma/dataengines/presence/presence.cpp #908587:908588
@@ -100,6 +100,20 @@
 	}
 };
 
+/**
+ * \class PresenceEngine
+ * \ingroup presence
+ * \headerfile <presence.h>
+ *
+ * Object representing a Presence data source.
+ */
+
+/**
+ * Construct a new PresenceEngine object.
+ *
+ * \param parent Object parent.
+ * \param args QVariantList arguments.
+ */
 PresenceEngine::PresenceEngine(QObject * parent, const QVariantList & args)
   : Plasma::DataEngine(parent, args),
   d(new PresenceEnginePrivate(this))
@@ -108,14 +122,19 @@
     Telepathy::registerTypes();
 }
 
+/**
+ * Class destructor
+ */
 PresenceEngine::~PresenceEngine()
 {
 	delete d->m_accountManager;
 	delete d;
 }
 
-void
-PresenceEngine::init()
+/**
+ * Initialize Presence.
+ */
+void PresenceEngine::init()
 {
     kDebug() << "init() started";
     /*
@@ -169,8 +188,12 @@
     }
 }
 
-bool
-PresenceEngine::sourceRequestEvent(const QString & name)
+/**
+ * Return whether source exist.
+ * 
+ * \return \c true if source exists.
+ */
+bool PresenceEngine::sourceRequestEvent(const QString & name)
 {
     /*
      * if the visualisation requests a
@@ -182,8 +205,12 @@
     return false;
 }
 
-void
-PresenceEngine::accountCreated(const QDBusObjectPath &path)
+/**
+ *  Slot for new account.
+ * 
+ * \param path QDBusObjectPath to created account.
+ */
+void PresenceEngine::accountCreated(const QDBusObjectPath &path)
 {
     kDebug() << "accountCreated() called";
     // Load the data for the new account. To avoid duplicating code, we treat
@@ -192,8 +219,13 @@
     d->createAccountDataSource(path);
 }
 
-void
-PresenceEngine::accountValidityChanged(const QDBusObjectPath &path, bool valid)
+/**
+ * Slot for account data changed.
+ * 
+ * \param QDBusObjectPath Name of the account path.
+ * \param valid true if the account is valid.
+ */
+void PresenceEngine::accountValidityChanged(const QDBusObjectPath &path, bool valid)
 {
 	Q_UNUSED(valid);
     kDebug() << "accountValidityChanged() called";
@@ -204,8 +236,12 @@
     d->createAccountDataSource(path);
 }
 
-void
-PresenceEngine::accountRemoved(const QDBusObjectPath &path)
+/**
+ * Slot for account removed.
+ * 
+ * \param QDBusObjectPath Name of the account path.
+ */
+void PresenceEngine::accountRemoved(const QDBusObjectPath &path)
 {
     kDebug() << "uint handle() called";
     /*
[prev in list] [next in list] [prev in thread] [next in thread]