GApplication: Clarify docs for @argv

Clearly state that @argv may be NULL.
https://bugzilla.gnome.org/show_bug.cgi?id=643649
This commit is contained in:
Matthias Clasen 2011-03-04 00:12:34 -05:00
parent 1a6455b785
commit 3c7203cf1a

View File

@ -1155,14 +1155,17 @@ g_application_open (GApplication *application,
/**
* g_application_run:
* @application: a #GApplication
* @argc: the argc from main()
* @argv: (array length=argc): the argv from main()
* @argc: the argc from main() (or 0 if @argv is %NULL)
* @argv: (array length=argc): the argv from main(), or %NULL
* @returns: the exit status
*
* Runs the application.
*
* This function is intended to be run from main() and its return value
* is intended to be returned by main().
* is intended to be returned by main(). Although you are expected to pass
* the @argc, @argv parameters from main() to this function, it is possible
* to pass %NULL if @argv is not available or commandline handling is not
* required.
*
* First, the local_command_line() virtual function is invoked.
* This function always runs on the local instance. It gets passed