From 1f50a4d0114e74c26a5281dedf5f5df0cf54e793 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Jard=C3=B3n?= Date: Mon, 11 Apr 2011 22:33:38 +0100 Subject: [PATCH] Move documentation to inline comments: GtkHSeparator --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtkhseparator.sgml | 53 ---------------------- gtk/gtkhseparator.c | 26 +++++++++++ 3 files changed, 27 insertions(+), 53 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkhseparator.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 87a6836029..227c4864a4 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -39,6 +39,7 @@ gtkhbox.sgml gtkhpaned.sgml gtkhscale.sgml gtkhscrollbar.sgml +gtkhseparator.sgml gtkiconview.sgml gtkimagemenuitem.sgml gtkimcontext.sgml diff --git a/docs/reference/gtk/tmpl/gtkhseparator.sgml b/docs/reference/gtk/tmpl/gtkhseparator.sgml deleted file mode 100644 index 9e295cb858..0000000000 --- a/docs/reference/gtk/tmpl/gtkhseparator.sgml +++ /dev/null @@ -1,53 +0,0 @@ - -GtkHSeparator - - -A horizontal separator - - - -The #GtkHSeparator widget is a horizontal separator, used to group the -widgets within a window. It displays a horizontal line with a shadow to -make it appear sunken into the interface. - - - -The #GtkHSeparator widget is not used as a separator within menus. -To create a separator in a menu create an empty #GtkSeparatorMenuItem -widget using gtk_separator_menu_item_new() and add it to the menu with -gtk_menu_shell_append(). - - - - - - - -#GtkVSeparator -a vertical separator. - - - - - - - - - - - - -The #GtkHSeparator-struct struct contains private data only, and -should be accessed using the functions below. - - - - - -Creates a new #GtkHSeparator. - - -@void: -@Returns: a new #GtkHSeparator. - - diff --git a/gtk/gtkhseparator.c b/gtk/gtkhseparator.c index edbc0c96a3..49b31d0b9b 100644 --- a/gtk/gtkhseparator.c +++ b/gtk/gtkhseparator.c @@ -30,6 +30,25 @@ #include "gtkorientable.h" +/** + * SECTION:gtkhseparator + * @Short_description: A horizontal separator + * @Title: GtkHSeparator + * @See_also: #GtkSeparator + * + * The #GtkHSeparator widget is a horizontal separator, used to group the + * widgets within a window. It displays a horizontal line with a shadow to + * make it appear sunken into the interface. + * + * + * The #GtkHSeparator widget is not used as a separator within menus. + * To create a separator in a menu create an empty #GtkSeparatorMenuItem + * widget using gtk_separator_menu_item_new() and add it to the menu with + * gtk_menu_shell_append(). + * + */ + + G_DEFINE_TYPE (GtkHSeparator, gtk_hseparator, GTK_TYPE_SEPARATOR) static void @@ -44,6 +63,13 @@ gtk_hseparator_init (GtkHSeparator *hseparator) GTK_ORIENTATION_HORIZONTAL); } +/** + * gtk_hseparator_new: + * + * Creates a new #GtkHSeparator. + * + * Returns: a new #GtkHSeparator. + */ GtkWidget * gtk_hseparator_new (void) {