Add descriptions of messages_recipient_type_e type.
authorWonYoung Choi <wy80.choi@samsung.com>
Fri, 7 Sep 2012 06:20:49 +0000 (15:20 +0900)
committerWonYoung Choi <wy80.choi@samsung.com>
Fri, 7 Sep 2012 06:20:49 +0000 (15:20 +0900)
include/messages_types.h

index b7f10d2..a25b1f0 100644 (file)
@@ -76,10 +76,10 @@ typedef enum {
  * @brief The recipient type of a message.
  */
 typedef enum {
-       MESSAGES_RECIPIENT_UNKNOWN = 0,
-       MESSAGES_RECIPIENT_TO = 1,
-       MESSAGES_RECIPIENT_CC = 2,
-       MESSAGES_RECIPIENT_BCC = 3,
+       MESSAGES_RECIPIENT_UNKNOWN = 0, /**< Unknown */
+       MESSAGES_RECIPIENT_TO = 1, /**< The 'To' recipient  */
+       MESSAGES_RECIPIENT_CC = 2, /**< The 'Cc' (carbon copy) recipient */
+       MESSAGES_RECIPIENT_BCC = 3, /**< The 'Bcc' (blind carbon copy) recipient */
 } messages_recipient_type_e;
 
 /**