Commit e4e581cc authored by Michael Natterer's avatar Michael Natterer 😴 Committed by Michael Natterer

in help texts, refer to other procedures using_c_syntax(). This way

2006-06-14  Michael Natterer  <mitch@gimp.org>

	* tools/pdbgen/pdb/[many].pdb: in help texts, refer to other
	procedures using_c_syntax(). This way gtk-doc can cross-reference
	them correctly in libgimp, and app.pl will transform them
	'to-canonical-names' for PDB registering.

	* app/pdb/[many]_cmds.c
	* libgimp/[many]_pdb.c: regenerated.
parent b01efbff
2006-06-14 Michael Natterer <mitch@gimp.org>
* tools/pdbgen/pdb/[many].pdb: in help texts, refer to other
procedures using_c_syntax(). This way gtk-doc can cross-reference
them correctly in libgimp, and app.pl will transform them
'to-canonical-names' for PDB registering.
* app/pdb/[many]_cmds.c
* libgimp/[many]_pdb.c: regenerated.
2006-06-13 Bill Skaggs <weskaggs@primate.ucdavis.edu>
* app/tools/gimpbycolorselect.[ch]: allow modifying threshold
......
......@@ -341,7 +341,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-add-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",
......
......@@ -1110,7 +1110,7 @@ register_color_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-curves-spline",
"Modifies the intensity curve(s) for specified drawable.",
"Modifies the intensity mapping for one channel in the specified drawable. The drawable must be either grayscale or RGB, and the channel can be either an intensity component, or the value. The 'control_pts' parameter is an array of integers which define a set of control points which describe a Catmull Rom spline which yields the final intensity curve. Use the 'gimp_curves_explicit' function to explicitly modify intensity levels.",
"Modifies the intensity mapping for one channel in the specified drawable. The drawable must be either grayscale or RGB, and the channel can be either an intensity component, or the value. The 'control_pts' parameter is an array of integers which define a set of control points which describe a Catmull Rom spline which yields the final intensity curve. Use the 'gimp-curves-explicit' function to explicitly modify intensity levels.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -1150,7 +1150,7 @@ register_color_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-curves-explicit",
"Modifies the intensity curve(s) for specified drawable.",
"Modifies the intensity mapping for one channel in the specified drawable. The drawable must be either grayscale or RGB, and the channel can be either an intensity component, or the value. The 'curve' parameter is an array of bytes which explicitly defines how each pixel value in the drawable will be modified. Use the 'gimp_curves_spline' function to modify intensity levels with Catmull Rom splines.",
"Modifies the intensity mapping for one channel in the specified drawable. The drawable must be either grayscale or RGB, and the channel can be either an intensity component, or the value. The 'curve' parameter is an array of bytes which explicitly defines how each pixel value in the drawable will be modified. Use the 'gimp-curves-spline' function to modify intensity levels with Catmull Rom splines.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -1283,7 +1283,7 @@ register_color_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-histogram",
"Returns information on the intensity histogram for the specified drawable.",
"This tool makes it possible to gather information about the intensity histogram of a drawable. A channel to examine is first specified. This can be either value, red, green, or blue, depending on whether the drawable is of type color or grayscale. The drawable may not be indexed. Second, a range of intensities are specified. The gimp_histogram function returns statistics based on the pixels in the drawable that fall under this range of values. Mean, standard deviation, median, number of pixels, and percentile are all returned. Additionally, the total count of pixels in the image is returned. Counts of pixels are weighted by any associated alpha values and by the current selection mask. That is, pixels that lie outside an active selection mask will not be counted. Similarly, pixels with transparent alpha values will not be counted.",
"This tool makes it possible to gather information about the intensity histogram of a drawable. A channel to examine is first specified. This can be either value, red, green, or blue, depending on whether the drawable is of type color or grayscale. The drawable may not be indexed. Second, a range of intensities are specified. The 'gimp-histogram' function returns statistics based on the pixels in the drawable that fall under this range of values. Mean, standard deviation, median, number of pixels, and percentile are all returned. Additionally, the total count of pixels in the image is returned. Counts of pixels are weighted by any associated alpha values and by the current selection mask. That is, pixels that lie outside an active selection mask will not be counted. Similarly, pixels with transparent alpha values will not be counted.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......
......@@ -578,7 +578,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-push",
"Pushes a context to the top of the plug-in's context stack.",
"This procedure creates a new context by copying the current context. This copy becomes the new current context for the calling plug-in until it is popped again using gimp-context-pop.",
"This procedure creates a new context by copying the current context. This copy becomes the new current context for the calling plug-in until it is popped again using 'gimp-context-pop'.",
"Michael Natterer <mitch@gimp.org> & Sven Neumann <sven@gimp.org>",
"Michael Natterer & Sven Neumann",
"2004",
......@@ -594,7 +594,7 @@ register_context_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-context-pop",
"Pops the topmost context from the plug-in's context stack.",
"This procedure removes the topmost context from the plug-in's context stack. The context that was active before the corresponding call to gimp-context-push becomes the new current context of the plug-in.",
"This procedure removes the topmost context from the plug-in's context stack. The context that was active before the corresponding call to 'gimp-context-push' becomes the new current context of the plug-in.",
"Michael Natterer <mitch@gimp.org> & Sven Neumann <sven@gimp.org>",
"Michael Natterer & Sven Neumann",
"2004",
......
......@@ -782,7 +782,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-edit-named-cut",
"Cut into a named buffer.",
"This procedure works like gimp-edit-cut, but additionally stores the cut buffer into a named buffer that will stay available for later pasting, regardless of any intermediate copy or cut operations.",
"This procedure works like 'gimp-edit-cut', but additionally stores the cut buffer into a named buffer that will stay available for later pasting, regardless of any intermediate copy or cut operations.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2005",
......@@ -818,7 +818,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-edit-named-copy",
"Copy into a named buffer.",
"This procedure works like gimp-edit-copy, but additionally stores the copied buffer into a named buffer that will stay available for later pasting, regardless of any intermediate copy or cut operations.",
"This procedure works like 'gimp-edit-copy', but additionally stores the copied buffer into a named buffer that will stay available for later pasting, regardless of any intermediate copy or cut operations.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2005",
......@@ -854,7 +854,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-edit-named-copy-visible",
"Copy from the projection into a named buffer.",
"This procedure works like gimp-edit-copy-visible, but additionally stores the copied buffer into a named buffer that will stay available for later pasting, regardless of any intermediate copy or cut operations.",
"This procedure works like 'gimp-edit-copy-visible', but additionally stores the copied buffer into a named buffer that will stay available for later pasting, regardless of any intermediate copy or cut operations.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2005",
......@@ -890,7 +890,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-edit-named-paste",
"Paste named buffer to the specified drawable.",
"This procedure works like gimp-edit-paste but pastes a named buffer instead of the global buffer.",
"This procedure works like 'gimp-edit-paste' but pastes a named buffer instead of the global buffer.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2005",
......@@ -931,7 +931,7 @@ register_edit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-edit-named-paste-as-new",
"Paste named buffer to a new image.",
"This procedure works like gimp-edit-paste-as-new but pastes a named buffer instead of the global buffer.",
"This procedure works like 'gimp-edit-paste-as-new' but pastes a named buffer instead of the global buffer.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2005",
......
......@@ -579,7 +579,7 @@ register_fileops_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-file-load-thumbnail",
"Loads the thumbnail for a file.",
"This procedure tries to load a thumbnail that belongs to the file with the given filename. This name is a full pathname. The returned data is an array of colordepth 3 (RGB), regardless of the image type. Width and height of the thumbnail are also returned. Don't use this function if you need a thumbnail of an already opened image, use gimp_image_thumbnail instead.",
"This procedure tries to load a thumbnail that belongs to the file with the given filename. This name is a full pathname. The returned data is an array of colordepth 3 (RGB), regardless of the image type. Width and height of the thumbnail are also returned. Don't use this function if you need a thumbnail of an already opened image, use 'gimp-image-thumbnail' instead.",
"Adam D. Moss, Sven Neumann",
"Adam D. Moss, Sven Neumann",
"1999-2003",
......
......@@ -238,7 +238,7 @@ register_gimprc_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-gimprc-set",
"Sets a gimprc token to a value and saves it in the gimprc.",
"This procedure is used to add or change additional information in the gimprc file that is considered extraneous to the operation of the GIMP. Plug-ins that need configuration information can use this function to store it, and gimp_gimprc_query to retrieve it. This will accept _only_ string values in UTF-8 encoding.",
"This procedure is used to add or change additional information in the gimprc file that is considered extraneous to the operation of the GIMP. Plug-ins that need configuration information can use this function to store it, and 'gimp-gimprc-query' to retrieve it. This will accept _only_ string values in UTF-8 encoding.",
"Seth Burgess",
"Seth Burgess",
"1999",
......
......@@ -77,7 +77,7 @@ register_help_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-help",
"Load a help page.",
"This procedure loads the specified help page into the helpbrowser or what ever is configured as help viewer. The help page is identified by its domain and ID: if help_domain is NULL, we use the help_domain which was registered using the gimp-plugin-help-register procedure. If help_domain is NULL and no help domain was registered, the help domain of the main GIMP installation is used.",
"This procedure loads the specified help page into the helpbrowser or what ever is configured as help viewer. The help page is identified by its domain and ID: if help_domain is NULL, we use the help_domain which was registered using the 'gimp-plugin-help-register' procedure. If help_domain is NULL and no help domain was registered, the help domain of the main GIMP installation is used.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2000",
......
......@@ -2180,7 +2180,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-new",
"Creates a new image with the specified width, height, and type.",
"Creates a new image, undisplayed with the specified extents and type. A layer should be created and added before this image is displayed, or subsequent calls to 'gimp_display_new' with this image as an argument will fail. Layers can be created using the 'gimp_layer_new' commands. They can be added to an image using the 'gimp_image_add_layer' command.",
"Creates a new image, undisplayed with the specified extents and type. A layer should be created and added before this image is displayed, or subsequent calls to 'gimp-display-new' with this image as an argument will fail. Layers can be created using the 'gimp-layer-new' commands. They can be added to an image using the 'gimp-image-add-layer' command.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -2356,7 +2356,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-free-shadow",
"Free the specified image's shadow data (if it exists).",
"This procedure is intended as a memory saving device. If any shadow memory has been allocated, it will be freed automatically on a call to 'gimp_image_delete'.",
"This procedure is intended as a memory saving device. If any shadow memory has been allocated, it will be freed automatically on a call to 'gimp-image-delete'.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -3627,7 +3627,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-is-dirty",
"Checks if the image has unsaved changes.",
"This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call gimp-image-clean-all after calling a save procedure to make the image clean.",
"This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call 'gimp-image-clean-all' after calling a save procedure to make the image clean.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -4209,7 +4209,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-get-unit",
"Returns the specified image's unit.",
"This procedure returns the specified image's unit. This value is independent of any of the layers in this image. See the gimp_unit_* procedure definitions for the valid range of unit IDs and a description of the unit system.",
"This procedure returns the specified image's unit. This value is independent of any of the layers in this image. See the gimp_unit_*() procedure definitions for the valid range of unit IDs and a description of the unit system.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"1998",
......@@ -4239,7 +4239,7 @@ register_image_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-set-unit",
"Sets the specified image's unit.",
"This procedure sets the specified image's unit. No scaling or resizing is performed. This value is independent of any of the layers in this image. See the gimp_unit_* procedure definitions for the valid range of unit IDs and a description of the unit system.",
"This procedure sets the specified image's unit. No scaling or resizing is performed. This value is independent of any of the layers in this image. See the gimp_unit_*() procedure definitions for the valid range of unit IDs and a description of the unit system.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"1998",
......
......@@ -838,7 +838,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-add-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",
......@@ -905,7 +905,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-add-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",
......@@ -1171,7 +1171,7 @@ register_layer_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-layer-create-mask",
"Create a layer mask for the specified specified layer.",
"This procedure creates a layer mask for the specified layer. Layer masks serve as an additional alpha channel for a layer. A number of ifferent types of masks are allowed for initialisation: completely white masks (which will leave the layer fully visible), completely black masks (which will give the layer complete transparency, the layer's already existing alpha channel (which will leave the layer fully visible, but which may be more useful than a white mask), the current selection or a grayscale copy of the layer. The layer mask still needs to be added to the layer. This can be done with a call to 'gimp_layer_add_mask'.",
"This procedure creates a layer mask for the specified layer. Layer masks serve as an additional alpha channel for a layer. A number of ifferent types of masks are allowed for initialisation: completely white masks (which will leave the layer fully visible), completely black masks (which will give the layer complete transparency, the layer's already existing alpha channel (which will leave the layer fully visible, but which may be more useful than a white mask), the current selection or a grayscale copy of the layer. The layer mask still needs to be added to the layer. This can be done with a call to 'gimp-layer-add-mask'.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......
......@@ -741,7 +741,7 @@ register_paint_tools_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-airbrush-default",
"Paint in the current brush with varying pressure. Paint application is time-dependent.",
"This tool simulates the use of an airbrush. It is similar to gimp_airbrush except that the pressure is derived from the airbrush tools options box. It the option has not been set the default for the option will be used.",
"This tool simulates the use of an airbrush. It is similar to 'gimp-airbrush' except that the pressure is derived from the airbrush tools options box. It the option has not been set the default for the option will be used.",
"Andy Thomas",
"Andy Thomas",
"1999",
......@@ -832,7 +832,7 @@ register_paint_tools_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-clone-default",
"Clone from the source to the dest drawable using the current brush",
"This tool clones (copies) from the source drawable starting at the specified source coordinates to the dest drawable. This function performs exactly the same as the gimp_clone function except that the tools arguments are obtained from the clones option dialog. It this dialog has not been activated then the dialogs default values will be used.",
"This tool clones (copies) from the source drawable starting at the specified source coordinates to the dest drawable. This function performs exactly the same as the 'gimp-clone' function except that the tools arguments are obtained from the clones option dialog. It this dialog has not been activated then the dialogs default values will be used.",
"Andy Thomas",
"Andy Thomas",
"1999",
......@@ -911,7 +911,7 @@ register_paint_tools_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-convolve-default",
"Convolve (Blur, Sharpen) using the current brush.",
"This tool convolves the specified drawable with either a sharpening or blurring kernel. This function performs exactly the same as the gimp_convolve function except that the tools arguments are obtained from the convolve option dialog. It this dialog has not been activated then the dialogs default values will be used.",
"This tool convolves the specified drawable with either a sharpening or blurring kernel. This function performs exactly the same as the 'gimp-convolve' function except that the tools arguments are obtained from the convolve option dialog. It this dialog has not been activated then the dialogs default values will be used.",
"Andy Thomas",
"Andy Thomas",
"1999",
......@@ -996,7 +996,7 @@ register_paint_tools_procs (GimpPDB *pdb)
gimp_object_set_static_name (GIMP_OBJECT (procedure), "gimp-dodgeburn-default");
gimp_procedure_set_static_strings (procedure,
"gimp-dodgeburn-default",
"Dodgeburn image with varying exposure. This is the same as the gimp_dodgeburn function except that the exposure, type and mode are taken from the tools option dialog. If the dialog has not been activated then the defaults as used by the dialog will be used.",
"Dodgeburn image with varying exposure. This is the same as the gimp_dodgeburn() function except that the exposure, type and mode are taken from the tools option dialog. If the dialog has not been activated then the defaults as used by the dialog will be used.",
"Dodgeburn. More details here later.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
......@@ -1077,7 +1077,7 @@ register_paint_tools_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-eraser-default",
"Erase using the current brush.",
"This tool erases using the current brush mask. This function performs exactly the same as the gimp_eraser function except that the tools arguments are obtained from the eraser option dialog. It this dialog has not been activated then the dialogs default values will be used.",
"This tool erases using the current brush mask. This function performs exactly the same as the 'gimp-eraser' function except that the tools arguments are obtained from the eraser option dialog. It this dialog has not been activated then the dialogs default values will be used.",
"Andy Thomas",
"Andy Thomas",
"1999",
......@@ -1267,7 +1267,7 @@ register_paint_tools_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-smudge-default",
"Smudge image with varying pressure.",
"This tool simulates a smudge using the current brush. It behaves exactly the same as gimp_smudge except that the pressure value is taken from the smudge tool options or the options default if the tools option dialog has not been activated.",
"This tool simulates a smudge using the current brush. It behaves exactly the same as 'gimp-smudge' except that the pressure value is taken from the smudge tool options or the options default if the tools option dialog has not been activated.",
"Andy Thomas",
"Andy Thomas",
"1999",
......
......@@ -389,7 +389,7 @@ register_plug_in_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-plugin-help-register",
"Register a help path for a plug-in.",
"This procedure changes the help rootdir for the plug-in which calls it. All subsequent calls of gimp_help from this plug-in will be interpreted relative to this rootdir.",
"This procedure changes the help rootdir for the plug-in which calls it. All subsequent calls of 'gimp-help' from this plug-in will be interpreted relative to this rootdir.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"2000",
......
......@@ -542,7 +542,7 @@ register_procedural_db_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-procedural-db-proc-info",
"Queries the procedural database for information on the specified procedure.",
"This procedure returns information on the specified procedure. A short blurb, detailed help, author(s), copyright information, procedure type, number of input, and number of return values are returned. For specific information on each input argument and return value, use the 'gimp_procedural_db_proc_arg' and 'gimp_procedural_db_proc_val' procedures.",
"This procedure returns information on the specified procedure. A short blurb, detailed help, author(s), copyright information, procedure type, number of input, and number of return values are returned. For specific information on each input argument and return value, use the 'gimp-procedural-db-proc-arg' and 'gimp-procedural-db-proc-val' procedures.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1997",
......
......@@ -276,7 +276,7 @@ register_undo_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-undo-is-enabled",
"Check if the image's undo stack is enabled.",
"This procedure checks if the image's undo stack is currently enabled or disabled. This is useful when several plugins or scripts call each other and want to check if their caller has already used 'gimp_image_undo_disable' or 'gimp_image_undo_freeze'.",
"This procedure checks if the image's undo stack is currently enabled or disabled. This is useful when several plugins or scripts call each other and want to check if their caller has already used 'gimp-image-undo-disable' or 'gimp-image-undo-freeze'.",
"Raphael Quinet",
"Raphael Quinet",
"1999",
......@@ -304,7 +304,7 @@ register_undo_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-undo-disable",
"Disable the image's undo stack.",
"This procedure disables the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp_image_undo_enable' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive.",
"This procedure disables the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp-image-undo-enable' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -332,7 +332,7 @@ register_undo_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-undo-enable",
"Enable the image's undo stack.",
"This procedure enables the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp_image_undo_disable' to temporarily disable an image undo stack.",
"This procedure enables the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp-image-undo-disable' to temporarily disable an image undo stack.",
"Spencer Kimball & Peter Mattis",
"Spencer Kimball & Peter Mattis",
"1995-1996",
......@@ -360,7 +360,7 @@ register_undo_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-undo-freeze",
"Freeze the image's undo stack.",
"This procedure freezes the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp_image_undo_thaw' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive. 'gimp_image_undo_{freeze,thaw}' and 'gimp_image_undo_{disable,enable}' differ in that the former does not free up all undo steps when undo is thawed, so is more suited to interactive in-situ previews. It is important in this case that the image is back to the same state it was frozen in before thawing, else 'undo' behaviour is undefined.",
"This procedure freezes the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp-image-undo-thaw' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive. 'gimp-image-undo-freeze' / 'gimp-image-undo-thaw' and 'gimp-image-undo-disable' / 'gimp-image-undo-enable' differ in that the former does not free up all undo steps when undo is thawed, so is more suited to interactive in-situ previews. It is important in this case that the image is back to the same state it was frozen in before thawing, else 'undo' behaviour is undefined.",
"Adam D. Moss",
"Adam D. Moss",
"1999",
......@@ -388,7 +388,7 @@ register_undo_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-image-undo-thaw",
"Thaw the image's undo stack.",
"This procedure thaws the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp_image_undo_freeze' to temporarily freeze an image undo stack. 'gimp_image_undo_thaw' does NOT free the undo stack as 'gimp_image_undo_enable' does, so is suited for situations where one wishes to leave the undo stack in the same state in which one found it despite non-destructively playing with the image in the meantime. An example would be in-situ plugin previews. Balancing freezes and thaws and ensuring image consistancy is the responsibility of the caller.",
"This procedure thaws the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp-image-undo-freeze' to temporarily freeze an image undo stack. 'gimp-image-undo-thaw' does NOT free the undo stack as 'gimp-image-undo-enable' does, so is suited for situations where one wishes to leave the undo stack in the same state in which one found it despite non-destructively playing with the image in the meantime. An example would be in-situ plugin previews. Balancing freezes and thaws and ensuring image consistancy is the responsibility of the caller.",
"Adam D. Moss",
"Adam D. Moss",
"1999",
......
......@@ -404,7 +404,7 @@ register_unit_procs (GimpPDB *pdb)
gimp_procedure_set_static_strings (procedure,
"gimp-unit-new",
"Creates a new unit and returns it's integer ID.",
"This procedure creates a new unit and returns it's integer ID. Note that the new unit will have it's deletion flag set to TRUE, so you will have to set it to FALSE with gimp_unit_set_deletion_flag to make it persistent.",
"This procedure creates a new unit and returns it's integer ID. Note that the new unit will have it's deletion flag set to TRUE, so you will have to set it to FALSE with 'gimp-unit-set-deletion-flag' to make it persistent.",
"Michael Natterer <mitch@gimp.org>",
"Michael Natterer",
"1999",
......
......@@ -840,7 +840,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. Needs to be added to an image using gimp_image_add_vectors.",
"Creates a new empty vectors object. Needs to be added to an image using 'gimp-image-add-vectors'.",
"Simon Budig",
"Simon Budig",
"2005",
......
......@@ -64,7 +64,7 @@ gimp_brushes_refresh (void)
*
* This procedure returns a complete listing of available GIMP brushes.
* Each name returned can be used as input to the
* 'gimp-context-set-brush' procedure.
* gimp_context_set_brush() procedure.
*
* Returns: The list of brush names.
*/
......
......@@ -39,7 +39,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_add_channel()
* command. Other attributes such as channel show masked, should be set
* with explicit procedure calls. The channel's contents are undefined
* initially.
......
......@@ -365,7 +365,7 @@ gimp_invert (gint32 drawable_ID)
* channel can be either an intensity component, or the value. The
* 'control_pts' parameter is an array of integers which define a set
* of control points which describe a Catmull Rom spline which yields
* the final intensity curve. Use the 'gimp_curves_explicit' function
* the final intensity curve. Use the gimp_curves_explicit() function
* to explicitly modify intensity levels.
*
* Returns: TRUE on success.
......@@ -409,7 +409,7 @@ gimp_curves_spline (gint32 drawable_ID,
* channel can be either an intensity component, or the value. The
* 'curve' parameter is an array of bytes which explicitly defines how
* each pixel value in the drawable will be modified. Use the
* 'gimp_curves_spline' function to modify intensity levels with
* gimp_curves_spline() function to modify intensity levels with
* Catmull Rom splines.
*
* Returns: TRUE on success.
......@@ -554,7 +554,7 @@ gimp_colorize (gint32 drawable_ID,
* specified. This can be either value, red, green, or blue, depending
* on whether the drawable is of type color or grayscale. The drawable
* may not be indexed. Second, a range of intensities are specified.
* The gimp_histogram function returns statistics based on the pixels
* The gimp_histogram() function returns statistics based on the pixels
* in the drawable that fall under this range of values. Mean, standard
* deviation, median, number of pixels, and percentile are all
* returned. Additionally, the total count of pixels in the image is
......
......@@ -32,7 +32,7 @@
*
* This procedure creates a new context by copying the current context.
* This copy becomes the new current context for the calling plug-in
* until it is popped again using gimp-context-pop.
* until it is popped again using gimp_context_pop().
*
* Returns: TRUE on success.
*
......@@ -63,7 +63,7 @@ gimp_context_push (void)
*
* This procedure removes the topmost context from the plug-in's
* context stack. The context that was active before the corresponding
* call to gimp-context-push becomes the new current context of the
* call to gimp_context_push() becomes the new current context of the
* plug-in.
*
* Returns: TRUE on success.
......
......@@ -34,7 +34,7 @@
* Creates a new display for the specified image. If the image already
* has a display, another is added. Multiple displays are handled
* transparently by the GIMP. The newly created display is returned and
* can be subsequently destroyed with a call to 'gimp-display-delete'.
* can be subsequently destroyed with a call to gimp_display_delete().
* This procedure only makes sense for use with the GIMP UI.
*
* Returns: The new display.
......
......@@ -34,7 +34,7 @@
* If there is a selection in the image, then the area specified by the
* selection is cut from the specified drawable and placed in an
* internal GIMP edit buffer. It can subsequently be retrieved using
* the 'gimp-edit-paste' command. If there is no selection, then the
* the gimp_edit_paste() command. If there is no selection, then the
* specified drawable will be removed and its contents stored in the
* internal GIMP edit buffer.
*
......@@ -69,7 +69,7 @@ gimp_edit_cut (gint32 drawable_ID)
* If there is a selection in the image, then the area specified by the
* selection is copied from the specified drawable and placed in an
* internal GIMP edit buffer. It can subsequently be retrieved using
* the 'gimp-edit-paste' command. If there is no selection, then the
* the gimp_edit_paste() command. If there is no selection, then the
* specified drawable's contents will be stored in the internal GIMP
* edit buffer.
*
......@@ -104,7 +104,7 @@ gimp_edit_copy (gint32 drawable_ID)
* If there is a selection in the image, then the area specified by the
* selection is copied from the projection and placed in an internal
* GIMP edit buffer. It can subsequently be retrieved using the
* 'gimp-edit-paste' command. If there is no selection, then the
* gimp_edit_paste() command. If there is no selection, then the
* projection's contents will be stored in the internal GIMP edit
* buffer.
*
......@@ -141,7 +141,7 @@ gimp_edit_copy_visible (gint32 image_ID)
*
* This procedure pastes a copy of the internal GIMP edit buffer to the
* specified drawable. The GIMP edit buffer will be empty unless a call
* was previously made to either 'gimp-edit-cut' or 'gimp-edit-copy'.
* was previously made to either gimp_edit_cut() or gimp_edit_copy().
* The \"paste_into\" option specifies whether to clear the current
* image selection, or to paste the buffer \"behind\" the selection.
* This allows the selection to act as a mask for the pasted buffer.
......@@ -186,7 +186,7 @@ gimp_edit_paste (gint32 drawable_ID,
*
* This procedure pastes a copy of the internal GIMP edit buffer to a
* new image. The GIMP edit buffer will be empty unless a call was
* previously made to either 'gimp-edit-cut' or 'gimp-edit-copy'. This
* previously made to either gimp_edit_cut() or gimp_edit_copy(). This
* procedure returns the new image.
*
* Returns: The new image.
......@@ -219,9 +219,10 @@ gimp_edit_paste_as_new (void)
*
* Cut into a named buffer.
*
* This procedure works like gimp-edit-cut, but additionally stores the
* cut buffer into a named buffer that will stay available for later
* pasting, regardless of any intermediate copy or cut operations.
* This procedure works like gimp_edit_cut(), but additionally stores
* the cut buffer into a named buffer that will stay available for
* later pasting, regardless of any intermediate copy or cut
* operations.
*
* Returns: The real name given to the buffer, or NULL if the selection contained only transparent pixels.
*
......@@ -256,7 +257,7 @@ gimp_edit_named_cut (gint32 drawable_ID,
*
* Copy into a named buffer.
*
* This procedure works like gimp-edit-copy, but additionally stores
* This procedure works like gimp_edit_copy(), but additionally stores
* the copied buffer into a named buffer that will stay available for
* later pasting, regardless of any intermediate copy or cut
* operations.
......@@ -294,7 +295,7 @@ gimp_edit_named_copy (gint32 drawable_ID,
*
* Copy from the projection into a named buffer.
*
* This procedure works like gimp-edit-copy-visible, but additionally
* This procedure works like gimp_edit_copy_visible(), but additionally
* stores the copied buffer into a named buffer that will stay
* available for later pasting, regardless of any intermediate copy or
* cut operations.
......@@ -333,8 +334,8 @@ gimp_edit_named_copy_visible (gint32 image_ID,
*
* Paste named buffer to the specified drawable.
*
* This procedure works like gimp-edit-paste but pastes a named buffer
* instead of the global buffer.
* This procedure works like gimp_edit_paste() but pastes a named
* buffer instead of the global buffer.
*
* Returns: The new floating selection.
*
......@@ -370,8 +371,8 @@ gimp_edit_named_paste (gint32 drawable_ID,
*
* Paste named buffer to a new image.
*
* This procedure works like gimp-edit-paste-as-new but pastes a named
* buffer instead of the global buffer.
* This procedure works like gimp_edit_paste_as_new() but pastes a
* named buffer instead of the global buffer.
*
* Returns: The new image.
*
......
......@@ -73,7 +73,7 @@ gimp_gimprc_query (const gchar *token)
* This procedure is used to add or change additional information in
* the gimprc file that is considered extraneous to the operation of
* the GIMP. Plug-ins that need configuration information can use this
* function to store it, and gimp_gimprc_query to retrieve it. This
* function to store it, and gimp_gimprc_query() to retrieve it. This
* will accept _only_ string values in UTF-8 encoding.
*
* Returns: TRUE on success.
......
......@@ -63,7 +63,7 @@ gimp_gradients_refresh (void)
* Retrieve the list of loaded gradients.
*
* This procedure returns a list of the gradients that are currently
* loaded. You can later use the 'gimp-context-set-gradient' function
* loaded. You can later use the gimp_context_set_gradient() function
* to set the active gradient.
*
* Returns: The list of gradient names.
......
......@@ -35,9 +35,9 @@
* This procedure loads the specified help page into the helpbrowser or
* what ever is configured as help viewer. The help page is identified
* by its domain and ID: if help_domain is NULL, we use the help_domain
* which was registered using the gimp-plugin-help-register procedure.
* If help_domain is NULL and no help domain was registered, the help
* domain of the main GIMP installation is used.
* which was registered using the gimp_plugin_help_register()
* procedure. If help_domain is NULL and no help domain was registered,
* the help domain of the main GIMP installation is used.
*
* Returns: TRUE on success.
*/
......
......@@ -75,10 +75,10 @@ gimp_image_list (gint *num_images)
*
* Creates a new image, undisplayed with the specified extents and
* type. A layer should be created and added before this image is
* displayed, or subsequent calls to 'gimp_display_new' with this image
* displayed, or subsequent calls to gimp_display_new() with this image
* as an argument will fail. Layers can be created using the
* 'gimp_layer_new' commands. They can be added to an image using the
* 'gimp_image_add_layer' command.
* gimp_layer_new() commands. They can be added to an image using the
* gimp_image_add_layer() command.
*
* Returns: The ID of the newly created image.
*/
......@@ -272,7 +272,7 @@ gimp_image_height (gint32 image_ID)
*
* This procedure is intended as a memory saving device. If any shadow
* memory has been allocated, it will be freed automatically on a call
* to 'gimp_image_delete'.
* to gimp_image_delete().
*
* Returns: TRUE on success.
*/
......@@ -1693,7 +1693,7 @@ gimp_image_clean_all (gint32 image_ID)
*
* This procedure checks the specified image's dirty count to see if it
* needs to be saved. Note that saving the image does not automatically
* set the dirty count to 0, you need to call gimp-image-clean-all
* set the dirty count to 0, you need to call gimp_image_clean_all()
* after calling a save procedure to make the image clean.
*
* Returns: TRUE if the image has unsaved changes.
......@@ -2341,9 +2341,9 @@ gimp_image_set_resolution (gint32 image_ID,
* Returns the specified image's unit.
*
* This procedure returns the specified image's unit. This value is
* independent of any of the layers in this image. See the gimp_unit_*
* procedure definitions for the valid range of unit IDs and a
* description of the unit system.
* independent of any of the layers in this image. See the
* gimp_unit_*() procedure definitions for the valid range of unit IDs
* and a description of the unit system.
*
* Returns: The unit.
*/
......@@ -2376,8 +2376,9 @@ gimp_image_get_unit (gint32 image_ID)
*
* This procedure sets the specified image's unit. No scaling or
* resizing is performed. This value is independent of any of the
* layers in this image. See the gimp_unit_* procedure definitions for
* the valid range of unit IDs and a description of the unit system.
* layers in this image. See the gimp_unit_*() procedure definitions
* for the valid range of unit IDs and a description of the unit
* system.
*
* Returns: TRUE on success.
*/
......
......@@ -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_add_layer()
* command. Other attributes such as layer mask modes, and offsets
* should be set with explicit procedure calls.
*
......@@ -88,7 +88,7 @@ _gimp_layer_new (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
* gimp_image_add_layer() command. Other attributes such as layer mask
* modes, and offsets should be set with explicit procedure calls.
*
* Returns: The newly copied layer.
......@@ -396,7 +396,7 @@ gimp_layer_set_offsets (gint32 layer_ID,
* fully visible, but which may be more useful than a white mask), the
* current selection or a grayscale copy of the layer. The layer mask
* still needs to be added to the layer. This can be done with a call
* to 'gimp_layer_add_mask'.
* to gimp_layer_add_mask().
*
* Returns: The newly created mask.
*/
......
......@@ -77,9 +77,9 @@ gimp_airbrush (gint32 drawable_ID,
* is time-dependent.
*
* This tool simulates the use of an airbrush. It is similar to
* gimp_airbrush except that the pressure is derived from the airbrush
* tools options box. It the option has not been set the default for
* the option will be used.
* gimp_airbrush() except that the pressure is derived from the
* airbrush tools options box. It the option has not been set the
* default for the option will be used.
*
* Returns: TRUE on success.
*/
......@@ -174,10 +174,10 @@ gimp_clone (gint32 drawable_ID,
*
* This tool clones (copies) from the source drawable starting at the
* specified source coordinates to the dest drawable. This function
* performs exactly the same as the gimp_clone function except that the
* tools arguments are obtained from the clones option dialog. It this
* dialog has not been activated then the dialogs default values will
* be used.
* performs exactly the same as the gimp_clone() function except that
* the tools arguments are obtained from the clones option dialog. It
* this dialog has not been activated then the dialogs default values
* will be used.
*
* Returns: TRUE on success.
*/
......@@ -258,9 +258,9 @@ gimp_convolve (gint32 drawable_ID,
*
* This tool convolves the specified drawable with either a sharpening
* or blurring kernel. This function performs exactly the same as the
* gimp_convolve function except that the tools arguments are obtained
* from the convolve option dialog. It this dialog has not been
* activated then the dialogs default values will be used.
* gimp_convolve() function except that the tools arguments are
* obtained from the convolve option dialog. It this dialog has not
* been activated then the dialogs default values will be used.
*
* Returns: TRUE on success.
*/
......@@ -338,8 +338,8 @@ gimp_dodgeburn (gint32 drawable_ID,
* @strokes: Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
*
* Dodgeburn image with varying exposure. This is the same as the
* gimp_dodgeburn function except that the exposure, type and mode are
* taken from the tools option dialog. If the dialog has not been
* gimp_dodgeburn() function except that the exposure, type and mode
* are taken from the tools option dialog. If the dialog has not been
* activated then the defaults as used by the dialog will be used.
*
* Dodgeburn. More details here later.
......@@ -423,7 +423,7 @@ gimp_eraser (gint32 drawable_ID,
* Erase using the current brush.
*
* This tool erases using the current brush mask. This function
* performs exactly the same as the gimp_eraser function except that
* performs exactly the same as the gimp_eraser() function except that
* the tools arguments are obtained from the eraser option dialog. It
* this dialog has not been activated then the dialogs default values
* will be used.
......@@ -644,7 +644,7 @@ gimp_smudge (gint32 drawable_ID,
* Smudge image with varying pressure.
*
* This tool simulates a smudge using the current brush. It behaves
* exactly the same as gimp_smudge except that the pressure value is
* exactly the same as gimp_smudge() except that the pressure value is
* taken from the smudge tool options or the options default if the
* tools option dialog has not been activated.
*
......
......@@ -62,7 +62,7 @@ gimp_palettes_refresh (void)
*
* This procedure returns a complete listing of available palettes.
* Each name returned can be used as input to the command
* 'gimp-context-set-palette'.
* gimp_context_set_palette().
*
* Returns: The list of palette names.
*/
......
......@@ -64,7 +64,7 @@ gimp_patterns_refresh (void)
*
* This procedure returns a complete listing of available GIMP
* patterns. Each name returned can be used as input to the
* 'gimp-context-set-pattern'.
* gimp_context_set_pattern().
*
* Returns: The list of pattern names.
*/
......
......@@ -72,7 +72,7 @@ gimp_plugin_domain_register (const gchar *domain_name,
* Register a help path for a plug-in.
*
* This procedure changes the help rootdir for the plug-in which calls
* it. All subsequent calls of gimp_help from this plug-in will be
* it. All subsequent calls of gimp_help() from this plug-in will be
* interpreted relative to this rootdir.
*
* Returns: TRUE on success.
......
......@@ -184,8 +184,8 @@ gimp_procedural_db_query (const gchar *name,
* short blurb, detailed help, author(s), copyright information,