Mercurial > pidgin

comparison finch/gntsound.h @ 20874:acf284962b40

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add @since doxygen tags for finch/libgnt.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 10 Oct 2007 03:54:14 +0000
parents 6bf32c9e15a7
children 44f53d3fc54f
comparison
equal deleted inserted replaced
20869:2a6ef74f5a4e 20874:acf284962b40
35 35
36 /** 36 /**
37 * Get the name of the active sound profile. 37 * Get the name of the active sound profile.
38 * 38 *
39 * @return The name of the profile 39 * @return The name of the profile
40 *
41 * @since 2.1.0
40 */ 42 */
41 const char *finch_sound_get_active_profile(void); 43 const char *finch_sound_get_active_profile(void);
42 44
43 /** 45 /**
44 * Set the active profile. If the profile doesn't exist, nothing is changed. 46 * Set the active profile. If the profile doesn't exist, nothing is changed.
45 * 47 *
46 * @param name The name of the profile 48 * @param name The name of the profile
49 *
50 * @since 2.1.0
47 */ 51 */
48 void finch_sound_set_active_profile(const char *name); 52 void finch_sound_set_active_profile(const char *name);
49 53
50 /** 54 /**
51 * Get a list of available sound profiles. 55 * Get a list of available sound profiles.
52 * 56 *
53 * @return A list of strings denoting sound profile names. 57 * @return A list of strings denoting sound profile names.
54 * Caller must free the list (but not the data). 58 * Caller must free the list (but not the data).
59 *
60 * @since 2.1.0
55 */ 61 */
56 GList *finch_sound_get_profiles(void); 62 GList *finch_sound_get_profiles(void);
57 63
58 /** 64 /**
59 * Determine whether any sound will be played or not. 65 * Determine whether any sound will be played or not.
60 * 66 *
61 * @return Returns FALSE if preference is set to 'No sound', or if volume is 67 * @return Returns FALSE if preference is set to 'No sound', or if volume is
62 * set to zero. 68 * set to zero.
69 *
70 * @since 2.2.0
63 */ 71 */
64 gboolean finch_sound_is_enabled(void); 72 gboolean finch_sound_is_enabled(void);
65 73
66 /** 74 /**
67 * Gets GNT sound UI ops. 75 * Gets GNT sound UI ops.
68 * 76 *
69 * @return The UI operations structure. 77 * @return The UI operations structure.
78 *
79 * @since 2.1.0
70 */ 80 */
71 PurpleSoundUiOps *finch_sound_get_ui_ops(void); 81 PurpleSoundUiOps *finch_sound_get_ui_ops(void);
72 82
73 /** 83 /**
74 * Show the sound settings dialog. 84 * Show the sound settings dialog.
85 *
86 * @since 2.1.0
75 */ 87 */
76 void finch_sounds_show_all(void); 88 void finch_sounds_show_all(void);
77 89
78 /*@}*/ 90 /*@}*/
79 91