[gimp] pdb: update several channel creation function's descriptions.



commit a7f11290a45603ac306dfe4b10da29fb0a18a1b7
Author: Jehan <jehan girinstud io>
Date:   Sat Sep 14 02:10:08 2013 +1200

    pdb: update several channel creation function's descriptions.
    
    More informative, detailed description or better wording.
    Also adds some newlines for better rendering.

 app/pdb/channel-cmds.c       |    6 +++---
 libgimp/gimpchannel_pdb.c    |   21 +++++++++++++--------
 tools/pdbgen/pdb/channel.pdb |   20 +++++++++++++-------
 3 files changed, 29 insertions(+), 18 deletions(-)
---
diff --git a/app/pdb/channel-cmds.c b/app/pdb/channel-cmds.c
index 7f2b1bf..7c98a1b 100644
--- a/app/pdb/channel-cmds.c
+++ b/app/pdb/channel-cmds.c
@@ -370,7 +370,7 @@ register_channel_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-channel-new",
                                      "Create a new channel.",
-                                     "This procedure creates a new channel with the specified width and 
height. Name, opacity, and color are also supplied parameters. The new channel still needs to be added to the 
image, as this is not automatic. Add the new channel with the 'gimp-image-insert-channel' command. Other 
attributes such as channel show masked, should be set with explicit procedure calls. The channel's contents 
are undefined initially.",
+                                     "This procedure creates a new channel with the specified width, height, 
name, opacity and color. \n\nThe new channel still needs to be added to the image, as this is not automatic. 
Add the new channel with 'gimp-image-insert-channel'. Other attributes, such as channel visibility, should be 
set with explicit procedure calls. \nThe channel's contents are undefined initially.",
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1995-1996",
@@ -431,7 +431,7 @@ register_channel_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-channel-new-from-component",
                                      "Create a new channel from a color component",
-                                     "This procedure creates a new channel from a color component.",
+                                     "This procedure creates a new channel from a color component. \n\nThe 
new channel still needs to be added to the image, as this is not automatic. Add the new channel with 
'gimp-image-insert-channel'. Other attributes, such as channel visibility, should be set with explicit 
procedure calls.",
                                      "Shlomi Fish <shlomif iglu org il>",
                                      "Shlomi Fish",
                                      "2005",
@@ -474,7 +474,7 @@ register_channel_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-channel-copy",
                                      "Copy a channel.",
-                                     "This procedure copies the specified channel and returns the copy.",
+                                     "This procedure copies the specified channel and returns the copy. 
\n\nThe new channel still needs to be added to the image, as this is not automatic. Add the new channel with 
'gimp-image-insert-channel'.",
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1995-1996",
diff --git a/libgimp/gimpchannel_pdb.c b/libgimp/gimpchannel_pdb.c
index 026f841..d432692 100644
--- a/libgimp/gimpchannel_pdb.c
+++ b/libgimp/gimpchannel_pdb.c
@@ -45,13 +45,12 @@
  *
  * Create a new channel.
  *
- * This procedure creates a new channel with the specified width and
- * height. Name, opacity, and color are also supplied parameters. The
- * new channel still needs to be added to the image, as this is not
- * automatic. Add the new channel with the gimp_image_insert_channel()
- * command. Other attributes such as channel show masked, should be set
- * with explicit procedure calls. The channel's contents are undefined
- * initially.
+ * This procedure creates a new channel with the specified width,
+ * height, name, opacity and color. \n\nThe new channel still needs to
+ * be added to the image, as this is not automatic. Add the new channel
+ * with gimp_image_insert_channel(). Other attributes, such as channel
+ * visibility, should be set with explicit procedure calls. \nThe
+ * channel's contents are undefined initially.
  *
  * Returns: The newly created channel.
  **/
@@ -93,7 +92,11 @@ _gimp_channel_new (gint32         image_ID,
  *
  * Create a new channel from a color component
  *
- * This procedure creates a new channel from a color component.
+ * This procedure creates a new channel from a color component. \n\nThe
+ * new channel still needs to be added to the image, as this is not
+ * automatic. Add the new channel with gimp_image_insert_channel().
+ * Other attributes, such as channel visibility, should be set with
+ * explicit procedure calls.
  *
  * Returns: The newly created channel.
  *
@@ -130,6 +133,8 @@ gimp_channel_new_from_component (gint32           image_ID,
  * Copy a channel.
  *
  * This procedure copies the specified channel and returns the copy.
+ * \n\nThe new channel still needs to be added to the image, as this is
+ * not automatic. Add the new channel with gimp_image_insert_channel().
  *
  * Returns: The newly copied channel.
  **/
diff --git a/tools/pdbgen/pdb/channel.pdb b/tools/pdbgen/pdb/channel.pdb
index 0916770..0a3bf03 100644
--- a/tools/pdbgen/pdb/channel.pdb
+++ b/tools/pdbgen/pdb/channel.pdb
@@ -20,13 +20,13 @@ sub channel_new {
     $blurb = 'Create a new channel.';
 
     $help = <<'HELP';
-This procedure creates a new channel with the specified width and
-height. Name, opacity, and color are also supplied parameters. The new
-channel still needs to be added to the image, as this is not
-automatic. Add the new channel with the gimp_image_insert_channel()
-command. Other attributes such as channel show masked, should be set
-with explicit procedure calls. The channel's contents are undefined
-initially.
+This procedure creates a new channel with the specified width, height,
+name, opacity and color.
+\n\nThe new channel still needs to be added to the image, as this is not
+automatic. Add the new channel with gimp_image_insert_channel(). Other
+attributes, such as channel visibility, should be set with explicit
+procedure calls.
+\nThe channel's contents are undefined initially.
 HELP
 
     &std_pdb_misc;
@@ -72,6 +72,8 @@ sub channel_copy {
 
     $help = <<'HELP';
 This procedure copies the specified channel and returns the copy.
+\n\nThe new channel still needs to be added to the image, as this is not
+automatic. Add the new channel with gimp_image_insert_channel().
 HELP
 
     &std_pdb_misc;
@@ -140,6 +142,10 @@ sub channel_new_from_component {
 
     $help = <<'HELP';
 This procedure creates a new channel from a color component.
+\n\nThe new channel still needs to be added to the image, as this is not
+automatic. Add the new channel with gimp_image_insert_channel(). Other
+attributes, such as channel visibility, should be set with explicit
+procedure calls.
 HELP
 
     &shlomi_pdb_misc('2005', '2.4');


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