[gtk+] Move documentation to inline comments: GtkRecentChooser



commit dfa9214681083f7a60c71fd4d7b837d53de13225
Author: Javier Jardón <jjardon gnome org>
Date:   Sun May 16 02:53:49 2010 +0200

    Move documentation to inline comments: GtkRecentChooser

 docs/reference/gtk/tmpl/.gitignore            |    1 +
 docs/reference/gtk/tmpl/gtkrecentchooser.sgml |  442 -------------------------
 gtk/gtkrecentchooser.c                        |   17 +
 gtk/gtkrecentchooser.h                        |   21 ++-
 4 files changed, 38 insertions(+), 443 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 0dc5174..5e0163b 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -9,6 +9,7 @@ gtkpagesetupunixdialog.sgml
 gtkprinter.sgml
 gtkradioaction.sgml
 gtkrecentaction.sgml
+gtkrecentchooser.sgml
 gtkrecentchooserwidget.sgml
 gtkscalebutton.sgml
 gtkseparator.sgml
diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c
index 71a5bcf..d381df3 100644
--- a/gtk/gtkrecentchooser.c
+++ b/gtk/gtkrecentchooser.c
@@ -33,6 +33,23 @@
 #include "gtkalias.h"
 
 
+/**
+ * SECTION:gtkrecentchooser
+ * @Short_description: Interface implemented by widgets displaying recently
+ *   used files
+ * @Title: GtkRecentChooser
+ * @See_also: #GtkRecentManager, #GtkRecentChooserDialog,
+ *   #GtkRecentChooserWidget, #GtkRecentChooserMenu
+ *
+ * #GtkRecentChooser is an interface that can be implemented by widgets
+ * displaying the list of recently used files.  In GTK+, the main objects
+ * that implement this interface are #GtkRecentChooserWidget,
+ * #GtkRecentChooserDialog and #GtkRecentChooserMenu.
+ *
+ * Recently used files are supported since GTK+ 2.10.
+ */
+
+
 enum
 {
   ITEM_ACTIVATED,
diff --git a/gtk/gtkrecentchooser.h b/gtk/gtkrecentchooser.h
index 8b891e1..f6494db 100644
--- a/gtk/gtkrecentchooser.h
+++ b/gtk/gtkrecentchooser.h
@@ -50,7 +50,9 @@ G_BEGIN_DECLS
  *
  * Used to specify the sorting method to be applyed to the recently
  * used resource list.
- **/
+ *
+ * Since: 2.10
+ */
 typedef enum
 {
   GTK_RECENT_SORT_NONE = 0,
@@ -67,8 +69,25 @@ typedef gint (*GtkRecentSortFunc) (GtkRecentInfo *a,
 typedef struct _GtkRecentChooser      GtkRecentChooser; /* dummy */
 typedef struct _GtkRecentChooserIface GtkRecentChooserIface;
 
+/**
+ * GTK_RECENT_CHOOSER_ERROR:
+ *
+ * Used to get the #GError quark for #GtkRecentChooser errors.
+ *
+ * Since: 2.10
+ */
 #define GTK_RECENT_CHOOSER_ERROR	(gtk_recent_chooser_error_quark ())
 
+/**
+ * GtkRecentChooserError:
+ * @GTK_RECENT_CHOOSER_ERROR_NOT_FOUND: Indicates that a file does not exist
+ * @GTK_RECENT_CHOOSER_ERROR_INVALID_URI: Indicates a malformed URI
+ *
+ * These identify the various errors that can occur while calling
+ * #GtkRecentChooser functions.
+ *
+ * Since: 2.10
+ */
 typedef enum
 {
   GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,



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