[gimp] pdb: preemtively update context docs for upcoming selection API changes



commit 108c6f4e41362e554ff44442698ccd396b696deb
Author: Michael Natterer <mitch gimp org>
Date:   Sat Oct 30 21:58:00 2010 +0200

    pdb: preemtively update context docs for upcoming selection API changes

 app/pdb/context-cmds.c       |    6 +++---
 libgimp/gimpcontext_pdb.c    |   19 ++++++++++++++-----
 tools/pdbgen/pdb/context.pdb |   20 ++++++++++++++------
 3 files changed, 31 insertions(+), 14 deletions(-)
---
diff --git a/app/pdb/context-cmds.c b/app/pdb/context-cmds.c
index 57174c3..0ba4dac 100644
--- a/app/pdb/context-cmds.c
+++ b/app/pdb/context-cmds.c
@@ -1560,7 +1560,7 @@ register_context_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-context-set-antialias",
                                      "Set the antialias setting.",
-                                     "This procedure modifies the antialias setting. This settings affects the following procedures: gimp-item-to-selection.",
+                                     "This procedure modifies the antialias setting. If antialiasing is turned on, the edges of selected region will contain intermediate values which give the appearance of a sharper, less pixelized edge. This should be set as TRUE most of the time unless a binary-only selection is wanted. This settings affects the following procedures: The entire gimp-image-select-foo group of procedures.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2010",
@@ -1606,7 +1606,7 @@ register_context_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-context-set-feather",
                                      "Set the feather setting.",
-                                     "This procedure modifies the feather setting. This settings affects the following procedures: gimp-item-to-selection.",
+                                     "This procedure modifies the feather setting. If the feather option is enabled, selections will be blurred before combining. The blur is a gaussian blur; its radii can be controlled using 'gimp-context-set-feather-radius'. This settings affects the following procedures: The entire gimp-image-select-foo group of procedures.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2010",
@@ -1658,7 +1658,7 @@ register_context_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-context-set-feather-radius",
                                      "Set the feather radius setting.",
-                                     "This procedure modifies the feather radius setting. This settings affects the following procedures: gimp-item-to-selection.",
+                                     "This procedure modifies the feather radius setting. This settings affects the following procedures: The entire gimp-image-select-foo group of procedures.",
                                      "Michael Natterer <mitch gimp org>",
                                      "Michael Natterer",
                                      "2010",
diff --git a/libgimp/gimpcontext_pdb.c b/libgimp/gimpcontext_pdb.c
index dcb8635..68e4de0 100644
--- a/libgimp/gimpcontext_pdb.c
+++ b/libgimp/gimpcontext_pdb.c
@@ -902,8 +902,12 @@ gimp_context_get_antialias (void)
  *
  * Set the antialias setting.
  *
- * This procedure modifies the antialias setting. This settings affects
- * the following procedures: gimp-item-to-selection.
+ * This procedure modifies the antialias setting. If antialiasing is
+ * turned on, the edges of selected region will contain intermediate
+ * values which give the appearance of a sharper, less pixelized edge.
+ * This should be set as TRUE most of the time unless a binary-only
+ * selection is wanted. This settings affects the following procedures:
+ * The entire gimp-image-select-foo group of procedures.
  *
  * Returns: TRUE on success.
  *
@@ -964,8 +968,12 @@ gimp_context_get_feather (void)
  *
  * Set the feather setting.
  *
- * This procedure modifies the feather setting. This settings affects
- * the following procedures: gimp-item-to-selection.
+ * This procedure modifies the feather setting. If the feather option
+ * is enabled, selections will be blurred before combining. The blur is
+ * a gaussian blur; its radii can be controlled using
+ * gimp_context_set_feather_radius(). This settings affects the
+ * following procedures: The entire gimp-image-select-foo group of
+ * procedures.
  *
  * Returns: TRUE on success.
  *
@@ -1039,7 +1047,8 @@ gimp_context_get_feather_radius (gdouble *feather_radius_x,
  * Set the feather radius setting.
  *
  * This procedure modifies the feather radius setting. This settings
- * affects the following procedures: gimp-item-to-selection.
+ * affects the following procedures: The entire gimp-image-select-foo
+ * group of procedures.
  *
  * Returns: TRUE on success.
  *
diff --git a/tools/pdbgen/pdb/context.pdb b/tools/pdbgen/pdb/context.pdb
index 2249295..f569b26 100644
--- a/tools/pdbgen/pdb/context.pdb
+++ b/tools/pdbgen/pdb/context.pdb
@@ -734,8 +734,12 @@ sub context_set_antialias {
     $blurb = 'Set the antialias setting.';
 
     $help = <<'HELP';
-This procedure modifies the antialias setting. This settings affects the
-following procedures: gimp-item-to-selection.
+This procedure modifies the antialias setting. If antialiasing is
+turned on, the edges of selected region will contain intermediate
+values which give the appearance of a sharper, less pixelized edge.
+This should be set as TRUE most of the time unless a binary-only
+selection is wanted. This settings affects the following procedures:
+The entire gimp-image-select-foo group of procedures.
 HELP
 
     &mitch_pdb_misc('2010', '2.8');
@@ -785,8 +789,11 @@ sub context_set_feather {
     $blurb = 'Set the feather setting.';
 
     $help = <<'HELP';
-This procedure modifies the feather setting. This settings affects the
-following procedures: gimp-item-to-selection.
+This procedure modifies the feather setting. If the feather option is
+enabled, selections will be blurred before combining. The blur is a
+gaussian blur; its radii can be controlled using
+gimp_context_set_feather_radius(). This settings affects the following
+procedures: The entire gimp-image-select-foo group of procedures.
 HELP
 
     &mitch_pdb_misc('2010', '2.8');
@@ -839,8 +846,9 @@ sub context_set_feather_radius {
     $blurb = 'Set the feather radius setting.';
 
     $help = <<'HELP';
-This procedure modifies the feather radius setting. This settings affects
-the following procedures: gimp-item-to-selection.
+This procedure modifies the feather radius setting. This settings
+affects the following procedures: The entire gimp-image-select-foo
+group of procedures.
 HELP
 
     &mitch_pdb_misc('2010', '2.8');



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