[gimp] libgimp: more docs and annotations for GimpPDB

[Michael Natterer <mitch src gnome org>]

commit 5d80b742044c2b8665642f03310aac9ccd9b841d
Author: Michael Natterer <mitch gimp org>
Date:   Thu Aug 8 00:34:16 2019 +0200

    libgimp: more docs and annotations for GimpPDB

 libgimp/gimppdb.c | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 2 deletions(-)
---
diff --git a/libgimp/gimppdb.c b/libgimp/gimppdb.c
index 6cfbb92c27..301ebbccf6 100644
--- a/libgimp/gimppdb.c
+++ b/libgimp/gimppdb.c
@@ -133,6 +133,21 @@ gimp_pdb_procedure_exists (GimpPDB     *pdb,
   return _gimp_pdb_proc_exists (procedure_name);
 }
 
+/**
+ * gimp_pdb_lookup_procedure:
+ * @pdb:            A #GimpPDB instance.
+ * @procedure_name: A procedure name
+ *
+ * This function returns the #GimpProcedure which is registered
+ * with @procedure_name if it exists, or returns %NULL otherwise.
+ *
+ * The returned #GimpProcedure is owned by @pdb and must not be
+ * modified.
+ *
+ * Return: (nullable) (transfer none): A #GimpProcedure, or %NULL.
+ *
+ * Since: 3.0
+ **/
 GimpProcedure *
 gimp_pdb_lookup_procedure (GimpPDB     *pdb,
                            const gchar *procedure_name)
@@ -156,6 +171,20 @@ gimp_pdb_lookup_procedure (GimpPDB     *pdb,
   return procedure;
 }
 
+/**
+ * gimp_pdb_run_procedure:
+ * @pdb:            the #GimpPDB object.
+ * @procedure_name: the procedure registered name.
+ * @first_type:     the #GType of the first argument, or #G_TYPE_NONE.
+ * @...:            the call arguments.
+ *
+ * Runs the procedure named @procedure_name with arguments given as
+ * list of (#GType, value) pairs, terminated by #G_TYPE_NONE.
+ *
+ * Returns: (transfer full): the return values for the procedure call.
+ *
+ * Since: 3.0
+ */
 GimpValueArray *
 gimp_pdb_run_procedure (GimpPDB     *pdb,
                         const gchar *procedure_name,
@@ -178,6 +207,20 @@ gimp_pdb_run_procedure (GimpPDB     *pdb,
   return return_values;
 }
 
+/**
+ * gimp_pdb_run_procedure_valist:
+ * @pdb:            the #GimpPDB object.
+ * @procedure_name: the procedure registered name.
+ * @first_type:     the #GType of the first argument, or #G_TYPE_NONE.
+ * @args:           the call arguments.
+ *
+ * Runs the procedure named @procedure_name with @args given in the
+ * order as passed to gimp_pdb_run_procedure().
+ *
+ * Returns: (transfer full): the return values for the procedure call.
+ *
+ * Since: 3.0
+ */
 GimpValueArray *
 gimp_pdb_run_procedure_valist (GimpPDB     *pdb,
                                const gchar *procedure_name,
@@ -241,9 +284,11 @@ gimp_pdb_run_procedure_valist (GimpPDB     *pdb,
  * @procedure_name: the procedure registered name.
  * @arguments:      the call arguments.
  *
- * Runs the procedure names @procedure_name with @arguments.
+ * Runs the procedure named @procedure_name with @arguments.
+ *
+ * Returns: (transfer full): the return values for the procedure call.
  *
- * Returns: (transfer full): the returned values for the procedure call.
+ * Since: 3.0
  */
 GimpValueArray *
 gimp_pdb_run_procedure_array (GimpPDB              *pdb,