gplugin/gplugin

Fix a bunch of stuff that was found in review
bugfix/docs-cleanup
2019-08-15, Gary Kramlich
ebea1f4d73fa
Parents 936498b316f1
Children 66388c55755d
Fix a bunch of stuff that was found in review
--- a/README.md Thu Aug 15 22:33:00 2019 -0500
+++ b/README.md Thu Aug 15 23:00:19 2019 -0500
@@ -2,8 +2,8 @@
GPlugin is a GObject based library that implements a reusable plugin system.
It supports loading plugins in multiple other languages via loaders. It relies
-heavily on [GObjectIntrospection](https://wiki.gnome.org/GObjectIntrospection)
-to expose its API to the other languages.
+heavily on [GObjectIntrospection](https://gi.readthedocs.io/) to expose its API
+to the other languages.
It has a simple API which makes it very easy to use in your application.
For more information on using GPlugin in your application, please see the
@@ -25,8 +25,8 @@
## API Reference
-The API reference can the default branch can be found at
+The API reference for the `default` branch can be found at
[docs.pidgin.im/gplugin/default](https://docs.pidgin.im/gplugin/default).
-The in development API reference for the develop branch can be found at
+The in-development API reference for the `develop` branch can be found at
[docs.pidgin.im/gplugin/develop](https://docs.pidgin.im/gplugin/develop).
--- a/gplugin-gtk/gplugin-gtk-store.c Thu Aug 15 22:33:00 2019 -0500
+++ b/gplugin-gtk/gplugin-gtk-store.c Thu Aug 15 23:00:19 2019 -0500
@@ -45,7 +45,7 @@
/**
* GPluginGtkStore:
*
- * A #GtkTreeStore that contains all of the known plugins in GPlugin.
+ * A #GtkListStore that contains all of the known plugins in GPlugin.
*/
struct _GPluginGtkStore {
--- a/gplugin/gplugin-loader.c Thu Aug 15 22:33:00 2019 -0500
+++ b/gplugin/gplugin-loader.c Thu Aug 15 23:00:19 2019 -0500
@@ -43,7 +43,8 @@
/**
* GPluginLoaderClass:
* @supported_extensions: The supported_extensions vfunc returns a #GList of
- * file extensions that this loader supports.
+ * file extensions that this loader supports without the
+ * leading dot. For example: 'so', 'dll', 'py', etc.
* @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
--- a/gplugin/reference/embedding.xml Thu Aug 15 22:33:00 2019 -0500
+++ b/gplugin/reference/embedding.xml Thu Aug 15 23:00:19 2019 -0500
@@ -23,13 +23,13 @@
During the start up of your application you need to add the following
code:
<informalexample><programlisting>
- /* initialize the gplugin library */
+ /* initialize the GPlugin library */
gplugin_init();
/* tell gplugin to look for plugins in its default paths */
gplugin_manager_add_default_paths();
- /* Optionally tell gplugin to look for plugins in application specific
+ /* Optionally tell GPlugin to look for plugins in application specific
* paths.
*/
gplugin_manager_add_app_paths(PREFIX, "application");
--- a/gplugin/reference/gplugin-docs.xml Thu Aug 15 22:33:00 2019 -0500
+++ b/gplugin/reference/gplugin-docs.xml Thu Aug 15 23:00:19 2019 -0500
@@ -23,8 +23,8 @@
<title>Tutorials</title>
<xi:include href="embedding.xml"/>
+ <xi:include href="native-plugins.xml"/>
<xi:include href="lua.xml"/>
- <xi:include href="native-plugins.xml"/>
<xi:include href="python.xml"/>
</part>
--- a/gplugin/reference/lua.xml Thu Aug 15 22:33:00 2019 -0500
+++ b/gplugin/reference/lua.xml Thu Aug 15 23:00:19 2019 -0500
@@ -39,7 +39,7 @@
summary = "basic lua plugin",
description = "description of the basic lua plugin",
authors = { "Gary Kramlich &lt;grim@reaperworld.com&gt;" },
- website = "http://bitbucket.org/gplugin/main/"
+ website = "https://bitbucket.org/gplugin/gplugin/"
}
end
--- a/gplugin/reference/native-plugins.xml Thu Aug 15 22:33:00 2019 -0500
+++ b/gplugin/reference/native-plugins.xml Thu Aug 15 23:00:19 2019 -0500
@@ -7,12 +7,13 @@
<simplesect id="intro">
<para>
- Writing Native plugins is like most other GPlugin Plugins very simple,
- but since it's C/C++ it's a bit more complicated.
+ Writing Native plugins is very 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.
+ There are currently no C++ bindings and no intention to write them, but
+ the C API is still usable from C++.
</para>
</simplesect>