Commit 5408ed17 authored by Michael Natterer's avatar Michael Natterer 😴 Committed by Michael Natterer

for deprecated procedures, create a gtk-doc comment that contains a link

2004-10-06  Michael Natterer  <mitch@gimp.org>

	* tools/pdbgen/lib.pl: for deprecated procedures, create a gtk-doc
	comment that contains a link to the replacement procedure and
	doesn't contain redundant information.

	* tools/pdbgen/pdb/text_tool.pdb: fixed names of replacement
	procedures.

	* libgimp/gimpbrushes.c
	* libgimp/gimpgradients.c
	* libgimp/gimppalettes.c
	* libgimp/gimppatterns.c: made the handwritten gtk-doc comments of
	deprecated procedures look like the generated ones.

	* app/pdb/text_tool_cmds.c
	* libgimp/gimpbrushes_pdb.c
	* libgimp/gimpgradients_pdb.c
	* libgimp/gimppalettes_pdb.c
	* libgimp/gimppatterns_pdb.c
	* libgimp/gimptexttool_pdb.c: regenerated.
parent 62c23a23
2004-10-06 Michael Natterer <mitch@gimp.org>
* tools/pdbgen/lib.pl: for deprecated procedures, create a gtk-doc
comment that contains a link to the replacement procedure and
doesn't contain redundant information.
* tools/pdbgen/pdb/text_tool.pdb: fixed names of replacement
procedures.
* libgimp/gimpbrushes.c
* libgimp/gimpgradients.c
* libgimp/gimppalettes.c
* libgimp/gimppatterns.c: made the handwritten gtk-doc comments of
deprecated procedures look like the generated ones.
* app/pdb/text_tool_cmds.c
* libgimp/gimpbrushes_pdb.c
* libgimp/gimpgradients_pdb.c
* libgimp/gimppalettes_pdb.c
* libgimp/gimppatterns_pdb.c
* libgimp/gimptexttool_pdb.c: regenerated.
2004-10-06 Michael Natterer <mitch@gimp.org>
* app/tools/gimp-tools.c (gimp_tools_restore): reset the tool
......
......@@ -544,12 +544,12 @@ static ProcArg text_outargs[] =
static ProcRecord text_proc =
{
"gimp_text",
"This procedure is deprecated! Use 'gimp_get_text_fontname' instead.",
"This procedure is deprecated! Use 'gimp_get_text_fontname' instead.",
"This procedure is deprecated! Use 'gimp_text_fontname' instead.",
"This procedure is deprecated! Use 'gimp_text_fontname' instead.",
"",
"",
"",
"gimp_get_text_fontname",
"gimp_text_fontname",
GIMP_INTERNAL,
17,
text_inargs,
......@@ -737,12 +737,12 @@ static ProcArg text_get_extents_outargs[] =
static ProcRecord text_get_extents_proc =
{
"gimp_text_get_extents",
"This procedure is deprecated! Use 'gimp_get_text_extents_fontname' instead.",
"This procedure is deprecated! Use 'gimp_get_text_extents_fontname' instead.",
"This procedure is deprecated! Use 'gimp_text_get_extents_fontname' instead.",
"This procedure is deprecated! Use 'gimp_text_get_extents_fontname' instead.",
"",
"",
"",
"gimp_get_text_extents_fontname",
"gimp_text_get_extents_fontname",
GIMP_INTERNAL,
11,
text_get_extents_inargs,
......
......@@ -28,9 +28,7 @@
/**
* gimp_brushes_get_opacity:
*
* Get the brush opacity.
*
* This procedure is deprecated! Use 'gimp_context_get_opacity' instead.
* This procedure is deprecated! Use gimp_context_get_opacity() instead.
*
* Returns: The brush opacity.
*/
......@@ -44,9 +42,7 @@ gimp_brushes_get_opacity (void)
* gimp_brushes_set_opacity:
* @opacity: The brush opacity.
*
* Set the brush opacity.
*
* This procedure is deprecated! Use 'gimp_context_set_opacity' instead.
* This procedure is deprecated! Use gimp_context_set_opacity() instead.
*
* Returns: TRUE on success.
*/
......@@ -59,9 +55,7 @@ gimp_brushes_set_opacity (gdouble opacity)
/**
* gimp_brushes_get_paint_mode:
*
* Get the brush paint mode.
*
* This procedure isdeprecated! Use 'gimp_context_get_paint_mode' instead.
* This procedure isdeprecated! Use gimp_context_get_paint_mode() instead.
*
* Returns: The paint mode.
*/
......@@ -75,9 +69,7 @@ gimp_brushes_get_paint_mode (void)
* gimp_brushes_set_paint_mode:
* @paint_mode: The paint mode.
*
* Set the brush paint mode.
*
* This procedure is deprecated! Use 'gimp_context_set_paint_mode' instead.
* This procedure is deprecated! Use gimp_context_set_paint_mode() instead.
*
* Returns: TRUE on success.
*/
......@@ -91,9 +83,7 @@ gimp_brushes_set_paint_mode (GimpLayerModeEffects paint_mode)
* gimp_brushes_set_brush:
* @name: The brush name.
*
* Set the specified brush as the active brush.
*
* This procedure is deprecated! Use 'gimp_context_set_brush' instead.
* This procedure is deprecated! Use gimp_context_set_brush() instead.
*
* Returns: TRUE on success.
*/
......
......@@ -103,9 +103,7 @@ gimp_brushes_get_list (const gchar *filter,
* @height: The brush height.
* @spacing: The brush spacing.
*
* This procedure is deprecated! Use 'gimp_context_get_brush' instead.
*
* This procedure is deprecated! Use 'gimp_context_get_brush' instead.
* This procedure is deprecated! Use gimp_context_get_brush() instead.
*
* Returns: The brush name.
*/
......@@ -138,9 +136,7 @@ gimp_brushes_get_brush (gint *width,
/**
* gimp_brushes_get_spacing:
*
* This procedure is deprecated! Use 'gimp_brush_get_spacing' instead.
*
* This procedure is deprecated! Use 'gimp_brush_get_spacing' instead.
* This procedure is deprecated! Use gimp_brush_get_spacing() instead.
*
* Returns: The brush spacing.
*/
......@@ -167,9 +163,7 @@ gimp_brushes_get_spacing (void)
* gimp_brushes_set_spacing:
* @spacing: The brush spacing.
*
* This procedure is deprecated! Use 'gimp_brush_set_spacing' instead.
*
* This procedure is deprecated! Use 'gimp_brush_set_spacing' instead.
* This procedure is deprecated! Use gimp_brush_set_spacing() instead.
*
* Returns: TRUE on success.
*/
......@@ -203,9 +197,7 @@ gimp_brushes_set_spacing (gint spacing)
* @length: Length of brush mask data.
* @mask_data: The brush mask data.
*
* This procedure is deprecated! Use 'gimp_brush_get_pixels' instead.
*
* This procedure is deprecated! Use 'gimp_brush_get_pixels' instead.
* This procedure is deprecated! Use gimp_brush_get_pixels() instead.
*
* Returns: The brush name.
*/
......
......@@ -28,9 +28,7 @@
/**
* gimp_gradients_get_gradient:
*
* Retrieve the name of the active gradient.
*
* This procedure is deprecated! Use 'gimp_context_get_gradient' instead.
* This procedure is deprecated! Use gimp_context_get_gradient() instead.
*
* Returns: The name of the active gradient.
*/
......@@ -44,9 +42,7 @@ gimp_gradients_get_gradient (void)
* gimp_gradients_set_gradient:
* @name: The name of the gradient to set.
*
* Sets the specified gradient as the active gradient.
*
* This procedure is deprecated! Use 'gimp_context_set_gradient' instead.
* This procedure is deprecated! Use gimp_context_set_gradient() instead.
*
* Returns: TRUE on success.
*/
......
......@@ -103,10 +103,7 @@ gimp_gradients_get_list (const gchar *filter,
* @reverse: Use the reverse gradient.
*
* This procedure is deprecated! Use
* 'gimp_gradient_get_uniform_samples' instead.
*
* This procedure is deprecated! Use
* 'gimp_gradient_get_uniform_samples' instead.
* gimp_gradient_get_uniform_samples() instead.
*
* Returns: Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
*/
......@@ -144,10 +141,7 @@ gimp_gradients_sample_uniform (gint num_samples,
* @positions: The list of positions to sample along the gradient.
* @reverse: Use the reverse gradient.
*
* This procedure is deprecated! Use 'gimp_gradient_get_custom_samples'
* instead.
*
* This procedure is deprecated! Use 'gimp_gradient_get_custom_samples'
* This procedure is deprecated! Use gimp_gradient_get_custom_samples()
* instead.
*
* Returns: Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
......@@ -191,10 +185,7 @@ gimp_gradients_sample_custom (gint num_samples,
* @grad_data: The gradient sample data.
*
* This procedure is deprecated! Use
* 'gimp_gradient_get_uniform_samples' instead.
*
* This procedure is deprecated! Use
* 'gimp_gradient_get_uniform_samples' instead.
* gimp_gradient_get_uniform_samples() instead.
*
* Returns: The gradient name.
*/
......
......@@ -27,9 +27,7 @@
* gimp_palettes_set_palette:
* @name: The palette name.
*
* Set the specified palette as the active palette.
*
* This procedure is deprecated! Use 'gimp_context_set_palette' instead.
* This procedure is deprecated! Use gimp_context_set_palette() instead.
*
* Returns: TRUE on success.
*/
......
......@@ -99,10 +99,7 @@ gimp_palettes_get_list (const gchar *filter,
* gimp_palettes_get_palette:
* @num_colors: The palette num_colors.
*
* This procedure is deprecated! Use 'gimp_context_get_palette'
* instead.
*
* This procedure is deprecated! Use 'gimp_context_get_palette'
* This procedure is deprecated! Use gimp_context_get_palette()
* instead.
*
* Returns: The palette name.
......@@ -136,10 +133,7 @@ gimp_palettes_get_palette (gint *num_colors)
* @num_colors: The palette num_colors.
* @color: The color requested.
*
* This procedure is deprecated! Use 'gimp_palette_entry_get_color'
* instead.
*
* This procedure is deprecated! Use 'gimp_palette_entry_get_color'
* This procedure is deprecated! Use gimp_palette_entry_get_color()
* instead.
*
* Returns: The palette name.
......
......@@ -29,9 +29,7 @@
* gimp_patterns_set_pattern:
* @name: The pattern name.
*
* Set the specified pattern as the active pattern.
*
* This procedure is deprecated! Use 'gimp_context_set_pattern' instead.
* This procedure is deprecated! Use gimp_context_set_pattern() instead.
*
* Returns: TRUE on success.
*/
......
......@@ -102,10 +102,7 @@ gimp_patterns_get_list (const gchar *filter,
* @width: The pattern width.
* @height: The pattern height.
*
* This procedure is deprecated! Use 'gimp_context_get_pattern'
* instead.
*
* This procedure is deprecated! Use 'gimp_context_get_pattern'
* This procedure is deprecated! Use gimp_context_get_pattern()
* instead.
*
* Returns: The pattern name.
......@@ -143,9 +140,7 @@ gimp_patterns_get_pattern (gint *width,
* @length: Length of pattern mask data.
* @mask_data: The pattern mask data.
*
* This procedure is deprecated! Use 'gimp_pattern_get_pixels' instead.
*
* This procedure is deprecated! Use 'gimp_pattern_get_pixels' instead.
* This procedure is deprecated! Use gimp_pattern_get_pixels() instead.
*
* Returns: The pattern name.
*/
......
......@@ -173,9 +173,7 @@ gimp_text_get_extents_fontname (const gchar *text,
* @registry: The font registry.
* @encoding: The font encoding.
*
* This procedure is deprecated! Use 'gimp_get_text_fontname' instead.
*
* This procedure is deprecated! Use 'gimp_get_text_fontname' instead.
* This procedure is deprecated! Use gimp_text_fontname() instead.
*
* Returns: The new text layer.
*/
......@@ -249,10 +247,7 @@ gimp_text (gint32 image_ID,
* @ascent: The ascent of the specified font.
* @descent: The descent of the specified font.
*
* This procedure is deprecated! Use 'gimp_get_text_extents_fontname'
* instead.
*
* This procedure is deprecated! Use 'gimp_get_text_extents_fontname'
* This procedure is deprecated! Use gimp_text_get_extents_fontname()
* instead.
*
* Returns: TRUE on success.
......
......@@ -456,7 +456,17 @@ CODE
$sincedesc = "\n *\n * Since: GIMP $proc->{since}";
}
$out->{code} .= <<CODE;
if ($proc->{deprecated}) {
$out->{code} .= <<CODE;
/**
* $wrapped$funcname:
$argdesc *
@{[ &desc_wrap("This procedure is deprecated! Use $proc->{deprecated}() instead.") ]}
CODE
}
else {
$out->{code} .= <<CODE;
/**
* $wrapped$funcname:
......@@ -464,6 +474,10 @@ $argdesc *
@{[ &desc_wrap($proc->{blurb}) ]}
*
@{[ &desc_wrap($proc->{help}) ]}
CODE
}
$out->{code} .= <<CODE;
*
* Returns: $retdesc$sincedesc
*/
......
......@@ -177,7 +177,7 @@ CODE
}
sub text {
&std_pdb_deprecated ('gimp_get_text_fontname');
&std_pdb_deprecated ('gimp_text_fontname');
@inargs = (
&render_args,
......@@ -210,7 +210,7 @@ CODE
}
sub text_get_extents {
&std_pdb_deprecated ('gimp_get_text_extents_fontname');
&std_pdb_deprecated ('gimp_text_get_extents_fontname');
@inargs = (
&text_arg,
......
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