[gtk+] Move documentation to inline comments: GtkRecentAction



commit bddf455874fcc648b8a743fe7616b5f8690108c0
Author: Javier Jardón <jjardon gnome org>
Date:   Sun May 16 00:20:20 2010 +0200

    Move documentation to inline comments: GtkRecentAction

 docs/reference/gtk/tmpl/.gitignore           |    1 +
 docs/reference/gtk/tmpl/gtkrecentaction.sgml |   84 --------------------------
 gtk/gtkrecentaction.c                        |   17 +++++
 3 files changed, 18 insertions(+), 84 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index d8fbb17..c304976 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -6,6 +6,7 @@ gtkmessagedialog.sgml
 gtkobject.sgml
 gtkorientable.sgml
 gtkpagesetupunixdialog.sgml
+gtkrecentaction.sgml
 gtkseparator.sgml
 gtktesting.sgml
 gtktextiter.sgml
diff --git a/gtk/gtkrecentaction.c b/gtk/gtkrecentaction.c
index 14acfb4..458d23f 100644
--- a/gtk/gtkrecentaction.c
+++ b/gtk/gtkrecentaction.c
@@ -32,6 +32,23 @@
 #include "gtkprivate.h"
 #include "gtkalias.h"
 
+
+/**
+ * SECTION:gtkrecentaction
+ * @Short_description: An action of which represents a list of recently used files
+ * @Title: GtkRecentAction
+ *
+ * A #GtkRecentAction represents a list of recently used files, which
+ * can be shown by widgets such as #GtkRecentChooserDialog or
+ * #GtkRecentChooserMenu.
+ *
+ * To construct a submenu showing recently used files, use a #GtkRecentAction
+ * as the action for a &lt;menuitem&gt;. To construct a menu toolbutton showing
+ * the recently used files in the popup menu, use a #GtkRecentAction as the
+ * action for a &lt;toolitem&gt; element.
+ */
+
+
 #define FALLBACK_ITEM_LIMIT     10
 
 #define GTK_RECENT_ACTION_GET_PRIVATE(obj)      \



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