[gtk+] docs: don't use <guimenuitem>



commit 17d45484d7ae5a7e717a42492492a7a7c4a61414
Author: William Jon McCann <william jon mccann gmail com>
Date:   Tue Jan 28 02:16:33 2014 -0500

    docs: don't use <guimenuitem>
    
    We don't want to assume menu bar structures.

 gtk/gtkfilechooser.c       |   18 +++++++++---------
 gtk/gtkfilechooserdialog.c |   12 ++++--------
 2 files changed, 13 insertions(+), 17 deletions(-)
---
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
index 9805722..ad2dbe4 100644
--- a/gtk/gtkfilechooser.c
+++ b/gtk/gtkfilechooser.c
@@ -735,10 +735,10 @@ gtk_file_chooser_get_filename (GtkFileChooser *chooser)
  * Note that the file must exist, or nothing will be done except
  * for the directory change.
  *
- * You should use this function only when implementing a <guimenuitem>File/Save
- * As...</guimenuitem> dialog for which you already have a file name to which
+ * You should use this function only when implementing a save
+ * dialog for which you already have a file name to which
  * the user may save.  For example, when the user opens an existing file and
- * then does <guimenuitem>File/Save As...</guimenuitem> on it to save a copy or
+ * then does Save As... to save a copy or
  * a modified version.  If you don't have a file name already &mdash; for
  * example, if the user just created a new file and is saving it for the first
  * time, do not call this function.  Instead, use something similar to this:
@@ -1087,10 +1087,10 @@ gtk_file_chooser_get_uri (GtkFileChooser *chooser)
  * Note that the URI must exist, or nothing will be done except for the 
  * directory change.
  *
- * You should use this function only when implementing a <guimenuitem>File/Save
- * As...</guimenuitem> dialog for which you already have a file name to which
- * the user may save.  For example, whenthe user opens an existing file and then
- * does <guimenuitem>File/Save As...</guimenuitem> on it to save a copy or a
+ * You should use this function only when implementing a save
+ * dialog for which you already have a file name to which
+ * the user may save.  For example, when the user opens an existing file and then
+ * does Save As... to save a copy or a
  * modified version.  If you don't have a file name already &mdash; for example,
  * if the user just created a new file and is saving it for the first time, do
  * not call this function.  Instead, use something similar to this:
@@ -1453,10 +1453,10 @@ gtk_file_chooser_get_files (GtkFileChooser *chooser)
  * Note that the file must exist, or nothing will be done except
  * for the directory change.
  *
- * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
+ * If you are implementing a save dialog,
  * you should use this function if you already have a file name to which the
  * user may save; for example, when the user opens an existing file and then
- * does <guimenuitem>File/Save As...</guimenuitem> on it.  If you don't have
+ * does Save As...  If you don't have
  * a file name already &mdash; for example, if the user just created a new
  * file and is saving it for the first time, do not call this function.
  * Instead, use something similar to this:
diff --git a/gtk/gtkfilechooserdialog.c b/gtk/gtkfilechooserdialog.c
index c7d2410..74e9c43 100644
--- a/gtk/gtkfilechooserdialog.c
+++ b/gtk/gtkfilechooserdialog.c
@@ -113,17 +113,14 @@
  * <section id="gtkfilechooserdialog-setting-up">
  * <title>Setting up a file chooser dialog</title>
  * There are various cases in which you may need to use a #GtkFileChooserDialog:
- * <itemizedlist><listitem>To select a file for opening, as for a
- *   <guimenuitem>File/Open</guimenuitem> command.  Use
+ * <itemizedlist><listitem>To select a file for opening. Use
  *   #GTK_FILE_CHOOSER_ACTION_OPEN.
  * </listitem>
- * <listitem>To save a file for the first time, as for a
- *   <guimenuitem>File/Save</guimenuitem> command.  Use
+ * <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, as for a
- *   <guimenuitem>File/Save As</guimenuitem> command.  Use
+ * <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>
@@ -140,8 +137,7 @@
  * able to make good suggestions on its own.  In general, you
  * should only cause the file chooser to show a specific folder
  * when it is appropriate to use gtk_file_chooser_set_filename(),
- * i.e. when you are doing a <guimenuitem>File/Save
- * As</guimenuitem> command and you already
+ * i.e. when you are doing a Save As command and you already
  * have a file saved somewhere.
  * </para>
  * </note>


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