[glib] doc: various improvements
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] doc: various improvements
- Date: Sun, 29 Jun 2014 15:58:04 +0000 (UTC)
commit 82352ab8e7bc0d499a1e1a805ba4c5f896d3ba8c
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sun May 11 18:51:29 2014 +0200
doc: various improvements
- g_subprocess_launcher_spawn() and spawnv(): there is no other way
AFAIK to create a GSubprocess from a launcher. So these
functions are not "convenience helper".
- annotate optional arguments for g_shell_parse_argv().
- other trivial fix
https://bugzilla.gnome.org/show_bug.cgi?id=732357
gio/gsubprocess.c | 2 +-
gio/gsubprocesslauncher.c | 6 ++----
glib/gshell.c | 7 ++++---
3 files changed, 7 insertions(+), 8 deletions(-)
---
diff --git a/gio/gsubprocess.c b/gio/gsubprocess.c
index ebdfd43..339b54b 100644
--- a/gio/gsubprocess.c
+++ b/gio/gsubprocess.c
@@ -1769,7 +1769,7 @@ g_subprocess_communicate_utf8 (GSubprocess *subprocess,
* @callback: Callback
* @user_data: User data
*
- * Asynchronous version of g_subprocess_communicate_utf(). Complete
+ * Asynchronous version of g_subprocess_communicate_utf8(). Complete
* invocation with g_subprocess_communicate_utf8_finish().
*/
void
diff --git a/gio/gsubprocesslauncher.c b/gio/gsubprocesslauncher.c
index 8c61b9d..fbcbf6a 100644
--- a/gio/gsubprocesslauncher.c
+++ b/gio/gsubprocesslauncher.c
@@ -675,8 +675,7 @@ g_subprocess_launcher_set_child_setup (GSubprocessLauncher *self,
* @argv0: Command line arguments
* @...: Continued arguments, %NULL terminated
*
- * A convenience helper for creating a #GSubprocess given a provided
- * varargs list of arguments.
+ * Creates a #GSubprocess given a provided varargs list of arguments.
*
* Since: 2.40
* Returns: (transfer full): A new #GSubprocess, or %NULL on error (and @error will be set)
@@ -719,8 +718,7 @@ g_subprocess_launcher_spawn (GSubprocessLauncher *launcher,
* @argv: (array zero-terminated=1) (element-type utf8): Command line arguments
* @error: Error
*
- * A convenience helper for creating a #GSubprocess given a provided
- * array of arguments.
+ * Creates a #GSubprocess given a provided array of arguments.
*
* Since: 2.40
* Returns: (transfer full): A new #GSubprocess, or %NULL on error (and @error will be set)
diff --git a/glib/gshell.c b/glib/gshell.c
index 596f081..a1c7e79 100644
--- a/glib/gshell.c
+++ b/glib/gshell.c
@@ -619,9 +619,10 @@ tokenize_command_line (const gchar *command_line,
/**
* g_shell_parse_argv:
* @command_line: command line to parse
- * @argcp: (out): return location for number of args
- * @argvp: (out) (array length=argcp zero-terminated=1): return location for array of args
- * @error: return location for error
+ * @argcp: (out) (optional): return location for number of args, or %NULL
+ * @argvp: (out) (optional) (array length=argcp zero-terminated=1): return
+ * location for array of args, or %NULL
+ * @error: (optional): return location for error, or %NULL
*
* Parses a command line into an argument vector, in much the same way
* the shell would, but without many of the expansions the shell would
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]