[gimp] pdb: update documentation for brush-related functions.
- From: Jehan Pagès <jehanp src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] pdb: update documentation for brush-related functions.
- Date: Mon, 2 Nov 2015 16:21:23 +0000 (UTC)
commit 2e40768ea5363c8a287b39e10bdd32eb5189a9a0
Author: Jehan <jehan girinstud io>
Date: Mon Nov 2 17:15:13 2015 +0100
pdb: update documentation for brush-related functions.
Blurbs use third person and need a final point.
Some description were wrong or inaccurate. Add also units where
needed (radius in pixels, angle in degrees).
Some returned values have to be freed.
app/pdb/brush-cmds.c | 78 +++++++++++++++++++-------------------
libgimp/gimpbrush_pdb.c | 89 +++++++++++++++++++++++--------------------
tools/pdbgen/pdb/brush.pdb | 84 ++++++++++++++++++++++--------------------
3 files changed, 131 insertions(+), 120 deletions(-)
---
diff --git a/app/pdb/brush-cmds.c b/app/pdb/brush-cmds.c
index 59e78ef..dcbe629 100644
--- a/app/pdb/brush-cmds.c
+++ b/app/pdb/brush-cmds.c
@@ -898,8 +898,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-new");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-new",
- "Creates a new brush",
- "This procedure creates a new, uninitialized brush",
+ "Creates a new brush.",
+ "This procedure creates a new, uninitialized brush.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
"2004",
@@ -914,7 +914,7 @@ register_brush_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("actual-name",
"actual name",
- "The actual new brush name",
+ "The actual new brush name. The returned value
must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
@@ -929,8 +929,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-duplicate");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-duplicate",
- "Duplicates a brush",
- "This procedure creates an identical brush by a different name",
+ "Duplicates a brush.",
+ "This procedure creates an identical brush by a different name.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
"2004",
@@ -945,7 +945,7 @@ register_brush_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("copy-name",
"copy name",
- "The name of the brush's copy",
+ "The name of the brush's copy. The returned value
must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
@@ -960,8 +960,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-is-generated");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-is-generated",
- "Tests if brush is generated",
- "Returns TRUE if this brush is parametric, FALSE for other types",
+ "Tests if brush is generated.",
+ "Returns TRUE if this brush is parametric, FALSE for other types.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
"2004",
@@ -990,8 +990,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-rename");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-rename",
- "Rename a brush",
- "This procedure renames a brush",
+ "Renames a brush.",
+ "This procedure renames a brush.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
"2004",
@@ -1013,7 +1013,7 @@ register_brush_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
gimp_param_spec_string ("actual-name",
"actual name",
- "The actual new name of the brush",
+ "The actual new name of the brush. The returned
value must be freed with g_free()",
FALSE, FALSE, FALSE,
NULL,
GIMP_PARAM_READWRITE));
@@ -1028,8 +1028,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-delete");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-delete",
- "Deletes a brush",
- "This procedure deletes a brush",
+ "Deletes a brush.",
+ "This procedure deletes a brush.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
"2004",
@@ -1052,8 +1052,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-is-editable");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-is-editable",
- "Tests if brush can be edited",
- "Returns TRUE if you have permission to change the brush",
+ "Tests if brush can be edited.",
+ "Returns TRUE if you have permission to change the brush.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
"2004",
@@ -1082,8 +1082,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-info");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-info",
- "Retrieve information about the specified brush.",
- "This procedure retrieves information about the specified brush. This
includes the brush name, and the brush extents (width and height).",
+ "Retrieves information about the specified brush.",
+ "This procedure retrieves information about the specified brush: brush
extents (width and height), color depth and mask depth.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
"2004",
@@ -1130,7 +1130,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-pixels");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-pixels",
- "Retrieve information about the specified brush.",
+ "Retrieves information about the specified brush.",
"This procedure retrieves information about the specified brush. This
includes the brush extents (width and height) and its pixels data.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
@@ -1200,7 +1200,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-spacing");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-spacing",
- "Get the brush spacing.",
+ "Gets the brush spacing.",
"This procedure returns the spacing setting for the specified brush.
The return value is an integer between 0 and 1000 which represents percentage of the maximum of the width and
height of the mask.",
"Michael Natterer <mitch gimp org>",
"Michael Natterer",
@@ -1230,7 +1230,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-spacing");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-spacing",
- "Set the brush spacing.",
+ "Sets the brush spacing.",
"This procedure modifies the spacing setting for the specified brush.
The value should be a integer between 0 and 1000.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1260,7 +1260,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-shape");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-shape",
- "Get the shape of a generated brush.",
+ "Gets the shape of a generated brush.",
"This procedure gets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current possibilities are Circle
(GIMP_BRUSH_GENERATED_CIRCLE), Square (GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added in the future.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1291,7 +1291,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-shape");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-shape",
- "Set the shape of a generated brush.",
+ "Sets the shape of a generated brush.",
"This procedure sets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current possibilities are Circle
(GIMP_BRUSH_GENERATED_CIRCLE), Square (GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added in the future.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1329,7 +1329,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-radius");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-radius",
- "Get the radius of a generated brush.",
+ "Gets the radius of a generated brush.",
"This procedure gets the radius value for a generated brush. If called
for any other type of brush, it does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1359,7 +1359,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-radius");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-radius",
- "Set the radius of a generated brush.",
+ "Sets the radius of a generated brush.",
"This procedure sets the radius for a generated brush. If called for
any other type of brush, it does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1375,7 +1375,7 @@ register_brush_procs (GimpPDB *pdb)
gimp_procedure_add_argument (procedure,
g_param_spec_double ("radius-in",
"radius in",
- "The desired brush radius",
+ "The desired brush radius in pixel",
-G_MAXDOUBLE, G_MAXDOUBLE, 0,
GIMP_PARAM_READWRITE));
gimp_procedure_add_return_value (procedure,
@@ -1395,7 +1395,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-spikes");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-spikes",
- "Get the number of spikes for a generated brush.",
+ "Gets the number of spikes for a generated brush.",
"This procedure gets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1425,7 +1425,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-spikes");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-spikes",
- "Set the number of spikes for a generated brush.",
+ "Sets the number of spikes for a generated brush.",
"This procedure sets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1461,8 +1461,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-hardness");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-hardness",
- "Get the hardness of a generated brush.",
- "This procedure gets the hardness of a generated brush. The hardness of
a brush is the amount its intensity fades at the outside edge. If called for any other type of brush, the
function does not succeed.",
+ "Gets the hardness of a generated brush.",
+ "This procedure gets the hardness of a generated brush. The hardness of
a brush is the amount its intensity fades at the outside edge, as a float between 0.0 and 1.0. If called for
any other type of brush, the function does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
"2004",
@@ -1491,8 +1491,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-hardness");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-hardness",
- "Set the hardness of a generated brush.",
- "This procedure sets the hardness for a generated brush. If called for
any other type of brush, it does not succeed.",
+ "Sets the hardness of a generated brush.",
+ "This procedure sets the hardness for a generated brush. If called for
any other type of brush, it does not succeed. The value should be a float between 0.0 and 1.0.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
"2004",
@@ -1527,8 +1527,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-aspect-ratio");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-aspect-ratio",
- "Get the aspect ratio of a generated brush.",
- "This procedure gets the aspect ratio of a generated brush. If called
for any other type of brush, it does not succeed.",
+ "Gets the aspect ratio of a generated brush.",
+ "This procedure gets the aspect ratio of a generated brush. If called
for any other type of brush, it does not succeed. The return value is a float between 0.0 and 1000.0.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
"2004",
@@ -1557,8 +1557,8 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-aspect-ratio");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-aspect-ratio",
- "Set the aspect ratio of a generated brush.",
- "This procedure sets the aspect ratio for a generated brush. If called
for any other type of brush, it does not succeed.",
+ "Sets the aspect ratio of a generated brush.",
+ "This procedure sets the aspect ratio for a generated brush. If called
for any other type of brush, it does not succeed. The value should be a float between 0.0 and 1000.0.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
"2004",
@@ -1593,7 +1593,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-get-angle");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-get-angle",
- "Get the rotation angle of a generated brush.",
+ "Gets the rotation angle of a generated brush.",
"This procedure gets the angle of rotation for a generated brush. If
called for any other type of brush, it does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1609,7 +1609,7 @@ register_brush_procs (GimpPDB *pdb)
gimp_procedure_add_return_value (procedure,
g_param_spec_double ("angle",
"angle",
- "The rotation angle of the brush.",
+ "The rotation angle of the brush in degree.",
-G_MAXDOUBLE, G_MAXDOUBLE, 0,
GIMP_PARAM_READWRITE));
gimp_pdb_register_procedure (pdb, procedure);
@@ -1623,7 +1623,7 @@ register_brush_procs (GimpPDB *pdb)
"gimp-brush-set-angle");
gimp_procedure_set_static_strings (procedure,
"gimp-brush-set-angle",
- "Set the rotation angle of a generated brush.",
+ "Sets the rotation angle of a generated brush.",
"This procedure sets the rotation angle for a generated brush. If
called for any other type of brush, it does not succeed.",
"Bill Skaggs <weskaggs primate ucdavis edu>",
"Bill Skaggs",
@@ -1639,7 +1639,7 @@ register_brush_procs (GimpPDB *pdb)
gimp_procedure_add_argument (procedure,
g_param_spec_double ("angle-in",
"angle in",
- "The desired brush rotation angle",
+ "The desired brush rotation angle in degree",
-G_MAXDOUBLE, G_MAXDOUBLE, 0,
GIMP_PARAM_READWRITE));
gimp_procedure_add_return_value (procedure,
diff --git a/libgimp/gimpbrush_pdb.c b/libgimp/gimpbrush_pdb.c
index 238b57d..6ae46a3 100644
--- a/libgimp/gimpbrush_pdb.c
+++ b/libgimp/gimpbrush_pdb.c
@@ -40,11 +40,12 @@
* gimp_brush_new:
* @name: The requested name of the new brush.
*
- * Creates a new brush
+ * Creates a new brush.
*
- * This procedure creates a new, uninitialized brush
+ * This procedure creates a new, uninitialized brush.
*
- * Returns: The actual new brush name.
+ * Returns: The actual new brush name. The returned value must be freed
+ * with g_free().
*
* Since: 2.2
**/
@@ -72,11 +73,12 @@ gimp_brush_new (const gchar *name)
* gimp_brush_duplicate:
* @name: The brush name.
*
- * Duplicates a brush
+ * Duplicates a brush.
*
- * This procedure creates an identical brush by a different name
+ * This procedure creates an identical brush by a different name.
*
- * Returns: The name of the brush's copy.
+ * Returns: The name of the brush's copy. The returned value must be
+ * freed with g_free().
*
* Since: 2.2
**/
@@ -104,9 +106,9 @@ gimp_brush_duplicate (const gchar *name)
* gimp_brush_is_generated:
* @name: The brush name.
*
- * Tests if brush is generated
+ * Tests if brush is generated.
*
- * Returns TRUE if this brush is parametric, FALSE for other types
+ * Returns TRUE if this brush is parametric, FALSE for other types.
*
* Returns: TRUE if the brush is generated.
*
@@ -137,11 +139,12 @@ gimp_brush_is_generated (const gchar *name)
* @name: The brush name.
* @new_name: The new name of the brush.
*
- * Rename a brush
+ * Renames a brush.
*
- * This procedure renames a brush
+ * This procedure renames a brush.
*
- * Returns: The actual new name of the brush.
+ * Returns: The actual new name of the brush. The returned value must
+ * be freed with g_free().
*
* Since: 2.2
**/
@@ -171,9 +174,9 @@ gimp_brush_rename (const gchar *name,
* gimp_brush_delete:
* @name: The brush name.
*
- * Deletes a brush
+ * Deletes a brush.
*
- * This procedure deletes a brush
+ * This procedure deletes a brush.
*
* Returns: TRUE on success.
*
@@ -202,9 +205,9 @@ gimp_brush_delete (const gchar *name)
* gimp_brush_is_editable:
* @name: The brush name.
*
- * Tests if brush can be edited
+ * Tests if brush can be edited.
*
- * Returns TRUE if you have permission to change the brush
+ * Returns TRUE if you have permission to change the brush.
*
* Returns: TRUE if the brush can be edited.
*
@@ -238,10 +241,10 @@ gimp_brush_is_editable (const gchar *name)
* @mask_bpp: The brush mask bpp.
* @color_bpp: The brush color bpp.
*
- * Retrieve information about the specified brush.
+ * Retrieves information about the specified brush.
*
- * This procedure retrieves information about the specified brush. This
- * includes the brush name, and the brush extents (width and height).
+ * This procedure retrieves information about the specified brush:
+ * brush extents (width and height), color depth and mask depth.
*
* Returns: TRUE on success.
*
@@ -295,7 +298,7 @@ gimp_brush_get_info (const gchar *name,
* @num_color_bytes: Length of brush color data.
* @color_bytes: The brush color data.
*
- * Retrieve information about the specified brush.
+ * Retrieves information about the specified brush.
*
* This procedure retrieves information about the specified brush. This
* includes the brush extents (width and height) and its pixels data.
@@ -363,7 +366,7 @@ gimp_brush_get_pixels (const gchar *name,
* @name: The brush name.
* @spacing: The brush spacing.
*
- * Get the brush spacing.
+ * Gets the brush spacing.
*
* This procedure returns the spacing setting for the specified brush.
* The return value is an integer between 0 and 1000 which represents
@@ -403,7 +406,7 @@ gimp_brush_get_spacing (const gchar *name,
* @name: The brush name.
* @spacing: The brush spacing.
*
- * Set the brush spacing.
+ * Sets the brush spacing.
*
* This procedure modifies the spacing setting for the specified brush.
* The value should be a integer between 0 and 1000.
@@ -437,7 +440,7 @@ gimp_brush_set_spacing (const gchar *name,
* gimp_brush_get_shape:
* @name: The brush name.
*
- * Get the shape of a generated brush.
+ * Gets the shape of a generated brush.
*
* This procedure gets the shape value for a generated brush. If called
* for any other type of brush, it does not succeed. The current
@@ -475,7 +478,7 @@ gimp_brush_get_shape (const gchar *name)
* @name: The brush name.
* @shape_in: The brush shape.
*
- * Set the shape of a generated brush.
+ * Sets the shape of a generated brush.
*
* This procedure sets the shape value for a generated brush. If called
* for any other type of brush, it does not succeed. The current
@@ -514,7 +517,7 @@ gimp_brush_set_shape (const gchar *name,
* gimp_brush_get_radius:
* @name: The brush name.
*
- * Get the radius of a generated brush.
+ * Gets the radius of a generated brush.
*
* This procedure gets the radius value for a generated brush. If
* called for any other type of brush, it does not succeed.
@@ -546,9 +549,9 @@ gimp_brush_get_radius (const gchar *name)
/**
* gimp_brush_set_radius:
* @name: The brush name.
- * @radius_in: The desired brush radius.
+ * @radius_in: The desired brush radius in pixel.
*
- * Set the radius of a generated brush.
+ * Sets the radius of a generated brush.
*
* This procedure sets the radius for a generated brush. If called for
* any other type of brush, it does not succeed.
@@ -583,7 +586,7 @@ gimp_brush_set_radius (const gchar *name,
* gimp_brush_get_spikes:
* @name: The brush name.
*
- * Get the number of spikes for a generated brush.
+ * Gets the number of spikes for a generated brush.
*
* This procedure gets the number of spikes for a generated brush. If
* called for any other type of brush, it does not succeed.
@@ -617,7 +620,7 @@ gimp_brush_get_spikes (const gchar *name)
* @name: The brush name.
* @spikes_in: The desired number of spikes.
*
- * Set the number of spikes for a generated brush.
+ * Sets the number of spikes for a generated brush.
*
* This procedure sets the number of spikes for a generated brush. If
* called for any other type of brush, it does not succeed.
@@ -652,11 +655,12 @@ gimp_brush_set_spikes (const gchar *name,
* gimp_brush_get_hardness:
* @name: The brush name.
*
- * Get the hardness of a generated brush.
+ * Gets the hardness of a generated brush.
*
* This procedure gets the hardness of a generated brush. The hardness
- * of a brush is the amount its intensity fades at the outside edge. If
- * called for any other type of brush, the function does not succeed.
+ * of a brush is the amount its intensity fades at the outside edge, as
+ * a float between 0.0 and 1.0. If called for any other type of brush,
+ * the function does not succeed.
*
* Returns: The hardness of the brush.
*
@@ -687,10 +691,11 @@ gimp_brush_get_hardness (const gchar *name)
* @name: The brush name.
* @hardness_in: The desired brush hardness.
*
- * Set the hardness of a generated brush.
+ * Sets the hardness of a generated brush.
*
* This procedure sets the hardness for a generated brush. If called
- * for any other type of brush, it does not succeed.
+ * for any other type of brush, it does not succeed. The value should
+ * be a float between 0.0 and 1.0.
*
* Returns: The brush hardness actually assigned.
*
@@ -722,10 +727,11 @@ gimp_brush_set_hardness (const gchar *name,
* gimp_brush_get_aspect_ratio:
* @name: The brush name.
*
- * Get the aspect ratio of a generated brush.
+ * Gets the aspect ratio of a generated brush.
*
* This procedure gets the aspect ratio of a generated brush. If called
- * for any other type of brush, it does not succeed.
+ * for any other type of brush, it does not succeed. The return value
+ * is a float between 0.0 and 1000.0.
*
* Returns: The aspect ratio of the brush.
*
@@ -756,10 +762,11 @@ gimp_brush_get_aspect_ratio (const gchar *name)
* @name: The brush name.
* @aspect_ratio_in: The desired brush aspect ratio.
*
- * Set the aspect ratio of a generated brush.
+ * Sets the aspect ratio of a generated brush.
*
* This procedure sets the aspect ratio for a generated brush. If
- * called for any other type of brush, it does not succeed.
+ * called for any other type of brush, it does not succeed. The value
+ * should be a float between 0.0 and 1000.0.
*
* Returns: The brush aspect ratio actually assigned.
*
@@ -791,12 +798,12 @@ gimp_brush_set_aspect_ratio (const gchar *name,
* gimp_brush_get_angle:
* @name: The brush name.
*
- * Get the rotation angle of a generated brush.
+ * Gets the rotation angle of a generated brush.
*
* This procedure gets the angle of rotation for a generated brush. If
* called for any other type of brush, it does not succeed.
*
- * Returns: The rotation angle of the brush.
+ * Returns: The rotation angle of the brush in degree.
*
* Since: 2.4
**/
@@ -823,9 +830,9 @@ gimp_brush_get_angle (const gchar *name)
/**
* gimp_brush_set_angle:
* @name: The brush name.
- * @angle_in: The desired brush rotation angle.
+ * @angle_in: The desired brush rotation angle in degree.
*
- * Set the rotation angle of a generated brush.
+ * Sets the rotation angle of a generated brush.
*
* This procedure sets the rotation angle for a generated brush. If
* called for any other type of brush, it does not succeed.
diff --git a/tools/pdbgen/pdb/brush.pdb b/tools/pdbgen/pdb/brush.pdb
index e51a170..92d0b42 100644
--- a/tools/pdbgen/pdb/brush.pdb
+++ b/tools/pdbgen/pdb/brush.pdb
@@ -17,8 +17,8 @@
# "Perlized" from C source by Manish Singh <yosh gimp org>
sub brush_new {
- $blurb = "Creates a new brush";
- $help = "This procedure creates a new, uninitialized brush";
+ $blurb = "Creates a new brush.";
+ $help = "This procedure creates a new, uninitialized brush.";
&mitch_pdb_misc('2004', '2.2');
@@ -29,7 +29,7 @@ sub brush_new {
@outargs = (
{ name => 'actual_name', type => 'string',
- desc => 'The actual new brush name' }
+ desc => 'The actual new brush name. The returned value must be freed with g_free()' }
);
%invoke = (
@@ -48,8 +48,8 @@ CODE
}
sub brush_duplicate {
- $blurb = "Duplicates a brush";
- $help = "This procedure creates an identical brush by a different name";
+ $blurb = "Duplicates a brush.";
+ $help = "This procedure creates an identical brush by a different name.";
&mitch_pdb_misc('2004', '2.2');
@@ -60,7 +60,7 @@ sub brush_duplicate {
@outargs = (
{ name => 'copy_name', type => 'string',
- desc => "The name of the brush's copy" }
+ desc => "The name of the brush's copy. The returned value must be freed with g_free()" }
);
%invoke = (
@@ -87,8 +87,8 @@ CODE
}
sub brush_is_generated {
- $blurb = "Tests if brush is generated";
- $help = "Returns TRUE if this brush is parametric, FALSE for other types";
+ $blurb = "Tests if brush is generated.";
+ $help = "Returns TRUE if this brush is parametric, FALSE for other types.";
&bill_pdb_misc('2004', '2.4');
@@ -117,8 +117,8 @@ CODE
}
sub brush_is_editable {
- $blurb = "Tests if brush can be edited";
- $help = "Returns TRUE if you have permission to change the brush";
+ $blurb = "Tests if brush can be edited.";
+ $help = "Returns TRUE if you have permission to change the brush.";
&bill_pdb_misc('2004', '2.4');
@@ -147,8 +147,8 @@ CODE
}
sub brush_rename {
- $blurb = "Rename a brush";
- $help = "This procedure renames a brush";
+ $blurb = "Renames a brush.";
+ $help = "This procedure renames a brush.";
&mitch_pdb_misc('2004', '2.2');
@@ -161,7 +161,7 @@ sub brush_rename {
@outargs = (
{ name => 'actual_name', type => 'string',
- desc => 'The actual new name of the brush' }
+ desc => 'The actual new name of the brush. The returned value must be freed with g_free()' }
);
%invoke = (
@@ -182,8 +182,8 @@ CODE
}
sub brush_delete {
- $blurb = "Deletes a brush";
- $help = "This procedure deletes a brush";
+ $blurb = "Deletes a brush.";
+ $help = "This procedure deletes a brush.";
&mitch_pdb_misc('2004', '2.2');
@@ -209,11 +209,11 @@ CODE
}
sub brush_get_info {
- $blurb = "Retrieve information about the specified brush.";
+ $blurb = "Retrieves information about the specified brush.";
$help = <<'HELP';
-This procedure retrieves information about the specified brush. This
-includes the brush name, and the brush extents (width and height).
+This procedure retrieves information about the specified brush:
+brush extents (width and height), color depth and mask depth.
HELP
&mitch_pdb_misc('2004', '2.2');
@@ -257,7 +257,7 @@ CODE
}
sub brush_get_pixels {
- $blurb = 'Retrieve information about the specified brush.';
+ $blurb = 'Retrieves information about the specified brush.';
$help = <<'HELP';
This procedure retrieves information about the specified brush. This
@@ -324,7 +324,7 @@ CODE
}
sub brush_get_spacing {
- $blurb = 'Get the brush spacing.';
+ $blurb = 'Gets the brush spacing.';
$help = <<'HELP';
This procedure returns the spacing setting for the specified brush.
@@ -359,7 +359,7 @@ CODE
}
sub brush_get_shape {
- $blurb = 'Get the shape of a generated brush.';
+ $blurb = 'Gets the shape of a generated brush.';
$help = <<'HELP';
This procedure gets the shape value for a generated brush. If
@@ -397,7 +397,7 @@ CODE
}
sub brush_get_radius {
- $blurb = 'Get the radius of a generated brush.';
+ $blurb = 'Gets the radius of a generated brush.';
$help = <<'HELP';
This procedure gets the radius value for a generated brush. If
@@ -431,7 +431,7 @@ CODE
}
sub brush_get_spikes {
- $blurb = 'Get the number of spikes for a generated brush.';
+ $blurb = 'Gets the number of spikes for a generated brush.';
$help = <<'HELP';
This procedure gets the number of spikes for a generated brush.
@@ -465,13 +465,14 @@ CODE
}
sub brush_get_hardness {
- $blurb = 'Get the hardness of a generated brush.';
+ $blurb = 'Gets the hardness of a generated brush.';
$help = <<'HELP';
This procedure gets the hardness of a generated brush. The
hardness of a brush is the amount its intensity fades at the
-outside edge. If called for any other type of brush, the function
-does not succeed.
+outside edge, as a float between 0.0 and 1.0.
+If called for any other type of brush, the function does not
+succeed.
HELP
&bill_pdb_misc('2004', '2.4');
@@ -501,11 +502,12 @@ CODE
}
sub brush_get_aspect_ratio {
- $blurb = 'Get the aspect ratio of a generated brush.';
+ $blurb = 'Gets the aspect ratio of a generated brush.';
$help = <<'HELP';
This procedure gets the aspect ratio of a generated brush.
If called for any other type of brush, it does not succeed.
+The return value is a float between 0.0 and 1000.0.
HELP
&bill_pdb_misc('2004', '2.4');
@@ -535,7 +537,7 @@ CODE
}
sub brush_get_angle {
- $blurb = 'Get the rotation angle of a generated brush.';
+ $blurb = 'Gets the rotation angle of a generated brush.';
$help = <<'HELP';
This procedure gets the angle of rotation for a generated brush.
@@ -551,7 +553,7 @@ HELP
@outargs = (
{ name => 'angle', type => 'float',
- desc => 'The rotation angle of the brush.' }
+ desc => 'The rotation angle of the brush in degree.' }
);
%invoke = (
@@ -569,7 +571,7 @@ CODE
}
sub brush_set_spacing {
- $blurb = 'Set the brush spacing.';
+ $blurb = 'Sets the brush spacing.';
$help = <<'HELP';
This procedure modifies the spacing setting for the specified brush.
@@ -600,7 +602,7 @@ CODE
}
sub brush_set_shape {
- $blurb = 'Set the shape of a generated brush.';
+ $blurb = 'Sets the shape of a generated brush.';
$help = <<'HELP';
This procedure sets the shape value for a generated brush. If
@@ -644,7 +646,7 @@ CODE
}
sub brush_set_radius {
- $blurb = 'Set the radius of a generated brush.';
+ $blurb = 'Sets the radius of a generated brush.';
$help = <<'HELP';
This procedure sets the radius for a generated brush. If
@@ -657,7 +659,7 @@ HELP
{ name => 'name', type => 'string', non_empty => 1,
desc => 'The brush name' },
{ name => 'radius_in', type => 'float',
- desc => 'The desired brush radius' }
+ desc => 'The desired brush radius in pixel' }
);
@outargs = (
@@ -684,7 +686,7 @@ CODE
}
sub brush_set_spikes {
- $blurb = 'Set the number of spikes for a generated brush.';
+ $blurb = 'Sets the number of spikes for a generated brush.';
$help = <<'HELP';
This procedure sets the number of spikes for a generated brush. If
@@ -724,11 +726,12 @@ CODE
}
sub brush_set_hardness {
- $blurb = 'Set the hardness of a generated brush.';
+ $blurb = 'Sets the hardness of a generated brush.';
$help = <<'HELP';
This procedure sets the hardness for a generated brush. If
called for any other type of brush, it does not succeed.
+The value should be a float between 0.0 and 1.0.
HELP
&bill_pdb_misc('2004', '2.4');
@@ -764,11 +767,12 @@ CODE
}
sub brush_set_aspect_ratio {
- $blurb = 'Set the aspect ratio of a generated brush.';
+ $blurb = 'Sets the aspect ratio of a generated brush.';
$help = <<'HELP';
-This procedure sets the aspect ratio for a generated brush. If
-called for any other type of brush, it does not succeed.
+This procedure sets the aspect ratio for a generated brush.
+If called for any other type of brush, it does not succeed.
+The value should be a float between 0.0 and 1000.0.
HELP
&bill_pdb_misc('2004', '2.4');
@@ -804,7 +808,7 @@ CODE
}
sub brush_set_angle {
- $blurb = 'Set the rotation angle of a generated brush.';
+ $blurb = 'Sets the rotation angle of a generated brush.';
$help = <<'HELP';
This procedure sets the rotation angle for a generated brush. If
@@ -817,7 +821,7 @@ HELP
{ name => 'name', type => 'string', non_empty => 1,
desc => 'The brush name' },
{ name => 'angle_in', type => 'float',
- desc => 'The desired brush rotation angle' }
+ desc => 'The desired brush rotation angle in degree' }
);
@outargs = (
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
