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
This commit is contained in:
Debarshi Ray 2017-07-21 17:16:12 +02:00
parent 2b049d5d66
commit 1031fa914a

View File

@ -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
* cant be initialized. Instead it returns %FALSE on failure.
* change: It does not terminate the program if the commandline
* arguments couldnt be parsed or the windowing system cant 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,