[libpeas] A few documentation fixes
- From: Garrett Regier <gregier src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libpeas] A few documentation fixes
- Date: Mon, 26 Jul 2010 11:12:02 +0000 (UTC)
commit a9d59b302024bad7b1349c7021646956aa60904d
Author: Garrett Regier <alias301 gmail com>
Date: Mon Jul 26 04:02:50 2010 -0700
A few documentation fixes
libpeas/peas-engine.c | 8 ++++++--
libpeas/peas-extension.c | 2 +-
libpeas/peas-object-module.c | 2 +-
libpeas/peas-plugin-info.c | 2 +-
4 files changed, 9 insertions(+), 5 deletions(-)
---
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index ea8119c..044c195 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -797,8 +797,10 @@ peas_engine_load_plugin_real (PeasEngine *engine,
* @info: A #PeasPluginInfo.
*
* Loads the plugin corresponding to @info if it's not currently loaded.
+ * Emits the "load-plugin" signal; loading the plugin
+ * actually occurs in the default signal handler.
*
- * Returns: whether the plugin has been successfuly loaded.
+ * Returns: whether the plugin has been successfully loaded.
*/
gboolean
peas_engine_load_plugin (PeasEngine *engine,
@@ -844,8 +846,10 @@ peas_engine_unload_plugin_real (PeasEngine *engine,
* @info: A #PeasPluginInfo.
*
* Unloads the plugin corresponding to @info.
+ * Emits the "unload-plugin" signal; unloading the plugin
+ * actually occurs in the default signal handler.
*
- * Returns: whether the plugin has been successfuly unloaded.
+ * Returns: whether the plugin has been successfully unloaded.
*/
gboolean
peas_engine_unload_plugin (PeasEngine *engine,
diff --git a/libpeas/peas-extension.c b/libpeas/peas-extension.c
index 3677596..8a8e559 100644
--- a/libpeas/peas-extension.c
+++ b/libpeas/peas-extension.c
@@ -86,7 +86,7 @@ peas_extension_class_init (PeasExtensionClass *klass)
* return type is not void, then a pointer to a variable of that type should
* be passed as the last argument.
*
- * For instance, if the method protoype is:
+ * For instance, if the method prototype is:
* |[ gint (*my_method) (MyClass *instance, const gchar *str, SomeObject *obj); ]|
* you should call peas_extension_call() this way:
* |[ peas_extension_call (extension, "my_method", "some_str", obj, &gint_var); ]|
diff --git a/libpeas/peas-object-module.c b/libpeas/peas-object-module.c
index 1ed79bb..5696a96 100644
--- a/libpeas/peas-object-module.c
+++ b/libpeas/peas-object-module.c
@@ -359,7 +359,7 @@ peas_object_module_get_library (PeasObjectModule *module)
* requested.
*
* This method is primarily meant to be used by native bindings (like gtkmm),
- * creatint native types which cannot be instantiated correctly using
+ * creating native types which cannot be instantiated correctly using
* g_object_new(). For other uses, you will usually prefer relying on
* peas_object_module_register_extension_type().
*/
diff --git a/libpeas/peas-plugin-info.c b/libpeas/peas-plugin-info.c
index 331bf9b..a3dd0da 100644
--- a/libpeas/peas-plugin-info.c
+++ b/libpeas/peas-plugin-info.c
@@ -600,7 +600,7 @@ peas_plugin_info_get_iage (const PeasPluginInfo *info)
* Gets a hash table of string keys present and #GValue values,
* present in the plugin information file, but not handled
* by libpeas. Note that libpeas only handles booleans and
- * strings, and that strings that are recognised as booleans,
+ * strings, and that strings that are recognized as booleans,
* as done by #g_key_file_get_boolean, will be of boolean type.
*
* Returns: a #GHashTable of string keys and #GValue values. Do
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]