[gtk+] Move documentation to inline comments: GtkVSeparator



commit 15d1d8bb3b3c408002aaac19566b5d1f23a04aa0
Author: Steven Harms <sharms ubuntu com>
Date:   Wed Mar 3 18:35:45 2010 -0500

    Move documentation to inline comments: GtkVSeparator
    
    Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611662

 docs/reference/gtk/tmpl/gtkvseparator.sgml |   41 ----------------------------
 gtk/gtkvseparator.c                        |   18 ++++++++++++
 gtk/gtkvseparator.h                        |    6 ++++
 3 files changed, 24 insertions(+), 41 deletions(-)
---
diff --git a/gtk/gtkvseparator.c b/gtk/gtkvseparator.c
index 855c168..77c3f59 100644
--- a/gtk/gtkvseparator.c
+++ b/gtk/gtkvseparator.c
@@ -30,6 +30,17 @@
 #include "gtkvseparator.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkvseparator
+ * @Short_description: A vertical separator
+ * @Title: GtkVSeparator
+ * @See_also: #GtkHSeparator
+ *
+ * The #GtkVSeparator widget is a vertical separator, used to group the
+ * widgets within a window. It displays a vertical line with a shadow to
+ * make it appear sunken into the interface.
+ */
+
 G_DEFINE_TYPE (GtkVSeparator, gtk_vseparator, GTK_TYPE_SEPARATOR)
 
 static void
@@ -44,6 +55,13 @@ gtk_vseparator_init (GtkVSeparator *vseparator)
                                   GTK_ORIENTATION_VERTICAL);
 }
 
+/**
+ * gtk_vseparator_new:
+ *
+ * Creates a new #GtkVSeparator.
+ *
+ * Returns: a new #GtkVSeparator.
+ */
 GtkWidget *
 gtk_vseparator_new (void)
 {
diff --git a/gtk/gtkvseparator.h b/gtk/gtkvseparator.h
index ee97ee0..a82ebfe 100644
--- a/gtk/gtkvseparator.h
+++ b/gtk/gtkvseparator.h
@@ -49,6 +49,12 @@ G_BEGIN_DECLS
 typedef struct _GtkVSeparator       GtkVSeparator;
 typedef struct _GtkVSeparatorClass  GtkVSeparatorClass;
 
+/**
+ * GtkVSeparator:
+ *
+ * The #GtkVSeparator struct contains private data only, and
+ * should be accessed using the functions below.
+ */
 struct _GtkVSeparator
 {
   GtkSeparator separator;



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]