[gtk+] Move documentation to inline comments: GtkToolButton
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Move documentation to inline comments: GtkToolButton
- Date: Fri, 15 Apr 2011 01:25:00 +0000 (UTC)
commit c0b3bfd7b633fadb29bba117524baa5f15415e5e
Author: Javier Jardón <jjardon gnome org>
Date: Fri Apr 15 00:04:49 2011 +0100
Move documentation to inline comments: GtkToolButton
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtktoolbutton.sgml | 253 ----------------------------
gtk/gtktoolbutton.c | 31 ++++
3 files changed, 32 insertions(+), 253 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 0c37085..c21db50 100644
--- 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/gtk/gtktoolbutton.c b/gtk/gtktoolbutton.c
index 5a3bc46..ddf321b 100644
--- 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 {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]