docs: Fill in gshell long description
authorMatthias Clasen <mclasen@redhat.com>
Sat, 31 May 2014 14:18:07 +0000 (10:18 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 31 May 2014 14:54:02 +0000 (10:54 -0400)
glib/gshell.c

index 1c39c33..596f081 100644 (file)
  * SECTION:shell
  * @title: Shell-related Utilities
  * @short_description: shell-like commandline handling
- **/
+ *
+ * GLib provides the functions g_shell_quote() and g_shell_unquote()
+ * to handle shell-like quoting in strings. The function g_shell_parse_argv()
+ * parses a string similar to the way a POSIX shell (/bin/sh) would.
+ *
+ * Note that string handling in shells has many obscure and historical
+ * corner-cases which these functions do not necessarily reproduce. They
+ * are good enough in practice, though.
+ */
 
 /**
  * G_SHELL_ERROR: