From dfa9214681083f7a60c71fd4d7b837d53de13225 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Jard=C3=B3n?= Date: Sun, 16 May 2010 02:53:49 +0200 Subject: [PATCH] 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(-) delete mode 100644 docs/reference/gtk/tmpl/gtkrecentchooser.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 0dc5174d59..5e0163b3af 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/docs/reference/gtk/tmpl/gtkrecentchooser.sgml b/docs/reference/gtk/tmpl/gtkrecentchooser.sgml deleted file mode 100644 index a491382395..0000000000 --- a/docs/reference/gtk/tmpl/gtkrecentchooser.sgml +++ /dev/null @@ -1,442 +0,0 @@ - -GtkRecentChooser - - -Interface implemented by widgets displaying recently used files - - - -#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. - - - - -#GtkRecentManager, #GtkRecentChooserDialog, #GtkRecentChooserWidget, -#GtkRecentChooserMenu - - - - - - - - - - - - - - - - - - - -@recentchooser: the object which received the signal. - - - - - - -@recentchooser: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@base_iface: -@set_current_uri: -@get_current_uri: -@select_uri: -@unselect_uri: -@select_all: -@unselect_all: -@get_items: -@get_recent_manager: -@add_filter: -@remove_filter: -@list_filters: -@set_sort_func: -@item_activated: -@selection_changed: - - - -Used to get the #GError quark for #GtkRecentChooser errors. - - - - - - -These identify the various errors that can occur while calling -#GtkRecentChooser functions. - - -@GTK_RECENT_CHOOSER_ERROR_NOT_FOUND: Indicates that a file does not exist -@GTK_RECENT_CHOOSER_ERROR_INVALID_URI: Indicates a malformed URI - - - - - - -@chooser: -@show_private: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@show_not_found: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@show_icons: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@select_multiple: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@local_only: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@limit: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@show_tips: - - - - - - - -@chooser: -@Returns: - - - - - - - -@GTK_RECENT_SORT_NONE: -@GTK_RECENT_SORT_MRU: -@GTK_RECENT_SORT_LRU: -@GTK_RECENT_SORT_CUSTOM: - - - - - - -@chooser: -@sort_type: - - - - - - - -@chooser: -@Returns: - - - - - - - -@a: -@b: -@user_data: -@Returns: - - - - - - - -@chooser: -@sort_func: -@sort_data: -@data_destroy: - - - - - - - -@chooser: -@uri: -@error: -@Returns: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@uri: -@error: -@Returns: - - - - - - - -@chooser: -@uri: - - - - - - - -@chooser: - - - - - - - -@chooser: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@length: -@Returns: - - - - - - - -@chooser: -@filter: - - - - - - - -@chooser: -@filter: - - - - - - - -@chooser: -@Returns: - - - - - - - -@chooser: -@filter: - - - - - - - -@chooser: -@Returns: - - diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c index 71a5bcfcd8..d381df328a 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 8b891e1d51..f6494db691 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,