]> Pileus Git - ~andy/gtk/commitdiff
Move documentation to inline comments: GtkToggleAction
authorJavier Jardón <jjardon@gnome.org>
Thu, 13 May 2010 01:23:30 +0000 (03:23 +0200)
committerJavier Jardón <jjardon@gnome.org>
Thu, 13 May 2010 01:23:30 +0000 (03:23 +0200)
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtktoggleaction.sgml [deleted file]
gtk/gtktoggleaction.c

index b0ce6166348a2d351098d3debd1c6087d6d9e751..85e880b6bbc762dcb256ab0fe47459b7564caca2 100644 (file)
@@ -7,4 +7,5 @@ gtkpagesetupunixdialog.sgml
 gtkseparator.sgml
 gtktesting.sgml
 gtktextiter.sgml
+gtktoggleaction.sgml
 gtktoolitem.sgml
diff --git a/docs/reference/gtk/tmpl/gtktoggleaction.sgml b/docs/reference/gtk/tmpl/gtktoggleaction.sgml
deleted file mode 100644 (file)
index 79a2455..0000000
+++ /dev/null
@@ -1,103 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkToggleAction
-
-<!-- ##### SECTION Short_Description ##### -->
-An action which can be toggled between two states
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A #GtkToggleAction corresponds roughly to a #GtkCheckMenuItem. It has an
-"active" state specifying whether the action has been checked or not.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkToggleAction ##### -->
-<para>
-The <structname>GtkToggleAction</structname> struct contains only 
-private members and should not be accessed directly.
-</para>
-
-
-<!-- ##### SIGNAL GtkToggleAction::toggled ##### -->
-<para>
-
-</para>
-
-@toggleaction: the object which received the signal.
-
-<!-- ##### ARG GtkToggleAction:active ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToggleAction:draw-as-radio ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_toggle_action_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@label: 
-@tooltip: 
-@stock_id: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_toggle_action_toggled ##### -->
-<para>
-
-</para>
-
-@action: 
-
-
-<!-- ##### FUNCTION gtk_toggle_action_set_active ##### -->
-<para>
-
-</para>
-
-@action: 
-@is_active: 
-
-
-<!-- ##### FUNCTION gtk_toggle_action_get_active ##### -->
-<para>
-
-</para>
-
-@action: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_toggle_action_set_draw_as_radio ##### -->
-<para>
-
-</para>
-
-@action: 
-@draw_as_radio: 
-
-
-<!-- ##### FUNCTION gtk_toggle_action_get_draw_as_radio ##### -->
-<para>
-
-</para>
-
-@action: 
-@Returns: 
-
-
index 6e464d72e9fe5869de8b94a0ae2932524aa31c02..5a144bb42d5bdaca6857b210769797808c07dc6f 100644 (file)
 #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