[gimp] libgimp: add missing API docs-comment for gimp_procedure_new_arguments()
- From: Jehan <jehanp src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] libgimp: add missing API docs-comment for gimp_procedure_new_arguments()
- Date: Sun, 25 Apr 2021 11:11:30 +0000 (UTC)
commit d9778763639229a442d5da9936f8138bf66d0095
Author: Jehan <jehan girinstud io>
Date: Sun Apr 25 13:10:16 2021 +0200
libgimp: add missing API docs-comment for gimp_procedure_new_arguments()
libgimp/gimpprocedure.c | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
---
diff --git a/libgimp/gimpprocedure.c b/libgimp/gimpprocedure.c
index 60b7e662f7..2eae229e62 100644
--- a/libgimp/gimpprocedure.c
+++ b/libgimp/gimpprocedure.c
@@ -1683,6 +1683,19 @@ gimp_procedure_get_argument_sync (GimpProcedure *procedure,
return sync;
}
+/**
+ * gimp_procedure_new_arguments:
+ * @procedure: the #GimpProcedure.
+ *
+ * Format the expected argument values of procedures, in the order as
+ * added with gimp_procedure_add_argument().
+ *
+ * Returns: (transfer full): the expected #GimpValueArray which could be given as
+ * arguments to run @procedure, with all values set to
+ * defaults. Free with gimp_value_array_unref().
+ *
+ * Since: 3.0
+ **/
GimpValueArray *
gimp_procedure_new_arguments (GimpProcedure *procedure)
{
@@ -1719,7 +1732,7 @@ gimp_procedure_new_arguments (GimpProcedure *procedure)
* Format the expected return values from procedures, using the return
* values set with gimp_procedure_add_return_value().
*
- * Returns: the expected #GimpValueArray as could be returned by a
+ * Returns: (transfer full): the expected #GimpValueArray as could be returned by a
* #GimpRunFunc.
*
* Since: 3.0
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]