qulogic/pidgin

Add documentation to PurpleSoundStatus

2015-11-30, Jorge VillaseƱor
b510a2c43981
Parents a9aa2aa0b1b6
Children 60b8311c4c2e
Add documentation to PurpleSoundStatus
--- a/libpurple/sound.h Tue Nov 24 23:16:45 2015 -0800
+++ b/libpurple/sound.h Mon Nov 30 20:49:30 2015 -0800
@@ -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 @@
*
* A type of sound.
*/
-
typedef enum
{
PURPLE_SOUND_BUDDY_ARRIVE = 0,