]> Pileus Git - ~andy/gtk/commitdiff
Move documentation to inline comments: GtkRecentChooserDialog
authorJavier Jardón <jjardon@gnome.org>
Fri, 21 May 2010 01:24:05 +0000 (03:24 +0200)
committerJavier Jardón <jjardon@gnome.org>
Fri, 21 May 2010 02:15:02 +0000 (04:15 +0200)
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtkrecentchooserdialog.sgml [deleted file]
gtk/gtkrecentchooserdialog.c

index d60266462ee335b9cf82909aa981bf059cc36c5c..0d0be57c29731081e80fc8546dcf74ccc4c05399 100644 (file)
@@ -12,6 +12,7 @@ gtkradiobutton.sgml
 gtkrange.sgml
 gtkrecentaction.sgml
 gtkrecentchooser.sgml
+gtkrecentchooserdialog.sgml
 gtkrecentchoosermenu.sgml
 gtkrecentchooserwidget.sgml
 gtkscalebutton.sgml
diff --git a/docs/reference/gtk/tmpl/gtkrecentchooserdialog.sgml b/docs/reference/gtk/tmpl/gtkrecentchooserdialog.sgml
deleted file mode 100644 (file)
index fd06e2b..0000000
+++ /dev/null
@@ -1,96 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkRecentChooserDialog
-
-<!-- ##### SECTION Short_Description ##### -->
-Displays recently used files in a dialog
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-#GtkRecentChooserDialog is a dialog box suitable for displaying the recently
-used documents.  This widgets works by putting a #GtkRecentChooserWidget inside
-a #GtkDialog.  It exposes the #GtkRecentChooserIface interface, so you can use
-all the #GtkRecentChooser functions on the recent chooser dialog as well as
-those for #GtkDialog.
-</para>
-
-<para>
-Note that #GtkRecentChooserDialog does not have any methods of its own.
-Instead, you should use the functions that work on a #GtkRecentChooser.
-</para>
-
-<example id="gtkrecentchooser-typical-usage">
-  <title>Typical usage</title>
-
-  <para>
-    In the simplest of cases, you can use the following code to use
-    a #GtkRecentChooserDialog to select a recently used file:
-  </para>
-
-  <programlisting>
-GtkWidget *dialog;
-
-dialog = gtk_recent_chooser_dialog_new ("Recent Documents",
-                                       parent_window,
-                                       GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
-                                       GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
-                                       NULL);
-                                       
-if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
-  {
-    GtkRecentInfo *info;
-
-    info = gtk_recent_chooser_get_current_item (GTK_RECENT_CHOOSER (dialog));
-    open_file (gtk_recent_info_get_uri (info));
-    gtk_recent_info_unref (info);
-  }
-
-gtk_widget_destroy (dialog);
-  </programlisting>
-</example>
-
-<para>
-Recently used files are supported since GTK+ 2.10.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GtkRecentChooser, #GtkDialog
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkRecentChooserDialog ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gtk_recent_chooser_dialog_new ##### -->
-<para>
-
-</para>
-
-@title: 
-@parent: 
-@first_button_text: 
-@Varargs: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_recent_chooser_dialog_new_for_manager ##### -->
-<para>
-
-</para>
-
-@title: 
-@parent: 
-@manager: 
-@first_button_text: 
-@Varargs: 
-@Returns: 
-
-
index 058439af8d9f5253a33adc4fdb4ae1a0dae0b39d..c86910f3fa57abb6d1e7abc6a60d5155d6aecf69 100644 (file)
 
 #include <stdarg.h>
 
+
+/**
+ * SECTION:gtkrecentchooserdialog
+ * @Short_description: Displays recently used files in a dialog
+ * @Title: GtkRecentChooserDialog
+ * @See_also:#GtkRecentChooser, #GtkDialog
+ *
+ * #GtkRecentChooserDialog is a dialog box suitable for displaying the recently
+ * used documents.  This widgets works by putting a #GtkRecentChooserWidget inside
+ * a #GtkDialog.  It exposes the #GtkRecentChooserIface interface, so you can use
+ * all the #GtkRecentChooser functions on the recent chooser dialog as well as
+ * those for #GtkDialog.
+ *
+ * Note that #GtkRecentChooserDialog does not have any methods of its own.
+ * Instead, you should use the functions that work on a #GtkRecentChooser.
+ *
+ * <example id="gtkrecentchooser-typical-usage">
+ * <title>Typical usage</title>
+ * In the simplest of cases, you can use the following code to use
+ * a #GtkRecentChooserDialog to select a recently used file:
+ * <programlisting>
+ * GtkWidget *dialog;
+ *
+ * dialog = gtk_recent_chooser_dialog_new ("Recent Documents",
+ *                                         parent_window,
+ *                                         GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
+ *                                         GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
+ *                                         NULL);
+ *
+ * if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
+ *   {
+ *     GtkRecentInfo *info;
+ *
+ *     info = gtk_recent_chooser_get_current_item (GTK_RECENT_CHOOSER (dialog));
+ *     open_file (gtk_recent_info_get_uri (info));
+ *     gtk_recent_info_unref (info);
+ *   }
+ *
+ * gtk_widget_destroy (dialog);
+ * </programlisting>
+ * </example>
+ *
+ * Recently used files are supported since GTK+ 2.10.
+ */
+
+
 struct _GtkRecentChooserDialogPrivate
 {
   GtkRecentManager *manager;