qulogic/pidgin

Update docs!

2017-10-05, Gary Kramlich
872e6924336e
Parents ec6c429d5f7b
Children 27da8e997900
Update docs!
3 files changed, 22 insertions(+), 0 deletions(-)
  • +1 -0
    doc/reference/libpurple/libpurple-docs.xml
  • +12 -0
    libpurple/options.c
  • +9 -0
    libpurple/options.h
    • --- a/doc/reference/libpurple/libpurple-docs.xml Thu Oct 05 22:48:31 2017 -0500
    +++ b/doc/reference/libpurple/libpurple-docs.xml Thu Oct 05 23:02:52 2017 -0500
    @@ -58,6 +58,7 @@
    <xi:include href="xml/nat-pmp.xml" />
    <xi:include href="xml/network.xml" />
    <xi:include href="xml/notify.xml" />
    + <xi:include href="xml/options.xml" />
    <xi:include href="xml/plugins.xml" />
    <xi:include href="xml/prefs.xml" />
    <xi:include href="xml/pluginpref.xml" />
    --- a/libpurple/options.c Thu Oct 05 22:48:31 2017 -0500
    +++ b/libpurple/options.c Thu Oct 05 23:02:52 2017 -0500
    @@ -53,6 +53,18 @@
    /******************************************************************************
    * API
    *****************************************************************************/
    +
    +/**
    + * purple_get_option_group:
    + *
    + * Returns a #GOptionGroup for the commandline arguments recognized by
    + * LibPurple. You should add this option group to your #GOptionContext with
    + * g_option_context_add_group(), if you are using g_option_context_parse() to
    + * parse your commandline arguments.
    + *
    + * Return Value: (transfer full): a #GOptionGroup for the commandline arguments
    + * recognized by LibPurple.
    + */
    GOptionGroup *
    purple_get_option_group(void) {
    GOptionGroup *group = NULL;
    --- a/libpurple/options.h Thu Oct 05 22:48:31 2017 -0500
    +++ b/libpurple/options.h Thu Oct 05 23:02:52 2017 -0500
    @@ -22,6 +22,15 @@
    #ifndef PURPLE_OPTIONS_H
    #define PURPLE_OPTIONS_H
    +/**
    + * SECTION:options
    + * @section_id: libpurple-options
    + * @short_description: <filename>options.h</filename>
    + * @title: Options API
    + *
    + * The functions defined here are to help in handling command line options.
    + */
    +
    #include <glib.h>
    G_BEGIN_DECLS