[gtk+] Move documentation to inline comments: GtkToggleAction



commit 8319585673632a67ec130de3a9c5c71db1da8c5c
Author: Javier Jardón <jjardon gnome org>
Date:   Thu May 13 03:23:30 2010 +0200

    Move documentation to inline comments: GtkToggleAction

 docs/reference/gtk/tmpl/.gitignore           |    1 +
 docs/reference/gtk/tmpl/gtktoggleaction.sgml |  103 --------------------------
 gtk/gtktoggleaction.c                        |   21 +++++-
 3 files changed, 20 insertions(+), 105 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index b0ce616..85e880b 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -7,4 +7,5 @@ gtkpagesetupunixdialog.sgml
 gtkseparator.sgml
 gtktesting.sgml
 gtktextiter.sgml
+gtktoggleaction.sgml
 gtktoolitem.sgml
diff --git a/gtk/gtktoggleaction.c b/gtk/gtktoggleaction.c
index 6e464d7..5a144bb 100644
--- a/gtk/gtktoggleaction.c
+++ b/gtk/gtktoggleaction.c
@@ -39,6 +39,17 @@
 #include "gtkprivate.h"
 #include "gtkalias.h"
 
+
+/**
+ * SECTION:gtktoggleaction
+ * @Short_description: An action which can be toggled between two states
+ * @Title: GtkToggleAction
+ *
+ * A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an
+ * "active" state specifying whether the action has been checked or not.
+ */
+
+
 enum 
 {
   TOGGLED,
@@ -120,7 +131,13 @@ gtk_toggle_action_class_init (GtkToggleActionClass *klass)
                                                          P_("If the toggle action should be active in or not"),
                                                          FALSE,
                                                          GTK_PARAM_READWRITE));
-
+  /**
+   * GtkToggleAction::toggled:
+   * @toggleaction: the object which received the signal.
+   *
+   * Should be connected if you wish to perform an action
+   * whenever the #GtkToggleAction state is changed.
+   */
   action_signals[TOGGLED] =
     g_signal_new (I_("toggled"),
                   G_OBJECT_CLASS_TYPE (klass),
@@ -275,7 +292,7 @@ gtk_toggle_action_set_active (GtkToggleAction *action,
  * @action: the action object
  *
  * Returns the checked state of the toggle action.
-
+ *
  * Returns: the checked state of the toggle action
  *
  * Since: 2.4



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