Commit 7b335188 authored by Michael Natterer's avatar Michael Natterer 😴

libgimpcolor: fix most gtk-doc warnings

parent 16492414
......@@ -29,7 +29,7 @@
/**
* SECTION: GimpAdaptiveSupersample
* SECTION: gimpadaptivesupersample
* @title: GimpAdaptiveSupersample
* @short_description: Functions to perform adaptive supersampling on
* an area.
......
......@@ -28,7 +28,7 @@
/**
* SECTION: GimpBilinear
* SECTION: gimpbilinear
* @title: GimpBilinear
* @short_description: Utility functions for bilinear interpolation.
*
......
......@@ -28,7 +28,7 @@
/**
* SECTION: GimpCMYK
* SECTION: gimpcmyk
* @title: GimpCMYK
* @short_description: Definitions and Functions relating to CMYK colors.
*
......
......@@ -29,7 +29,7 @@
/**
* SECTION: GimpColorManaged
* SECTION: gimpcolormanaged
* @title: GimpColorManaged
* @short_description: An interface dealing with color profiles.
*
......
......@@ -31,7 +31,7 @@
/**
* SECTION: GimpColorSpace
* SECTION: gimpcolorspace
* @title: GimpColorSpace
* @short_description: Utility functions which convert colors between
* different color models.
......
......@@ -35,21 +35,64 @@ typedef struct _GimpHSV GimpHSV;
typedef struct _GimpHSL GimpHSL;
typedef struct _GimpCMYK GimpCMYK;
/**
* GimpRGB:
* @r: the red component
* @g: the green component
* @b: the blue component
* @a: the alpha component
*
* Used to keep RGB and RGBA colors. All components are in a range of
* [0.0..1.0].
**/
struct _GimpRGB
{
gdouble r, g, b, a;
};
/**
* GimpHSV:
* @h: the hue component
* @s: the saturation component
* @v: the value component
* @a: the alpha component
*
* Used to keep HSV and HSVA colors. All components are in a range of
* [0.0..1.0].
**/
struct _GimpHSV
{
gdouble h, s, v, a;
};
/**
* GimpHSL:
* @h: the hue component
* @s: the saturation component
* @l: the lightness component
* @a: the alpha component
*
* Used to keep HSL and HSLA colors. All components are in a range of
* [0.0..1.0].
**/
struct _GimpHSL
{
gdouble h, s, l, a;
};
/**
* GimpCMYK:
* @c: the cyan component
* @m: the magenta component
* @y: the yellow component
* @k: the black component
* @a: the alpha component
*
* Used to keep CMYK and CMYKA colors. All components are in a range
* of [0.0..1.0]. An alpha value is somewhat useless in the CMYK
* colorspace, but we keep one around anyway so color conversions
* going to CMYK and back can preserve alpha.
**/
struct _GimpCMYK
{
gdouble c, m, y, k, a;
......
......@@ -26,7 +26,7 @@
/**
* SECTION: GimpHSV
* SECTION: gimphsv
* @title: GimpHSV
* @short_description: Definitions and Functions relating to HSV colors.
*
......
......@@ -29,7 +29,7 @@
/**
* SECTION: GimpRGB
* SECTION: gimprgb
* @title: GimpRGB
* @short_description: Definitions and Functions relating to RGB colors.
*
......@@ -91,10 +91,10 @@ gimp_rgb_copy (const GimpRGB *rgb)
/**
* gimp_rgb_set:
* @rgb: a #GimpRGB struct
* @red:
* @green:
* @blue:
* @rgb: a #GimpRGB struct
* @red: the red component
* @green: the green component
* @blue: the blue component
*
* Sets the red, green and blue components of @rgb and leaves the
* alpha component unchanged. The color values should be between 0.0
......@@ -116,8 +116,8 @@ gimp_rgb_set (GimpRGB *rgb,
/**
* gimp_rgb_set_alpha:
* @rgb: a #GimpRGB struct
* @alpha:
* @rgb: a #GimpRGB struct
* @alpha: the alpha component
*
* Sets the alpha component of @rgb and leaves the RGB components unchanged.
**/
......@@ -132,10 +132,10 @@ gimp_rgb_set_alpha (GimpRGB *rgb,
/**
* gimp_rgb_set_uchar:
* @rgb: a #GimpRGB struct
* @red:
* @green:
* @blue:
* @rgb: a #GimpRGB struct
* @red: the red component
* @green: the green component
* @blue: the blue component
*
* Sets the red, green and blue components of @rgb from 8bit values
* (0 to 255) and leaves the alpha component unchanged.
......@@ -266,7 +266,7 @@ gimp_rgb_gamma (GimpRGB *rgb,
/**
* gimp_rgb_luminance:
* @rgb:
* @rgb: a #GimpRGB struct
*
* Return value: the luminous intensity of the range from 0.0 to 1.0.
*
......@@ -286,7 +286,7 @@ gimp_rgb_luminance (const GimpRGB *rgb)
/**
* gimp_rgb_luminance_uchar:
* @rgb:
* @rgb: a #GimpRGB struct
*
* Return value: the luminous intensity in the range from 0 to 255.
*
......@@ -302,7 +302,7 @@ gimp_rgb_luminance_uchar (const GimpRGB *rgb)
/**
* gimp_rgb_intensity:
* @rgb:
* @rgb: a #GimpRGB struct
*
* This function is deprecated! Use gimp_rgb_luminance() instead.
*
......@@ -322,7 +322,7 @@ gimp_rgb_intensity (const GimpRGB *rgb)
/**
* gimp_rgb_intensity_uchar:
* @rgb:
* @rgb: a #GimpRGB struct
*
* This function is deprecated! Use gimp_rgb_luminance_uchar() instead.
*
......@@ -385,11 +385,11 @@ gimp_rgb_composite (GimpRGB *color1,
/**
* gimp_rgba_set:
* @rgba: a #GimpRGB struct
* @red:
* @green:
* @blue:
* @alpha:
* @rgba: a #GimpRGB struct
* @red: the red component
* @green: the green component
* @blue: the blue component
* @alpha: the alpha component
*
* Sets the red, green, blue and alpha components of @rgb. The values
* should be between 0.0 and 1.0 but there is no check to enforce this
......@@ -412,11 +412,11 @@ gimp_rgba_set (GimpRGB *rgba,
/**
* gimp_rgba_set_uchar:
* @rgba: a #GimpRGB struct
* @red:
* @green:
* @blue:
* @alpha:
* @rgba: a #GimpRGB struct
* @red: the red component
* @green: the green component
* @blue: the blue component
* @alpha: the alpha component
*
* Sets the red, green, blue and alpha components of @rgb from 8bit
* values (0 to 255).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment