From 38a061422532b3d7b8bce0988f3767806ac28f8f Mon Sep 17 00:00:00 2001 From: "Jasper St. Pierre" Date: Tue, 16 Sep 2014 15:41:58 -0600 Subject: [PATCH] GApplication:handle-local-options: document return value The return value for this signal was documented in the prose, but not properly in a Returns: stanza. Fix that. --- gio/gapplication.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/gio/gapplication.c b/gio/gapplication.c index 4d5dc0d..d39d55a 100644 --- a/gio/gapplication.c +++ b/gio/gapplication.c @@ -1415,11 +1415,6 @@ g_application_class_init (GApplicationClass *class) * decide to perform certain actions, including direct local handling * (which may be useful for options like --version). * - * If the options have been "handled" then a non-negative value should - * be returned. In this case, the return value is the exit status: 0 - * for success and a positive value for failure. -1 means to continue - * normal processing. - * * In the event that the application is marked * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will * send the @option dictionary to the primary instance where it can be @@ -1450,6 +1445,11 @@ g_application_class_init (GApplicationClass *class) * capabilities than what is provided here, but this should not * normally be required. * + * Returns: an exit code. If you have handled your options and want + * to exit the process, return a non-negative option, 0 for success, + * and a positive value for failure. To continue, return -1 to let + * the default option processing continue. + * * Since: 2.40 **/ g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] = -- 2.7.4