[gimp] libgimp: fix various docs typos or small errors.



commit 512d2279afe58192f52b4f14270da72fb653f0e0
Author: Jehan <jehan girinstud io>
Date:   Fri Aug 2 02:30:07 2019 +0200

    libgimp: fix various docs typos or small errors.

 libgimp/gimpplugin.h    |  2 +-
 libgimp/gimpprocedure.c | 17 +++++++++--------
 2 files changed, 10 insertions(+), 9 deletions(-)
---
diff --git a/libgimp/gimpplugin.h b/libgimp/gimpplugin.h
index 72d29811c7..c373770b44 100644
--- a/libgimp/gimpplugin.h
+++ b/libgimp/gimpplugin.h
@@ -114,7 +114,7 @@ struct _GimpPlugInClass
    * This method should be overridden by all plug-ins and return a newly
    * allocated #GimpProcedure named @name.
    * It will be called for every @name as returned by query_procedures()
-   * so care must be taken.
+   * and init_procedures() so care must be taken to handle them all.
    *
    * Returns: (transfer full):
    *          the procedure to be registered by @plug_in.
diff --git a/libgimp/gimpprocedure.c b/libgimp/gimpprocedure.c
index 43b1112835..197a7c8b4c 100644
--- a/libgimp/gimpprocedure.c
+++ b/libgimp/gimpprocedure.c
@@ -171,7 +171,7 @@ gimp_procedure_finalize (GObject *object)
  * @proc_type: the new procedure's #GimpPDBProcType.
  * @run_func:  the run function for the new procedure.
  * @run_data:  user data passed to @run_func.
- * @run_data_destroy: (nullable) free function for @run_data, or %NULL.
+ * @run_data_destroy: (nullable): free function for @run_data, or %NULL.
  *
  * Creates a new procedure named @name which will call @run_func when
  * invoked.
@@ -314,7 +314,7 @@ gimp_procedure_set_menu_label (GimpProcedure *procedure,
  * @procedure: A #GimpProcedure.
  *
  * Returns: The procedure's menu label given in
- *          gimp_procedure_set_strings().
+ *          gimp_procedure_set_menu_label().
  *
  * Since: 3.0
  **/
@@ -341,7 +341,7 @@ gimp_procedure_get_menu_label (GimpProcedure *procedure)
  * for example using N_("Blurb"). GIMP will look up the translation in
  * the textdomain registered for the plug-in.
  *
- * @help: is a free-form text that's meant as documentation for
+ * @help is a free-form text that's meant as documentation for
  * developers of scripts and plug-ins.
  *
  * Sets various documentation strings on @procedure.
@@ -369,7 +369,8 @@ gimp_procedure_set_documentation (GimpProcedure *procedure,
  * gimp_procedure_get_blurb:
  * @procedure: A #GimpProcedure.
  *
- * Returns: The procedure's blurb given in gimp_procedure_set_help().
+ * Returns: The procedure's blurb given in
+ *          gimp_procedure_set_documentation().
  *
  * Since: 3.0
  **/
@@ -386,7 +387,7 @@ gimp_procedure_get_blurb (GimpProcedure *procedure)
  * @procedure: A #GimpProcedure.
  *
  * Returns: The procedure's help text given in
- *          gimp_procedure_set_help().
+ *          gimp_procedure_set_documentation().
  *
  * Since: 3.0
  **/
@@ -403,7 +404,7 @@ gimp_procedure_get_help (GimpProcedure *procedure)
  * @procedure: A #GimpProcedure.
  *
  * Returns: The procedure's help ID given in
- *          gimp_procedure_set_help().
+ *          gimp_procedure_set_documentation().
  *
  * Since: 3.0
  **/
@@ -420,7 +421,7 @@ gimp_procedure_get_help_id (GimpProcedure *procedure)
  * @procedure: A #GimpProcedure.
  * @authors:   The @procedure's author(s).
  * @copyright: The @procedure's copyright.
- * @data:      The @procedure's date (written or pushished).
+ * @date:      The @procedure's date (written or published).
  *
  * Sets various attribution strings on @procedure.
  *
@@ -674,7 +675,7 @@ gimp_procedure_add_argument (GimpProcedure *procedure,
  *
  * Add a new return value to @procedure according to @pspec
  * specifications. The returned values will be ordered according to the
- * call order to * gimp_procedure_add_return_value().
+ * call order to gimp_procedure_add_return_value().
  **/
 void
 gimp_procedure_add_return_value (GimpProcedure *procedure,


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