[libpeas] Fix some documentation
- From: Garrett Regier <gregier src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libpeas] Fix some documentation
- Date: Tue, 22 Sep 2015 08:09:23 +0000 (UTC)
commit 63889482442b64226a382bd638b95fc18c0a470a
Author: Garrett Regier <garrettregier gmail com>
Date: Mon Sep 21 21:31:54 2015 -0700
Fix some documentation
libpeas/peas-engine.c | 7 +++----
libpeas/peas-object-module.c | 2 +-
libpeas/peas-plugin-loader-c.c | 2 +-
loaders/lua5.1/peas-plugin-loader-lua.c | 1 +
4 files changed, 6 insertions(+), 6 deletions(-)
---
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index d953f55..6776eb7 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -529,8 +529,7 @@ peas_engine_class_init (PeasEngineClass *klass)
*
* This will be modified when peas_engine_rescan_plugins() is called.
*
- * Note that the list belongs to the engine and should not be modified
- * or freed.
+ * Note: the list belongs to the engine and should not be modified or freed.
*/
properties[PROP_PLUGIN_LIST] =
g_param_spec_pointer ("plugin-list",
@@ -808,9 +807,9 @@ get_plugin_loader (PeasEngine *engine,
*
* Enable a loader, enables a loader for plugins.
* The C plugin loader is always enabled. The other plugin
- * loaders are: lua5.1 and python and python3.
+ * loaders are: lua5.1, python and python3.
*
- * For instance, the following code will enable python plugins
+ * For instance, the following code will enable Python 2 plugins
* to be loaded:
* |[
* peas_engine_enable_loader (engine, "python");
diff --git a/libpeas/peas-object-module.c b/libpeas/peas-object-module.c
index 3139f07..fb6f975 100644
--- a/libpeas/peas-object-module.c
+++ b/libpeas/peas-object-module.c
@@ -344,7 +344,7 @@ peas_object_module_new (const gchar *module_name,
* @resident: If the module should be resident.
* @local_linkage: Whether to load the module with local linkage.
*
- * Creates a new #PeasObjectModule with local linkage.
+ * Creates a new #PeasObjectModule.
*
* Return value: a new #PeasObjectModule.
*
diff --git a/libpeas/peas-plugin-loader-c.c b/libpeas/peas-plugin-loader-c.c
index 2f9dd69..a76ef9c 100644
--- a/libpeas/peas-plugin-loader-c.c
+++ b/libpeas/peas-plugin-loader-c.c
@@ -190,7 +190,7 @@ peas_plugin_loader_c_class_init (PeasPluginLoaderCClass *klass)
loader_class->create_extension = peas_plugin_loader_c_create_extension;
}
-/**
+/*
* peas_plugin_loader_c_new:
*
* Return a new instance of #PeasPluginLoaderC.
diff --git a/loaders/lua5.1/peas-plugin-loader-lua.c b/loaders/lua5.1/peas-plugin-loader-lua.c
index ca0924f..d4a78bb 100644
--- a/loaders/lua5.1/peas-plugin-loader-lua.c
+++ b/loaders/lua5.1/peas-plugin-loader-lua.c
@@ -102,6 +102,7 @@ thread_leave (PeasPluginLoaderLua *lua_loader,
PeasPluginLoaderLuaPrivate *priv = GET_PRIV (lua_loader);
lua_State *L = info->loader_data;
+ /* Prevent keeping the L as a usable variable */
g_assert (*L_ptr == L);
*L_ptr = NULL;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]