GShell: move docs from tmpl to .c

This commit is contained in:
Ryan Lortie 2010-01-30 22:15:35 -05:00
parent f6482a1eaa
commit 0ab7bb4b18
3 changed files with 23 additions and 68 deletions

View File

@ -5,5 +5,6 @@ gvarianttype.sgml
hash_tables.sgml hash_tables.sgml
option.sgml option.sgml
random_numbers.sgml random_numbers.sgml
shell.sgml
threads.sgml threads.sgml
timers.sgml timers.sgml

View File

@ -1,68 +0,0 @@
<!-- ##### SECTION Title ##### -->
Shell-related Utilities
<!-- ##### SECTION Short_Description ##### -->
shell-like commandline handling
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GShellError ##### -->
<para>
Error codes returned by shell functions.
</para>
@G_SHELL_ERROR_BAD_QUOTING: Mismatched or otherwise mangled quoting.
@G_SHELL_ERROR_EMPTY_STRING: String to be parsed was empty.
@G_SHELL_ERROR_FAILED: Some other error.
<!-- ##### MACRO G_SHELL_ERROR ##### -->
<para>
Error domain for shell functions. Errors in this domain will
be from the #GShellError enumeration. See #GError for information on
error domains.
</para>
<!-- ##### FUNCTION g_shell_parse_argv ##### -->
<para>
</para>
@command_line:
@argcp:
@argvp:
@error:
@Returns:
<!-- ##### FUNCTION g_shell_quote ##### -->
<para>
</para>
@unquoted_string:
@Returns:
<!-- ##### FUNCTION g_shell_unquote ##### -->
<para>
</para>
@quoted_string:
@error:
@Returns:

View File

@ -33,6 +33,28 @@
#include "glibintl.h" #include "glibintl.h"
#include "galias.h" #include "galias.h"
/**
* SECTION: shell
* @title: Shell-related Utilities
* @short_description: shell-like commandline handling
**/
/**
* G_SHELL_ERROR:
*
* Error domain for shell functions. Errors in this domain will be from
* the #GShellError enumeration. See #GError for information on error
* domains.
**/
/**
* GShellError:
* @G_SHELL_ERROR_BAD_QUOTING: Mismatched or otherwise mangled quoting.
* @G_SHELL_ERROR_EMPTY_STRING: String to be parsed was empty.
* @G_SHELL_ERROR_FAILED: Some other error.
*
* Error codes returned by shell functions.
**/
GQuark GQuark
g_shell_error_quark (void) g_shell_error_quark (void)
{ {