/pidgin/main: b510a2c43981: Add documentation to PurpleSoundStatus

[Jorge Villase?or]

Changeset: b510a2c43981a8b6f6d00b757bf53291c10865c4
Author:	 Jorge Villase?or <salinasv at pidgin.im>
Date:	 2015-11-30 20:49 -0800
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/b510a2c43981

Description:

Add documentation to PurpleSoundStatus

diffstat:

 libpurple/sound.h |  7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diffs (24 lines):

diff --git a/libpurple/sound.h b/libpurple/sound.h
--- a/libpurple/sound.h
+++ b/libpurple/sound.h
@@ -39,6 +39,12 @@
 typedef struct _PurpleSoundUiOps PurpleSoundUiOps;
 
 /**
+ * PurpleSoundStatus:
+ * @PURPLE_SOUND_STATUS_AVAILABLE:	Only play sound when Status is Available.
+ * @PURPLE_SOUND_STATUS_AWAY:		Only play sound when Status is Not Available.
+ * @PURPLE_SOUND_STATUS_ALWAYS:		Always play sound.
+ *
+ * A preference option on when to play sounds depending on the current status
  */
 typedef enum {
 	PURPLE_SOUND_STATUS_AVAILABLE = 1,
@@ -64,7 +70,6 @@ typedef enum {
  *
  * A type of sound.
  */
-
 typedef enum
 {
 	PURPLE_SOUND_BUDDY_ARRIVE = 0,