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.
This commit is contained in:
Jasper St. Pierre 2014-09-16 15:41:58 -06:00 committed by Ryan Lortie
parent 8061694c49
commit 38a0614225

View File

@ -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] =