Commit aec579b7 authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

include the documentation of the format string in the gtk-doc comment.

2003-11-15  Sven Neumann  <sven@gimp.org>

	* libgimpwidgets/gimpunitmenu.c: include the documentation of the
	format string in the gtk-doc comment.
parent 20ed0468
2003-11-15 Sven Neumann <sven@gimp.org>
* libgimpwidgets/gimpunitmenu.c: include the documentation of the
format string in the gtk-doc comment.
2003-11-15 Michael Natterer <mitch@gimp.org>
* plug-ins/FractalExplorer/Dialogs.c
2003-11-15 Sven Neumann <sven@gimp.org>
* */tmpl/*.sgml: removed unused parameters.
2003-11-15 Sven Neumann <sven@gimp.org>
* app/Makefile.am (unused_symbols): use $SYMPREFIX as defined by
......
......@@ -117,9 +117,5 @@ Functions related to getting and setting brushes.
@length:
@mask_data:
@Returns:
<!-- # Unused Parameters # -->
@brush_name:
@mask_data_size:
@pname:
......@@ -28,8 +28,6 @@ gimpbrushselect
@mask_data:
@dialog_closing:
@user_data:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_brush_select_new ##### -->
......
......@@ -130,10 +130,6 @@ Functions for manipulating channels.
@channel_ID:
@color:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_channel_set_color ##### -->
......@@ -144,10 +140,6 @@ Functions for manipulating channels.
@channel_ID:
@color:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_channel_get_tattoo ##### -->
......
......@@ -132,8 +132,6 @@ Functions to manipulate drawables.
@height:
@bpp:
@Returns:
<!-- # Unused Parameters # -->
@bytes:
<!-- ##### FUNCTION gimp_drawable_merge_shadow ##### -->
......@@ -144,8 +142,6 @@ Functions to manipulate drawables.
@drawable_ID:
@undo:
@Returns:
<!-- # Unused Parameters # -->
@undoable:
<!-- ##### FUNCTION gimp_drawable_fill ##### -->
......@@ -331,8 +327,6 @@ Functions to manipulate drawables.
</para>
@Returns:
<!-- # Unused Parameters # -->
@drawable_ID:
<!-- ##### MACRO gimp_drawable_bpp ##### -->
......@@ -341,8 +335,6 @@ Functions to manipulate drawables.
</para>
@Returns:
<!-- # Unused Parameters # -->
@drawable_ID:
<!-- ##### FUNCTION gimp_drawable_parasite_find ##### -->
......
......@@ -58,8 +58,6 @@ File operations (load, save, etc.)
@prefixes:
@magics:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_register_load_handler ##### -->
......@@ -71,8 +69,6 @@ File operations (load, save, etc.)
@extensions:
@prefixes:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_register_save_handler ##### -->
......@@ -84,7 +80,5 @@ File operations (load, save, etc.)
@extensions:
@prefixes:
@Returns:
<!-- # Unused Parameters # -->
@name:
......@@ -22,8 +22,6 @@ gimpfonts
@font_name:
@dialog_closing:
@user_data:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_font_select_new ##### -->
......
......@@ -24,8 +24,6 @@ gimpgradientselect
@grad_data:
@dialog_closing:
@user_data:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_gradient_select_new ##### -->
......@@ -59,8 +57,6 @@ gimpgradientselect
@initial_gradient:
@sample_size:
@Returns:
<!-- # Unused Parameters # -->
@gradients_callback:
<!-- ##### FUNCTION gimp_gradients_close_popup ##### -->
......@@ -70,8 +66,6 @@ gimpgradientselect
@gradient_callback:
@Returns:
<!-- # Unused Parameters # -->
@gradients_callback:
<!-- ##### FUNCTION gimp_gradients_set_popup ##### -->
......@@ -82,7 +76,4 @@ gimpgradientselect
@gradient_callback:
@gradient_name:
@Returns:
<!-- # Unused Parameters # -->
@gradients_callback:
......@@ -22,9 +22,4 @@ Loading help pages using gimp_help.
@prog_name:
@help_id:
@Returns:
<!-- # Unused Parameters # -->
@help_page:
@help_data:
@Returns:
......@@ -57,9 +57,6 @@ and operations involving multiple layers.
@offx:
@offy:
@Returns:
<!-- # Unused Parameters # -->
@offset_x:
@offset_y:
<!-- ##### FUNCTION gimp_image_scale ##### -->
......@@ -112,8 +109,6 @@ and operations involving multiple layers.
@image_ID:
@num_layers:
@Returns:
<!-- # Unused Parameters # -->
@nlayers:
<!-- ##### FUNCTION gimp_image_get_channels ##### -->
......@@ -124,8 +119,6 @@ and operations involving multiple layers.
@image_ID:
@num_channels:
@Returns:
<!-- # Unused Parameters # -->
@nchannels:
<!-- ##### FUNCTION gimp_image_unset_active_channel ##### -->
......@@ -279,8 +272,6 @@ and operations involving multiple layers.
@image_ID:
@layer_ID:
@Returns:
<!-- # Unused Parameters # -->
@channel_ID:
<!-- ##### FUNCTION gimp_image_add_channel ##### -->
......@@ -457,8 +448,6 @@ and operations involving multiple layers.
@image_ID:
@active_layer_ID:
@Returns:
<!-- # Unused Parameters # -->
@layer_ID:
<!-- ##### FUNCTION gimp_image_get_active_channel ##### -->
......@@ -478,8 +467,6 @@ and operations involving multiple layers.
@image_ID:
@active_channel_ID:
@Returns:
<!-- # Unused Parameters # -->
@channel_ID:
<!-- ##### FUNCTION gimp_image_get_selection ##### -->
......@@ -550,8 +537,6 @@ and operations involving multiple layers.
@image_ID:
@filename:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_image_get_name ##### -->
......@@ -632,8 +617,6 @@ and operations involving multiple layers.
@image_ID:
@num_colors:
@Returns:
<!-- # Unused Parameters # -->
@ncolors:
<!-- ##### FUNCTION gimp_image_set_cmap ##### -->
......@@ -645,8 +628,6 @@ and operations involving multiple layers.
@cmap:
@num_colors:
@Returns:
<!-- # Unused Parameters # -->
@ncolors:
<!-- ##### FUNCTION gimp_image_get_thumbnail_data ##### -->
......@@ -659,8 +640,6 @@ and operations involving multiple layers.
@height:
@bpp:
@Returns:
<!-- # Unused Parameters # -->
@bytes:
<!-- ##### MACRO gimp_image_convert_rgb ##### -->
......@@ -668,33 +647,18 @@ and operations involving multiple layers.
</para>
<!-- # Unused Parameters # -->
@image_ID:
<!-- ##### MACRO gimp_image_convert_grayscale ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@image_ID:
<!-- ##### MACRO gimp_image_convert_indexed ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@image_ID:
@dither_type:
@palette_type:
@num_colors:
@alpha_dither:
@remove_unused:
@palette:
<!-- ##### FUNCTION gimp_image_duplicate ##### -->
<para>
......
......@@ -72,9 +72,6 @@ Operations on single layers.
@offx:
@offy:
@Returns:
<!-- # Unused Parameters # -->
@offset_x:
@offset_y:
<!-- ##### FUNCTION gimp_layer_resize_to_image_size ##### -->
......@@ -104,9 +101,6 @@ Operations on single layers.
@offx:
@offy:
@Returns:
<!-- # Unused Parameters # -->
@offset_x:
@offset_y:
<!-- ##### FUNCTION gimp_layer_add_alpha ##### -->
......@@ -127,9 +121,6 @@ Operations on single layers.
@offx:
@offy:
@Returns:
<!-- # Unused Parameters # -->
@offset_x:
@offset_y:
<!-- ##### FUNCTION gimp_layer_mask ##### -->
......@@ -347,8 +338,6 @@ Operations on single layers.
</para>
@Returns:
<!-- # Unused Parameters # -->
@layer_ID:
<!-- ##### MACRO gimp_layer_get_image_id ##### -->
......@@ -357,8 +346,6 @@ Operations on single layers.
</para>
@Returns:
<!-- # Unused Parameters # -->
@layer_ID:
<!-- ##### FUNCTION gimp_layer_is_floating_sel ##### -->
......@@ -376,8 +363,6 @@ Operations on single layers.
</para>
@Returns:
<!-- # Unused Parameters # -->
@layer_ID:
<!-- ##### MACRO gimp_layer_get_preserve_transparency ##### -->
......@@ -386,17 +371,9 @@ Operations on single layers.
</para>
@Returns:
<!-- # Unused Parameters # -->
@layer_ID:
<!-- ##### MACRO gimp_layer_set_preserve_transparency ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@layer_ID:
@preserve_transparency:
......@@ -22,10 +22,6 @@ Functions for setting colors in the palette.
@foreground:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_palette_get_background ##### -->
......@@ -35,10 +31,6 @@ Functions for setting colors in the palette.
@background:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_palette_set_foreground ##### -->
......@@ -48,10 +40,6 @@ Functions for setting colors in the palette.
@foreground:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_palette_set_background ##### -->
......@@ -61,10 +49,6 @@ Functions for setting colors in the palette.
@background:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_palette_set_default_colors ##### -->
......
......@@ -35,8 +35,6 @@ gimppaths
@num_path_point_details:
@points_pairs:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_path_get_current ##### -->
......@@ -56,8 +54,6 @@ gimppaths
@image_ID:
@name:
@Returns:
<!-- # Unused Parameters # -->
@set_current_path_name:
<!-- ##### FUNCTION gimp_path_set_points ##### -->
......@@ -71,8 +67,6 @@ gimppaths
@num_path_points:
@points_pairs:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_path_stroke_current ##### -->
......@@ -104,8 +98,6 @@ gimppaths
@image_ID:
@name:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_get_path_by_tattoo ##### -->
......@@ -126,8 +118,6 @@ gimppaths
@image_ID:
@name:
@Returns:
<!-- # Unused Parameters # -->
@path_name_to_del:
<!-- ##### FUNCTION gimp_path_get_locked ##### -->
......@@ -138,8 +128,6 @@ gimppaths
@image_ID:
@name:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_path_set_locked ##### -->
......@@ -151,8 +139,6 @@ gimppaths
@name:
@lockstatus:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_path_set_tattoo ##### -->
......@@ -164,8 +150,6 @@ gimppaths
@name:
@tattovalue:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_path_to_selection ##### -->
......@@ -181,8 +165,6 @@ gimppaths
@feather_radius_x:
@feather_radius_y:
@Returns:
<!-- # Unused Parameters # -->
@pathname:
<!-- ##### FUNCTION gimp_path_import ##### -->
......
......@@ -64,7 +64,5 @@ Functions relating to patterns.
@length:
@mask_data:
@Returns:
<!-- # Unused Parameters # -->
@mask_data_size:
......@@ -26,8 +26,6 @@ gimppatternselect
@mask_data:
@dialog_closing:
@user_data:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gimp_pattern_select_new ##### -->
......
......@@ -59,7 +59,4 @@ Functions useful for plugins, e.g. registration and progress indicators.
@domain_name:
@domain_uri:
@Returns:
<!-- # Unused Parameters # -->
@help_path:
......@@ -32,8 +32,6 @@ Functions for querying and changing procedural database (PDB) entries.
@args:
@return_vals:
@Returns:
<!-- # Unused Parameters # -->
@params:
<!-- ##### FUNCTION gimp_procedural_db_get_data ##### -->
......@@ -55,8 +53,6 @@ Functions for querying and changing procedural database (PDB) entries.
@data:
@bytes:
@Returns:
<!-- # Unused Parameters # -->
@length:
<!-- ##### FUNCTION gimp_procedural_db_dump ##### -->
......@@ -83,8 +79,6 @@ Functions for querying and changing procedural database (PDB) entries.
@num_matches:
@procedure_names:
@Returns:
<!-- # Unused Parameters # -->
@proc_names:
<!-- ##### FUNCTION gimp_procedural_db_proc_arg ##### -->
......
......@@ -27,8 +27,6 @@ Functions for manipulating selections.
@x2:
@y2:
@Returns:
<!-- # Unused Parameters # -->
@none_empty:
<!-- ##### FUNCTION gimp_selection_all ##### -->
......@@ -77,9 +75,6 @@ Functions for manipulating selections.
@offx:
@offy:
@Returns:
<!-- # Unused Parameters # -->
@x_offset:
@y_offset:
<!-- ##### FUNCTION gimp_selection_load ##### -->
......
......@@ -92,10 +92,6 @@ Functions giving access to common toolbox tools.
@feather_radius:
@sample_merged:
@Returns:
<!-- # Unused Parameters # -->
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_clone ##### -->
......@@ -138,11 +134,6 @@ Functions giving access to common toolbox tools.
@average_radius:
@color:
@Returns:
<!-- # Unused Parameters # -->
@save_color:
@red:
@green:
@blue:
<!-- ##### FUNCTION gimp_convolve ##### -->
......
......@@ -58,9 +58,6 @@ up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
@button:
@active:
<!-- # Unused Parameters # -->
@gcb:
@is_active:
<!-- ##### FUNCTION gimp_chain_button_get_active ##### -->
......@@ -70,8 +67,6 @@ up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
@button:
@Returns:
<!-- # Unused Parameters # -->
@gcb:
<!-- ##### SIGNAL GimpChainButton::toggled ##### -->
......
......@@ -47,8 +47,6 @@ Displays a GimpRGB color, optionally with alpha-channel.
@area:
@color:
<!-- # Unused Parameters # -->
@gca:
<!-- ##### FUNCTION gimp_color_area_get_color ##### -->
......@@ -58,8 +56,6 @@ Displays a GimpRGB color, optionally with alpha-channel.
@area:
@color:
<!-- # Unused Parameters # -->
@gca:
<!-- ##### FUNCTION gimp_color_area_has_alpha ##### -->
......@@ -69,8 +65,6 @@ Displays a GimpRGB color, optionally with alpha-channel.
@area:
@Returns:
<!-- # Unused Parameters # -->
@gca:
<!-- ##### FUNCTION gimp_color_area_set_type ##### -->
......@@ -80,8 +74,6 @@ Displays a GimpRGB color, optionally with alpha-channel.
@area:
@type:
<!-- # Unused Parameters # -->
@gca:
<!-- ##### FUNCTION gimp_color_area_set_draw_border ##### -->
......
......@@ -38,8 +38,6 @@ color, the "color_changed" signal is emitted.
@color:
@type:
@Returns:
<!-- # Unused Parameters # -->
@alpha:
<!-- ##### FUNCTION gimp_color_button_set_color ##### -->
......@@ -49,8 +47,6 @@ color, the "color_changed" signal is emitted.
@button:
@color:
<!-- # Unused Parameters # -->
@gcb:
<!-- ##### FUNCTION gimp_color_button_get_color ##### -->
......@@ -60,8 +56,6 @@ color, the "color_changed" signal is emitted.
@button:
@color:
<!-- # Unused Parameters # -->
@gcb:
<!-- ##### FUNCTION gimp_color_button_set_update ##### -->
......@@ -89,8 +83,6 @@ color, the "color_changed" signal is emitted.
@button:
@Returns:
<!-- # Unused Parameters # -->
@gcb:
<!-- ##### FUNCTION gimp_color_button_set_type ##### -->
......@@ -100,9 +92,6 @@ color, the "color_changed" signal is emitted.
@button:
@type:
<!-- # Unused Parameters # -->
@gcb:
@alpha:
<!-- ##### SIGNAL GimpColorButton::color-changed ##### -->
......
......@@ -83,11 +83,6 @@ display color correction modules.
@display:
@Returns:
<!-- # Unused Parameters # -->
@ok_func:
@ok_data:
@cancel_func:
@cancel_data:
<!-- ##### FUNCTION gimp_color_display_configure_reset ##### -->
......
......@@ -28,9 +28,6 @@ Fancy colored sliders.
@orientation:
@channel:
@Returns:
<!-- # Unused Parameters # -->
@rgb:
@hsv:
<!-- ##### FUNCTION gimp_color_scale_set_channel ##### -->
......
......@@ -34,13 +34,6 @@ dialog-related stuff.
@help_id:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@wmclass_name:
@position:
@allow_shrink:
@allow_grow:
@auto_shrink:
@help_data:
<!-- ##### FUNCTION gimp_dialog_new_valist ##### -->
......
......@@ -56,8 +56,6 @@ will be emitted.
@selection:
@Returns:
<!-- # Unused Parameters # -->
@gfs:
<!-- ##### FUNCTION gimp_file_selection_set_filename ##### -->
......@@ -67,8 +65,6 @@ will be emitted.
@selection:
@filename:
<!-- # Unused Parameters # -->
@gfs:
<!-- ##### SIGNAL GimpFileSelection::filename-changed ##### -->
......
......@@ -2,7 +2,7 @@
GimpHelpUI
<!-- ##### SECTION Short_Description ##### -->
Functions for setting #GtkTooltips and HTML links into the GIMP help
Functions for setting #GtkTooltips and help identifier used by GIMP help
system.
<!-- ##### SECTION Long_Description ##### -->
......@@ -44,8 +44,6 @@ the help.
@help_id:
@data:
<!-- # Unused Parameters # -->
@help_data: A string containing the path to a HTML page.
<!-- ##### FUNCTION gimp_help_enable_tooltips ##### -->
......@@ -80,7 +78,7 @@ See #GimpHelpFunc for the naming conventions of HTML help files.
</para>
@help_id:
@help_data: A string containing the path to a HTML page.
@help_data: A unique help identifier.
<!-- ##### FUNCTION gimp_help_connect ##### -->
......@@ -102,8 +100,6 @@ See #GimpHelpFunc for the naming conventions of HTML help files.
@widget:
@tooltip:
@help_id:
<!-- # Unused Parameters # -->
@help_data:
<!-- ##### FUNCTION gimp_context_help ##### -->
......
......@@ -31,8 +31,6 @@ The #GimpSizeEntry struct is considered private.
@lower:
@upper: