Move documentation to inline comments: GtkToolButton

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 0c37085575ebd333381c257ec514aa7b78ab05d7..c21db50ca8a9d6990f4afaa2fc76c07ff2c19aca 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -113,6 +113,7 @@ gtktextview.sgml
 gtktoggleaction.sgml
 gtktoggletoolbutton.sgml
 gtktoolbar.sgml
+gtktoolbutton.sgml
 gtktoolitem.sgml
 gtktooltip.sgml
 gtktreednd.sgml

diff --git a/docs/reference/gtk/tmpl/gtktoolbutton.sgml b/docs/reference/gtk/tmpl/gtktoolbutton.sgml
deleted file mode 100644 (file)
index 10d9e1d..0000000
--- a/docs/reference/gtk/tmpl/gtktoolbutton.sgml
+++ /dev/null
@@ -1,253 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkToolButton
-
-<!-- ##### SECTION Short_Description ##### -->
-A GtkToolItem subclass that displays buttons
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-#GtkToolButton<!-- -->s are #GtkToolItems containing buttons.
-</para>
-
-<para>
-Use gtk_tool_button_new() to create a new #GtkToolButton. Use
-gtk_tool_button_new_with_stock() to create a #GtkToolButton
-containing a stock item.
-</para>
-
-<para>
-The label of a #GtkToolButton is determined by the properties
-"label-widget", "label", and "stock-id". If "label-widget" is
-non-%NULL, then that widget is used as the label. Otherwise, if
-"label" is non-%NULL, that string is used as the label. Otherwise, if
-"stock-id" is non-%NULL, the label is determined by the stock
-item. Otherwise, the button does not have a label.
-</para>
-
-<para>
-The icon of a #GtkToolButton is determined by the properties
-"icon-widget" and "stock-id". If "icon-widget" is non-%NULL, then
-that widget is used as the icon. Otherwise, if "stock-id" is
-non-%NULL, the icon is determined by the stock item. Otherwise,
-the button does not have a icon.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-
-<varlistentry>
-<term>#GtkToolbar</term>
-<listitem><para>The toolbar widget</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term>#GtkMenuToolButton</term>
-<listitem><para>A subclass of #GtkToolButton that displays on 
-    the toolbar a button with an additional dropdown
-    menu</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term>#GtkToggleToolButton</term>
-<listitem><para>A subclass of #GtkToolButton that displays toggle
-    buttons on the toolbar</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term>#GtkRadioToolButton</term>
-<listitem><para>A subclass of #GtkToolButton that displays radio
-    buttons on the toolbar</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term>#GtkSeparatorToolItem</term>
-<listitem><para>A subclass of #GtkToolItem that separates groups of
-    items on a toolbar</para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkToolButton ##### -->
-<para>
-The #GtkToolButton struct contains only private. It should only be
-accessed with the function described below.
-</para>
-
-
-<!-- ##### SIGNAL GtkToolButton::clicked ##### -->
-<para>
-
-</para>
-
-@toolbutton: the object which received the signal.
-
-<!-- ##### ARG GtkToolButton:icon-name ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolButton:icon-widget ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolButton:label ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolButton:label-widget ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolButton:stock-id ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolButton:use-underline ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolButton:icon-spacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_tool_button_new ##### -->
-<para>
-
-</para>
-
-@icon_widget: 
-@label: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_new_from_stock ##### -->
-<para>
-
-</para>
-
-@stock_id: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_set_label ##### -->
-<para>
-
-</para>
-
-@button: 
-@label: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_get_label ##### -->
-<para>
-
-</para>
-
-@button: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_set_use_underline ##### -->
-<para>
-
-</para>
-
-@button: 
-@use_underline: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_get_use_underline ##### -->
-<para>
-
-</para>
-
-@button: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_set_stock_id ##### -->
-<para>
-
-</para>
-
-@button: 
-@stock_id: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_get_stock_id ##### -->
-<para>
-
-</para>
-
-@button: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_set_icon_name ##### -->
-<para>
-
-</para>
-
-@button: 
-@icon_name: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_get_icon_name ##### -->
-<para>
-
-</para>
-
-@button: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_set_icon_widget ##### -->
-<para>
-
-</para>
-
-@button: 
-@icon_widget: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_get_icon_widget ##### -->
-<para>
-
-</para>
-
-@button: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_set_label_widget ##### -->
-<para>
-
-</para>
-
-@button: 
-@label_widget: 
-
-
-<!-- ##### FUNCTION gtk_tool_button_get_label_widget ##### -->
-<para>
-
-</para>
-
-@button: 
-@Returns: 
-
-

diff --git a/gtk/gtktoolbutton.c b/gtk/gtktoolbutton.c
index 5a3bc469e24fec26d65ac20b86ce8cd945e6ebb7..ddf321b09b913db2a90b2fda2655aa74eb0cb79e 100644 (file)
--- a/gtk/gtktoolbutton.c
+++ b/gtk/gtktoolbutton.c
@@ -37,6 +37,37 @@
 
 #include <string.h>
 
+
+/**
+ * SECTION:gtktoolbutton
+ * @Short_description: A GtkToolItem subclass that displays buttons
+ * @Title: GtkToolButton
+ * @See_also: #GtkToolbar, #GtkMenuToolButton, #GtkToggleToolButton,
+ *   #GtkRadioToolButton, #GtkSeparatorToolItem
+ *
+ * #GtkToolButton<!-- -->s are #GtkToolItems containing buttons.
+ *
+ * Use gtk_tool_button_new() to create a new #GtkToolButton. Use
+ * gtk_tool_button_new_with_stock() to create a #GtkToolButton
+ * containing a stock item.
+ *
+ * The label of a #GtkToolButton is determined by the properties
+ * #GtkToolButton:label-widget, #GtkToolButton:label, and
+ * #GtkToolButton:stock-id. If #GtkToolButton:label-widget is
+ * non-%NULL, then that widget is used as the label. Otherwise, if
+ * #GtkToolButton:label is non-%NULL, that string is used as the label.
+ * Otherwise, if #GtkToolButton:stock-id is non-%NULL, the label is
+ * determined by the stock item. Otherwise, the button does not have a label.
+ *
+ * The icon of a #GtkToolButton is determined by the properties
+ * #GtkToolButton:icon-widget and #GtkToolButton:stock-id. If
+ * #GtkToolButton:icon-widget is non-%NULL, then
+ * that widget is used as the icon. Otherwise, if #GtkToolButton:stock-id is
+ * non-%NULL, the icon is determined by the stock item. Otherwise,
+ * the button does not have a icon.
+ */
+
+
 #define MENU_ID "gtk-tool-button-menu-id"
 
 enum {