gplugin/gplugin

Document all the gplugin symbols that should be documented
bugfix/docs-cleanup
2019-08-14, Gary Kramlich
b04534e0e9ab
Parents 6e5db792b535
Children ed03b04d550e
Document all the gplugin symbols that should be documented
9 files changed, 97 insertions(+), 1 deletions(-)
  • +26 -0
    gplugin/gplugin-loader.c
  • +4 -1
    gplugin/gplugin-loader.h
  • +12 -0
    gplugin/gplugin-native-loader.c
  • +13 -0
    gplugin/gplugin-native-plugin.c
  • +19 -0
    gplugin/gplugin-plugin-info.c
  • +1 -0
    gplugin/gplugin-plugin-info.h
  • +20 -0
    gplugin/gplugin-plugin.c
  • +1 -0
    gplugin/gplugin-plugin.h
  • +1 -0
    gplugin/reference/gplugin-docs.xml
    • --- a/gplugin/gplugin-loader.c Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-loader.c Wed Aug 14 00:43:52 2019 -0500
    @@ -20,6 +20,12 @@
    #include <gplugin/gplugin-core.h>
    /**
    + * GPLUGIN_TYPE_LOADER:
    + *
    + * The standard _get_type macro for #GPluginLoader.
    + */
    +
    +/**
    * SECTION:gplugin-loader
    * @Title: Plugin Loader Interface
    * @Short_description: interface for loading plugins
    @@ -28,6 +34,26 @@
    * be able to use it to load plugins.
    */
    +/**
    + * GPluginLoader:
    + *
    + * An abstract data type that should not be accessed directly.
    + */
    +
    +/**
    + * GPluginLoaderClass:
    + * @supported_extensions: The supported_extensions vfunc returns a #GList of
    + * file extensions that this loader supports.
    + * @query: The query vfunc is called when the plugin manager needs to query a
    + * plugin that has a file extension from @supported_extensions.
    + * @load: The load vfunc is called when the plugin manager wants to load a
    + * plugin that was previously queried by this loader.
    + * @unload: The unload vfunc is called when the plugin manager wants to unload
    + * a previously loaded plugin from this loader.
    + *
    + * #GPluginLoader class defines the behavior for loading plugins.
    + */
    +
    /******************************************************************************
    * GObject Stuff
    *****************************************************************************/
    --- a/gplugin/gplugin-loader.h Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-loader.h Wed Aug 14 00:43:52 2019 -0500
    @@ -34,15 +34,18 @@
    #include <gplugin/gplugin-plugin.h>
    struct _GPluginLoaderClass {
    + /*< private >*/
    GObjectClass gparent;
    - GSList *(*supported_extensions)(const GPluginLoaderClass *klass);
    + /*< public >*/
    + GSList *(*supported_extensions)(GPluginLoaderClass *klass);
    GPluginPlugin *(*query)(GPluginLoader *loader, const gchar *filename, GError **error);
    gboolean (*load)(GPluginLoader *loader, GPluginPlugin *plugin, GError **error);
    gboolean (*unload)(GPluginLoader *loader, GPluginPlugin *plugin, GError **error);
    + /*< private >*/
    gpointer reserved[4];
    };
    --- a/gplugin/gplugin-native-loader.c Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-native-loader.c Wed Aug 14 00:43:52 2019 -0500
    @@ -39,6 +39,18 @@
    */
    /**
    + * GPLUGIN_TYPE_NATIVE_LOADER:
    + *
    + * The standard _get_type macro for #GPluginNativeLoader.
    + */
    +
    +/**
    + * GPluginNativeLoader:
    + *
    + * A #GPluginLoader subclass that is able to load native plugins.
    + */
    +
    +/**
    * GPLUGIN_NATIVE_PLUGIN_ABI_VERSION:
    *
    * The ABI version of the #GPluginNativeLoader. Your plugin should use this
    --- a/gplugin/gplugin-native-plugin.c Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-native-plugin.c Wed Aug 14 00:43:52 2019 -0500
    @@ -35,6 +35,19 @@
    * language.
    */
    +/**
    + * GPLUGIN_TYPE_NATIVE_PLUGIN:
    + *
    + * The standard _get_type macro for #GPluginNativePlugin.
    + */
    +
    +/**
    + * GPluginNativePlugin:
    + *
    + * An instance of a loaded native plugin. A native plugin is a plugin that was
    + * compiled to machine native code, typically these are written in C/C++.
    + */
    +
    /******************************************************************************
    * Structs
    *****************************************************************************/
    --- a/gplugin/gplugin-plugin-info.c Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-plugin-info.c Wed Aug 14 00:43:52 2019 -0500
    @@ -29,6 +29,25 @@
    * #GPluginPluginInfo holds metadata for plugins.
    */
    +/**
    + * GPLUGIN_TYPE_PLUGIN_INFO:
    + *
    + * The standard _get_type macro for #GPluginPluginInfo.
    + */
    +
    +/**
    + * GPluginPluginInfo:
    + *
    + * #GPluginPluginInfo holds all of the data about a plugin. It is created when
    + * a plugin is queried.
    + */
    +
    +/**
    + * GPluginPluginInfoClass:
    + *
    + * The class structure for #GPluginPluginInfo.
    + */
    +
    /******************************************************************************
    * Structs
    *****************************************************************************/
    --- a/gplugin/gplugin-plugin-info.h Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-plugin-info.h Wed Aug 14 00:43:52 2019 -0500
    @@ -34,6 +34,7 @@
    #include <gplugin/gplugin-version.h>
    struct _GPluginPluginInfoClass {
    + /*< private >*/
    GInitiallyUnownedClass gparent;
    gpointer reserved[4];
    --- a/gplugin/gplugin-plugin.c Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-plugin.c Wed Aug 14 00:43:52 2019 -0500
    @@ -43,6 +43,26 @@
    * The expected states of a plugin.
    */
    +/**
    + * GPLUGIN_TYPE_PLUGIN:
    + *
    + * The standard _get_type macro for #GPluginPlugin.
    + */
    +
    +/**
    + * GPluginPlugin:
    + *
    + * #GPluginPlugin is an opaque data structure and should not be used directly.
    + */
    +
    +/**
    + * GPluginPluginInterface:
    + * @state_changed: The signal to emit when the plugin's state has changed.
    + *
    + * The interface that defines the behavior of plugins, including properties and
    + * signals.
    + */
    +
    /******************************************************************************
    * Enums
    *****************************************************************************/
    --- a/gplugin/gplugin-plugin.h Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/gplugin-plugin.h Wed Aug 14 00:43:52 2019 -0500
    @@ -50,6 +50,7 @@
    /*< private >*/
    GTypeInterface parent;
    + /*< public >*/
    void (*state_changed)(GPluginPlugin *plugin, GPluginPluginState oldstate, GPluginPluginState newstate);
    /*< private >*/
    --- a/gplugin/reference/gplugin-docs.xml Mon Aug 12 23:38:40 2019 -0500
    +++ b/gplugin/reference/gplugin-docs.xml Wed Aug 14 00:43:52 2019 -0500
    @@ -23,6 +23,7 @@
    <title>Tutorials</title>
    <xi:include href="embedding.xml"/>
    + <xi:include href="native-plugins.xml"/>
    </part>
    <part id="object-hierarchy">