[gimp] Bug 672487 - Impeove API docs of gimp_image_get_channels()

[Michael Natterer <mitch src gnome org>]

commit cf3d234f8886254793c93673cff1c726bd185d2f
Author: Michael Natterer <mitch gimp org>
Date:   Fri May 10 22:11:14 2013 +0200

    Bug 672487 - Impeove API docs of gimp_image_get_channels()
    
    Point out that the image's components are not "channels".

 app/pdb/image-cmds.c       |    2 +-
 libgimp/gimpimage_pdb.c    |    4 +++-
 tools/pdbgen/pdb/image.pdb |    3 ++-
 3 files changed, 6 insertions(+), 3 deletions(-)
---
diff --git a/app/pdb/image-cmds.c b/app/pdb/image-cmds.c
index b2d0a08..72cf1b0 100644
--- a/app/pdb/image-cmds.c
+++ b/app/pdb/image-cmds.c
@@ -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",
diff --git a/libgimp/gimpimage_pdb.c b/libgimp/gimpimage_pdb.c
index a4e099f..3cc5fd4 100644
--- a/libgimp/gimpimage_pdb.c
+++ b/libgimp/gimpimage_pdb.c
@@ -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().
diff --git a/tools/pdbgen/pdb/image.pdb b/tools/pdbgen/pdb/image.pdb
index d81014d..767be93 100644
--- a/tools/pdbgen/pdb/image.pdb
+++ b/tools/pdbgen/pdb/image.pdb
@@ -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;