[libpeas] Add (array zero-terminated=1) annotation to API



commit 6a952cf25d5874074acda9dff1f0618d34c0a44c
Author: Garrett Regier <alias301 gmail com>
Date:   Fri Feb 11 01:44:35 2011 -0800

    Add (array zero-terminated=1) annotation to API

 libpeas/peas-engine.c      |    9 ++++++---
 libpeas/peas-plugin-info.c |    4 ++--
 2 files changed, 8 insertions(+), 5 deletions(-)
---
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index 55e760f..962fd84 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -1089,8 +1089,8 @@ peas_engine_create_extension (PeasEngine     *engine,
  * Please note that the returned array is a newly allocated one: you will need
  * to free it using g_strfreev().
  *
- * Returns: (transfer full): A newly-allocated %NULL-terminated
- * array of strings.
+ * Returns: (transfer full) (array zero-terminated=1): A newly-allocated
+ * %NULL-terminated array of strings.
  */
 gchar **
 peas_engine_get_loaded_plugins (PeasEngine *engine)
@@ -1131,11 +1131,14 @@ string_in_strv (const gchar  *needle,
 /**
  * peas_engine_set_loaded_plugins:
  * @engine: A #PeasEngine.
- * @plugin_names: A %NULL-terminated array of plugin names.
+ * @plugin_names: (allow-none) (array zero-terminated=1): A %NULL-terminated
+ *  array of plugin names, or %NULL.
  *
  * Sets the list of loaded plugins for @engine. When this function is called,
  * the #PeasEngine will load all the plugins whose names are in @plugin_names,
  * and ensures all other active plugins are unloaded.
+ *
+ * If @plugin_names is %NULL, all plugins will be unloaded.
  */
 void
 peas_engine_set_loaded_plugins (PeasEngine   *engine,
diff --git a/libpeas/peas-plugin-info.c b/libpeas/peas-plugin-info.c
index 478b60a..553aaf2 100644
--- a/libpeas/peas-plugin-info.c
+++ b/libpeas/peas-plugin-info.c
@@ -608,11 +608,11 @@ peas_plugin_info_get_icon_name (const PeasPluginInfo *info)
  * peas_plugin_info_get_authors:
  * @info: A #PeasPluginInfo.
  *
- * Gets a NULL-terminated array of strings with the authors of the plugin.
+ * Gets a %NULL-terminated array of strings with the authors of the plugin.
  *
  * The relevant key in the plugin info file is "Authors".
  *
- * Returns: (transfer none): the plugin's author list.
+ * Returns: (transfer none) (array zero-terminated=1): the plugin's author list.
  */
 const gchar **
 peas_plugin_info_get_authors (const PeasPluginInfo *info)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]