Commit 014cc214 authored by Michael Natterer's avatar Michael Natterer 😴

libgimp: document which context setting affects what prodecures

parent b33076be
......@@ -1789,7 +1789,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. 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.",
"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: 'gimp-image-select-color', 'gimp-image-select-ellipse', 'gimp-image-select-polygon', 'gimp-image-select-fuzzy', 'gimp-image-select-round-rectangle', 'gimp-image-select-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -1835,7 +1835,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. 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.",
"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 setting affects the following procedures: 'gimp-image-select-color', 'gimp-image-select-ellipse', 'gimp-image-select-polygon', 'gimp-image-select-fuzzy', 'gimp-image-select-rectangle', 'gimp-image-select-round-rectangle', 'gimp-image-select-item'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -1887,7 +1887,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: The entire gimp-image-select-foo group of procedures.",
"This procedure modifies the feather radius setting. This setting affects the all procedures that are affected by 'gimp-context-set-feather'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -2172,7 +2172,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-set-interpolation",
"Set the interpolation type.",
"This procedure modifies the interpolation setting. It affects the following procedures: all transform procedures which can produce sub-pixel results, 'gimp-image-scale', 'gimp-layer-scale'.",
"This procedure modifies the interpolation setting. This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix', 'gimp-image-scale', 'gimp-layer-scale'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -2220,7 +2220,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-set-transform-direction",
"Set the transform direction.",
"This procedure modifies the transform direction setting.",
"This procedure modifies the transform direction setting. This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -2268,7 +2268,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-set-transform-resize",
"Set the transform resize type.",
"This procedure modifies the transform resize setting. When transforming pixels, if the result of a transform operation has a different size than the original area, this setting determines how the resulting area is sized.",
"This procedure modifies the transform resize setting. When transforming pixels, if the result of a transform operation has a different size than the original area, this setting determines how the resulting area is sized. This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-flip-simple', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-rotate-simple', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......@@ -2315,7 +2315,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-set-transform-recursion",
"Set the transform supersampling recursion.",
"This procedure modifies the transform supersampling recursion level setting. Whether or not a transformation does supersampling is determined by the interplolation type. The recursion level defaults to 3, which is a nice default value.",
"This procedure modifies the transform supersampling recursion level setting. Whether or not a transformation does supersampling is determined by the interplolation type. The recursion level defaults to 3, which is a nice default value. This setting affects affects the following procedures: 'gimp-item-transform-flip', 'gimp-item-transform-perspective', 'gimp-item-transform-rotate', 'gimp-item-transform-scale', 'gimp-item-transform-shear', 'gimp-item-transform-2d', 'gimp-item-transform-matrix'.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2010",
......
......@@ -907,7 +907,9 @@ gimp_context_get_antialias (void)
* 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.
* gimp_image_select_color(), gimp_image_select_ellipse(),
* gimp_image_select_polygon(), gimp_image_select_fuzzy(),
* gimp_image_select_round_rectangle(), gimp_image_select_item().
*
* Returns: TRUE on success.
*
......@@ -971,9 +973,11 @@ gimp_context_get_feather (void)
* 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.
* gimp_context_set_feather_radius(). This setting affects the
* following procedures: gimp_image_select_color(),
* gimp_image_select_ellipse(), gimp_image_select_polygon(),
* gimp_image_select_fuzzy(), gimp_image_select_rectangle(),
* gimp_image_select_round_rectangle(), gimp_image_select_item().
*
* Returns: TRUE on success.
*
......@@ -1046,9 +1050,9 @@ 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: The entire gimp-image-select-foo
* group of procedures.
* This procedure modifies the feather radius setting. This setting
* affects the all procedures that are affected by
* gimp_context_set_feather().
*
* Returns: TRUE on success.
*
......@@ -1446,9 +1450,13 @@ gimp_context_get_interpolation (void)
*
* Set the interpolation type.
*
* This procedure modifies the interpolation setting. It affects the
* following procedures: all transform procedures which can produce
* sub-pixel results, gimp_image_scale(), gimp_layer_scale().
* This procedure modifies the interpolation setting. This setting
* affects affects the following procedures:
* gimp_item_transform_flip(), gimp_item_transform_perspective(),
* gimp_item_transform_rotate(), gimp_item_transform_scale(),
* gimp_item_transform_shear(), gimp_item_transform_2d(),
* gimp_item_transform_matrix(), gimp_image_scale(),
* gimp_layer_scale().
*
* Returns: TRUE on success.
*
......@@ -1511,7 +1519,12 @@ gimp_context_get_transform_direction (void)
*
* Set the transform direction.
*
* This procedure modifies the transform direction setting.
* This procedure modifies the transform direction setting. This
* setting affects affects the following procedures:
* gimp_item_transform_flip(), gimp_item_transform_perspective(),
* gimp_item_transform_rotate(), gimp_item_transform_scale(),
* gimp_item_transform_shear(), gimp_item_transform_2d(),
* gimp_item_transform_matrix().
*
* Returns: TRUE on success.
*
......@@ -1577,7 +1590,13 @@ gimp_context_get_transform_resize (void)
* This procedure modifies the transform resize setting. When
* transforming pixels, if the result of a transform operation has a
* different size than the original area, this setting determines how
* the resulting area is sized.
* the resulting area is sized. This setting affects affects the
* following procedures: gimp_item_transform_flip(),
* gimp_item_transform_flip_simple(),
* gimp_item_transform_perspective(), gimp_item_transform_rotate(),
* gimp_item_transform_rotate_simple(), gimp_item_transform_scale(),
* gimp_item_transform_shear(), gimp_item_transform_2d(),
* gimp_item_transform_matrix().
*
* Returns: TRUE on success.
*
......@@ -1641,7 +1660,11 @@ gimp_context_get_transform_recursion (void)
* This procedure modifies the transform supersampling recursion level
* setting. Whether or not a transformation does supersampling is
* determined by the interplolation type. The recursion level defaults
* to 3, which is a nice default value.
* to 3, which is a nice default value. This setting affects affects
* the following procedures: gimp_item_transform_flip(),
* gimp_item_transform_perspective(), gimp_item_transform_rotate(),
* gimp_item_transform_scale(), gimp_item_transform_shear(),
* gimp_item_transform_2d(), gimp_item_transform_matrix().
*
* Returns: TRUE on success.
*
......
......@@ -738,8 +738,12 @@ 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.
selection is wanted.
This settings affects the following procedures:
gimp_image_select_color(), gimp_image_select_ellipse(),
gimp_image_select_polygon(), gimp_image_select_fuzzy(),
gimp_image_select_round_rectangle(), gimp_image_select_item().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -792,8 +796,13 @@ sub context_set_feather {
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.
gimp_context_set_feather_radius().
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_ellipse(),
gimp_image_select_polygon(), gimp_image_select_fuzzy(),
gimp_image_select_rectangle(), gimp_image_select_round_rectangle(),
gimp_image_select_item().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -846,9 +855,10 @@ 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: The entire gimp-image-select-foo
group of procedures.
This procedure modifies the feather radius setting.
This setting affects the all procedures that are affected
by gimp_context_set_feather().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -906,8 +916,9 @@ depends on the colors of the pixels present in a drawable, like when
doing a seed fill, this setting controls whether the pixel data from
the specified drawable is used ('sample-merged' is FALSE), or the
pixel data from the composite image ('sample-merged' is TRUE. This is
equivalent to sampling for colors after merging all visible
layers). This setting affects the following procedures:
equivalent to sampling for colors after merging all visible layers).
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_fuzzy().
HELP
......@@ -961,9 +972,10 @@ sub context_set_sample_criterion {
This procedure modifies the sample criterion setting. If an operation
depends on the colors of the pixels present in a drawable, like when
doing a seed fill, this setting controls how color similarity is
determined. SELECT_CRITERION_COMPOSITE is the default value. This
setting affects the following procedures: gimp_image_select_color(),
gimp_image_select_fuzzy().
determined. SELECT_CRITERION_COMPOSITE is the default value.
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_fuzzy().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -1019,8 +1031,10 @@ depends on the colors of the pixels present in a drawable, like when
doing a seed fill, this setting controls what is "sufficiently close"
to be considered a similar color. If the sample threshold has not been
set explicitly, the default threshold set in gimprc will be used.
This setting affects the following procedures: gimp_image_select_color(),
gimp_image_select_fuzzy().
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_fuzzy().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -1045,8 +1059,8 @@ sub context_get_sample_threshold_int {
$blurb = 'Get the sample threshold setting as an integer value.';
$help = <<'HELP';
This procedure returns the sample threshold setting as an integer value.
See gimp_context_get_sample_threshold().
This procedure returns the sample threshold setting as an integer
value. See gimp_context_get_sample_threshold().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -1075,9 +1089,8 @@ sub context_set_sample_threshold_int {
$blurb = 'Set the sample threshold setting as an integer value.';
$help = <<'HELP';
This procedure modifies the sample threshold setting as an integer value.
See gimp_context_set_sample_threshold().
This procedure modifies the sample threshold setting as an integer
value. See gimp_context_set_sample_threshold().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -1127,13 +1140,15 @@ sub context_set_sample_transparent {
$blurb = 'Set the sample transparent setting.';
$help = <<'HELP';
This procedure modifies the sample transparent setting. If an
operation depends on the colors of the pixels present in a drawable,
like when doing a seed fill, this setting controls whether
transparency is considered to be a unique selectable color. When this
setting is TRUE, transparent areas can be selected or filled. This
setting affects the following procedures: gimp_image_select_color(),
gimp_image_select_fuzzy().
setting is TRUE, transparent areas can be selected or filled.
This setting affects the following procedures:
gimp_image_select_color(), gimp_image_select_fuzzy().
HELP
&mitch_pdb_misc('2011', '2.8');
......@@ -1187,9 +1202,13 @@ sub context_set_interpolation {
$blurb = 'Set the interpolation type.';
$help = <<'HELP';
This procedure modifies the interpolation setting. It affects the
following procedures: all transform procedures which can produce
sub-pixel results, gimp_image_scale(), gimp_layer_scale().
This procedure modifies the interpolation setting.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_perspective(),
gimp_item_transform_rotate(), gimp_item_transform_scale(),
gimp_item_transform_shear(), gimp_item_transform_2d(),
gimp_item_transform_matrix(), gimp_image_scale(), gimp_layer_scale().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -1242,6 +1261,12 @@ sub context_set_transform_direction {
$help = <<'HELP';
This procedure modifies the transform direction setting.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_perspective(),
gimp_item_transform_rotate(), gimp_item_transform_scale(),
gimp_item_transform_shear(), gimp_item_transform_2d(),
gimp_item_transform_matrix().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -1297,6 +1322,13 @@ This procedure modifies the transform resize setting. When transforming
pixels, if the result of a transform operation has a different size
than the original area, this setting determines how the resulting area
is sized.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_flip_simple(),
gimp_item_transform_perspective(), gimp_item_transform_rotate(),
gimp_item_transform_rotate_simple(), gimp_item_transform_scale(),
gimp_item_transform_shear(), gimp_item_transform_2d(),
gimp_item_transform_matrix().
HELP
&mitch_pdb_misc('2010', '2.8');
......@@ -1350,6 +1382,12 @@ This procedure modifies the transform supersampling recursion level
setting. Whether or not a transformation does supersampling is
determined by the interplolation type. The recursion level defaults
to 3, which is a nice default value.
This setting affects affects the following procedures:
gimp_item_transform_flip(), gimp_item_transform_perspective(),
gimp_item_transform_rotate(), gimp_item_transform_scale(),
gimp_item_transform_shear(), gimp_item_transform_2d(),
gimp_item_transform_matrix().
HELP
&mitch_pdb_misc('2010', '2.8');
......
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