ardour/libs/glibmm2/glib/src/glib_docs_override.xml

<root>
    <function name="g_option_context_set_summary">
        <description>
            Adds a string to be displayed in --help output before the list of options. This
            is typically a summary of the program functionality. 

            Note that the summary is translated (see set_translate_func(),
            set_translation_domain()).

            Since: 2.14

        </description>
        <parameters>
            <parameter name="summary">
                <parameter_description> a string to be shown in --help output before the list of
                    options
                </parameter_description>
            </parameter>
        </parameters>
        <return></return>
    </function>

    <function name="g_option_context_get_summary">
        <description>
            Returns: the summary
            See set_summary() for more information

        </description>
        <parameters>
        </parameters>
        <return> the summary

            Since: 2.14
        </return>
    </function>

    <function name="g_option_context_set_description">
        <description>
            Adds a string to be displayed in --help output after the list of
            options. This text often includes a bug reporting address.

            Note that the summary is translated (see set_translate_func()).

            Since: 2.14

        </description>
        <parameters>
            <parameter name="description">
                <parameter_description> a string to be shown in --help output
                    after the list of options
                </parameter_description>
            </parameter>
        </parameters>
        <return></return>
    </function>

    <function name="g_option_context_get_description">
        <description>
            Returns: the description
            See set_description() for more information

        </description>
        <parameters>
        </parameters>
        <return> the description

            Since: 2.14
        </return>
    </function>

    <function name="g_option_context_set_translation_domain">
        <description>
            A convenience function to use gettext() for translating
            user-visible strings. 

            Since: 2.14

        </description>
        <parameters>
            <parameter name="domain">
                <parameter_description> the domain to use
                </parameter_description>
            </parameter>
        </parameters>
        <return></return>
    </function>


<function name="g_key_file_get_double">
<description>
Return value: the value associated with the key as a double, or

</description>
<parameters>
<parameter name="key_file">
<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
<parameter name="group_name">
<parameter_description> a group name
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a key
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
<return> the value associated with the key as a double, or
0.0 if the key was not found or could not be parsed.

Since: 2.14
</return>
</function>


<function name="g_key_file_set_double">
<description>
Associates a new double value with @key under @group_name.
If @key cannot be found then it is created. 

Since: 2.14

</description>
<parameters>
<parameter name="key_file">
<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
<parameter name="group_name">
<parameter_description> a group name
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a key
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> an double value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>


<function name="g_key_file_load_from_file">
<description>
Loads a key file into an empty KeyFile instance.
If the file could not be loaded then a FileError or KeyFileError exception is thrown.

@throw Glib::FileError
@throw Glib::KeyFileError
</description>
<parameters>
<parameter name="key_file">
<parameter_description> an empty #GKeyFile struct
</parameter_description>
</parameter>
<parameter name="file">
<parameter_description> the path of a filename to load, in the GLib file name encoding
</parameter_description>
</parameter>
<parameter name="flags">
<parameter_description> flags from #GKeyFileFlags
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> %TRUE if a key file could be loaded, %FALSE othewise
Since: 2.6
</return>
</function>


<function name="g_key_file_get_value">
<description>
Returns the value associated with @key under @group_name.

@throw Glib::FileError in the event the key cannot be found (with the Glib::KEY_FILE_ERROR_KEY_NOT_FOUND code).
@throw Glib::KeyFileError in the event that the @group_name cannot be found (with the Glib::KEY_FILE_ERROR_GROUP_NOT_FOUND).
</description>
<parameters>
<parameter name="key_file">
<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
<parameter name="group_name">
<parameter_description> a group name
</parameter_description>
</parameter>
<parameter name="key">
<parameter_description> a key
</parameter_description>
</parameter>
<parameter name="error">
<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
<return> The value as a string.

Since: 2.6
</return>
</function>


</root>