gplugin/gplugin

Lot's of doc updates
feature/gtk-doc
2017-07-31, Gary Kramlich
9a04aaa24642
Parents 3fc76104d688
Children ad5a61020b96
Lot's of doc updates
6 files changed, 53 insertions(+), 0 deletions(-)
  • +9 -0
    gplugin/gplugin-core.c
  • +8 -0
    gplugin/gplugin-enums.c.tmpl
  • +9 -0
    gplugin/gplugin-manager.c
  • +8 -0
    gplugin/gplugin-native-loader.c
  • +9 -0
    gplugin/gplugin-native-plugin.c
  • +10 -0
    gplugin/gplugin-options.c
    • --- a/gplugin/gplugin-core.c Mon Jul 31 22:42:40 2017 -0500
    +++ b/gplugin/gplugin-core.c Mon Jul 31 22:55:34 2017 -0500
    @@ -23,6 +23,15 @@
    #include <gplugin/gplugin-private.h>
    #include <gplugin/gplugin-plugin.h>
    +/**
    + * SECTION:gplugin-core
    + * @Title: Core API
    + * @Short_description: the core api
    + *
    + * This section contains the core api of gplugin, which includes #gplugin_init
    + * and #gplugin_uninit.
    + */
    +
    /******************************************************************************
    * API
    *****************************************************************************/
    --- a/gplugin/gplugin-enums.c.tmpl Mon Jul 31 22:42:40 2017 -0500
    +++ b/gplugin/gplugin-enums.c.tmpl Mon Jul 31 22:55:34 2017 -0500
    @@ -22,6 +22,14 @@
    /*** END file-header ***/
    +/**
    + * SECTION:gplugin-enums
    + * @Title: Enumerations
    + * @Short_description: common enumerations
    + *
    + * The enums defined here are used throughout %GPlugin.
    + */
    +
    /*** BEGIN file-production ***/
    /* enumerations from "@filename@" */
    --- a/gplugin/gplugin-manager.c Mon Jul 31 22:42:40 2017 -0500
    +++ b/gplugin/gplugin-manager.c Mon Jul 31 22:55:34 2017 -0500
    @@ -31,6 +31,15 @@
    #include <gplugin/gplugin-file-tree.h>
    +/**
    + * SECTION:gplugin-manager
    + * @Title: Manager API
    + * @Short_description: API for managing plugins
    + *
    + * The manager is used to manager all plugins in %GPlugin. This includes
    + * loading, unloading, querying, checking for new plugins, and so on.
    + */
    +
    /******************************************************************************
    * Enums
    *****************************************************************************/
    --- a/gplugin/gplugin-native-loader.c Mon Jul 31 22:42:40 2017 -0500
    +++ b/gplugin/gplugin-native-loader.c Mon Jul 31 22:55:34 2017 -0500
    @@ -30,6 +30,14 @@
    #define GPLUGIN_LOAD_SYMBOL "gplugin_load"
    #define GPLUGIN_UNLOAD_SYMBOL "gplugin_unload"
    +/**
    + * SECTION:gplugin-native-loader
    + * @Title: Native Loader API
    + * @Short_description: API for the native plugin loader
    + *
    + * Basic API for the native plugin loader.
    + */
    +
    /******************************************************************************
    * Helpers
    *****************************************************************************/
    --- a/gplugin/gplugin-native-plugin.c Mon Jul 31 22:42:40 2017 -0500
    +++ b/gplugin/gplugin-native-plugin.c Mon Jul 31 22:55:34 2017 -0500
    @@ -26,6 +26,15 @@
    #include <glib/gi18n.h>
    +/**
    + * SECTION:gplugin-native-plugin
    + * @Title: Native Plugin API
    + * @Short_description: API for native plugins
    + *
    + * API for use by native plugins. That is plugins written in a compiled
    + * language.
    + */
    +
    #define GPLUGIN_NATIVE_PLUGIN_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE((obj), GPLUGIN_TYPE_NATIVE_PLUGIN, GPluginNativePluginPrivate))
    --- a/gplugin/gplugin-options.c Mon Jul 31 22:42:40 2017 -0500
    +++ b/gplugin/gplugin-options.c Mon Jul 31 22:55:34 2017 -0500
    @@ -23,6 +23,16 @@
    #include <gplugin/gplugin-manager.h>
    +/**
    + * SECTION:gplugin-options
    + * @Title: Command line option support
    + * @Short_description: command line option support
    + *
    + * This section contains #gplugin_get_option_group that makes it easy to
    + * initialize %GPlugin from your application when it is added to a
    + * #GOptionContext.
    + */
    +
    /******************************************************************************
    * Options
    *****************************************************************************/