[gimp] pdb: update docs to mention the new insert procs instead of the add ones



commit 9e0dccec73e273a702f4bb63cb8c9e0e320fcea6
Author: Michael Natterer <mitch gimp org>
Date:   Mon Sep 6 00:03:29 2010 +0200

    pdb: update docs to mention the new insert procs instead of the add ones

 app/pdb/channel-cmds.c          |    2 +-
 app/pdb/fileops-cmds.c          |    4 ++--
 app/pdb/layer-cmds.c            |    6 +++---
 app/pdb/text-layer-cmds.c       |    2 +-
 app/pdb/vectors-cmds.c          |    4 ++--
 libgimp/gimpchannel.c           |    8 ++++----
 libgimp/gimpchannel_pdb.c       |    2 +-
 libgimp/gimpfileops_pdb.c       |    6 ++++--
 libgimp/gimplayer.c             |    2 +-
 libgimp/gimplayer_pdb.c         |   10 +++++-----
 libgimp/gimptextlayer_pdb.c     |    2 +-
 libgimp/gimpvectors_pdb.c       |    4 ++--
 tools/pdbgen/pdb/channel.pdb    |   13 +++++++------
 tools/pdbgen/pdb/fileops.pdb    |    4 ++--
 tools/pdbgen/pdb/layer.pdb      |   30 ++++++++++++++++--------------
 tools/pdbgen/pdb/text_layer.pdb |    2 +-
 tools/pdbgen/pdb/vectors.pdb    |    4 ++--
 17 files changed, 55 insertions(+), 50 deletions(-)
---
diff --git a/app/pdb/channel-cmds.c b/app/pdb/channel-cmds.c
index 2032bf9..3dddf32 100644
--- a/app/pdb/channel-cmds.c
+++ b/app/pdb/channel-cmds.c
@@ -364,7 +364,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-add-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 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.",
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1995-1996",
diff --git a/app/pdb/fileops-cmds.c b/app/pdb/fileops-cmds.c
index a477e91..41ef79f 100644
--- a/app/pdb/fileops-cmds.c
+++ b/app/pdb/fileops-cmds.c
@@ -609,7 +609,7 @@ register_fileops_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-file-load-layer",
                                      "Loads an image file as a layer for an existing image.",
-                                     "This procedure behaves like the file-load procedure but opens the specified image as a layer for an existing image. The returned layer needs to be added to the existing image with 'gimp-image-add-layer'.",
+                                     "This procedure behaves like the file-load procedure but opens the specified image as a layer for an existing image. The returned layer needs to be added to the existing image with 'gimp-image-insert-layer'.",
                                      "Sven Neumann <sven gimp org>",
                                      "Sven Neumann",
                                      "2005",
@@ -654,7 +654,7 @@ register_fileops_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-file-load-layers",
                                      "Loads an image file as layers for an existing image.",
-                                     "This procedure behaves like the file-load procedure but opens the specified image as layers for an existing image. The returned layers needs to be added to the existing image with 'gimp-image-add-layer'.",
+                                     "This procedure behaves like the file-load procedure but opens the specified image as layers for an existing image. The returned layers needs to be added to the existing image with 'gimp-image-insert-layer'.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2006",
diff --git a/app/pdb/layer-cmds.c b/app/pdb/layer-cmds.c
index 8e21821..3ca4c88 100644
--- a/app/pdb/layer-cmds.c
+++ b/app/pdb/layer-cmds.c
@@ -1041,7 +1041,7 @@ register_layer_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-layer-new",
                                      "Create a new layer.",
-                                     "This procedure creates a new layer with the specified width, height, and type. Name, opacity, and mode are also supplied parameters. The new layer still needs to be added to the image, as this is not automatic. Add the new layer with the 'gimp-image-add-layer' command. Other attributes such as layer mask modes, and offsets should be set with explicit procedure calls.",
+                                     "This procedure creates a new layer with the specified width, height, and type. Name, opacity, and mode are also supplied parameters. The new layer still needs to be added to the image, as this is not automatic. Add the new layer with the 'gimp-image-insert-layer' command. Other attributes such as layer mask modes, and offsets should be set with explicit procedure calls.",
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1995-1996",
@@ -1109,7 +1109,7 @@ register_layer_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-layer-new-from-visible",
                                      "Create a new layer from what is visible in an image.",
-                                     "This procedure creates a new layer from what is visible in the given image. The new layer still needs to be added to the destination image, as this is not automatic. Add the new layer with the 'gimp-image-add-layer' command. Other attributes such as layer mask modes, and offsets should be set with explicit procedure calls.",
+                                     "This procedure creates a new layer from what is visible in the given image. The new layer still needs to be added to the destination image, as this is not automatic. Add the new layer with the 'gimp-image-insert-layer' command. Other attributes such as layer mask modes, and offsets should be set with explicit procedure calls.",
                                      "Sven Neumann <sven gimp org>",
                                      "Sven Neumann",
                                      "2008",
@@ -1151,7 +1151,7 @@ register_layer_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-layer-new-from-drawable",
                                      "Create a new layer by copying an existing drawable.",
-                                     "This procedure creates a new layer as a copy of the specified drawable. The new layer still needs to be added to the image, as this is not automatic. Add the new layer with the 'gimp-image-add-layer' command. Other attributes such as layer mask modes, and offsets should be set with explicit procedure calls.",
+                                     "This procedure creates a new layer as a copy of the specified drawable. The new layer still needs to be added to the image, as this is not automatic. Add the new layer with the 'gimp-image-insert-layer' command. Other attributes such as layer mask modes, and offsets should be set with explicit procedure calls.",
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1995-1996",
diff --git a/app/pdb/text-layer-cmds.c b/app/pdb/text-layer-cmds.c
index a054192..f56fb51 100644
--- a/app/pdb/text-layer-cmds.c
+++ b/app/pdb/text-layer-cmds.c
@@ -1210,7 +1210,7 @@ register_text_layer_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-text-layer-new",
                                      "Creates a new text layer.",
-                                     "This procedure creates a new text layer. The arguments are kept as simple as necessary for the normal case. All text attributes, however, can be modified with the appropriate gimp_text_layer_set_*() procedures. The new layer still needs to be added to the image, as this is not automatic. Add the new layer using 'gimp-image-add-layer'.",
+                                     "This procedure creates a new text layer. The arguments are kept as simple as necessary for the normal case. All text attributes, however, can be modified with the appropriate gimp_text_layer_set_*() procedures. The new layer still needs to be added to the image, as this is not automatic. Add the new layer using 'gimp-image-insert-layer'.",
                                      "Marcus Heese <heese cip ifi lmu de>",
                                      "Marcus Heese",
                                      "2008",
diff --git a/app/pdb/vectors-cmds.c b/app/pdb/vectors-cmds.c
index f63c912..8aeb1f8 100644
--- a/app/pdb/vectors-cmds.c
+++ b/app/pdb/vectors-cmds.c
@@ -1584,7 +1584,7 @@ register_vectors_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-vectors-new",
                                      "Creates a new empty vectors object.",
-                                     "Creates a new empty vectors object. The vectors object needs to be added to the image using 'gimp-image-add-vectors'.",
+                                     "Creates a new empty vectors object. The vectors object needs to be added to the image using 'gimp-image-insert-vectors'.",
                                      "Simon Budig",
                                      "Simon Budig",
                                      "2005",
@@ -1620,7 +1620,7 @@ register_vectors_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-vectors-new-from-text-layer",
                                      "Creates a new vectors object from a text layer.",
-                                     "Creates a new vectors object from a text layer. The vectors object needs to be added to the image using 'gimp-image-add-vectors'.",
+                                     "Creates a new vectors object from a text layer. The vectors object needs to be added to the image using 'gimp-image-insert-vectors'.",
                                      "Marcus Heese <heese cip ifi lmu de>",
                                      "Marcus Heese",
                                      "2008",
diff --git a/libgimp/gimpchannel.c b/libgimp/gimpchannel.c
index 8af318f..8b7e13a 100644
--- a/libgimp/gimpchannel.c
+++ b/libgimp/gimpchannel.c
@@ -37,10 +37,10 @@
  * 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_add_channel'
- * command. Other attributes such as channel show masked, should be set
- * with explicit procedure calls. The channel's contents are undefined
- * initially.
+ * 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.
  *
  * Returns: The newly created channel.
  */
diff --git a/libgimp/gimpchannel_pdb.c b/libgimp/gimpchannel_pdb.c
index d4ee0c6..e7621a9 100644
--- a/libgimp/gimpchannel_pdb.c
+++ b/libgimp/gimpchannel_pdb.c
@@ -48,7 +48,7 @@
  * 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_add_channel()
+ * 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.
diff --git a/libgimp/gimpfileops_pdb.c b/libgimp/gimpfileops_pdb.c
index 5992427..c1e9d7b 100644
--- a/libgimp/gimpfileops_pdb.c
+++ b/libgimp/gimpfileops_pdb.c
@@ -88,7 +88,8 @@ gimp_file_load (GimpRunMode  run_mode,
  *
  * This procedure behaves like the file-load procedure but opens the
  * specified image as a layer for an existing image. The returned layer
- * needs to be added to the existing image with gimp_image_add_layer().
+ * needs to be added to the existing image with
+ * gimp_image_insert_layer().
  *
  * Returns: The layer created when loading the image file.
  *
@@ -129,7 +130,8 @@ gimp_file_load_layer (GimpRunMode  run_mode,
  *
  * This procedure behaves like the file-load procedure but opens the
  * specified image as layers for an existing image. The returned layers
- * needs to be added to the existing image with gimp_image_add_layer().
+ * needs to be added to the existing image with
+ * gimp_image_insert_layer().
  *
  * Returns: The list of loaded layers.
  *
diff --git a/libgimp/gimplayer.c b/libgimp/gimplayer.c
index 101052c..9680b79 100644
--- a/libgimp/gimplayer.c
+++ b/libgimp/gimplayer.c
@@ -40,7 +40,7 @@
  * This procedure creates a new layer with the specified width, height,
  * and type. Name, opacity, and mode are also supplied parameters. The
  * new layer still needs to be added to the image, as this is not
- * automatic. Add the new layer with the 'gimp_image_add_layer'
+ * automatic. Add the new layer with the gimp_image_insert_layer()
  * command. Other attributes such as layer mask modes, and offsets
  * should be set with explicit procedure calls.
  *
diff --git a/libgimp/gimplayer_pdb.c b/libgimp/gimplayer_pdb.c
index 2ae3d1b..53908dd 100644
--- a/libgimp/gimplayer_pdb.c
+++ b/libgimp/gimplayer_pdb.c
@@ -49,7 +49,7 @@
  * This procedure creates a new layer with the specified width, height,
  * and type. Name, opacity, and mode are also supplied parameters. The
  * new layer still needs to be added to the image, as this is not
- * automatic. Add the new layer with the gimp_image_add_layer()
+ * automatic. Add the new layer with the gimp_image_insert_layer()
  * command. Other attributes such as layer mask modes, and offsets
  * should be set with explicit procedure calls.
  *
@@ -98,8 +98,8 @@ _gimp_layer_new (gint32                image_ID,
  * This procedure creates a new layer from what is visible in the given
  * image. The new layer still needs to be added to the destination
  * image, as this is not automatic. Add the new layer with the
- * gimp_image_add_layer() command. Other attributes such as layer mask
- * modes, and offsets should be set with explicit procedure calls.
+ * gimp_image_insert_layer() command. Other attributes such as layer
+ * mask modes, and offsets should be set with explicit procedure calls.
  *
  * Returns: The newly created layer.
  *
@@ -139,8 +139,8 @@ gimp_layer_new_from_visible (gint32       image_ID,
  * This procedure creates a new layer as a copy of the specified
  * drawable. The new layer still needs to be added to the image, as
  * this is not automatic. Add the new layer with the
- * gimp_image_add_layer() command. Other attributes such as layer mask
- * modes, and offsets should be set with explicit procedure calls.
+ * gimp_image_insert_layer() command. Other attributes such as layer
+ * mask modes, and offsets should be set with explicit procedure calls.
  *
  * Returns: The newly copied layer.
  */
diff --git a/libgimp/gimptextlayer_pdb.c b/libgimp/gimptextlayer_pdb.c
index ddebf48..3b29d35 100644
--- a/libgimp/gimptextlayer_pdb.c
+++ b/libgimp/gimptextlayer_pdb.c
@@ -52,7 +52,7 @@
  * however, can be modified with the appropriate
  * gimp_text_layer_set_*() procedures. The new layer still needs to be
  * added to the image, as this is not automatic. Add the new layer
- * using gimp_image_add_layer().
+ * using gimp_image_insert_layer().
  *
  * Returns: The new text layer.
  *
diff --git a/libgimp/gimpvectors_pdb.c b/libgimp/gimpvectors_pdb.c
index 17343dc..ffb3d42 100644
--- a/libgimp/gimpvectors_pdb.c
+++ b/libgimp/gimpvectors_pdb.c
@@ -77,7 +77,7 @@ gimp_vectors_is_valid (gint32 vectors_ID)
  * Creates a new empty vectors object.
  *
  * Creates a new empty vectors object. The vectors object needs to be
- * added to the image using gimp_image_add_vectors().
+ * added to the image using gimp_image_insert_vectors().
  *
  * Returns: the current vector object, 0 if no vector exists in the image.
  *
@@ -113,7 +113,7 @@ gimp_vectors_new (gint32       image_ID,
  * Creates a new vectors object from a text layer.
  *
  * Creates a new vectors object from a text layer. The vectors object
- * needs to be added to the image using gimp_image_add_vectors().
+ * needs to be added to the image using gimp_image_insert_vectors().
  *
  * Returns: The vectors of the text layer.
  *
diff --git a/tools/pdbgen/pdb/channel.pdb b/tools/pdbgen/pdb/channel.pdb
index 9d26dfa..6c0d8f5 100644
--- a/tools/pdbgen/pdb/channel.pdb
+++ b/tools/pdbgen/pdb/channel.pdb
@@ -20,12 +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_add_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 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.
 HELP
 
     &std_pdb_misc;
diff --git a/tools/pdbgen/pdb/fileops.pdb b/tools/pdbgen/pdb/fileops.pdb
index 93c21e3..8b11093 100644
--- a/tools/pdbgen/pdb/fileops.pdb
+++ b/tools/pdbgen/pdb/fileops.pdb
@@ -116,7 +116,7 @@ sub file_load_layer {
     $help = <<'HELP';
 This procedure behaves like the file-load procedure but opens the specified
 image as a layer for an existing image. The returned layer needs to be
-added to the existing image with gimp_image_add_layer().
+added to the existing image with gimp_image_insert_layer().
 HELP
 
     &neo_pdb_misc('2005', '2.4');
@@ -171,7 +171,7 @@ sub file_load_layers {
     $help = <<'HELP';
 This procedure behaves like the file-load procedure but opens the specified
 image as layers for an existing image. The returned layers needs to be
-added to the existing image with gimp_image_add_layer().
+added to the existing image with gimp_image_insert_layer().
 HELP
 
     &mitch_pdb_misc('2006', '2.4');
diff --git a/tools/pdbgen/pdb/layer.pdb b/tools/pdbgen/pdb/layer.pdb
index 6d9b172..e3a8488 100644
--- a/tools/pdbgen/pdb/layer.pdb
+++ b/tools/pdbgen/pdb/layer.pdb
@@ -20,11 +20,12 @@ sub layer_new {
     $blurb = 'Create a new layer.';
 
     $help = <<'HELP';
-This procedure creates a new layer with the specified width, height, and type.
-Name, opacity, and mode are also supplied parameters. The new layer still needs
-to be added to the image, as this is not automatic. Add the new layer with the
-gimp_image_add_layer() command. Other attributes such as layer mask modes, and
-offsets should be set with explicit procedure calls.
+This procedure creates a new layer with the specified width, height,
+and type.  Name, opacity, and mode are also supplied parameters. The
+new layer still needs to be added to the image, as this is not
+automatic. Add the new layer with the gimp_image_insert_layer()
+command. Other attributes such as layer mask modes, and offsets should
+be set with explicit procedure calls.
 HELP
 
     &std_pdb_misc;
@@ -68,11 +69,11 @@ sub layer_new_from_visible {
     $blurb = 'Create a new layer from what is visible in an image.';
 
     $help = <<'HELP';
-This procedure creates a new layer from what is visible in the given image.
-The new layer still needs to be added to the destination image, as this is
-not automatic. Add the new layer with the gimp_image_add_layer() command.
-Other attributes such as layer mask modes, and offsets should be set with
-explicit procedure calls.
+This procedure creates a new layer from what is visible in the given
+image.  The new layer still needs to be added to the destination
+image, as this is not automatic. Add the new layer with the
+gimp_image_insert_layer() command.  Other attributes such as layer
+mask modes, and offsets should be set with explicit procedure calls.
 HELP
 
     &neo_pdb_misc('2008', '2.6');
@@ -112,10 +113,11 @@ sub layer_new_from_drawable {
     $blurb = 'Create a new layer by copying an existing drawable.';
 
     $help = <<'HELP';
-This procedure creates a new layer as a copy of the specified drawable.  The
-new layer still needs to be added to the image, as this is not automatic.  Add
-the new layer with the gimp_image_add_layer() command. Other attributes such
-as layer mask modes, and offsets should be set with explicit procedure calls.
+This procedure creates a new layer as a copy of the specified
+drawable.  The new layer still needs to be added to the image, as this
+is not automatic.  Add the new layer with the
+gimp_image_insert_layer() command. Other attributes such as layer mask
+modes, and offsets should be set with explicit procedure calls.
 HELP
 
     &std_pdb_misc;
diff --git a/tools/pdbgen/pdb/text_layer.pdb b/tools/pdbgen/pdb/text_layer.pdb
index dad0cea..2bad960 100644
--- a/tools/pdbgen/pdb/text_layer.pdb
+++ b/tools/pdbgen/pdb/text_layer.pdb
@@ -26,7 +26,7 @@ This procedure creates a new text layer. The arguments are kept as
 simple as necessary for the normal case. All text attributes, however,
 can be modified with the appropriate gimp_text_layer_set_*()
 procedures. The new layer still needs to be added to the image, as
-this is not automatic. Add the new layer using gimp_image_add_layer().
+this is not automatic. Add the new layer using gimp_image_insert_layer().
 HELP
 
     &marcus_pdb_misc('2008', '2.6');
diff --git a/tools/pdbgen/pdb/vectors.pdb b/tools/pdbgen/pdb/vectors.pdb
index d6a97a9..4900ff6 100644
--- a/tools/pdbgen/pdb/vectors.pdb
+++ b/tools/pdbgen/pdb/vectors.pdb
@@ -43,7 +43,7 @@ sub vectors_new {
 
     $help = <<'HELP';
 Creates a new empty vectors object. The vectors object needs to be added to
-the image using gimp_image_add_vectors().
+the image using gimp_image_insert_vectors().
 HELP
 
     &simon_pdb_misc('2005', '2.4');
@@ -76,7 +76,7 @@ sub vectors_new_from_text_layer {
 
     $help = <<'HELP';
 Creates a new vectors object from a text layer. The vectors object needs to
-be added to the image using gimp_image_add_vectors().
+be added to the image using gimp_image_insert_vectors().
 HELP
 
     &marcus_pdb_misc('2008', '2.6');



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