grim/gplugin

Fix some issues found in review
feature/docs-review
2020-02-18, Gary Kramlich
679fc25edf7f
Parents 4b2c044b1f86
Children 953a9d10ec26
Fix some issues found in review
7 files changed, 14 insertions(+), 14 deletions(-)
  • +1 -1
    gplugin-gtk/gplugin-gtk-store.c
  • +2 -2
    gplugin-gtk/gplugin-gtk-view.c
  • +2 -2
    gplugin/gplugin-core.c
  • +2 -2
    gplugin/gplugin-loader.c
  • +2 -2
    gplugin/gplugin-options.c
  • +4 -4
    gplugin/gplugin-plugin-info.c
  • +1 -1
    gplugin/reference/native-plugins.xml
    • --- a/gplugin-gtk/gplugin-gtk-store.c Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin-gtk/gplugin-gtk-store.c Tue Feb 18 23:01:56 2020 -0600
    @@ -237,7 +237,7 @@
    *
    * Returns the columns that #GPluginGtkStore's will use.
    *
    - * Returns: (transfer none): A list of #GType's for the columes that the store
    + * Returns: (transfer none): A list of #GType's for the columns that the store
    * will use.
    */
    const GType *
    --- a/gplugin-gtk/gplugin-gtk-view.c Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin-gtk/gplugin-gtk-view.c Tue Feb 18 23:01:56 2020 -0600
    @@ -22,8 +22,8 @@
    /**
    * SECTION:gplugin-gtk-view
    - * @Title: GtkTreeView for plugins
    - * @Short_description: A view for plugins
    + * @title: GtkTreeView for plugins
    + * @short_description: A view for plugins
    *
    * #GPluginGtkView is a display widget for a list of plugins.
    */
    --- a/gplugin/gplugin-core.c Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin/gplugin-core.c Tue Feb 18 23:01:56 2020 -0600
    @@ -25,8 +25,8 @@
    /**
    * SECTION:gplugin-core
    - * @Title: Core API
    - * @Short_description: the core API
    + * @title: Core API
    + * @short_description: the core API
    *
    * This section contains the core API of GPlugin.
    */
    --- a/gplugin/gplugin-loader.c Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin/gplugin-loader.c Tue Feb 18 23:01:56 2020 -0600
    @@ -21,8 +21,8 @@
    /**
    * SECTION:gplugin-loader
    - * @Title: Plugin Loader
    - * @Short_description: Abstract class for loading plugins
    + * @title: Plugin Loader
    + * @short_description: Abstract class for loading plugins
    *
    * GPluginLoader defines the base behavior for loaders of all languages.
    */
    --- a/gplugin/gplugin-options.c Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin/gplugin-options.c Tue Feb 18 23:01:56 2020 -0600
    @@ -97,8 +97,8 @@
    * g_option_context_add_group(), if you are using g_option_context_parse() to
    * parse your commandline arguments.
    *
    - * If #gplugin_init() has yet to be called before #g_option_context_parse() is
    - * called, #gplugin_init() will be called automatically.
    + * 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.
    --- a/gplugin/gplugin-plugin-info.c Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin/gplugin-plugin-info.c Tue Feb 18 23:01:56 2020 -0600
    @@ -687,7 +687,7 @@
    * 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>".
    + * `"First Last <user@domain.com>"`.
    */
    properties[PROP_AUTHORS] = g_param_spec_boxed(
    "authors", "authors",
    @@ -745,9 +745,9 @@
    * @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.
    + * Creates a new #GPluginPluginInfo instance.
    *
    - * Returns: (transfer full): The new GPluginPluginInfo instance.
    + * Returns: (transfer full): The new #GPluginPluginInfo instance.
    */
    /**
    @@ -1087,7 +1087,7 @@
    * This function is only used by the native plugin loader.
    *
    * Returns: %TRUE if the plugin has requested to be loaded with its symbols
    - * bound locally, %FALSE if they should bind be bound globally.
    + * bound locally, %FALSE if they should be bound globally.
    */
    gboolean
    gplugin_plugin_info_get_bind_local(GPluginPluginInfo *info) {
    --- a/gplugin/reference/native-plugins.xml Tue Feb 18 03:56:13 2020 -0600
    +++ b/gplugin/reference/native-plugins.xml Tue Feb 18 23:01:56 2020 -0600
    @@ -12,7 +12,7 @@
    </para>
    <para>
    - There are currently no C++ bindings with no intention to write them, but
    + There are currently no C++ bindings and no intention to write them, but
    the C API is still usable from C++.
    </para>
    </simplesect>