From 983dd431f12ae6a6b33dfcf0d356896abbeebf49 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 3 Aug 2004 20:44:24 +0000 Subject: [PATCH] Add a section for GOption. Include GOption section. New template. Tue Aug 3 16:43:22 2004 Matthias Clasen * glib/glib-sections.txt: Add a section for GOption. * glib/glib-docs.sgml: Include GOption section. * glib/tmpl/option.sgml: New template. --- docs/reference/ChangeLog | 6 + docs/reference/glib/glib-docs.sgml | 2 + docs/reference/glib/glib-sections.txt | 37 ++++ docs/reference/glib/tmpl/option.sgml | 294 ++++++++++++++++++++++++++ 4 files changed, 339 insertions(+) create mode 100644 docs/reference/glib/tmpl/option.sgml diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index ac4f139c6..38d8ec2ec 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,9 @@ +Tue Aug 3 16:43:22 2004 Matthias Clasen + + * glib/glib-sections.txt: Add a section for GOption. + * glib/glib-docs.sgml: Include GOption section. + * glib/tmpl/option.sgml: New template. + Tue Aug 3 15:34:16 2004 Matthias Clasen * glib/glib-sections.txt: Add a separate section for diff --git a/docs/reference/glib/glib-docs.sgml b/docs/reference/glib/glib-docs.sgml index b0b7ef056..8dce8c4df 100644 --- a/docs/reference/glib/glib-docs.sgml +++ b/docs/reference/glib/glib-docs.sgml @@ -53,6 +53,7 @@ + @@ -142,6 +143,7 @@ synchronize their operation. &glib-Spawn; &glib-Fileutils; &glib-Shell; + &glib-Option; &glib-Pattern-Matching; &glib-Markup; &glib-Windows-Compatability-Functions; diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index 4d2e31f5f..37e21345b 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -920,6 +920,43 @@ g_shell_error_quark +
+Commandline option parser +option +GOptionError +G_OPTION_ERROR +GOptionFlags +GOptionArg +GOptionArgFunc +GOptionContext +g_option_context_new +g_option_context_free +g_option_context_parse +g_option_context_set_help_enabled +g_option_context_get_help_enabled +g_option_context_set_ignore_unknown_options +g_option_context_get_ignore_unknown_options +GOptionEntry +g_option_context_add_main_entries +GOptionGroup +g_option_context_add_group +g_option_context_set_main_group +g_option_context_get_main_group +g_option_group_new +g_option_group_free +g_option_group_add_entries +GOptionParseFunc +g_option_group_set_parse_hooks +GOptionErrorFunc +g_option_group_set_error_hook +GTranslateFunc +g_option_group_set_translate_func +g_option_group_set_translation_domain + +g_option_context_error_quark +
+ +
File Utilities fileutils diff --git a/docs/reference/glib/tmpl/option.sgml b/docs/reference/glib/tmpl/option.sgml new file mode 100644 index 000000000..bd9d15a9e --- /dev/null +++ b/docs/reference/glib/tmpl/option.sgml @@ -0,0 +1,294 @@ + +Commandline option parser + + + + + + + + + + + + + + + + + + + +@G_OPTION_ERROR_UNKNOWN_OPTION: +@G_OPTION_ERROR_BAD_VALUE: +@G_OPTION_ERROR_FAILED: + + + + + + + + + + + + + +@G_OPTION_FLAG_HIDDEN: +@G_OPTION_FLAG_IN_MAIN: + + + + + + +@G_OPTION_ARG_NONE: +@G_OPTION_ARG_STRING: +@G_OPTION_ARG_INT: +@G_OPTION_ARG_CALLBACK: +@G_OPTION_ARG_FILENAME: +@G_OPTION_ARG_STRING_ARRAY: +@G_OPTION_ARG_FILENAME_ARRAY: + + + + + + +@option_name: +@value: +@data: +@error: +@Returns: + + + + + + + + + + + + + +@parameter_string: +@Returns: + + + + + + + +@context: + + + + + + + +@context: +@argc: +@argv: +@error: +@Returns: + + + + + + + +@context: +@help_enabled: + + + + + + + +@context: +@Returns: + + + + + + + +@context: +@ignore_unknown: + + + + + + + +@context: +@Returns: + + + + + + + +@long_name: +@short_name: +@flags: +@arg: +@arg_data: +@description: +@arg_description: + + + + + + +@context: +@entries: +@translation_domain: + + + + + + + + + + + + + +@context: +@group: + + + + + + + +@context: +@group: + + + + + + + +@context: +@Returns: + + + + + + + +@name: +@description: +@help_description: +@user_data: +@destroy: +@Returns: + + + + + + + +@group: + + + + + + + +@group: +@entries: + + + + + + + +@context: +@group: +@data: +@error: +@Returns: + + + + + + + +@group: +@pre_parse_func: +@post_parse_func: + + + + + + + +@context: +@group: +@data: +@error: + + + + + + + +@group: +@error_func: + + + + + + + +@str: +@data: +@Returns: + + + + + + + +@group: +@func: +@data: +@destroy_notify: + + + + + + + +@group: +@domain: + +