[libpeas] Fix GI Annotations for va_rarg, va_list and alternative functions



commit b4973d84c8978c4c8933e09d0b3c91a84177e303
Author: Garrett Regier <alias301 gmail com>
Date:   Wed Jan 19 02:48:59 2011 -0800

    Fix GI Annotations for va_rarg, va_list and alternative functions

 libpeas/peas-engine.c        |   13 ++++++++-----
 libpeas/peas-extension-set.c |   14 +++++++++-----
 libpeas/peas-extension.c     |   19 +++++++++++++++++--
 3 files changed, 34 insertions(+), 12 deletions(-)
---
diff --git a/libpeas/peas-engine.c b/libpeas/peas-engine.c
index 0294fc0..0fb835d 100644
--- a/libpeas/peas-engine.c
+++ b/libpeas/peas-engine.c
@@ -917,7 +917,8 @@ peas_engine_provides_extension (PeasEngine     *engine,
  * @info: A loaded #PeasPluginInfo.
  * @extension_type: The implemented extension #GType.
  * @n_parameters: the length of the @parameters array.
- * @parameters: an array of #GParameter.
+ * @parameters: (allow-none) (array length=n_parameters):
+ *   an array of #GParameter.
  *
  * If the plugin identified by @info implements the @extension_type interface,
  * then this function will return a new instance of this implementation,
@@ -927,6 +928,8 @@ peas_engine_provides_extension (PeasEngine     *engine,
  *
  * Returns: (transfer full): a new instance of #PeasExtension wrapping
  * the @extension_type instance, or %NULL.
+ *
+ * Rename to: peas_engine_create_extension
  */
 PeasExtension *
 peas_engine_create_extensionv (PeasEngine     *engine,
@@ -946,7 +949,7 @@ peas_engine_create_extensionv (PeasEngine     *engine,
 }
 
 /**
- * peas_engine_create_extension_valist:
+ * peas_engine_create_extension_valist: (skip)
  * @engine: A #PeasEngine.
  * @info: A loaded #PeasPluginInfo.
  * @extension_type: The implemented extension #GType.
@@ -960,7 +963,7 @@ peas_engine_create_extensionv (PeasEngine     *engine,
  *
  * See peas_engine_create_extension() for more information.
  *
- * Returns: (transfer full): a new instance of #PeasExtension wrapping
+ * Returns: a new instance of #PeasExtension wrapping
  * the @extension_type instance, or %NULL.
  */
 PeasExtension *
@@ -996,7 +999,7 @@ peas_engine_create_extension_valist (PeasEngine     *engine,
 }
 
 /**
- * peas_engine_create_extension:
+ * peas_engine_create_extension: (skip)
  * @engine: A #PeasEngine.
  * @info: A loaded #PeasPluginInfo.
  * @extension_type: The implemented extension #GType.
@@ -1017,7 +1020,7 @@ peas_engine_create_extension_valist (PeasEngine     *engine,
  * principle of never giving you the actual object (also because it might as
  * well *not* be an actual object).
  *
- * Returns: (transfer full): a new instance of #PeasExtension wrapping
+ * Returns: a new instance of #PeasExtension wrapping
  * the @extension_type instance, or %NULL.
  */
 PeasExtension *
diff --git a/libpeas/peas-extension-set.c b/libpeas/peas-extension-set.c
index 6ed7ba0..4f3322e 100644
--- a/libpeas/peas-extension-set.c
+++ b/libpeas/peas-extension-set.c
@@ -472,7 +472,7 @@ peas_extension_set_get_extension (PeasExtensionSet *set,
 }
 
 /**
- * peas_extension_set_call:
+ * peas_extension_set_call: (skip)
  * @set: A #PeasExtensionSet.
  * @method_name: the name of the method that should be called.
  * @Varargs: arguments for the method.
@@ -499,7 +499,7 @@ peas_extension_set_call (PeasExtensionSet *set,
 }
 
 /**
- * peas_extension_set_call_valist:
+ * peas_extension_set_call_valist: (skip)
  * @set: A #PeasExtensionSet.
  * @method_name: the name of the method that should be called.
  * @va_args: the arguments for the method.
@@ -547,6 +547,8 @@ peas_extension_set_call_valist (PeasExtensionSet *set,
  * See peas_extension_callv() for more information.
  *
  * Return value: %TRUE on successful call.
+ *
+ * Rename to: peas_extension_set_call
  */
 gboolean
 peas_extension_set_callv (PeasExtensionSet *set,
@@ -567,13 +569,15 @@ peas_extension_set_callv (PeasExtensionSet *set,
  * @engine: A #PeasEngine.
  * @exten_type: the extension #GType.
  * @n_parameters: the length of the @parameters array.
- * @parameters: an array of #GParameter.
+ * @parameters: (array length=n_parameters): an array of #GParameter.
  *
  * Create a new #PeasExtensionSet for the @exten_type extension type.
  *
  * See peas_extension_set_new() for more information.
  *
  * Returns: (transfer full): a new instance of #PeasExtensionSet.
+ *
+ * Rename to: peas_extension_set_new
  */
 PeasExtensionSet *
 peas_extension_set_newv (PeasEngine *engine,
@@ -591,7 +595,7 @@ peas_extension_set_newv (PeasEngine *engine,
 }
 
 /**
- * peas_extension_set_new_valist:
+ * peas_extension_set_new_valist: (skip)
  * @engine: A #PeasEngine.
  * @exten_type: the extension #GType.
  * @first_property: the name of the first property.
@@ -636,7 +640,7 @@ peas_extension_set_new_valist (PeasEngine  *engine,
 }
 
 /**
- * peas_extension_set_new:
+ * peas_extension_set_new: (skip)
  * @engine: A #PeasEngine.
  * @exten_type: the extension #GType.
  * @first_property: the name of the first property.
diff --git a/libpeas/peas-extension.c b/libpeas/peas-extension.c
index e5820d9..c102ade 100644
--- a/libpeas/peas-extension.c
+++ b/libpeas/peas-extension.c
@@ -170,7 +170,7 @@ peas_extension_get_extension_type (PeasExtension *exten)
 }
 
 /**
- * peas_extension_call:
+ * peas_extension_call: (skip)
  * @exten: A #PeasExtension.
  * @method_name: the name of the method that should be called.
  * @Varargs: arguments for the method.
@@ -209,7 +209,7 @@ peas_extension_call (PeasExtension *exten,
 }
 
 /**
- * peas_extension_call_valist:
+ * peas_extension_call_valist: (skip)
  * @exten: A #PeasExtension.
  * @method_name: the name of the method that should be called.
  * @args: the arguments for the method.
@@ -257,6 +257,21 @@ peas_extension_call_valist (PeasExtension *exten,
   return ret;
 }
 
+/**
+ * peas_extension_callv:
+ * @exten: A #PeasExtension.
+ * @method_name: the name of the method that should be called.
+ * @args: the arguments for the method.
+ * @return_value: the return falue for the method.
+ *
+ * Call a method of the object behind @extension, using @args as arguments.
+ *
+ * See peas_extension_call() for more information.
+ *
+ * Return value: (transfer full): %TRUE on successful call.
+ *
+ * Rename to: peas_extension_call
+ */
 gboolean
 peas_extension_callv (PeasExtension *exten,
                       const gchar   *method_name,



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