Commit cf3d234f authored by Michael Natterer's avatar Michael Natterer 😴

Bug 672487 - Impeove API docs of gimp_image_get_channels()

Point out that the image's components are not "channels".
parent 8602fdbe
......@@ -3518,7 +3518,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-get-channels",
"Returns the list of channels contained in the specified image.",
"This procedure returns the list of channels contained in the specified image. This does not include the selection mask, or layer masks. The order is from topmost to bottommost.",
"This procedure returns the list of channels contained in the specified image. This does not include the selection mask, or layer masks. The order is from topmost to bottommost. Note that \"channels\" are custom channels and do not include the image's color components.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......
......@@ -730,7 +730,9 @@ gimp_image_get_layers (gint32 image_ID,
*
* This procedure returns the list of channels contained in the
* specified image. This does not include the selection mask, or layer
* masks. The order is from topmost to bottommost.
* masks. The order is from topmost to bottommost. Note that
* \"channels\" are custom channels and do not include the image's
* color components.
*
* Returns: The list of channels contained in the image. The returned
* value must be freed with g_free().
......
......@@ -541,7 +541,8 @@ sub image_get_channels {
$help = <<HELP;
This procedure returns the list of channels contained in the specified image.
This does not include the selection mask, or layer masks. The order is from
topmost to bottommost.
topmost to bottommost. Note that "channels" are custom channels and do not
include the image's color components.
HELP
&std_pdb_misc;
......
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