[gimp] libgimp*: various doc fixes



commit caef6d0deb29cf4f418dda16fc0f84933e060930
Author: Michael Natterer <mitch gimp org>
Date:   Sat Jun 3 21:22:12 2017 +0200

    libgimp*: various doc fixes

 libgimpconfig/gimpcolorconfig.c     |    3 ++-
 libgimpconfig/gimpconfig-path.c     |    2 +-
 libgimpmath/gimpmatrix.c            |   18 +++++++++---------
 libgimpwidgets/gimpcolorbutton.c    |    2 +-
 libgimpwidgets/gimppropwidgets.c    |    2 +-
 libgimpwidgets/gimppropwidgets.h    |    2 +-
 libgimpwidgets/gimpstringcombobox.c |    5 +++--
 libgimpwidgets/gimpwidgetsenums.h   |    2 +-
 8 files changed, 19 insertions(+), 17 deletions(-)
---
diff --git a/libgimpconfig/gimpcolorconfig.c b/libgimpconfig/gimpcolorconfig.c
index aac8f33..ea8266c 100644
--- a/libgimpconfig/gimpcolorconfig.c
+++ b/libgimpconfig/gimpcolorconfig.c
@@ -305,7 +305,8 @@ gimp_color_config_class_init (GimpColorConfigClass *klass)
 
   GIMP_CONFIG_PROP_STRING (object_class, PROP_DISPLAY_MODULE,
                            "display-module",
-                           NULL, NULL,
+                           "Display module",
+                           "This property is deprecated and its value ignored",
                            "CdisplayLcms",
                            GIMP_PARAM_STATIC_STRINGS);
 
diff --git a/libgimpconfig/gimpconfig-path.c b/libgimpconfig/gimpconfig-path.c
index 6af5adb..4676656 100644
--- a/libgimpconfig/gimpconfig-path.c
+++ b/libgimpconfig/gimpconfig-path.c
@@ -446,7 +446,7 @@ gimp_file_new_for_config_path (const gchar  *path,
 }
 
 /**
- * gimp_file_new_for_config_path:
+ * gimp_file_get_config_path:
  * @file:   a #GFile
  * @error:  return location for errors
  *
diff --git a/libgimpmath/gimpmatrix.c b/libgimpmath/gimpmatrix.c
index 457057d..bef9927 100644
--- a/libgimpmath/gimpmatrix.c
+++ b/libgimpmath/gimpmatrix.c
@@ -867,11 +867,11 @@ gimp_matrix3_is_simple (const GimpMatrix3 *matrix)
 
 /**
  * gimp_matrix3_will_explode:
- * @m:  The matrix that is to be tested.
- * @u1: The rectangle's left coordinate.
- * @v1: The rectangle's top coordinate.
- * @u2: The rectangle's right coordinate.
- * @v2: The rectangle's bottom coordinate.
+ * @matrix: The matrix that is to be tested.
+ * @u1:     The rectangle's left coordinate.
+ * @v1:     The rectangle's top coordinate.
+ * @u2:     The rectangle's right coordinate.
+ * @v2:     The rectangle's bottom coordinate.
  *
  * Checks if the given transformation maps a point of the rectangle to
  * infinity, or something equally stupid.
@@ -881,15 +881,15 @@ gimp_matrix3_is_simple (const GimpMatrix3 *matrix)
  * Since: 2.10
  */
 gboolean
-gimp_matrix3_will_explode (const GimpMatrix3 *m,
+gimp_matrix3_will_explode (const GimpMatrix3 *matrix,
                            gdouble            u1,
                            gdouble            v1,
                            gdouble            u2,
                            gdouble            v2)
 {
-  const gdouble a  = m->coeff[2][0];
-  const gdouble b  = m->coeff[2][1];
-  const gdouble c  = m->coeff[2][2];
+  const gdouble a  = matrix->coeff[2][0];
+  const gdouble b  = matrix->coeff[2][1];
+  const gdouble c  = matrix->coeff[2][2];
   const gdouble d1 = a * u1 + b * v1 + c;
   const gdouble d2 = a * u1 + b * v2 + c;
   const gdouble d3 = a * u2 + b * v1 + c;
diff --git a/libgimpwidgets/gimpcolorbutton.c b/libgimpwidgets/gimpcolorbutton.c
index 324aaf4..c9f56c8 100644
--- a/libgimpwidgets/gimpcolorbutton.c
+++ b/libgimpwidgets/gimpcolorbutton.c
@@ -677,7 +677,7 @@ gimp_color_button_new (const gchar       *title,
 /**
  * gimp_color_button_set_title:
  * @button: a #GimpColorButton.
- * @color:  the new title.
+ * @title:  the new title.
  *
  * Sets the @button dialog's title.
  *
diff --git a/libgimpwidgets/gimppropwidgets.c b/libgimpwidgets/gimppropwidgets.c
index 71c946c..9a66185 100644
--- a/libgimpwidgets/gimppropwidgets.c
+++ b/libgimpwidgets/gimppropwidgets.c
@@ -1349,7 +1349,7 @@ gimp_prop_hscale_new (GObject     *config,
  * @step_increment: Step size.
  * @page_increment: Page size.
  * @digits:         Number of digits after decimal point to display.
- * @scale_limits:   %FALSE if the range of possible values of the
+ * @limit_scale:    %FALSE if the range of possible values of the
  *                  GtkHScale should be the same as of the GtkSpinButton.
  * @lower_limit:    The scale's lower boundary if @scale_limits is %TRUE.
  * @upper_limit:    The scale's upper boundary if @scale_limits is %TRUE.
diff --git a/libgimpwidgets/gimppropwidgets.h b/libgimpwidgets/gimppropwidgets.h
index 19dca84..59fc439 100644
--- a/libgimpwidgets/gimppropwidgets.h
+++ b/libgimpwidgets/gimppropwidgets.h
@@ -93,7 +93,7 @@ GtkWidget     * gimp_prop_enum_stock_box_new      (GObject      *config,
 
 GtkWidget     * gimp_prop_enum_icon_box_new       (GObject      *config,
                                                    const gchar  *property_name,
-                                                   const gchar  *stock_prefix,
+                                                   const gchar  *icon_prefix,
                                                    gint          minimum,
                                                    gint          maximum);
 
diff --git a/libgimpwidgets/gimpstringcombobox.c b/libgimpwidgets/gimpstringcombobox.c
index 5ad373a..172983d 100644
--- a/libgimpwidgets/gimpstringcombobox.c
+++ b/libgimpwidgets/gimpstringcombobox.c
@@ -253,8 +253,9 @@ gimp_string_model_lookup (GtkTreeModel *model,
 
 /**
  * gimp_string_combo_box_new:
- * @id_column:
- * @label_column:
+ * @model:        a #GtkTreeModel
+ * @id_column:    the model column of the ID
+ * @label_column: the modl column of the label
  *
  * Return value: a new #GimpStringComboBox.
  *
diff --git a/libgimpwidgets/gimpwidgetsenums.h b/libgimpwidgets/gimpwidgetsenums.h
index 0d8ca48..471fcfd 100644
--- a/libgimpwidgets/gimpwidgetsenums.h
+++ b/libgimpwidgets/gimpwidgetsenums.h
@@ -97,7 +97,7 @@ typedef enum
  * @GIMP_COLOR_SELECTOR_BLUE:           the blue channel
  * @GIMP_COLOR_SELECTOR_ALPHA:          the alpha channel
  * @GIMP_COLOR_SELECTOR_LCH_LIGHTNESS:  the lightness channel
- * @GIMP_COLOR_SELECTOR_LCH_CHOMA:      the chroma channel
+ * @GIMP_COLOR_SELECTOR_LCH_CHROMA:     the chroma channel
  * @GIMP_COLOR_SELECTOR_LCH_HUE:        the hue channel
  *
  * An enum to specify the types of color channels edited in


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