Add a section for GOption. Include GOption section. New template.

Tue Aug  3 16:43:22 2004  Matthias Clasen  <maclas@gmx.de>

	* glib/glib-sections.txt: Add a section for GOption.
	* glib/glib-docs.sgml: Include GOption section.
	* glib/tmpl/option.sgml: New template.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index ac4f139..38d8ec2 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+Tue Aug  3 16:43:22 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * 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  <maclas@gmx.de>
 
        * 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 b0b7ef0..8dce8c4 100644 (file)
--- a/docs/reference/glib/glib-docs.sgml
+++ b/docs/reference/glib/glib-docs.sgml
@@ -53,6 +53,7 @@
 <!ENTITY glib-Spawn SYSTEM "xml/spawn.xml">
 <!ENTITY glib-Fileutils SYSTEM "xml/fileutils.xml">
 <!ENTITY glib-Shell SYSTEM "xml/shell.xml">
+<!ENTITY glib-Option SYSTEM "xml/option.xml">
 <!ENTITY glib-Markup SYSTEM "xml/markup.xml">
 <!ENTITY glib-i18n SYSTEM "xml/i18n.xml">
 <!ENTITY glib-Version SYSTEM "xml/version.xml">
@@ -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 4d2e31f..37e2134 100644 (file)
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -921,6 +921,43 @@ g_shell_error_quark
 
 
 <SECTION>
+<TITLE>Commandline option parser</TITLE>
+<FILE>option</FILE>
+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
+<SUBSECTION Private>
+g_option_context_error_quark
+</SECTION>
+
+
+<SECTION>
 <TITLE>File Utilities</TITLE>
 <FILE>fileutils</FILE>
 GFileError

diff --git a/docs/reference/glib/tmpl/option.sgml b/docs/reference/glib/tmpl/option.sgml
new file mode 100644 (file)
index 0000000..bd9d15a
--- /dev/null
+++ b/docs/reference/glib/tmpl/option.sgml
@@ -0,0 +1,294 @@
+<!-- ##### SECTION Title ##### -->
+Commandline option parser
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### ENUM GOptionError ##### -->
+<para>
+
+</para>
+
+@G_OPTION_ERROR_UNKNOWN_OPTION: 
+@G_OPTION_ERROR_BAD_VALUE: 
+@G_OPTION_ERROR_FAILED: 
+
+<!-- ##### MACRO G_OPTION_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### ENUM GOptionFlags ##### -->
+<para>
+
+</para>
+
+@G_OPTION_FLAG_HIDDEN: 
+@G_OPTION_FLAG_IN_MAIN: 
+
+<!-- ##### ENUM GOptionArg ##### -->
+<para>
+
+</para>
+
+@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: 
+
+<!-- ##### USER_FUNCTION GOptionArgFunc ##### -->
+<para>
+
+</para>
+
+@option_name: 
+@value: 
+@data: 
+@error: 
+@Returns: 
+
+
+<!-- ##### STRUCT GOptionContext ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION g_option_context_new ##### -->
+<para>
+
+</para>
+
+@parameter_string: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_context_free ##### -->
+<para>
+
+</para>
+
+@context: 
+
+
+<!-- ##### FUNCTION g_option_context_parse ##### -->
+<para>
+
+</para>
+
+@context: 
+@argc: 
+@argv: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_context_set_help_enabled ##### -->
+<para>
+
+</para>
+
+@context: 
+@help_enabled: 
+
+
+<!-- ##### FUNCTION g_option_context_get_help_enabled ##### -->
+<para>
+
+</para>
+
+@context: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_context_set_ignore_unknown_options ##### -->
+<para>
+
+</para>
+
+@context: 
+@ignore_unknown: 
+
+
+<!-- ##### FUNCTION g_option_context_get_ignore_unknown_options ##### -->
+<para>
+
+</para>
+
+@context: 
+@Returns: 
+
+
+<!-- ##### STRUCT GOptionEntry ##### -->
+<para>
+
+</para>
+
+@long_name: 
+@short_name: 
+@flags: 
+@arg: 
+@arg_data: 
+@description: 
+@arg_description: 
+
+<!-- ##### FUNCTION g_option_context_add_main_entries ##### -->
+<para>
+
+</para>
+
+@context: 
+@entries: 
+@translation_domain: 
+
+
+<!-- ##### STRUCT GOptionGroup ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION g_option_context_add_group ##### -->
+<para>
+
+</para>
+
+@context: 
+@group: 
+
+
+<!-- ##### FUNCTION g_option_context_set_main_group ##### -->
+<para>
+
+</para>
+
+@context: 
+@group: 
+
+
+<!-- ##### FUNCTION g_option_context_get_main_group ##### -->
+<para>
+
+</para>
+
+@context: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_group_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@description: 
+@help_description: 
+@user_data: 
+@destroy: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_group_free ##### -->
+<para>
+
+</para>
+
+@group: 
+
+
+<!-- ##### FUNCTION g_option_group_add_entries ##### -->
+<para>
+
+</para>
+
+@group: 
+@entries: 
+
+
+<!-- ##### USER_FUNCTION GOptionParseFunc ##### -->
+<para>
+
+</para>
+
+@context: 
+@group: 
+@data: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_group_set_parse_hooks ##### -->
+<para>
+
+</para>
+
+@group: 
+@pre_parse_func: 
+@post_parse_func: 
+
+
+<!-- ##### USER_FUNCTION GOptionErrorFunc ##### -->
+<para>
+
+</para>
+
+@context: 
+@group: 
+@data: 
+@error: 
+
+
+<!-- ##### FUNCTION g_option_group_set_error_hook ##### -->
+<para>
+
+</para>
+
+@group: 
+@error_func: 
+
+
+<!-- ##### USER_FUNCTION GTranslateFunc ##### -->
+<para>
+
+</para>
+
+@str: 
+@data: 
+@Returns: 
+
+
+<!-- ##### FUNCTION g_option_group_set_translate_func ##### -->
+<para>
+
+</para>
+
+@group: 
+@func: 
+@data: 
+@destroy_notify: 
+
+
+<!-- ##### FUNCTION g_option_group_set_translation_domain ##### -->
+<para>
+
+</para>
+
+@group: 
+@domain: 
+
+