Commit c6e93e4f authored by Michael Natterer's avatar Michael Natterer 😴

pdb: generate nicer gtk-doc comments (no doc contents changed)

parent bbc44c9a
......@@ -47,7 +47,7 @@
* Returns: The actual new brush name.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_brush_new (const gchar *name)
{
......@@ -79,7 +79,7 @@ gimp_brush_new (const gchar *name)
* Returns: The name of the brush's copy.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_brush_duplicate (const gchar *name)
{
......@@ -111,7 +111,7 @@ gimp_brush_duplicate (const gchar *name)
* Returns: TRUE if the brush is generated.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_brush_is_generated (const gchar *name)
{
......@@ -144,7 +144,7 @@ gimp_brush_is_generated (const gchar *name)
* Returns: The actual new name of the brush.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_brush_rename (const gchar *name,
const gchar *new_name)
......@@ -178,7 +178,7 @@ gimp_brush_rename (const gchar *name,
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_brush_delete (const gchar *name)
{
......@@ -209,7 +209,7 @@ gimp_brush_delete (const gchar *name)
* Returns: TRUE if the brush can be edited.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_brush_is_editable (const gchar *name)
{
......@@ -246,7 +246,7 @@ gimp_brush_is_editable (const gchar *name)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_brush_get_info (const gchar *name,
gint *width,
......@@ -303,7 +303,7 @@ gimp_brush_get_info (const gchar *name,
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_brush_get_pixels (const gchar *name,
gint *width,
......@@ -372,7 +372,7 @@ gimp_brush_get_pixels (const gchar *name,
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_brush_get_spacing (const gchar *name,
gint *spacing)
......@@ -411,7 +411,7 @@ gimp_brush_get_spacing (const gchar *name,
* Returns: TRUE on success.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_brush_set_spacing (const gchar *name,
gint spacing)
......@@ -449,7 +449,7 @@ gimp_brush_set_spacing (const gchar *name,
* Returns: The brush shape.
*
* Since: GIMP 2.4
*/
**/
GimpBrushGeneratedShape
gimp_brush_get_shape (const gchar *name)
{
......@@ -487,7 +487,7 @@ gimp_brush_get_shape (const gchar *name)
* Returns: The brush shape actually assigned.
*
* Since: GIMP 2.4
*/
**/
GimpBrushGeneratedShape
gimp_brush_set_shape (const gchar *name,
GimpBrushGeneratedShape shape_in)
......@@ -522,7 +522,7 @@ gimp_brush_set_shape (const gchar *name,
* Returns: The radius of the brush in pixels.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_get_radius (const gchar *name)
{
......@@ -556,7 +556,7 @@ gimp_brush_get_radius (const gchar *name)
* Returns: The brush radius actually assigned.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_set_radius (const gchar *name,
gdouble radius_in)
......@@ -591,7 +591,7 @@ gimp_brush_set_radius (const gchar *name,
* Returns: The number of spikes on the brush.
*
* Since: GIMP 2.4
*/
**/
gint
gimp_brush_get_spikes (const gchar *name)
{
......@@ -625,7 +625,7 @@ gimp_brush_get_spikes (const gchar *name)
* Returns: The number of spikes actually assigned.
*
* Since: GIMP 2.4
*/
**/
gint
gimp_brush_set_spikes (const gchar *name,
gint spikes_in)
......@@ -661,7 +661,7 @@ gimp_brush_set_spikes (const gchar *name,
* Returns: The hardness of the brush.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_get_hardness (const gchar *name)
{
......@@ -695,7 +695,7 @@ gimp_brush_get_hardness (const gchar *name)
* Returns: The brush hardness actually assigned.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_set_hardness (const gchar *name,
gdouble hardness_in)
......@@ -730,7 +730,7 @@ gimp_brush_set_hardness (const gchar *name,
* Returns: The aspect ratio of the brush.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_get_aspect_ratio (const gchar *name)
{
......@@ -764,7 +764,7 @@ gimp_brush_get_aspect_ratio (const gchar *name)
* Returns: The brush aspect ratio actually assigned.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_set_aspect_ratio (const gchar *name,
gdouble aspect_ratio_in)
......@@ -799,7 +799,7 @@ gimp_brush_set_aspect_ratio (const gchar *name,
* Returns: The rotation angle of the brush.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_get_angle (const gchar *name)
{
......@@ -833,7 +833,7 @@ gimp_brush_get_angle (const gchar *name)
* Returns: The brush rotation angle actually assigned.
*
* Since: GIMP 2.4
*/
**/
gdouble
gimp_brush_set_angle (const gchar *name,
gdouble angle_in)
......
......@@ -48,7 +48,7 @@
* path and updates the brush dialogs accordingly.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_brushes_refresh (void)
{
......@@ -79,7 +79,7 @@ gimp_brushes_refresh (void)
* gimp_context_set_brush() procedure.
*
* Returns: The list of brush names.
*/
**/
gchar **
gimp_brushes_get_list (const gchar *filter,
gint *num_brushes)
......@@ -118,7 +118,7 @@ gimp_brushes_get_list (const gchar *filter,
* Deprecated: Use gimp_context_get_brush() instead.
*
* Returns: The brush name.
*/
**/
gchar *
gimp_brushes_get_brush (gint *width,
gint *height,
......@@ -151,7 +151,7 @@ gimp_brushes_get_brush (gint *width,
* Deprecated: Use gimp_brush_get_spacing() instead.
*
* Returns: The brush spacing.
*/
**/
gint
gimp_brushes_get_spacing (void)
{
......@@ -178,7 +178,7 @@ gimp_brushes_get_spacing (void)
* Deprecated: Use gimp_brush_set_spacing() instead.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_brushes_set_spacing (gint spacing)
{
......@@ -212,7 +212,7 @@ gimp_brushes_set_spacing (gint spacing)
* Deprecated: Use gimp_brush_get_pixels() instead.
*
* Returns: The brush name.
*/
**/
gchar *
gimp_brushes_get_brush_data (const gchar *name,
gdouble *opacity,
......
......@@ -48,7 +48,7 @@
* This procedure opens the brush selection dialog.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_brushes_popup (const gchar *brush_callback,
const gchar *popup_title,
......@@ -87,7 +87,7 @@ gimp_brushes_popup (const gchar *brush_callback,
* This procedure closes an opened brush selection dialog.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_brushes_close_popup (const gchar *brush_callback)
{
......@@ -120,7 +120,7 @@ gimp_brushes_close_popup (const gchar *brush_callback)
* Sets the current brush in a brush selection dialog.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_brushes_set_popup (const gchar *brush_callback,
const gchar *brush_name,
......
......@@ -47,7 +47,7 @@
* Returns: The list of buffer names.
*
* Since: GIMP 2.4
*/
**/
gchar **
gimp_buffers_get_list (const gchar *filter,
gint *num_buffers)
......@@ -89,7 +89,7 @@ gimp_buffers_get_list (const gchar *filter,
* Returns: The real name given to the buffer.
*
* Since: GIMP 2.4
*/
**/
gchar *
gimp_buffer_rename (const gchar *buffer_name,
const gchar *new_name)
......@@ -123,7 +123,7 @@ gimp_buffer_rename (const gchar *buffer_name,
* Returns: TRUE on success.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_buffer_delete (const gchar *buffer_name)
{
......@@ -154,7 +154,7 @@ gimp_buffer_delete (const gchar *buffer_name)
* Returns: The buffer width.
*
* Since: GIMP 2.4
*/
**/
gint
gimp_buffer_get_width (const gchar *buffer_name)
{
......@@ -186,7 +186,7 @@ gimp_buffer_get_width (const gchar *buffer_name)
* Returns: The buffer height.
*
* Since: GIMP 2.4
*/
**/
gint
gimp_buffer_get_height (const gchar *buffer_name)
{
......@@ -218,7 +218,7 @@ gimp_buffer_get_height (const gchar *buffer_name)
* Returns: The buffer bpp.
*
* Since: GIMP 2.4
*/
**/
gint
gimp_buffer_get_bytes (const gchar *buffer_name)
{
......@@ -250,7 +250,7 @@ gimp_buffer_get_bytes (const gchar *buffer_name)
* Returns: The buffer image type.
*
* Since: GIMP 2.4
*/
**/
GimpImageBaseType
gimp_buffer_get_image_type (const gchar *buffer_name)
{
......
......@@ -54,7 +54,7 @@
* initially.
*
* Returns: The newly created channel.
*/
**/
gint32
_gimp_channel_new (gint32 image_ID,
gint width,
......@@ -98,7 +98,7 @@ _gimp_channel_new (gint32 image_ID,
* Returns: The newly created channel.
*
* Since: GIMP 2.4
*/
**/
gint32
gimp_channel_new_from_component (gint32 image_ID,
GimpChannelType component,
......@@ -132,7 +132,7 @@ gimp_channel_new_from_component (gint32 image_ID,
* This procedure copies the specified channel and returns the copy.
*
* Returns: The newly copied channel.
*/
**/
gint32
gimp_channel_copy (gint32 channel_ID)
{
......@@ -167,7 +167,7 @@ gimp_channel_copy (gint32 channel_ID)
* the first channel.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_channel_combine_masks (gint32 channel1_ID,
gint32 channel2_ID,
......@@ -206,7 +206,7 @@ gimp_channel_combine_masks (gint32 channel1_ID,
* masked regions are shown. Otherwise, selected regions are shown.
*
* Returns: The channel composite method.
*/
**/
gboolean
gimp_channel_get_show_masked (gint32 channel_ID)
{
......@@ -239,7 +239,7 @@ gimp_channel_get_show_masked (gint32 channel_ID)
* masked regions are shown. Otherwise, selected regions are shown.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_channel_set_show_masked (gint32 channel_ID,
gboolean show_masked)
......@@ -270,7 +270,7 @@ gimp_channel_set_show_masked (gint32 channel_ID,
* This procedure returns the specified channel's opacity.
*
* Returns: The channel opacity.
*/
**/
gdouble
gimp_channel_get_opacity (gint32 channel_ID)
{
......@@ -301,7 +301,7 @@ gimp_channel_get_opacity (gint32 channel_ID)
* This procedure sets the specified channel's opacity.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_channel_set_opacity (gint32 channel_ID,
gdouble opacity)
......@@ -333,7 +333,7 @@ gimp_channel_set_opacity (gint32 channel_ID,
* This procedure returns the specified channel's compositing color.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_channel_get_color (gint32 channel_ID,
GimpRGB *color)
......@@ -367,7 +367,7 @@ gimp_channel_get_color (gint32 channel_ID,
* This procedure sets the specified channel's compositing color.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_channel_set_color (gint32 channel_ID,
const GimpRGB *color)
......
......@@ -50,7 +50,7 @@
* are defined between -127 and 127.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_brightness_contrast (gint32 drawable_ID,
gint brightness,
......@@ -100,7 +100,7 @@ gimp_brightness_contrast (gint32 drawable_ID,
* grayscale images. It will not operate on indexed drawables.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_levels (gint32 drawable_ID,
GimpHistogramChannel channel,
......@@ -139,7 +139,7 @@ gimp_levels (gint32 drawable_ID,
* Deprecated: Use gimp_levels_stretch() instead.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_levels_auto (gint32 drawable_ID)
{
......@@ -172,7 +172,7 @@ gimp_levels_auto (gint32 drawable_ID)
* not operate on indexed drawables.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_levels_stretch (gint32 drawable_ID)
{
......@@ -203,7 +203,7 @@ gimp_levels_stretch (gint32 drawable_ID)
* intensity channel to the specified 'levels' parameter.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_posterize (gint32 drawable_ID,
gint levels)
......@@ -235,7 +235,7 @@ gimp_posterize (gint32 drawable_ID,
* This procedure only works on drawables of type RGB color.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_desaturate (gint32 drawable_ID)
{
......@@ -270,7 +270,7 @@ gimp_desaturate (gint32 drawable_ID)
* Returns: TRUE on success.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_desaturate_full (gint32 drawable_ID,
GimpDesaturateMode desaturate_mode)
......@@ -309,7 +309,7 @@ gimp_desaturate_full (gint32 drawable_ID,
* adjusted based on the histogram for the entire image.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_equalize (gint32 drawable_ID,
gboolean mask_only)
......@@ -343,7 +343,7 @@ gimp_equalize (gint32 drawable_ID,
* valid for this operation.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_invert (gint32 drawable_ID)
{
......@@ -381,7 +381,7 @@ gimp_invert (gint32 drawable_ID)
* to explicitly modify intensity levels.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_curves_spline (gint32 drawable_ID,
GimpHistogramChannel channel,
......@@ -425,7 +425,7 @@ gimp_curves_spline (gint32 drawable_ID,
* Catmull Rom splines.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_curves_explicit (gint32 drawable_ID,
GimpHistogramChannel channel,
......@@ -472,7 +472,7 @@ gimp_curves_explicit (gint32 drawable_ID,
* luminosity of each pixel remains fixed.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_color_balance (gint32 drawable_ID,
GimpTransferMode transfer_mode,
......@@ -519,7 +519,7 @@ gimp_color_balance (gint32 drawable_ID,
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_colorize (gint32 drawable_ID,
gdouble hue,
......@@ -576,7 +576,7 @@ gimp_colorize (gint32 drawable_ID,
* pixels with transparent alpha values will not be counted.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_histogram (gint32 drawable_ID,
GimpHistogramChannel channel,
......@@ -640,7 +640,7 @@ gimp_histogram (gint32 drawable_ID,
* provides the capability to limit range of affected hues.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_hue_saturation (gint32 drawable_ID,
GimpHueRange hue_range,
......@@ -682,7 +682,7 @@ gimp_hue_saturation (gint32 drawable_ID,
* black.
*
* Returns: TRUE on success.
*/
**/
gboolean
gimp_threshold (gint32 drawable_ID,
gint low_threshold,
......
......@@ -46,7 +46,7 @@
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_push (void)
{
......@@ -78,7 +78,7 @@ gimp_context_push (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_pop (void)
{
......@@ -110,7 +110,7 @@ gimp_context_pop (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_context_list_paint_methods (gint *num_paint_methods,
gchar ***paint_methods)
......@@ -153,7 +153,7 @@ gimp_context_list_paint_methods (gint *num_paint_methods,
* Returns: The name of the active paint method.
*
* Since: GIMP 2.4
*/
**/
gchar *
gimp_context_get_paint_method (void)
{
......@@ -189,7 +189,7 @@ gimp_context_get_paint_method (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.4
*/
**/
gboolean
gimp_context_set_paint_method (const gchar *name)
{
......@@ -222,7 +222,7 @@ gimp_context_set_paint_method (const gchar *name)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_get_foreground (GimpRGB *foreground)
{
......@@ -257,7 +257,7 @@ gimp_context_get_foreground (GimpRGB *foreground)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_foreground (const GimpRGB *foreground)
{
......@@ -290,7 +290,7 @@ gimp_context_set_foreground (const GimpRGB *foreground)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_get_background (GimpRGB *background)
{
......@@ -326,7 +326,7 @@ gimp_context_get_background (GimpRGB *background)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_background (const GimpRGB *background)
{
......@@ -358,7 +358,7 @@ gimp_context_set_background (const GimpRGB *background)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_default_colors (void)
{
......@@ -389,7 +389,7 @@ gimp_context_set_default_colors (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_swap_colors (void)
{
......@@ -419,7 +419,7 @@ gimp_context_swap_colors (void)
* Returns: The opacity.
*
* Since: GIMP 2.2
*/
**/
gdouble
gimp_context_get_opacity (void)
{
......@@ -451,7 +451,7 @@ gimp_context_get_opacity (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_opacity (gdouble opacity)
{
......@@ -483,7 +483,7 @@ gimp_context_set_opacity (gdouble opacity)
* Returns: The paint mode.
*
* Since: GIMP 2.2
*/
**/
GimpLayerModeEffects
gimp_context_get_paint_mode (void)
{
......@@ -514,7 +514,7 @@ gimp_context_get_paint_mode (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_paint_mode (GimpLayerModeEffects paint_mode)
{
......@@ -546,7 +546,7 @@ gimp_context_set_paint_mode (GimpLayerModeEffects paint_mode)
* Returns: The name of the active brush.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_context_get_brush (void)
{
......@@ -581,7 +581,7 @@ gimp_context_get_brush (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_brush (const gchar *name)
{
......@@ -613,7 +613,7 @@ gimp_context_set_brush (const gchar *name)
* Returns: The name of the active pattern.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_context_get_pattern (void)
{
......@@ -649,7 +649,7 @@ gimp_context_get_pattern (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_pattern (const gchar *name)
{
......@@ -679,7 +679,7 @@ gimp_context_set_pattern (const gchar *name)
* Returns: The name of the active gradient.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_context_get_gradient (void)
{
......@@ -715,7 +715,7 @@ gimp_context_get_gradient (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_gradient (const gchar *name)
{
......@@ -745,7 +745,7 @@ gimp_context_set_gradient (const gchar *name)
* Returns: The name of the active palette.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_context_get_palette (void)
{
......@@ -781,7 +781,7 @@ gimp_context_get_palette (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_palette (const gchar *name)
{
......@@ -811,7 +811,7 @@ gimp_context_set_palette (const gchar *name)
* Returns: The name of the active font.
*
* Since: GIMP 2.2
*/
**/
gchar *
gimp_context_get_font (void)
{
......@@ -846,7 +846,7 @@ gimp_context_get_font (void)
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
**/
gboolean
gimp_context_set_font (const gchar *name)
{
......@@ -876,7 +876,7 @@ gimp_context_set_font (const gchar *name)
* Returns: The antialias setting.