[gimp] libgimp: more docs and annotations



commit 41fb55298847c7f8456b1baa676b2f1928ee911f
Author: Michael Natterer <mitch gimp org>
Date:   Fri Aug 9 12:41:45 2019 +0200

    libgimp: more docs and annotations

 libgimp/gimppdb.c       | 31 +++++++++++++++++++++++++++++++
 libgimp/gimpprocedure.c |  6 ++++--
 2 files changed, 35 insertions(+), 2 deletions(-)
---
diff --git a/libgimp/gimppdb.c b/libgimp/gimppdb.c
index 149c3137d9..0733b79084 100644
--- a/libgimp/gimppdb.c
+++ b/libgimp/gimppdb.c
@@ -434,6 +434,21 @@ _gimp_pdb_error_quark (void)
 
 /*  Temporary API, to go away before 3.0  */
 
+/**
+ * gimp_pdb_proc_argument:
+ * @procedure_name: The procedure name.
+ * @arg_num: The argument number.
+ *
+ * Queries the procedural database for information on the specified
+ * procedure's argument.
+ *
+ * This procedure returns the #GParamSpec of procedure_name's argument.
+ *
+ * Returns: (transfer full): The GParamSpec of the argument.
+ *          The returned value must be freed with g_param_spec_unref().
+ *
+ * Since: 3.0
+ **/
 GParamSpec *
 gimp_pdb_proc_argument (const gchar *procedure_name,
                         gint         arg_num)
@@ -441,6 +456,22 @@ gimp_pdb_proc_argument (const gchar *procedure_name,
   return _gimp_pdb_proc_argument (procedure_name, arg_num);
 }
 
+/**
+ * gimp_pdb_proc_return_value:
+ * @procedure_name: The procedure name.
+ * @val_num: The return value number.
+ *
+ * Queries the procedural database for information on the specified
+ * procedure's return value.
+ *
+ * This procedure returns the #GParamSpec of procedure_name's return
+ * value.
+ *
+ * Returns: (transfer full): The GParamSpec of the return value.
+ *          The returned value must be freed with g_param_spec_unref().
+ *
+ * Since: 3.0
+ **/
 GParamSpec *
 gimp_pdb_proc_return_value (const gchar *procedure_name,
                             gint         val_num)
diff --git a/libgimp/gimpprocedure.c b/libgimp/gimpprocedure.c
index d2370dc76b..68a7055b04 100644
--- a/libgimp/gimpprocedure.c
+++ b/libgimp/gimpprocedure.c
@@ -815,7 +815,8 @@ gimp_procedure_get_icon_name (GimpProcedure *procedure)
  *
  * Gets the file of the icon if one was set for @procedure.
  *
- * Returns: (nullable): the icon #GFile or %NULL if no file was set.
+ * Returns: (nullable) (transfer none): the icon #GFile or %NULL if no
+ *          file was set.
  *
  * Since: 3.0
  */
@@ -837,7 +838,8 @@ gimp_procedure_get_icon_file (GimpProcedure *procedure)
  * Gets the #GdkPixbuf of the icon if an icon was set this way for
  * @procedure.
  *
- * Returns: (nullable): the icon pixbuf or %NULL if no icon name was set.
+ * Returns: (nullable) (transfer none): the icon pixbuf or %NULL if no
+ *          icon name was set.
  *
  * Since: 3.0
  */


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