summaryrefslogtreecommitdiff
path: root/gtk/gtkfilechooserdialog.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2014-02-02 01:07:39 -0500
committerMatthias Clasen <mclasen@redhat.com>2014-02-02 01:07:39 -0500
commit30cc1512e634417eb040bd5a287736c1ef7782d9 (patch)
tree7fcb1dbbe0e184f762bc6f29dd6e362cd01112e3 /gtk/gtkfilechooserdialog.c
parent09d1b28249af38448be0b52d00dd9924adac5d1c (diff)
downloadgtk+-30cc1512e634417eb040bd5a287736c1ef7782d9.tar.gz
Docs: Use markdown for lists
This greatly reduces the amount of xml in the docs.
Diffstat (limited to 'gtk/gtkfilechooserdialog.c')
-rw-r--r--gtk/gtkfilechooserdialog.c65
1 files changed, 28 insertions, 37 deletions
diff --git a/gtk/gtkfilechooserdialog.c b/gtk/gtkfilechooserdialog.c
index 1ae2574ceb..d2622bc4a4 100644
--- a/gtk/gtkfilechooserdialog.c
+++ b/gtk/gtkfilechooserdialog.c
@@ -110,26 +110,23 @@
* ]|
* </para>
* </example>
- * <section id="gtkfilechooserdialog-setting-up">
- * <title>Setting up a file chooser dialog</title>
+ *
+ * ## Setting up a file chooser dialog
+ *
+ * <para id="gtkfilechooserdialog-setting-up">
* There are various cases in which you may need to use a #GtkFileChooserDialog:
- * <itemizedlist><listitem>To select a file for opening. Use
- * #GTK_FILE_CHOOSER_ACTION_OPEN.
- * </listitem>
- * <listitem>To save a file for the first time. Use
- * #GTK_FILE_CHOOSER_ACTION_SAVE, and suggest a name such as
- * "Untitled" with gtk_file_chooser_set_current_name().
- * </listitem>
- * <listitem>To save a file under a different name. Use
- * #GTK_FILE_CHOOSER_ACTION_SAVE, and set the existing filename
- * with gtk_file_chooser_set_filename().
- * </listitem>
- * <listitem>To choose a folder instead of a file. Use
- * #GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
- * </listitem></itemizedlist>
- * <note>
- * <para>
- * Old versions of the file chooser's documentation suggested
+ *
+ * - To select a file for opening. Use #GTK_FILE_CHOOSER_ACTION_OPEN.
+ *
+ * - To save a file for the first time. Use #GTK_FILE_CHOOSER_ACTION_SAVE,
+ * and suggest a name such as "Untitled" with gtk_file_chooser_set_current_name().
+ *
+ * - To save a file under a different name. Use #GTK_FILE_CHOOSER_ACTION_SAVE,
+ * and set the existing filename with gtk_file_chooser_set_filename().
+ *
+ * - To choose a folder instead of a file. Use #GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
+ *
+ * Note that old versions of the file chooser's documentation suggested
* using gtk_file_chooser_set_current_folder() in various
* situations, with the intention of letting the application
* suggest a reasonable default folder. This is no longer
@@ -139,16 +136,14 @@
* when it is appropriate to use gtk_file_chooser_set_filename(),
* i.e. when you are doing a Save As command and you already
* have a file saved somewhere.
- * </para>
- * </note>
- * </section>
- * <section id="gtkfilechooserdialog-response-codes">
- * <title>Response Codes</title>
+ *
+ * ## Response Codes
+ *
+ * <para id="gtkfilechooserdialog-response-codes">
* #GtkFileChooserDialog inherits from #GtkDialog, so buttons that
* go in its action area have response codes such as
* #GTK_RESPONSE_ACCEPT and #GTK_RESPONSE_CANCEL. For example, you
* could call gtk_file_chooser_dialog_new() as follows:
- * <para>
* |[
* GtkWidget *dialog;
*
@@ -160,6 +155,8 @@
* NULL);
* ]|
* </para>
+ *
+ * <para id="gtkfilechooserdialog-responses">
* This will create buttons for "Cancel" and "Open" that use stock
* response identifiers from #GtkResponseType. For most dialog
* boxes you can use your own custom response codes rather than the
@@ -167,27 +164,21 @@
* its "accept"-type action, e.g. an "Open" or "Save" button,
* will have one of the following response
* codes:
- * <para>
- * <simplelist id="gtkfilechooserdialog-responses">
- * <member>#GTK_RESPONSE_ACCEPT</member>
- * <member>#GTK_RESPONSE_OK</member>
- * <member>#GTK_RESPONSE_YES</member>
- * <member>#GTK_RESPONSE_APPLY</member>
- * </simplelist>
+ * - #GTK_RESPONSE_ACCEPT
+ * - #GTK_RESPONSE_OK
+ * - #GTK_RESPONSE_YES
+ * - #GTK_RESPONSE_APPLY
* </para>
+ *
* This is because #GtkFileChooserDialog must intercept responses
* and switch to folders if appropriate, rather than letting the
* dialog terminate &mdash; the implementation uses these known
* response codes to know which responses can be blocked if
* appropriate.
- * <para>
- * <note>
+ *
* To summarize, make sure you use a
* <link linkend="gtkfilechooserdialog-responses">stock response code</link>
* when you use #GtkFileChooserDialog to ensure proper operation.
- * </note>
- * </para>
- * </section>
*/