[gimp] libgimpcolor: some doc fixes and updates



commit 60a50096fa2fee6d8f2b26c981d58525d0fd3008
Author: Michael Natterer <mitch gimp org>
Date:   Sat Jun 3 21:03:25 2017 +0200

    libgimpcolor: some doc fixes and updates

 libgimpcolor/gimpcolormanaged.c   |    2 +-
 libgimpcolor/gimpcolorprofile.c   |    9 +++---
 libgimpcolor/gimpcolortransform.c |   54 ++++++++++++++++++------------------
 libgimpcolor/gimpcolortransform.h |    4 +-
 4 files changed, 34 insertions(+), 35 deletions(-)
---
diff --git a/libgimpcolor/gimpcolormanaged.c b/libgimpcolor/gimpcolormanaged.c
index 6c85932..bad9f0a 100644
--- a/libgimpcolor/gimpcolormanaged.c
+++ b/libgimpcolor/gimpcolormanaged.c
@@ -135,7 +135,7 @@ gimp_color_managed_get_icc_profile (GimpColorManaged *managed,
  * @managed: an object the implements the #GimpColorManaged interface
  *
  * This function always returns a #GimpColorProfile and falls back to
- * gimp_color_profile_new_srgb() if the method is not implemented.
+ * gimp_color_profile_new_rgb_srgb() if the method is not implemented.
  *
  * Return value: The @managed's #GimpColorProfile.
  *
diff --git a/libgimpcolor/gimpcolorprofile.c b/libgimpcolor/gimpcolorprofile.c
index 76a948c..efb1749 100644
--- a/libgimpcolor/gimpcolorprofile.c
+++ b/libgimpcolor/gimpcolorprofile.c
@@ -376,9 +376,9 @@ gimp_color_profile_new_from_lcms_profile (gpointer   lcms_profile,
 
 /**
  * gimp_color_profile_save_to_file:
- * profile: a #GimpColorProfile
- * @file:   a #GFile
- * @error:  return location for #GError
+ * @profile: a #GimpColorProfile
+ * @file:    a #GFile
+ * @error:   return location for #GError
  *
  * This function saves @profile to @file as ICC profile.
  *
@@ -409,7 +409,6 @@ gimp_color_profile_save_to_file (GimpColorProfile  *profile,
  * gimp_color_profile_get_icc_profile:
  * @profile: a #GimpColorProfile
  * @length:  return location for the number of bytes
- * @error:   return location for #GError
  *
  * This function returns @profile as ICC profile data. The returned
  * memory belongs to @profile and must not be modified or freed.
@@ -1306,7 +1305,7 @@ gimp_color_profile_new_d65_gray_srgb_trc_internal (void)
  * gimp_color_profile_new_d65_gray_srgb_trc
  *
  * This function creates a grayscale #GimpColorProfile with an
- * sRGB TRC. See gimp_color_profile_new_srgb().
+ * sRGB TRC. See gimp_color_profile_new_rgb_srgb().
  *
  * Return value: the sRGB-gamma grayscale #GimpColorProfile.
  *
diff --git a/libgimpcolor/gimpcolortransform.c b/libgimpcolor/gimpcolortransform.c
index 05329b8..f64f764 100644
--- a/libgimpcolor/gimpcolortransform.c
+++ b/libgimpcolor/gimpcolortransform.c
@@ -170,12 +170,12 @@ gimp_color_transform_finalize (GObject *object)
 
 /**
  * gimp_color_transform_new:
- * @src_profile:
- * @src_format:
- * @desr_profile:
- * @dest_format:
- * @rendering_intent:
- * @flags:
+ * @src_profile:      the source #GimpColorProfile
+ * @src_format:       the source #Babl format
+ * @dest_profile:     the destination #GimpColorProfile
+ * @dest_format:      the destination #Babl format
+ * @rendering_intent: the rendering intent
+ * @flags:            transform flags
  *
  * This function creates an color transform.
  *
@@ -248,14 +248,14 @@ gimp_color_transform_new (GimpColorProfile         *src_profile,
 
 /**
  * gimp_color_transform_new_proofing:
- * @src_profile:
- * @src_format:
- * @desr_profile:
- * @dest_format:
- * @proof_profile:
- * @proof_intent:
- * @display_intent:
- * @flags:
+ * @src_profile:    the source #GimpColorProfile
+ * @src_format:     the source #Babl format
+ * @dest_profile:   the destination #GimpColorProfile
+ * @dest_format:    the destination #Babl format
+ * @proof_profile:  the proof #GimpColorProfile
+ * @proof_intent:   the proof intent
+ * @display_intent: the display intent
+ * @flags:          transform flags
  *
  * This function creates a simulation / proofing color transform.
  *
@@ -331,12 +331,12 @@ gimp_color_transform_new_proofing (GimpColorProfile         *src_profile,
 
 /**
  * gimp_color_transform_process_pixels:
- * @transform:
- * @src_format:
- * @src_pixels:
- * @dest_format:
- * @dest_pixels:
- * @length:
+ * @transform:   a #GimpColorTransform
+ * @src_format:  #Babl format of @src_pixels
+ * @src_pixels:  pointer to the source pixels
+ * @dest_format: #Babl format of @dest_pixels
+ * @dest_pixels: pointer to the destination pixels
+ * @length:      number of pixels to process
  *
  * This function transforms a contiguous line of pixels.
  *
@@ -409,11 +409,11 @@ gimp_color_transform_process_pixels (GimpColorTransform *transform,
 
 /**
  * gimp_color_transform_process_buffer:
- * @transform:
- * @src_format:
- * @src_rect:
- * @dest_format:
- * @dest_rect:
+ * @transform:   a #GimpColorTransform
+ * @src_buffer:  source #GeglBuffer
+ * @src_rect:    rectangle in @src_buffer
+ * @dest_buffer: destination #GeglBuffer
+ * @dest_rect:   rectangle in @dest_buffer
  *
  * This function transforms buffer into another buffer.
  *
@@ -507,8 +507,8 @@ gimp_color_transform_process_buffer (GimpColorTransform  *transform,
 
 /**
  * gimp_color_transform_can_gegl_copy:
- * @src_format:  src profile
- * @dest_format: dest profile
+ * @src_profile:  source #GimpColorProfile
+ * @dest_profile: destination #GimpColorProfile
  *
  * This function checks if a GimpColorTransform is needed at all.
  *
diff --git a/libgimpcolor/gimpcolortransform.h b/libgimpcolor/gimpcolortransform.h
index 067cd39..7906017 100644
--- a/libgimpcolor/gimpcolortransform.h
+++ b/libgimpcolor/gimpcolortransform.h
@@ -96,9 +96,9 @@ GimpColorTransform *
 
 void    gimp_color_transform_process_pixels   (GimpColorTransform       *transform,
                                                const Babl               *src_format,
-                                               gconstpointer             src,
+                                               gconstpointer             src_pixels,
                                                const Babl               *dest_format,
-                                               gpointer                  dest,
+                                               gpointer                  dest_pixels,
                                                gsize                     length);
 
 void    gimp_color_transform_process_buffer   (GimpColorTransform       *transform,


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