/soc/2013/ankitkv/gobjectification: ff5eccb9f797: Remove @internal

Ankit Vani a at nevitus.org
Thu Feb 6 09:47:10 EST 2014


Changeset: ff5eccb9f797b90b52c5e9d695eb67aff54679dd
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-06 18:40 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/ff5eccb9f797

Description:

Remove @internal

diffstat:

 finch/libgnt/gnt.h             |  12 ++++++------
 finch/libgnt/gntstyle.h        |   9 +++++----
 finch/libgnt/gntwidget.h       |   7 ++++---
 finch/libgnt/gntwm.h           |   5 +++--
 libpurple/smiley.h             |   3 +--
 libpurple/sound-theme-loader.h |   3 +--
 libpurple/sound-theme.h        |   3 +--
 libpurple/theme-loader.h       |   3 +--
 libpurple/theme-manager.h      |   4 +---
 libpurple/theme.h              |   3 +--
 pidgin/gtkblist-theme-loader.h |   4 ++--
 pidgin/gtkblist-theme.h        |   3 +--
 pidgin/gtkconv-theme-loader.h  |   4 ++--
 pidgin/gtkconv-theme.h         |   3 +--
 pidgin/gtkicon-theme-loader.h  |   3 +--
 pidgin/gtkicon-theme.h         |   3 +--
 pidgin/gtkstatus-icon-theme.h  |   3 +--
 pidgin/pidginstock.h           |   3 +--
 18 files changed, 34 insertions(+), 44 deletions(-)

diffs (truncated from 307 to 300 lines):

diff --git a/finch/libgnt/gnt.h b/finch/libgnt/gnt.h
--- a/finch/libgnt/gnt.h
+++ b/finch/libgnt/gnt.h
@@ -72,24 +72,24 @@ void gnt_window_present(GntWidget *windo
 /**
  * gnt_screen_occupy:
  *
- * @internal
- * Use #gnt_widget_show instead.
+ * Internal function -- do not use.
+ * Use gnt_widget_show() instead.
  */
 void gnt_screen_occupy(GntWidget *widget);
 
 /**
  * gnt_screen_release:
  *
- * @internal
- * Use #gnt_widget_hide instead.
+ * Internal function -- do not use.
+ * Use gnt_widget_hide() instead.
  */
 void gnt_screen_release(GntWidget *widget);
 
 /**
  * gnt_screen_update:
  *
- * @internal
- * Use #gnt_widget_draw instead.
+ * Internal function -- do not use.
+ * Use gnt_widget_draw() instead.
  */
 void gnt_screen_update(GntWidget *widget);
 
diff --git a/finch/libgnt/gntstyle.h b/finch/libgnt/gntstyle.h
--- a/finch/libgnt/gntstyle.h
+++ b/finch/libgnt/gntstyle.h
@@ -128,14 +128,14 @@ gboolean gnt_style_get_bool(GntStyle sty
 /**
  * gnt_styles_get_keyremaps:
  *
- * @internal
+ * Internal function -- do not use.
  */
 void gnt_styles_get_keyremaps(GType type, GHashTable *hash);
 
 /**
  * gnt_style_read_actions:
  *
- * @internal
+ * Internal function -- do not use.
  */
 void gnt_style_read_actions(GType type, GntBindableClass *klass);
 
@@ -153,8 +153,9 @@ gboolean gnt_style_read_menu_accels(cons
 /**
  * gnt_style_read_workspaces:
  *
- * @internal
- * Read workspace information.
+ * Reads workspace information.
+ *
+ * Internal function -- do not use.
  */
 void gnt_style_read_workspaces(GntWM *wm);
 
diff --git a/finch/libgnt/gntwidget.h b/finch/libgnt/gntwidget.h
--- a/finch/libgnt/gntwidget.h
+++ b/finch/libgnt/gntwidget.h
@@ -181,8 +181,9 @@ void gnt_widget_draw(GntWidget *widget);
 /**
  * gnt_widget_expose:
  *
- * @internal
  * Expose part of a widget.
+ *
+ * Internal function -- do not use.
  */
 void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height);
 
@@ -322,8 +323,8 @@ const char *gnt_widget_get_name(GntWidge
 /**
  * gnt_widget_queue_update:
  *
- * @internal
- * Use #gnt_widget_draw instead.
+ * Internal function -- do not use.
+ * Use gnt_widget_draw() instead.
  */
 void gnt_widget_queue_update(GntWidget *widget);
 
diff --git a/finch/libgnt/gntwm.h b/finch/libgnt/gntwm.h
--- a/finch/libgnt/gntwm.h
+++ b/finch/libgnt/gntwm.h
@@ -360,14 +360,14 @@ void gnt_wm_raise_window(GntWM *wm, GntW
 /**
  * gnt_wm_set_event_stack:
  *
- * @internal
+ * Internal function -- do not use.
  */
 void gnt_wm_set_event_stack(GntWM *wm, gboolean set);
 
 /**
  * gnt_wm_copy_win:
  *
- * @internal
+ * Internal function -- do not use.
  */
 void gnt_wm_copy_win(GntWidget *widget, GntNode *node);
 
@@ -379,4 +379,5 @@ void gnt_wm_copy_win(GntWidget *widget, 
 time_t gnt_wm_get_idle_time(void);
 
 G_END_DECLS
+
 #endif
diff --git a/libpurple/smiley.h b/libpurple/smiley.h
--- a/libpurple/smiley.h
+++ b/libpurple/smiley.h
@@ -79,8 +79,7 @@ G_BEGIN_DECLS
 /**
  * purple_smiley_get_type:
  *
- * GObject-fu.
- * @internal.
+ * Returns: The #GType for a smiley.
  */
 GType purple_smiley_get_type(void);
 
diff --git a/libpurple/sound-theme-loader.h b/libpurple/sound-theme-loader.h
--- a/libpurple/sound-theme-loader.h
+++ b/libpurple/sound-theme-loader.h
@@ -72,8 +72,7 @@ G_BEGIN_DECLS
 /**
  * purple_sound_theme_loader_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for sound theme loader.
  */
 GType purple_sound_theme_loader_get_type(void);
 
diff --git a/libpurple/sound-theme.h b/libpurple/sound-theme.h
--- a/libpurple/sound-theme.h
+++ b/libpurple/sound-theme.h
@@ -74,8 +74,7 @@ G_BEGIN_DECLS
 /**
  * purple_sound_theme_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a sound theme.
  */
 GType purple_sound_theme_get_type(void);
 
diff --git a/libpurple/theme-loader.h b/libpurple/theme-loader.h
--- a/libpurple/theme-loader.h
+++ b/libpurple/theme-loader.h
@@ -76,8 +76,7 @@ G_BEGIN_DECLS
 /**
  * purple_theme_loader_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for theme loader.
  */
 GType purple_theme_loader_get_type(void);
 
diff --git a/libpurple/theme-manager.h b/libpurple/theme-manager.h
--- a/libpurple/theme-manager.h
+++ b/libpurple/theme-manager.h
@@ -68,9 +68,7 @@ G_BEGIN_DECLS
 /**
  * purple_theme_manager_get_type:
  *
- * GObject foo.
- *
- * @internal.
+ * Returns: The #GType for theme manager.
  */
 GType purple_theme_manager_get_type(void);
 
diff --git a/libpurple/theme.h b/libpurple/theme.h
--- a/libpurple/theme.h
+++ b/libpurple/theme.h
@@ -72,8 +72,7 @@ G_BEGIN_DECLS
 /**
  * purple_theme_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a theme.
  */
 GType purple_theme_get_type(void);
 
diff --git a/pidgin/gtkblist-theme-loader.h b/pidgin/gtkblist-theme-loader.h
--- a/pidgin/gtkblist-theme-loader.h
+++ b/pidgin/gtkblist-theme-loader.h
@@ -66,10 +66,10 @@ G_BEGIN_DECLS
 /**
  * pidgin_blist_theme_loader_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a blist theme loader.
  */
 GType pidgin_blist_theme_loader_get_type(void);
 
 G_END_DECLS
+
 #endif /* PIDGIN_BLIST_THEME_LOADER_H */
diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h
--- a/pidgin/gtkblist-theme.h
+++ b/pidgin/gtkblist-theme.h
@@ -166,8 +166,7 @@ const gchar * pidgin_theme_font_get_colo
 /**
  * pidgin_blist_theme_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a blist theme.
  */
 GType pidgin_blist_theme_get_type(void);
 
diff --git a/pidgin/gtkconv-theme-loader.h b/pidgin/gtkconv-theme-loader.h
--- a/pidgin/gtkconv-theme-loader.h
+++ b/pidgin/gtkconv-theme-loader.h
@@ -66,11 +66,11 @@ G_BEGIN_DECLS
 /**
  * pidgin_conversation_theme_loader_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a conversation theme loader.
  */
 GType pidgin_conversation_theme_loader_get_type(void);
 
 G_END_DECLS
+
 #endif /* PIDGIN_CONV_THEME_LOADER_H */
 
diff --git a/pidgin/gtkconv-theme.h b/pidgin/gtkconv-theme.h
--- a/pidgin/gtkconv-theme.h
+++ b/pidgin/gtkconv-theme.h
@@ -89,8 +89,7 @@ G_BEGIN_DECLS
 /**
  * pidgin_conversation_theme_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a conversation theme.
  */
 GType pidgin_conversation_theme_get_type(void);
 
diff --git a/pidgin/gtkicon-theme-loader.h b/pidgin/gtkicon-theme-loader.h
--- a/pidgin/gtkicon-theme-loader.h
+++ b/pidgin/gtkicon-theme-loader.h
@@ -66,8 +66,7 @@ G_BEGIN_DECLS
 /**
  * pidgin_icon_theme_loader_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for an icon theme loader.
  */
 GType pidgin_icon_theme_loader_get_type(void);
 
diff --git a/pidgin/gtkicon-theme.h b/pidgin/gtkicon-theme.h
--- a/pidgin/gtkicon-theme.h
+++ b/pidgin/gtkicon-theme.h
@@ -69,8 +69,7 @@ G_BEGIN_DECLS
 /**
  * pidgin_icon_theme_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for an icon theme.
  */
 GType pidgin_icon_theme_get_type(void);
 
diff --git a/pidgin/gtkstatus-icon-theme.h b/pidgin/gtkstatus-icon-theme.h
--- a/pidgin/gtkstatus-icon-theme.h
+++ b/pidgin/gtkstatus-icon-theme.h
@@ -68,8 +68,7 @@ G_BEGIN_DECLS
 /**
  * pidgin_status_icon_theme_get_type:
  *
- * GObject foo.
- * @internal.
+ * Returns: The #GType for a status icon theme.
  */
 GType pidgin_status_icon_theme_get_type(void);
 
diff --git a/pidgin/pidginstock.h b/pidgin/pidginstock.h
--- a/pidgin/pidginstock.h
+++ b/pidgin/pidginstock.h
@@ -222,8 +222,7 @@ G_BEGIN_DECLS
 /**
  * pidgin_stock_icon_theme_get_type:



More information about the Commits mailing list