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

List:       kde-commits
Subject:    KDE/kdepimlibs/akonadi/kmime
From:       Tobias Koenig <tokoe () kde ! org>
Date:       2010-11-09 10:17:02
Message-ID: 20101109101702.07CE5AC89B () svn ! kde ! org
[Download RAW message or body]

SVN commit 1194541 by tokoe:

Extend API docs


 M  +12 -2     messagestatus.h  


--- trunk/KDE/kdepimlibs/akonadi/kmime/messagestatus.h #1194540:1194541
@@ -175,6 +175,9 @@
     */
     bool hasAttachment() const;
 
+    /** Check for Invitation status.
+        @return true if status indicates an invitation.
+    */
     bool hasInvitation() const;
 
     /* ----- setters ----------------------------------------------------- */
@@ -241,10 +244,13 @@
     void setHam( bool ham = true );
 
     /** Set the status for an attachment.
-        @param withAttechment Set (true) or unset (false) this status flag.
+        @param hasAttachment Set (true) or unset (false) this status flag.
     */
-    void setHasAttachment( bool withAttachment = true );
+    void setHasAttachment( bool hasAttachment = true );
     
+    /** Set the status for an invitation.
+        @param hasInvitation Set (true) or unset (false) this status flag.
+    */
     void setHasInvitation( bool hasInvitation = true );
 
     /* ----- state representation  --------------------------------------- */
@@ -372,6 +378,10 @@
     */
     static MessageStatus statusHasAttachment();
 
+    /** Return a predefined status initialized as Invitation as is useful
+        e.g. when providing a state for comparison.
+        @return A reference to a status instance initialized as Invitation.
+    */
     static MessageStatus statusHasInvitation();
 
   private:
[prev in list] [next in list] [prev in thread] [next in thread]