Move documentation to inline comments: GtkSeparatorToolItem

[~andy/gtk] / gtk / gtkseparatortoolitem.c

diff --git a/gtk/gtkseparatortoolitem.c b/gtk/gtkseparatortoolitem.c
index 4aa4b15697035f3f51c60ed51c861de457942ce8..2a35efe5f012e9eeedb2abb2b034b7afc0812d9d 100644 (file)
--- a/gtk/gtkseparatortoolitem.c
+++ b/gtk/gtkseparatortoolitem.c
@@ -27,6 +27,26 @@
 #include "gtkprivate.h"
 #include "gtkalias.h"
 
+
+/**
+ * SECTION:gtkseparatortoolitem
+ * @Short_description: A toolbar item that separates groups of other
+ *   toolbar items
+ * @Title: GtkSeparatorToolItem
+ * @See_also: #GtkToolbar, #GtkRadioToolButton
+ *
+ * A #GtkSeparatorItem is a #GtkToolItem that separates groups of other
+ * #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
+ * often look like a vertical line on horizontally docked toolbars.
+ *
+ * If the #GtkToolbar child property "expand" is %TRUE and the property
+ * #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as
+ * a "spring" that forces other items to the ends of the toolbar.
+ *
+ * Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
+ */
+
+
 #define MENU_ID "gtk-separator-tool-item-menu-id"
 
 enum {