[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=4e7d91a

The following commit has been merged in the master branch:
commit 4e7d91a59da80abfbebfb37edcdaa6b338545907
Author: Lasath Fernando <kde at lasath.org>
Date:   Tue May 1 16:53:37 2012 +1000

    Document the message class
    
    I want to get this checked by someone who doesn't know
    how this works, so that way I can see if it's sensible
    documentation in any way.
---
 KTp/message.h | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/KTp/message.h b/KTp/message.h
index c9d4340..5ee9314 100644
--- a/KTp/message.h
+++ b/KTp/message.h
@@ -29,17 +29,63 @@ class KDE_TELEPATHY_CHAT_EXPORT Message {
 public:
     Message(const Tp::Message& original);
 
+    /*! rief The body of the message
+     * 
eturn the contents of the body of the message, as HTML
+     */
     QString mainMessagePart() const;
+
+    /*! rief Edit the main component of the message
+     * 
ote: This operation is thread-safe.
+     * \param message the string to replace the body with. Must be correct HTML
+     */
     void setMainMessagePart(const QString& message);
+
+    /*! rief Add new visual content to the end of the message
+     *
+     * \par
+     * Each plugin that adds visual components should call this once thier
+     * processing is complete. Once a message part is added, it cannot be
+     * changed!
+     * 
+     * 
ote: This operation is thread-safe.
+     * \param part the content to be added, in valid HTML
+     */
     void appendMessagePart(const QString& part);
 
+    /*! rief Construct the final procesesd content
+     * \par
+     * This will concatenate all the visual 'parts' of the message into one
+     * (Qt supported) HTML string.
+     *
+     * 
ote
+     * All user interfaces need only care about this
+     *
+     */
     QString finalizedMessage() const;
 
+    /*! rief Sets the contents of a property
+     * \par
+     * These messages contain meta-data for plugins in the form of 'properties'.
+     * A property can be set to any QMetaType (i.e type that can stuck in a
+     * QVariant) and is identified by a string (name).
+     *
+     * \par
+     * These are set by plugins for use in other plugins, creating implicit
+     * dependencies between plugins. Since these plugins are (or will be)
+     * run concurrently, calling this method on a property that hasn't been set
+     * yet will block until it has been set by some plugin. If it isn't set when
+     * all plugins are finished, this plugin will be cancelled.
+     *
+     * \param name the identifier of the property 
+     */
     QVariant property(const char *name) const;
     void setProperty(const char *name, const QVariant &value);
 
+    /*! 
eturn the timestamp from the internal Tp::Message */
     QDateTime time() const;
+    /*! 
eturn the unique token from the internal Tp::Message*/
     QString   token() const;
+    /*! 
eturn the type of the internal Tp::Message*/
     Tp::ChannelTextMessageType type() const;
 
 private:

-- 
ktp-common-internals packaging