/soc/2013/ankitkv/gobjectification: dfcc9f64f58c: Move media/the...

[Ankit Vani]

Changeset: dfcc9f64f58c93a3e3e4a656b27ac4ae386ffd5e
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-10-02 16:15 +0530
Branch:	 soc.2013.gobjectification
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/dfcc9f64f58c

Description:

Move media/theme GObject docs to appropriate places

diffstat:

 libpurple/media.h        |   3 +--
 libpurple/sound-theme.h  |  13 ++++++-------
 libpurple/theme-loader.h |  14 +++++++-------
 libpurple/theme.h        |  12 ++++++------
 4 files changed, 20 insertions(+), 22 deletions(-)

diffs (113 lines):

diff --git a/libpurple/media.h b/libpurple/media.h
--- a/libpurple/media.h
+++ b/libpurple/media.h
@@ -41,7 +41,7 @@
 #define PURPLE_IS_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA))
 #define PURPLE_MEDIA_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA, PurpleMediaClass))
 
-/** A structure representing a media call. */
+/** @copydoc _PurpleMedia */
 typedef struct _PurpleMedia PurpleMedia;
 
 #include "signals.h"
@@ -51,7 +51,6 @@ typedef struct _PurpleMedia PurpleMedia;
 
 /** @copydoc _PurpleMediaClass */
 typedef struct _PurpleMediaClass    PurpleMediaClass;
-/** @copydoc _PurpleMediaPrivate */
 typedef struct _PurpleMediaPrivate  PurpleMediaPrivate;
 
 /** The media instance */
diff --git a/libpurple/sound-theme.h b/libpurple/sound-theme.h
--- a/libpurple/sound-theme.h
+++ b/libpurple/sound-theme.h
@@ -31,14 +31,9 @@
 #include "theme.h"
 #include "sound.h"
 
-/**
- * extends PurpleTheme (theme.h)
- * A purple sound theme.
- * This is an object for Purple to represent a sound theme.
- *
- * PurpleSoundTheme is a PurpleTheme Object.
- */
+/** @copydoc _PurpleSoundTheme */
 typedef struct _PurpleSoundTheme        PurpleSoundTheme;
+/** @copydoc _PurpleSoundThemeClass */
 typedef struct _PurpleSoundThemeClass   PurpleSoundThemeClass;
 
 #define PURPLE_TYPE_SOUND_THEME             (purple_sound_theme_get_type())
@@ -48,6 +43,10 @@ typedef struct _PurpleSoundThemeClass   
 #define PURPLE_IS_SOUND_THEME_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_SOUND_THEME))
 #define PURPLE_SOUND_THEME_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
 
+/**
+ * A purple sound theme.
+ * This is an object for Purple to represent a sound theme.
+ */
 struct _PurpleSoundTheme
 {
 	/*< private >*/
diff --git a/libpurple/theme-loader.h b/libpurple/theme-loader.h
--- a/libpurple/theme-loader.h
+++ b/libpurple/theme-loader.h
@@ -30,14 +30,9 @@
 #include <glib-object.h>
 #include "theme.h"
 
-/**
- * A purple theme loader.
- * This is an abstract class for Purple to use with the Purple theme manager.
- * The loader is responsible for building each type of theme
- *
- * PurpleThemeLoader is a GObject.
- */
+/** @copydoc _PurpleThemeLoader */
 typedef struct _PurpleThemeLoader        PurpleThemeLoader;
+/** @copydoc _PurpleThemeLoaderClass */
 typedef struct _PurpleThemeLoaderClass   PurpleThemeLoaderClass;
 
 #define PURPLE_TYPE_THEME_LOADER            (purple_theme_loader_get_type())
@@ -47,6 +42,11 @@ typedef struct _PurpleThemeLoaderClass  
 #define PURPLE_IS_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_THEME_LOADER))
 #define PURPLE_THEME_LOADER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_THEME_LOADER, PurpleThemeLoaderClass))
 
+/**
+ * A purple theme loader.
+ * This is an abstract class for Purple to use with the Purple theme manager.
+ * The loader is responsible for building each type of theme
+ */
 struct _PurpleThemeLoader
 {
 	/*< private >*/
diff --git a/libpurple/theme.h b/libpurple/theme.h
--- a/libpurple/theme.h
+++ b/libpurple/theme.h
@@ -30,13 +30,9 @@
 #include <glib-object.h>
 #include "imgstore.h"
 
-/**
- * A purple theme.
- * This is an abstract class for Purple to use with the Purple theme manager.
- *
- * PurpleTheme is a GObject.
- */
+/** @copydoc _PurpleTheme */
 typedef struct _PurpleTheme        PurpleTheme;
+/** @copydoc _PurpleThemeClass */
 typedef struct _PurpleThemeClass   PurpleThemeClass;
 
 #define PURPLE_TYPE_THEME            (purple_theme_get_type ())
@@ -46,6 +42,10 @@ typedef struct _PurpleThemeClass   Purpl
 #define PURPLE_IS_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_THEME))
 #define PURPLE_THEME_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_THEME, PurpleThemeClass))
 
+/**
+ * A purple theme.
+ * This is an abstract class for Purple to use with the Purple theme manager.
+ */
 struct _PurpleTheme
 {
 	/*< private >*/