qulogic/gplugin

Cleanup all of the visible gplugin docs, and fix incorrect uses if it's all over the codebase
feature/docs-review
2020-02-18, Gary Kramlich
438c749ee39e
Parents be9aa9727078
Children 0ca3b6799266
Cleanup all of the visible gplugin docs, and fix incorrect uses if it's all over the codebase
26 files changed, 293 insertions(+), 312 deletions(-)
  • +1 -1
    ChangeLog
  • +12 -6
    gplugin-gtk/reference/gplugin-gtk-docs.xml
  • +3 -5
    gplugin/gplugin-core.c
  • +2 -3
    gplugin/gplugin-core.h
  • +35 -34
    gplugin/gplugin-loader.c
  • +1 -1
    gplugin/gplugin-loader.h
  • +34 -34
    gplugin/gplugin-manager.c
  • +0 -8
    gplugin/gplugin-native-loader.c
  • +0 -9
    gplugin/gplugin-native-plugin.c
  • +3 -3
    gplugin/gplugin-options.c
  • +1 -3
    gplugin/gplugin-options.h
  • +41 -41
    gplugin/gplugin-plugin-info.c
  • +1 -2
    gplugin/gplugin-plugin-info.h
  • +25 -24
    gplugin/gplugin-plugin.c
  • +1 -2
    gplugin/gplugin-plugin.h
  • +12 -13
    gplugin/gplugin-version.c
  • +1 -2
    gplugin/gplugin-version.h.in
  • +4 -5
    gplugin/reference/embedding.xml
  • +15 -21
    gplugin/reference/gplugin-docs.xml
  • +26 -25
    gplugin/reference/lua.xml
  • +4 -0
    gplugin/reference/meson.build
  • +9 -9
    gplugin/reference/native-plugins.xml
  • +24 -24
    gplugin/reference/python.xml
  • +36 -35
    gplugin/reference/vala.xml
  • +1 -1
    gplugin/tests/test-bind-local.c
  • +1 -1
    perl/gplugin-perl-loader.c
    • --- a/ChangeLog Mon Feb 17 21:08:07 2020 -0600
    +++ b/ChangeLog Tue Feb 18 01:28:55 2020 -0600
    @@ -177,7 +177,7 @@
    * Moved the native loader to the loader-testing static library
    * Overhauled the native loader tests
    * Fixed a bug where in certain conditions a load-on-query plugin that failed
    - to load, would get it's info tracked twice.
    + to load, would get its info tracked twice.
    0.0.11: 2013/12/02
    * Added gplugin_get_option_group which implements options for adding paths
    --- a/gplugin-gtk/reference/gplugin-gtk-docs.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin-gtk/reference/gplugin-gtk-docs.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -6,12 +6,18 @@
    ]>
    <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
    <bookinfo>
    - <title>GPlugin Gtk Reference Manual</title>\
    - <releaseinfo>
    - This document is for GPluginGtk &version;
    - The latest version of this documentation can be found on-line at
    - <ulink role="online-location" url="https://docs.pidgin.im/gplugin-gtk/latest">https://docs.pidgin.im/gplugin/latest/</ulink>.
    - </releaseinfo>
    + <title>GPlugin Gtk Reference Manual</title>
    + <abstract>
    + <title>GPluginGtk &version;</title>
    + <para>
    + GPluginGtk is a collection of Gtk widgets to make it easier to
    + integrate GPlugin into applications.
    + </para>
    + <para>
    + The latest version of this documentation can be found on-line at
    + <ulink role="online-location" url="https://docs.pidgin.im/gplugin-gtk/latest">https://docs.pidgin.im/gplugin-gtk/latest/</ulink>.
    + </para>
    + </abstract>
    </bookinfo>
    <part id="object-hierarchy">
    --- a/gplugin/gplugin-core.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-core.c Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -26,10 +26,9 @@
    /**
    * SECTION:gplugin-core
    * @Title: Core API
    - * @Short_description: the core api
    + * @Short_description: the core API
    *
    - * This section contains the core api of gplugin, which includes #gplugin_init
    - * and #gplugin_uninit.
    + * This section contains the core API of GPlugin.
    */
    /******************************************************************************
    @@ -76,4 +75,3 @@
    gplugin_uninit(void) {
    gplugin_manager_private_uninit();
    }
    -
    --- a/gplugin/gplugin-core.h Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-core.h Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -25,7 +25,7 @@
    #include <glib.h>
    #include <glib-object.h>
    -#define GPLUGIN_DOMAIN (g_quark_from_static_string("gplugin"))
    +#define GPLUGIN_DOMAIN (g_quark_from_static_string("gplugin"))
    G_BEGIN_DECLS
    @@ -35,4 +35,3 @@
    G_END_DECLS
    #endif /* GPLUGIN_CORE_H */
    -
    --- a/gplugin/gplugin-loader.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-loader.c Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -20,24 +20,23 @@
    #include <gplugin/gplugin-core.h>
    /**
    + * SECTION:gplugin-loader
    + * @Title: Plugin Loader
    + * @Short_description: Abstract class for loading plugins
    + *
    + * GPluginLoader defines the base behavior for loaders of all languages.
    + */
    +
    +/**
    * GPLUGIN_TYPE_LOADER:
    *
    * The standard _get_type macro for #GPluginLoader.
    */
    /**
    - * SECTION:gplugin-loader
    - * @Title: Plugin Loader Interface
    - * @Short_description: interface for loading plugins
    - *
    - * A PluginLoader has to implement the interface described here for GPlugin to
    - * be able to use it to load plugins.
    - */
    -
    -/**
    * GPluginLoader:
    *
    - * An abstract data type that should not be accessed directly.
    + * An abstract class that should not be accessed directly.
    */
    /**
    @@ -52,11 +51,11 @@
    * @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.
    + * #GPluginLoaderClass defines the behavior for loading plugins.
    */
    /******************************************************************************
    - * GObject Stuff
    + * GObject Implementation
    *****************************************************************************/
    G_DEFINE_ABSTRACT_TYPE(GPluginLoader, gplugin_loader, G_TYPE_OBJECT);
    @@ -74,14 +73,15 @@
    /**
    * gplugin_loader_query_plugin:
    - * @loader: #GPluginLoader instance performing the query
    - * @filename: filename to query
    - * @error: return location for a GError, or NULL
    + * @loader: The #GPluginLoader instance performing the query.
    + * @filename: The filename to query.
    + * @error: (nullable): The return location for a #GError, or %NULL.
    *
    - * This function is called by the plugin manager to ask a loader to query the
    - * given file and determine if it's a usable plugin.
    + * This function is called by the plugin manager to ask @loader to query
    + * @filename and determine if it's a usable plugin.
    *
    - * Return value: (transfer full): A #GPluginPlugin instance or NULL on failure
    + * Return value: (transfer full): A #GPluginPlugin instance or %NULL on
    + * failure.
    */
    GPluginPlugin *
    gplugin_loader_query_plugin(GPluginLoader *loader,
    @@ -104,14 +104,14 @@
    /**
    * gplugin_loader_load_plugin:
    - * @loader: #GPluginLoader instance performing the load
    - * @plugin: #GPluginPlugin instance to load
    - * @error: return location for a GError, or NULL
    + * @loader: The #GPluginLoader instance performing the load.
    + * @plugin: The #GPluginPlugin instance to load.
    + * @error: (nullable): The return location for a #GError, or %NULL.
    *
    - * This function is called by the plugin manager to ask a loader to load the
    - * given plugin.
    + * This function is called by the plugin manager to ask @loader to load
    + * @plugin.
    *
    - * Return value: TRUE if @plugin was loaded successfully, FALSE otherwise
    + * Return value: %TRUE if @plugin was loaded successfully, %FALSE otherwise.
    */
    gboolean
    gplugin_loader_load_plugin(GPluginLoader *loader,
    @@ -139,14 +139,14 @@
    /**
    * gplugin_loader_unload_plugin:
    - * @loader: #GPluginLoader instance performing the unload
    - * @plugin: #GPluginPlugin instance to unload
    - * @error: return location for a GError, or NULL
    + * @loader: The #GPluginLoader instance performing the unload.
    + * @plugin: The #GPluginPlugin instance to unload.
    + * @error: (nullable): The return location for a #GError, or %NULL.
    *
    - * This function is called by the plugin manager to ask a loader to unload the
    - * given plugin.
    + * This function is called by the plugin manager to ask @loader to unload
    + * @plugin.
    *
    - * Return value: TRUE if @plugin was unloaded successfully, FALSE otherwise
    + * Return value: %TRUE if @plugin was unloaded successfully, %FALSE otherwise.
    */
    gboolean
    gplugin_loader_unload_plugin(GPluginLoader *loader,
    @@ -174,9 +174,11 @@
    /**
    * gplugin_loader_class_get_supported_extensions:
    - * @klass: #GPluginLoader instance
    + * @klass: The #GPluginLoaderClass.
    *
    - * Returns a #GSList of string for which extensions the loader supports.
    + * Returns a #GSList of strings containing the extensions that the loader
    + * supports. Each extension should not include the dot. For example: so,
    + * dll, py, etc.
    *
    * Return value: (element-type utf8) (transfer container): A #GSList of
    * extensions that the loader supports.
    @@ -190,4 +192,3 @@
    return NULL;
    }
    -
    --- a/gplugin/gplugin-loader.h Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-loader.h Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    --- a/gplugin/gplugin-manager.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-manager.c Tue Feb 18 01:28:55 2020 -0600
    @@ -380,7 +380,7 @@
    GPluginPluginState state =
    gplugin_plugin_get_state(plugin);
    - /* The plugin is in our "view", check it's state. If it's
    + /* The plugin is in our "view", check its state. If it's
    * queried or loaded, move on to the next one.
    */
    if(state == GPLUGIN_PLUGIN_STATE_QUERIED ||
    @@ -409,7 +409,7 @@
    filename,
    &error);
    - /* Check the GError, if it's set, output it's message and
    + /* Check the GError, if it's set, output its message and
    * try the next loader.
    */
    if(plugin == NULL || error) {
    @@ -1056,7 +1056,7 @@
    /**
    * gplugin_manager_append_path:
    - * @path: A path to add to the end of the plugin search paths
    + * @path: A path to add to the end of the plugin search paths.
    *
    * Adds @path to the end of the list of paths to search for plugins.
    */
    @@ -1075,7 +1075,7 @@
    /**
    * gplugin_manager_prepend_path:
    - * @path: A path to add to the beginning of the plugin search paths
    + * @path: A path to add to the beginning of the plugin search paths.
    *
    * Adds @path to the beginning of the list of paths to search for plugins.
    */
    @@ -1094,7 +1094,7 @@
    /**
    * gplugin_manager_remove_path:
    - * @path: A path to remove from the plugin search paths
    + * @path: A path to remove from the plugin search paths.
    *
    * Removes @path from the list of paths to search for plugins.
    */
    @@ -1133,7 +1133,8 @@
    * gplugin_manager_add_default_paths:
    *
    * Adds the path that GPlugin was installed to to the plugin search path, as
    - * well as ${XDG_CONFIG_HOME}/gplugin.
    + * well as `${XDG_CONFIG_HOME}/gplugin` so users can install additional loaders
    + * themselves.
    */
    void
    gplugin_manager_add_default_paths(void) {
    @@ -1155,8 +1156,8 @@
    * @appname: The name of the application whose paths to add.
    *
    * Adds the application installation path for @appname. This will add
    - * $prefix/@appname/plugins to the list as well as
    - * ${XDG_CONFIG_HOME}/@appname/plugins.
    + * `@prefix/@appname/plugins` to the list as well as
    + * `${XDG_CONFIG_HOME}/@appname/plugins`.
    */
    void
    gplugin_manager_add_app_paths(const gchar *prefix,
    @@ -1178,10 +1179,10 @@
    /**
    * gplugin_manager_get_paths:
    *
    - * Gets the list of paths which will be search for plugins.
    + * Gets the list of paths which will be searched for plugins.
    *
    - * Return value: (element-type utf8) (transfer none): list of paths which will
    - * be searched for plugins.
    + * Returns: (element-type utf8) (transfer none): The list of paths which will
    + * be searched for plugins.
    */
    GList *
    gplugin_manager_get_paths(void) {
    @@ -1199,7 +1200,7 @@
    /**
    * gplugin_manager_register_loader:
    - * @type: #GType of a #GPluginLoader
    + * @type: #GType of a #GPluginLoader.
    *
    * Registers @type as an available loader.
    */
    @@ -1217,7 +1218,7 @@
    /**
    * gplugin_manager_unregister_loader:
    - * @type: #GType of a #GPluginLoader
    + * @type: #GType of a #GPluginLoader.
    *
    * Unregisters @type as an available loader.
    */
    @@ -1252,14 +1253,14 @@
    /**
    * gplugin_manager_find_plugins:
    - * @id: id string of the plugin to find
    + * @id: id string of the plugin to find.
    *
    * Finds all plugins matching @id.
    *
    - * Return value: (element-type GPlugin.Plugin) (transfer full): A #GSList of
    - * referenced #GPluginPlugin's matching @id. Call
    - * #gplugin_manager_free_plugin_list on the returned value
    - * when you're done with it.
    + * Returns: (element-type GPlugin.Plugin) (transfer full): A #GSList of
    + * referenced #GPluginPlugin's matching @id. Call
    + * #gplugin_manager_free_plugin_list on the returned value when you're
    + * done with it.
    */
    GSList *
    gplugin_manager_find_plugins(const gchar *id) {
    @@ -1368,9 +1369,9 @@
    /**
    * gplugin_manager_free_plugin_list:
    * @plugins_list: (element-type GPlugin.Plugin) (nullable): Returned value from
    - * #gplugin_manager_find_plugins
    + * #gplugin_manager_find_plugins.
    *
    - * Frees the return value of #gplugin_manager_find_plugins.
    + * Frees the returned value of #gplugin_manager_find_plugins.
    */
    void
    gplugin_manager_free_plugin_list(GSList *plugins_list) {
    @@ -1422,12 +1423,12 @@
    /**
    * gplugin_manager_get_plugin_dependencies:
    * @plugin: The #GPluginPlugin whose dependencies to get.
    - * @error: Return address for a #GError.
    + * @error: (out) (nullable): Return address for a #GError.
    *
    * Returns a list of all the #GPluginPlugin's that @plugin depends on.
    *
    * Return value: (element-type GPlugin.Plugin) (transfer full): A #GSList of
    - * #GPluginPlugin's that @plugin depends on, or NULL on error
    + * #GPluginPlugin's that @plugin depends on, or %NULL on error
    * with @error set. Call #gplugin_manager_free_plugin_list on
    * the returned value when you're done with it.
    */
    @@ -1451,15 +1452,15 @@
    /**
    * gplugin_manager_load_plugin:
    - * @plugin: #GPluginPlugin instance
    - * @error: (out): return location for a #GError or null
    + * @plugin: #GPluginPlugin instance.
    + * @error: (out) (nullable): return location for a #GError or %NULL.
    *
    - * Loads @plugin and all of it's dependencies. If a dependency can not be
    + * Loads @plugin and all of its dependencies. If a dependency can not be
    * loaded, @plugin will not be loaded either. However, any other plugins that
    * @plugin depends on that were loaded from this call, will not be unloaded.
    *
    - * Return value: TRUE if @plugin was loaded successfully or already loaded,
    - * FALSE otherwise.
    + * Return value: %TRUE if @plugin was loaded successfully or already loaded,
    + * %FALSE otherwise.
    */
    gboolean
    gplugin_manager_load_plugin(GPluginPlugin *plugin, GError **error) {
    @@ -1480,13 +1481,13 @@
    /**
    * gplugin_manager_unload_plugin:
    - * @plugin: #GPluginPlugin instance
    - * @error: (out): return location for a #GError or null
    + * @plugin: #GPluginPlugin instance.
    + * @error: (out) (nullable): Return location for a #GError or %NULL.
    *
    * Unloads @plugin. If @plugin has dependencies, they are not unloaded.
    *
    - * Return value: TRUE if @plugin was unloaded successfully or not loaded,
    - * FALSE otherwise.
    + * Returns: %TRUE if @plugin was unloaded successfully or not loaded, %FALSE
    + * otherwise.
    */
    gboolean
    gplugin_manager_unload_plugin(GPluginPlugin *plugin, GError **error) {
    @@ -1538,8 +1539,8 @@
    * This is provided so that signals can be connected and should not be tinkered
    * with in any way.
    *
    - * Return Value: (transfer none): The #GObject that is the instance of the
    - * plugin manager.
    + * Returns: (transfer none): The #GObject that is the instance of the plugin
    + * manager.
    */
    GObject *
    gplugin_manager_get_instance(void) {
    @@ -1548,4 +1549,3 @@
    return NULL;
    }
    -
    --- a/gplugin/gplugin-native-loader.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-native-loader.c Tue Feb 18 01:28:55 2020 -0600
    @@ -31,14 +31,6 @@
    #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.
    - */
    -
    -/**
    * GPLUGIN_TYPE_NATIVE_LOADER:
    *
    * The standard _get_type macro for #GPluginNativeLoader.
    --- a/gplugin/gplugin-native-plugin.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-native-plugin.c Tue Feb 18 01:28:55 2020 -0600
    @@ -27,15 +27,6 @@
    #include <glib/gi18n-lib.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.
    - */
    -
    -/**
    * GPLUGIN_TYPE_NATIVE_PLUGIN:
    *
    * The standard _get_type macro for #GPluginNativePlugin.
    --- a/gplugin/gplugin-options.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-options.c Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -97,7 +97,8 @@
    * g_option_context_add_group(), if you are using g_option_context_parse() to
    * parse your commandline arguments.
    *
    - * GPlugin must be initialized before you call this function.
    + * If #gplugin_init() has yet to be called before #g_option_context_parse() is
    + * called, #gplugin_init() will be called automatically.
    *
    * Return Value: (transfer full): a #GOptionGroup for the commandline arguments
    * recognized by GPlugin.
    @@ -116,4 +117,3 @@
    return group;
    }
    -
    --- a/gplugin/gplugin-options.h Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-options.h Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -23,7 +23,6 @@
    #define GPLUGIN_OPTIONS_H
    #include <glib.h>
    -#include <glib-object.h>
    G_BEGIN_DECLS
    @@ -32,4 +31,3 @@
    G_END_DECLS
    #endif /* GPLUGIN_OPTIONS_H */
    -
    --- a/gplugin/gplugin-plugin-info.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-plugin-info.c Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -24,7 +24,7 @@
    /**
    * SECTION:gplugin-plugin-info
    * @Title: Plugin Info Objects
    - * @Short_description: information about plugins
    + * @Short_description: information about plugins.
    *
    * #GPluginPluginInfo holds metadata for plugins.
    */
    @@ -474,7 +474,7 @@
    * format: &lt;application or library&gt;/&lt;name of the plugin&gt;.
    *
    * For example, the python loader in GPlugin has an id of
    - * "gplugin/python-plugin-loader".
    + * "gplugin/python-loader".
    */
    properties[PROP_ID] = g_param_spec_string(
    "id", "id",
    @@ -489,14 +489,16 @@
    *
    * The GPlugin ABI version that the plugin was compiled against.
    *
    - * GPlugin only uses the first byte (0xff000000) of this value. The
    + * GPlugin only uses the first byte (`0xff000000`) of this value. The
    * remaining 3 bytes are available for the application to use.
    *
    * Take the following example from an application:
    *
    + * |[<!-- language="C" -->
    * #define ABI_VERSION (GPLUGIN_NATIVE_ABI_VERSION |
    * (APPLICATION_MAJOR_VERSION << 8) |
    * (APPLICATION_MINOR_VERSION))
    + * ]|
    *
    * The application here uses the thrid and fourth bytes, but could use
    * the second as well.
    @@ -513,7 +515,7 @@
    *
    * Whether or not the plugin is considered an "internal" plugin.
    *
    - * Defaults to FALSE.
    + * Defaults to %FALSE.
    */
    properties[PROP_INTERNAL] = g_param_spec_boolean(
    "internal", "internal",
    @@ -530,7 +532,7 @@
    * This is used by the loaders and may be useful to your application as
    * well.
    *
    - * Defaults to FALSE.
    + * Defaults to %FALSE.
    */
    properties[PROP_LOQ] = g_param_spec_boolean(
    "load-on-query", "load-on-query",
    @@ -542,7 +544,7 @@
    /**
    * GPluginPluginInfo:bind-local:
    *
    - * Determines whether the plugin should be have it's symbols bound locally.
    + * Determines whether the plugin should be have its symbols bound locally.
    *
    * Note: This should only be used by the native plugin loader.
    */
    @@ -568,7 +570,7 @@
    /**
    * GPluginPluginInfo:version:
    *
    - * The version of the plugin.
    + * The version of the plugin. Preferably a semantic version.
    */
    properties[PROP_VERSION] = g_param_spec_string(
    "version", "version",
    @@ -583,8 +585,8 @@
    * The short name of the license.
    *
    * It is recommended to use the identifier of the license from
    - * http://dep.debian.net/deps/dep5/#license-specification and should be
    - * "Other" for licenses that are not mentioned in DEP5.
    + * https://spdx.org/licenses/ and should be "Other" for licenses that are
    + * not listed.
    *
    * If a plugin has multiple license, they should be separated by a pipe
    * (|). In the odd case that you have multiple licenses that are used at
    @@ -601,7 +603,7 @@
    * GPluginPluginInfo:license-text:
    *
    * The text of the license for this plugin. This should only be used when
    - * the plugin is licensed under a license that is not listed in DEP5.
    + * the plugin is licensed under a license that is not listed at spdx.org.
    */
    properties[PROP_LICENSE_TEXT] = g_param_spec_string(
    "license-text", "license text",
    @@ -614,7 +616,7 @@
    * GPluginPluginInfo:license-url:
    *
    * The url to the text of the license. This should primarily only be used
    - * for licenses not listed in DEP5.
    + * for licenses not listed at spdx.org.
    */
    properties[PROP_LICENSE_URL] = g_param_spec_string(
    "license-url", "license url",
    @@ -682,11 +684,10 @@
    /**
    * GPluginPluginInfo:authors:
    *
    - * A gchar ** of the names and email addresses of the authors.
    + * A list of the names and email addresses of the authors.
    *
    * It is recommended to use the RFC 822, 2822 format of:
    - * "First Last <user@domain.com>" with additional authors separated by a
    - * comma.
    + * "`First Last <user@domain.com>".
    */
    properties[PROP_AUTHORS] = g_param_spec_boxed(
    "authors", "authors",
    @@ -740,18 +741,18 @@
    /**
    * gplugin_plugin_info_new: (skip)
    - * @id: The id of the plugin
    - * @abi_version: The GPlugin ABI version that the plugin uses
    + * @id: The id of the plugin.
    + * @abi_version: The GPlugin ABI version that the plugin uses.
    * @...: name/value pairs of properties to set, followed by %NULL.
    *
    * Creates a new GPluginPluginInfo instance.
    *
    - * Returns: The new GPluginPluginInfo instance.
    + * Returns: (transfer full): The new GPluginPluginInfo instance.
    */
    /**
    * gplugin_plugin_info_get_id:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the id that the plugin identifies itself as.
    *
    @@ -770,7 +771,7 @@
    /**
    * gplugin_plugin_info_get_abi_version:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the ABI or Application Binary Interface version that the plugin
    * is supposed to work against.
    @@ -790,13 +791,13 @@
    /**
    * gplugin_plugin_info_get_internal:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns where or not this plugin is is considered an internal plugin. An
    * internal plugin would be something like a plugin loader or another plugin
    * that should not be shown to users.
    *
    - * Returns: TRUE if the plugin is internal, FALSE otherwise.
    + * Returns: %TRUE if the plugin is internal, %FALSE otherwise.
    */
    gboolean
    gplugin_plugin_info_get_internal(GPluginPluginInfo *info) {
    @@ -811,14 +812,14 @@
    /**
    * gplugin_plugin_info_get_load_on_query:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns whether or not this plugin should be loaded when queried. This is
    * useful for internal plugins that are adding functionality and should always
    * be turned on. The plugin loaders use this to make sure all plugins can
    * always be loaded.
    *
    - * Returns: TRUE if the plugin should be loaded on query, FALSE otherwise.
    + * Returns: %TRUE if the plugin should be loaded on query, %FALSE otherwise.
    */
    gboolean
    gplugin_plugin_info_get_load_on_query(GPluginPluginInfo *info) {
    @@ -833,7 +834,7 @@
    /**
    * gplugin_plugin_info_get_name:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the name of the plugin as specified in @info.
    *
    @@ -852,7 +853,7 @@
    /**
    * gplugin_plugin_info_get_version:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the version of the plugin as specified in @info.
    *
    @@ -871,7 +872,7 @@
    /**
    * gplugin_plugin_info_get_license_id:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the liences id for the plugin as specified in @info.
    *
    @@ -890,7 +891,7 @@
    /**
    * gplugin_plugin_info_get_license_text:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the license text for the plugin as specified in @info.
    *
    @@ -909,7 +910,7 @@
    /**
    * gplugin_plugin_info_get_license_url:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the url of the license for the plugin as specified in @info
    *
    @@ -928,7 +929,7 @@
    /**
    * gplugin_plugin_info_get_icon:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the name of the icon for the plugin as specified in @info.
    *
    @@ -947,7 +948,7 @@
    /**
    * gplugin_plugin_info_get_summary:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the summery for the plugin as specified in @info.
    *
    @@ -966,7 +967,7 @@
    /**
    * gplugin_plugin_info_get_description:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the description for the plugin as specified in @info.
    *
    @@ -985,7 +986,7 @@
    /**
    * gplugin_plugin_info_get_category:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the category of the plugin as specified in @info.
    *
    @@ -1004,7 +1005,7 @@
    /**
    * gplugin_plugin_info_get_authors:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the authors of the plugin as specified in @info.
    *
    @@ -1023,7 +1024,7 @@
    /**
    * gplugin_plugin_info_get_help:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the help text for the plugin as specified in @info.
    *
    @@ -1042,7 +1043,7 @@
    /**
    * gplugin_plugin_info_get_website:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the website for the plugin as specified in @info.
    *
    @@ -1061,7 +1062,7 @@
    /**
    * gplugin_plugin_info_get_dependencies:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * Returns the dependencies of the plugins as specified in @info.
    *
    @@ -1081,12 +1082,12 @@
    /**
    * gplugin_plugin_info_get_bind_local:
    - * @info: #GPluginPluginInfo instance
    + * @info: The #GPluginPluginInfo instance.
    *
    * This function is only used by the native plugin loader.
    *
    - * Returns: TRUE if the plugin has requested to be loaded with it's symbols
    - * bound locally, FALSE if they should bind be bound globally.
    + * Returns: %TRUE if the plugin has requested to be loaded with its symbols
    + * bound locally, %FALSE if they should bind be bound globally.
    */
    gboolean
    gplugin_plugin_info_get_bind_local(GPluginPluginInfo *info) {
    @@ -1098,4 +1099,3 @@
    return priv->bind_local;
    }
    -
    --- a/gplugin/gplugin-plugin-info.h Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-plugin-info.h Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -69,4 +69,3 @@
    G_END_DECLS
    #endif /* GPLUGIN_PLUGIN_INFO_H */
    -
    --- a/gplugin/gplugin-plugin.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-plugin.c Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -22,25 +22,25 @@
    /**
    * SECTION:gplugin-plugin
    - * @Title: Plugin Objects
    - * @Short_description: abstract plugin implementation
    + * @Title: Plugin Interface
    + * @Short_description: The plugin interface that all plugins must implement.
    *
    - * #GPluginPlugin is an abstract class that tracks the state of a plugin. It
    - * is subclassed by each loader for them to add additional data for their
    + * #GPluginPlugin is an interface that defines the behavior of plugins. It
    + * is implemented by each loader which add additional data for their
    * implementation.
    */
    /**
    * GPluginPluginState:
    - * @GPLUGIN_PLUGIN_STATE_UNKNOWN: The state of the plugin is unknown
    + * @GPLUGIN_PLUGIN_STATE_UNKNOWN: The state of the plugin is unknown.
    * @GPLUGIN_PLUGIN_STATE_ERROR: There was an error loading or unloading the
    - * plugin
    - * @GPLUGIN_PLUGIN_STATE_QUERIED: The plugin has been queried but not loaded
    - * @GPLUGIN_PLUGIN_STATE_REQUERY: The plugin should be requeried
    - * @GPLUGIN_PLUGIN_STATE_LOADED: The plugin is loaded
    - * @GPLUGIN_PLUGIN_STATE_LOAD_FAILED: The plugin failed to load
    + * plugin.
    + * @GPLUGIN_PLUGIN_STATE_QUERIED: The plugin has been queried but not loaded.
    + * @GPLUGIN_PLUGIN_STATE_REQUERY: The plugin should be requeried.
    + * @GPLUGIN_PLUGIN_STATE_LOADED: The plugin is loaded.
    + * @GPLUGIN_PLUGIN_STATE_LOAD_FAILED: The plugin failed to load.
    *
    - * The expected states of a plugin.
    + * The known states of a plugin.
    */
    /**
    @@ -57,7 +57,8 @@
    /**
    * GPluginPluginInterface:
    - * @state_changed: The class closure for the #GPluginPlugin::state-changed signal.
    + * @state_changed: The class closure for the #GPluginPlugin::state-changed
    + * signal.
    *
    * The interface that defines the behavior of plugins, including properties and
    * signals.
    @@ -162,11 +163,11 @@
    /**
    * gplugin_plugin_get_filename:
    - * @plugin: #GPluginPlugin instance
    + * @plugin: The #GPluginPlugin instance.
    *
    * Returns the filename that @plugin was loaded from.
    *
    - * Returns: (transfer full): The filename of @plugin
    + * Returns: (transfer full): The filename of @plugin.
    */
    gchar *
    gplugin_plugin_get_filename(GPluginPlugin *plugin) {
    @@ -181,11 +182,11 @@
    /**
    * gplugin_plugin_get_loader:
    - * @plugin: #GPluginPlugin instance
    + * @plugin: The #GPluginPlugin instance.
    *
    * Returns the #GPluginLoader that loaded @plugin.
    *
    - * Returns: (transfer full): The #GPluginLoader that loaded @plugin
    + * Returns: (transfer full): The #GPluginLoader that loaded @plugin.
    */
    GPluginLoader *
    gplugin_plugin_get_loader(GPluginPlugin *plugin) {
    @@ -200,11 +201,11 @@
    /**
    * gplugin_plugin_get_info:
    - * @plugin: #GPluginPlugin instance
    + * @plugin: The #GPluginPlugin instance.
    *
    * Returns the #GPluginPluginInfo for @plugin.
    *
    - * Returns: (transfer full): The #GPluginPluginInfo instance for @plugin
    + * Returns: (transfer full): The #GPluginPluginInfo instance for @plugin.
    */
    GPluginPluginInfo *
    gplugin_plugin_get_info(GPluginPlugin *plugin) {
    @@ -219,11 +220,11 @@
    /**
    * gplugin_plugin_get_state:
    - * @plugin: #GPluginPlugin instance
    + * @plugin: The #GPluginPlugin instance.
    *
    - * Gets the current state of @plugin
    + * Gets the current state of @plugin.
    *
    - * Returns: (transfer full): The current state of @plugin
    + * Returns: (transfer full): The current state of @plugin.
    */
    GPluginPluginState
    gplugin_plugin_get_state(GPluginPlugin *plugin) {
    @@ -238,8 +239,8 @@
    /**
    * gplugin_plugin_set_state:
    - * @plugin: #GPluginPlugin instance
    - * @state: new #GPluginPluginState for @plugin
    + * @plugin: The #GPluginPlugin instance.
    + * @state: A new #GPluginPluginState for @plugin.
    *
    * Changes the state of @plugin to @state. This function should only be called
    * by loaders.
    --- a/gplugin/gplugin-plugin.h Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-plugin.h Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -67,4 +67,3 @@
    G_END_DECLS
    #endif /* GPLUGIN_PLUGIN_H */
    -
    --- a/gplugin/gplugin-version.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-version.c Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2014 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -18,11 +18,11 @@
    /**
    * SECTION:gplugin-version
    * @Title: Version Information
    - * @Short_description: variables and functions to check the GPlugin version
    + * @Short_description: variables and functions to check the version of GPlugin.
    *
    - * GPlugin provides version information, primarily useful in configure
    - * checks for builds that have a configure script. Applications will
    - * not typically use the features described here.
    + * GPlugin provided version information, primarily useful when building against
    + * GPlugin. Applications will not typically use the features described here
    + * unless checking for new versions during builds.
    */
    #include <gplugin/gplugin-core.h>
    @@ -148,12 +148,12 @@
    /**
    * GPLUGIN_VERSION_CHECK:
    - * @major: the major version to compare for
    - * @minor: the minor version to compare for
    - * @micro: the micro version to compare for
    + * @major: The major version to compare for.
    + * @minor: The minor version to compare for.
    + * @micro: The micro version to compare for.
    *
    * Checks the version of the GPlugin library that is being compiled
    - * against. See gplugin_version_compare() for a runtime check.
    + * against.
    *
    * Returns: %TRUE if the version of the GPlugin header files
    * is the same as or newer than the passed-in version.
    @@ -161,9 +161,9 @@
    /**
    * gplugin_version_compare:
    - * @v1: The first version to compare
    - * @v2: The second version to compare
    - * @error: A #GError return address if there are any errors.
    + * @v1: The first version to compare.
    + * @v2: The second version to compare.
    + * @error: (out) (nullable): A #GError return address if there are any errors.
    *
    * A semantic version checker which ignores any characters after the micro
    * version.
    @@ -202,4 +202,3 @@
    return v2_mic - v1_mic;
    }
    -
    --- a/gplugin/gplugin-version.h.in Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/gplugin-version.h.in Tue Feb 18 01:28:55 2020 -0600
    @@ -1,5 +1,5 @@
    /*
    - * Copyright (C) 2011-2013 Gary Kramlich <grim@reaperworld.com>
    + * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    @@ -43,4 +43,3 @@
    G_END_DECLS
    #endif /* GPLUGIN_VERSION_H */
    -
    --- a/gplugin/reference/embedding.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/embedding.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -13,8 +13,8 @@
    </para>
    <para>
    - Using GPlugin is pretty simple and I'd like to think straight forward
    - since that's the way I designed it.
    + GPlugin was designed to be simple to implement and use. Initialization
    + and teardown examples can be found below.
    </para>
    </simplesect>
    @@ -30,14 +30,13 @@
    gplugin_manager_add_default_paths();
    /* Optionally tell GPlugin to look for plugins in application specific
    - * paths.
    + * paths. This will add `$PREFIX/lib/application`.
    */
    gplugin_manager_add_app_paths(PREFIX, "application");
    /* Once you're ready to find/load plugins call g_plugin_manager_refresh.
    */
    gplugin_manager_refresh();
    -
    </programlisting></informalexample>
    </para>
    </simplesect>
    @@ -51,4 +50,4 @@
    </programlisting></informalexample>
    </para>
    </simplesect>
    -</chapter>
    \ No newline at end of file
    +</chapter>
    --- a/gplugin/reference/gplugin-docs.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/gplugin-docs.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -11,10 +11,13 @@
    <abstract>
    <title>GPlugin &version;</title>
    <para>
    - GPlugin is a GObject based library that implements a reusable plugin system that
    - supports loading plugins in other languages
    - via loaders. GPlugin also implements
    - dependencies among the plugins.
    + GPlugin is a GObject based library that implements a reusable plugin
    + system that supports loading plugins in other languages via loaders.
    + GPlugin also implements dependencies among the plugins.
    + </para>
    + <para>
    + The latest version of this documentation can be found on-line at
    + <ulink role="online-location" url="https://docs.pidgin.im/gplugin/latest">https://docs.pidgin.im/gplugin/latest/</ulink>.
    </para>
    </abstract>
    </bookinfo>
    @@ -26,6 +29,7 @@
    <xi:include href="genie.xml"/>
    <xi:include href="lua.xml"/>
    <xi:include href="native-plugins.xml"/>
    + <xi:include href="perl.xml"/>
    <xi:include href="python.xml"/>
    <xi:include href="vala.xml"/>
    </part>
    @@ -39,23 +43,13 @@
    <part id="API">
    <title>API Reference</title>
    - <chapter id="coreapi">
    - <title>Core API</title>
    - <xi:include href="xml/gplugin-core.xml"/>
    - <xi:include href="xml/gplugin-loader.xml"/>
    - <xi:include href="xml/gplugin-manager.xml"/>
    - <xi:include href="xml/gplugin-options.xml"/>
    - <xi:include href="xml/gplugin-plugin-info.xml"/>
    - <xi:include href="xml/gplugin-plugin.xml"/>
    - <xi:include href="xml/gplugin-version.xml"/>
    - </chapter>
    -
    - <chapter id="nativeapi">
    - <title>Native API</title>
    -
    - <xi:include href="xml/gplugin-native-plugin.xml"/>
    - <xi:include href="xml/gplugin-native-loader.xml"/>
    - </chapter>
    + <xi:include href="xml/gplugin-core.xml"/>
    + <xi:include href="xml/gplugin-loader.xml"/>
    + <xi:include href="xml/gplugin-manager.xml"/>
    + <xi:include href="xml/gplugin-options.xml"/>
    + <xi:include href="xml/gplugin-plugin-info.xml"/>
    + <xi:include href="xml/gplugin-plugin.xml"/>
    + <xi:include href="xml/gplugin-version.xml"/>
    </part>
    <index id="api-index-full">
    --- a/gplugin/reference/lua.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/lua.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -24,33 +24,34 @@
    <para>
    The following is a basic Lua plugin.
    - <informalexample><programlisting>
    - local lgi = require 'lgi'
    - local GPlugin = lgi.GPlugin
    + </para>
    +
    + <informalexample><programlisting>
    + local lgi = require "lgi"
    + local GPlugin = lgi.GPlugin
    - function gplugin_query()
    - return GPlugin.PluginInfo {
    - id = "gplugin-lua/basic-plugin",
    - abi_version = 0x01020304,
    - name = "basic plugin",
    - category = "test",
    - version = "0.0.10",
    - license_id = "license-id",
    - summary = "basic lua plugin",
    - description = "description of the basic lua plugin",
    - authors = { "Gary Kramlich &lt;grim@reaperworld.com&gt;" },
    - website = "https://bitbucket.org/gplugin/gplugin/"
    - }
    - end
    + function gplugin_query()
    + return GPlugin.PluginInfo {
    + id = "gplugin-lua/basic-plugin",
    + abi_version = 0x01020304,
    + name = "basic plugin",
    + category = "test",
    + version = "0.0.10",
    + license_id = "license-id",
    + summary = "basic lua plugin",
    + description = "description of the basic lua plugin",
    + authors = { "Gary Kramlich &lt;grim@reaperworld.com&gt;" },
    + website = "https://bitbucket.org/gplugin/gplugin/"
    + }
    + end
    - function gplugin_load(plugin)
    - return true
    - end
    + function gplugin_load(plugin)
    + return true
    + end
    - function gplugin_unload(plugin)
    - return true
    - end
    - </programlisting></informalexample>
    - </para>
    + function gplugin_unload(plugin)
    + return true
    + end
    + </programlisting></informalexample>
    </simplesect>
    </chapter>
    --- a/gplugin/reference/meson.build Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/meson.build Tue Feb 18 01:28:55 2020 -0600
    @@ -7,6 +7,8 @@
    'gplugin-loader-tests.h',
    'gplugin-native-private.h',
    'gplugin-native.h',
    + 'gplugin-native-loader.h',
    + 'gplugin-native-plugin.h',
    'gplugin-private.h',
    'gplugin.h',
    ]
    @@ -29,7 +31,9 @@
    'genie.xml',
    'lua.xml',
    'native-plugins.xml',
    + 'perl.xml',
    'python.xml',
    + 'vala.xml',
    ]
    gnome.gtkdoc(DOC_MODULE,
    --- a/gplugin/reference/native-plugins.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/native-plugins.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -7,12 +7,12 @@
    <simplesect id="intro">
    <para>
    - Writing Native plugins is very simple, but since it's C/C++ it's a bit
    + Writing Native plugins is pretty simple, but since it's C/C++ it's a bit
    more complicated.
    </para>
    <para>
    - There are currently no C++ bindings and no intention to write them, but
    + There are currently no C++ bindings with no intention to write them, but
    the C API is still usable from C++.
    </para>
    </simplesect>
    @@ -25,17 +25,17 @@
    /* gplugin_plugin_query is called by the native loader to determine if
    * the plugin is loadable. It must have this signature and should
    - * return a valid GPluginPluginInfo if everything is fine. If something
    - * went wrong, error should be set to a valid GError and NULL should be
    - * returned.
    + * return a valid GPluginPluginInfo instance if everything is fine. If
    + * something went wrong, error should be set to a valid GError and NULL
    + * should be returned.
    */
    G_MODULE_EXPORT GPluginPluginInfo *
    gplugin_plugin_query(GError **error) {
    - /* Authors is a list of authors of the plugin. Generally these are
    - * in the "Name Surname &lt;user@domain.com&gt;" format.
    + /* Authors is a list of authors who worked on the plugin. Generally
    + * these are in the "Name Surname &lt;user@domain.com&gt;" format.
    */
    const gchar * const authors[] = {
    - "author",
    + "Author O &lt;author@example.com&gt;",
    NULL
    };
    @@ -77,4 +77,4 @@
    </programlisting></informalexample>
    </para>
    </simplesect>
    -</chapter>
    \ No newline at end of file
    +</chapter>
    --- a/gplugin/reference/python.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/python.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -24,33 +24,33 @@
    <para>
    The following is a basic Python plugin.
    - <informalexample><programlisting>
    - import gi
    + </para>
    - gi.require_version('GPlugin', '0.0')
    - from gi.repository import GPlugin
    + <informalexample><programlisting>
    + import gi
    +
    + gi.require_version("GPlugin", "0.0")
    + from gi.repository import GPlugin
    - def gplugin_plugin_query():
    - return GPlugin.PluginInfo(
    - id='gplugin-python/basic-plugin',
    - abi_version=0x01020304,
    - name='basic plugin',
    - authors=['author1'],
    - category='test',
    - version='version',
    - license_id='license',
    - summary='summary',
    - website='website',
    - description='description',
    - )
    + def gplugin_plugin_query():
    + return GPlugin.PluginInfo(
    + id="gplugin-python/basic-plugin",
    + abi_version=0x01020304,
    + name="basic plugin",
    + authors=["author1"],
    + category="test",
    + version="version",
    + license_id="license",
    + summary="summary",
    + website="website",
    + description="description",
    + )
    - def gplugin_plugin_load(plugin):
    - return True
    -
    + def gplugin_plugin_load(plugin):
    + return True
    - def gplugin_plugin_unload(plugin):
    - return True
    - </programlisting></informalexample>
    - </para>
    + def gplugin_plugin_unload(plugin):
    + return True
    + </programlisting></informalexample>
    </simplesect>
    </chapter>
    --- a/gplugin/reference/vala.xml Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/reference/vala.xml Tue Feb 18 01:28:55 2020 -0600
    @@ -8,8 +8,8 @@
    <warning>
    <para>
    You <emphasis role="strong">MUST</emphasis> have the Vala bindings
    - installed on your system for this to work. They are built by the
    - default GPlugin build.
    + installed on your system for this to work. They are built by
    + default.
    </para>
    </warning>
    @@ -29,46 +29,47 @@
    <para>
    The following is a basic Vala plugin.
    - <informalexample><programlisting>
    - using GPlugin;
    + </para>
    - public class BasicPluginInfo : GPlugin.PluginInfo {
    - public BasicPluginInfo() {
    - string[] authors = {"author1"};
    + <informalexample><programlisting>
    + using GPlugin;
    +
    + public class BasicPluginInfo : GPlugin.PluginInfo {
    + public BasicPluginInfo() {
    + string[] authors = {"author1"};
    - Object(
    - id: "gplugin/vala-basic-plugin",
    - abi_version: 0x01020304,
    - name: "basic plugin",
    - authors: authors,
    - category: "test",
    - version: "version",
    - license_id: "license",
    - summary: "summary",
    - website: "website",
    - description: "description"
    - );
    - }
    + Object(
    + id: "gplugin/vala-basic-plugin",
    + abi_version: 0x01020304,
    + name: "basic plugin",
    + authors: authors,
    + category: "test",
    + version: "version",
    + license_id: "license",
    + summary: "summary",
    + website: "website",
    + description: "description"
    + );
    }
    -
    - public GPlugin.PluginInfo gplugin_query(out Error error) {
    - error = null;
    + }
    - return new BasicPluginInfo();
    - }
    + public GPlugin.PluginInfo gplugin_query(out Error error) {
    + error = null;
    - public bool gplugin_load(GPlugin.Plugin plugin, out Error error) {
    - error = null;
    + return new BasicPluginInfo();
    + }
    - return true;
    - }
    + public bool gplugin_load(GPlugin.Plugin plugin, out Error error) {
    + error = null;
    +
    + return true;
    + }
    - public bool gplugin_unload(GPlugin.Plugin plugin, out Error error) {
    - error = null;
    + public bool gplugin_unload(GPlugin.Plugin plugin, out Error error) {
    + error = null;
    - return true;
    - }
    - </programlisting></informalexample>
    - </para>
    + return true;
    + }
    + </programlisting></informalexample>
    </simplesect>
    </chapter>
    --- a/gplugin/tests/test-bind-local.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/gplugin/tests/test-bind-local.c Tue Feb 18 01:28:55 2020 -0600
    @@ -27,7 +27,7 @@
    *****************************************************************************/
    /* This test kind of sucks because theres no way for us to lookup whether or
    - * not a module handle has had it's symbols bound locally. Therefore, right
    + * not a module handle has had its symbols bound locally. Therefore, right
    * now we have to settle to see if it was loaded correctly.
    */
    static void
    --- a/perl/gplugin-perl-loader.c Mon Feb 17 21:08:07 2020 -0600
    +++ b/perl/gplugin-perl-loader.c Tue Feb 18 01:28:55 2020 -0600
    @@ -96,7 +96,7 @@
    info = (GPluginPluginInfo *)gperl_get_object(POPs);
    /* if we did get a real GPluginPluginInfo ref it because the perl
    - * code below will take it out of scope and delete it if it's
    + * code below will take it out of scope and delete it if its
    * reference count is zero.
    */
    if(GPLUGIN_IS_PLUGIN_INFO(info)) {