[gtk+/gtk-3-22] docs: gtk_init_check will also fail if the commandline was invalid



commit 1031fa914a67551cf0896dd1adf26f455cdd3da8
Author: Debarshi Ray <debarshir gnome org>
Date:   Fri Jul 21 17:16:12 2017 +0200

    docs: gtk_init_check will also fail if the commandline was invalid
    
    The existing documentation seems to suggest that gtk_init_check will
    ignore any failure to parse the commandline arguments, and that its
    return value only depends on its ability to initialize the windowing
    system. That's not true.
    
    Be more explicit to avoid misunderstandings.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=771959

 gtk/gtkmain.c |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)
---
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 3152971..e291bb3 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -1071,15 +1071,17 @@ gtk_parse_args (int    *argc,
  *     understood by GTK+ are stripped before return.
  *
  * This function does the same work as gtk_init() with only a single
- * change: It does not terminate the program if the windowing system
- * can’t be initialized. Instead it returns %FALSE on failure.
+ * change: It does not terminate the program if the commandline
+ * arguments couldn’t be parsed or the windowing system can’t be
+ * initialized. Instead it returns %FALSE on failure.
  *
  * This way the application can fall back to some other means of
  * communication with the user - for example a curses or command line
  * interface.
  *
- * Returns: %TRUE if the windowing system has been successfully
- *     initialized, %FALSE otherwise
+ * Returns: %TRUE if the commandline arguments (if any) were valid and
+ *     the windowing system has been successfully initialized, %FALSE
+ *     otherwise
  */
 gboolean
 gtk_init_check (int    *argc,


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