libpurple/sound-theme.h

branch
soc.2013.gobjectification.plugins
changeset 37045
aadac46d3bb3
parent 37037
c391f5d677e4
parent 35403
9282701d7aa9
child 37061
77a5c789fff1
--- a/libpurple/sound-theme.h	Sat Feb 01 02:32:30 2014 +0530
+++ b/libpurple/sound-theme.h	Sat Feb 01 17:27:24 2014 +0530
@@ -31,9 +31,7 @@
 #include "theme.h"
 #include "sound.h"
 
-/** @copydoc _PurpleSoundTheme */
 typedef struct _PurpleSoundTheme        PurpleSoundTheme;
-/** @copydoc _PurpleSoundThemeClass */
 typedef struct _PurpleSoundThemeClass   PurpleSoundThemeClass;
 
 #define PURPLE_TYPE_SOUND_THEME             (purple_sound_theme_get_type())
@@ -44,6 +42,8 @@
 #define PURPLE_SOUND_THEME_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
 
 /**
+ * PurpleSoundTheme:
+ *
  * A purple sound theme.
  * This is an object for Purple to represent a sound theme.
  */
@@ -70,28 +70,32 @@
 G_BEGIN_DECLS
 
 /**
+ * purple_sound_theme_get_type:
+ *
  * GObject foo.
  * @internal.
  */
 GType purple_sound_theme_get_type(void);
 
 /**
- * Returns a copy of the filename for the sound event.
- *
+ * purple_sound_theme_get_file:
  * @theme: The theme.
  * @event: The purple sound event to look up.
  *
+ * Returns a copy of the filename for the sound event.
+ *
  * Returns: The filename of the sound event.
  */
 const gchar *purple_sound_theme_get_file(PurpleSoundTheme *theme,
 		const gchar *event);
 
 /**
- * Returns a copy of the directory and filename for the sound event
- *
+ * purple_sound_theme_get_file_full:
  * @theme: The theme.
  * @event: The purple sound event to look up
  *
+ * Returns a copy of the directory and filename for the sound event
+ *
  * Returns: The directory + '/' + filename of the sound event.  This is
  *          a newly allocated string that should be freed with g_free.
  */
@@ -99,15 +103,17 @@
 		const gchar *event);
 
 /**
- * Sets the filename for a given sound event
- *
+ * purple_sound_theme_set_file:
  * @theme:    The theme.
  * @event:    the purple sound event to look up
  * @filename: the name of the file to be used for the event
+ *
+ * Sets the filename for a given sound event
  */
 void purple_sound_theme_set_file(PurpleSoundTheme *theme,
 		const gchar *event,
 		const gchar *filename);
 
 G_END_DECLS
+
 #endif /* PURPLE_SOUND_THEME_H */

mercurial