diff --git a/ChangeLog b/ChangeLog
index 628e810cb1..4da7cdf37f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2003-08-08 Sven Neumann <sven@gimp.org>
+
+ * app/config/gimpconfig-deserialize.c
+ * app/config/gimpconfig-serialize.c
+ * app/config/gimpconfig.c
+ * app/config/gimprc.c
+ * app/core/gimpitem.[ch]
+ * app/display/gimpprogress.[ch]
+ * app/widgets/gimpdialogfactory.c
+ * app/widgets/gimpenummenu.c
+ * app/widgets/gimpfontselection.c
+ * app/widgets/gimpwidgets-utils.c: documentation fixes.
+
2003-08-08 Simon Budig <simon@gimp.org>
* app/tools/gimppainttool.c: Added changing the opacity via
diff --git a/app/config/gimpconfig-deserialize.c b/app/config/gimpconfig-deserialize.c
index 2d54440205..5cba05ddd8 100644
--- a/app/config/gimpconfig-deserialize.c
+++ b/app/config/gimpconfig-deserialize.c
@@ -102,7 +102,7 @@ static inline gboolean scanner_string_utf8_valid (GScanner *scanner,
* gimp_config_deserialize_properties:
* @object: a #GObject.
* @scanner: a #GScanner.
- * @embedded_scope: %TRUE if a trailing ')' should not trigger a parse error.
+ * @nest_level:
* @store_unknown_tokens: %TRUE if you want to store unknown tokens.
*
* This function uses the @scanner to configure the properties of @object.
diff --git a/app/config/gimpconfig-serialize.c b/app/config/gimpconfig-serialize.c
index 69f5333384..ddfda5e464 100644
--- a/app/config/gimpconfig-serialize.c
+++ b/app/config/gimpconfig-serialize.c
@@ -58,6 +58,8 @@ static void serialize_unknown_token (const gchar *key,
* @writer: a #GimpConfigWriter.
*
* This function writes all object properties to the @writer.
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_properties (GObject *object,
@@ -100,6 +102,8 @@ gimp_config_serialize_properties (GObject *object,
*
* This function writes all object properties that have been changed from
* their default values to the @writer.
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_changed_properties (GObject *object,
@@ -153,6 +157,8 @@ gimp_config_serialize_changed_properties (GObject *object,
* This function compares @object and @compare and writes all
* properties of @object that have different values than @compare to
* the @writer.
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_properties_diff (GObject *object,
@@ -481,6 +487,8 @@ gimp_config_serialize_value (const GValue *value,
*
* Writes all unknown tokens attached to #object to the @writer. See
* gimp_config_add_unknown_token().
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_unknown_tokens (GObject *object,
diff --git a/app/config/gimpconfig.c b/app/config/gimpconfig.c
index b903be9c3e..5f7aa66ab4 100644
--- a/app/config/gimpconfig.c
+++ b/app/config/gimpconfig.c
@@ -318,13 +318,14 @@ gimp_config_deserialize_file (GObject *object,
* @object: a #GObject that implements the #GimpConfigInterface.
* @text: string to deserialize (in UTF-8 encoding)
* @text_len: length of @text in bytes or -1
+ * @data:
* @error:
*
* Configures @object from @text. Basically this function creates a
* properly configured #GScanner for you and calls the deserialize
* function of the @object's #GimpConfigInterface.
*
- * Return value: %TRUE if deserialization succeeded, %FALSE otherwise.
+ * Returns: %TRUE if deserialization succeeded, %FALSE otherwise.
**/
gboolean
gimp_config_deserialize_string (GObject *object,
@@ -575,6 +576,8 @@ gimp_config_add_unknown_token (GObject *object,
* This function retrieves data that was previously attached using
* gimp_config_add_unknown_token(). You should not free or modify
* the returned string.
+ *
+ * Returns: a pointer to a constant string.
**/
const gchar *
gimp_config_lookup_unknown_token (GObject *object,
diff --git a/app/config/gimprc.c b/app/config/gimprc.c
index d41f3d19a0..e8f74c2b0a 100644
--- a/app/config/gimprc.c
+++ b/app/config/gimprc.c
@@ -541,7 +541,7 @@ gimp_rc_query (GimpRc *rc,
/**
* gimp_rc_save:
- * @rc: a #GimpRc object.
+ * @gimprc: a #GimpRc object.
*
* Saves any settings that differ from the system-wide defined
* defaults to the users personal gimprc file.
diff --git a/app/core/gimpitem.c b/app/core/gimpitem.c
index b9257edb1e..f0246e714c 100644
--- a/app/core/gimpitem.c
+++ b/app/core/gimpitem.c
@@ -78,7 +78,7 @@ static void gimp_item_real_scale (GimpItem *item,
gint new_height,
gint new_offset_x,
gint new_offset_y,
- GimpInterpolationType interp_type);
+ GimpInterpolationType interpolation);
static void gimp_item_real_resize (GimpItem *item,
gint new_width,
gint new_height,
@@ -322,7 +322,7 @@ gimp_item_real_scale (GimpItem *item,
gint new_height,
gint new_offset_x,
gint new_offset_y,
- GimpInterpolationType interp_type)
+ GimpInterpolationType interpolation)
{
item->width = new_width;
item->height = new_height;
@@ -493,7 +493,7 @@ gimp_item_scale (GimpItem *item,
gint new_height,
gint new_offset_x,
gint new_offset_y,
- GimpInterpolationType interpolation_type)
+ GimpInterpolationType interpolation)
{
GimpItemClass *item_class;
@@ -505,7 +505,7 @@ gimp_item_scale (GimpItem *item,
item_class = GIMP_ITEM_GET_CLASS (item);
item_class->scale (item, new_width, new_height, new_offset_x, new_offset_y,
- interpolation_type);
+ interpolation);
}
/**
@@ -513,6 +513,7 @@ gimp_item_scale (GimpItem *item,
* @item: Item to be transformed by explicit width and height factors.
* @w_factor: scale factor to apply to width and horizontal offset
* @h_factor: scale factor to apply to height and vertical offset
+ * @interpolation:
*
* Scales item dimensions and offsets by uniform width and
* height factors.
@@ -540,7 +541,7 @@ gboolean
gimp_item_scale_by_factors (GimpItem *item,
gdouble w_factor,
gdouble h_factor,
- GimpInterpolationType interpolation_type)
+ GimpInterpolationType interpolation)
{
gint new_width, new_height;
gint new_offset_x, new_offset_y;
@@ -563,7 +564,7 @@ gimp_item_scale_by_factors (GimpItem *item,
gimp_item_scale (item,
new_width, new_height,
new_offset_x, new_offset_y,
- interpolation_type);
+ interpolation);
return TRUE;
}
@@ -600,7 +601,7 @@ void
gimp_item_scale_by_origin (GimpItem *item,
gint new_width,
gint new_height,
- GimpInterpolationType interpolation_type,
+ GimpInterpolationType interpolation,
gboolean local_origin)
{
gint new_offset_x, new_offset_y;
@@ -632,7 +633,7 @@ gimp_item_scale_by_origin (GimpItem *item,
gimp_item_scale (item,
new_width, new_height,
new_offset_x, new_offset_y,
- interpolation_type);
+ interpolation);
}
void
@@ -689,7 +690,7 @@ void
gimp_item_transform (GimpItem *item,
const GimpMatrix3 *matrix,
GimpTransformDirection direction,
- GimpInterpolationType interpolation_type,
+ GimpInterpolationType interpolation,
gboolean clip_result,
GimpProgressFunc progress_callback,
gpointer progress_data)
@@ -700,7 +701,7 @@ gimp_item_transform (GimpItem *item,
item_class = GIMP_ITEM_GET_CLASS (item);
- item_class->transform (item, matrix, direction, interpolation_type,
+ item_class->transform (item, matrix, direction, interpolation,
clip_result,
progress_callback, progress_data);
}
diff --git a/app/core/gimpitem.h b/app/core/gimpitem.h
index 3918081ed5..f23cb33e96 100644
--- a/app/core/gimpitem.h
+++ b/app/core/gimpitem.h
@@ -131,7 +131,7 @@ void gimp_item_translate (GimpItem *item,
gint offset_y,
gboolean push_undo);
-gboolean gimp_item_check_scaling (const GimpItem *layer,
+gboolean gimp_item_check_scaling (const GimpItem *item,
gint new_width,
gint new_height);
void gimp_item_scale (GimpItem *item,
@@ -139,15 +139,15 @@ void gimp_item_scale (GimpItem *item,
gint new_height,
gint new_offset_x,
gint new_offset_y,
- GimpInterpolationType interp_type);
+ GimpInterpolationType interpolation);
gboolean gimp_item_scale_by_factors (GimpItem *item,
gdouble w_factor,
gdouble h_factor,
- GimpInterpolationType interp_type);
+ GimpInterpolationType interpolation);
void gimp_item_scale_by_origin (GimpItem *item,
gint new_width,
gint new_height,
- GimpInterpolationType interp_type,
+ GimpInterpolationType interpolation,
gboolean local_origin);
void gimp_item_resize (GimpItem *item,
gint new_width,
diff --git a/app/display/gimpprogress.c b/app/display/gimpprogress.c
index 5d6561a3e6..546ee6da22 100644
--- a/app/display/gimpprogress.c
+++ b/app/display/gimpprogress.c
@@ -348,7 +348,7 @@ gimp_progress_end (GimpProgress *progress)
* gimp_progress_update_and_flush:
* @min: The minimum, ...
* @max: ... the maximum, ...
- * @curr: ... and the current progress of your operation.
+ * @current: ... and the current progress of your operation.
* @data: The #GimpProgress you want to update.
*
* This function's prototype is conveniently
@@ -357,11 +357,11 @@ gimp_progress_end (GimpProgress *progress)
void
gimp_progress_update_and_flush (gint min,
gint max,
- gint curr,
+ gint current,
gpointer data)
{
gimp_progress_update ((GimpProgress *) data,
- (gfloat) (curr - min) / (gfloat) (max - min));
+ (gfloat) (current - min) / (gfloat) (max - min));
while (gtk_events_pending ())
gtk_main_iteration ();
diff --git a/app/display/gimpprogress.h b/app/display/gimpprogress.h
index 9cf64d77af..c21a84cf9b 100644
--- a/app/display/gimpprogress.h
+++ b/app/display/gimpprogress.h
@@ -34,9 +34,9 @@ void gimp_progress_update (GimpProgress *progress,
void gimp_progress_step (GimpProgress *progress);
void gimp_progress_end (GimpProgress *progress);
-void gimp_progress_update_and_flush (gint ymin,
- gint ymax,
- gint curr_x,
+void gimp_progress_update_and_flush (gint min,
+ gint max,
+ gint current,
gpointer data);
diff --git a/app/widgets/gimpdialogfactory.c b/app/widgets/gimpdialogfactory.c
index 71ea7db43a..54c84fba19 100644
--- a/app/widgets/gimpdialogfactory.c
+++ b/app/widgets/gimpdialogfactory.c
@@ -561,6 +561,7 @@ gimp_dialog_factory_dialog_new_internal (GimpDialogFactory *factory,
* @factory: a #GimpDialogFactory
* @identifier: the identifier of the dialog as registered with
* gimp_dialog_factory_register_entry()
+ * preview_size:
*
* Creates a new toplevel dialog or a #GimpDockable, depending on whether
* %factory is a toplevel of dockable factory.
@@ -590,6 +591,7 @@ gimp_dialog_factory_dialog_new (GimpDialogFactory *factory,
* @factory : a #GimpDialogFactory
* @identifier: the identifier of the dialog as registered with
* gimp_dialog_factory_register_entry()
+ * @preview_size:
*
* Raises an already existing toplevel dialog or #GimpDockable if it was
* already created by this %facory.
@@ -619,6 +621,7 @@ gimp_dialog_factory_dialog_raise (GimpDialogFactory *factory,
* @dock : a #GimpDock crated by this %factory.
* @identifier: the identifier of the dialog as registered with
* gimp_dialog_factory_register_entry()
+ * preview_size:
*
* Creates a new #GimpDockable in the context of the #GimpDock it will be
* added to.
diff --git a/app/widgets/gimpenummenu.c b/app/widgets/gimpenummenu.c
index fe9af58826..6cb01602fc 100644
--- a/app/widgets/gimpenummenu.c
+++ b/app/widgets/gimpenummenu.c
@@ -585,6 +585,7 @@ gimp_enum_radio_frame_new_with_range (GType enum_type,
* gimp_enum_stock_box_new:
* @enum_type: the #GType of an enum.
* @stock_prefix: the prefix of the group of stock ids to use.
+ * @icon_size:
* @callback: a callback to connect to the "toggled" signal of each
* #GtkRadioButton that is created.
* @callback_data: data to pass to the @callback.
diff --git a/app/widgets/gimpfontselection.c b/app/widgets/gimpfontselection.c
index 55235fb0ec..14ce18149e 100644
--- a/app/widgets/gimpfontselection.c
+++ b/app/widgets/gimpfontselection.c
@@ -297,7 +297,7 @@ gimp_font_selection_get_fontname (GimpFontSelection *fontsel)
/**
* gimp_font_selection_set_font_desc:
* @fontsel:
- * @new_desc:
+ * @font_desc:
*
* This function does not check if there is a font matching the
* new font description. It should only be used with validated
@@ -305,23 +305,23 @@ gimp_font_selection_get_fontname (GimpFontSelection *fontsel)
**/
void
gimp_font_selection_set_font_desc (GimpFontSelection *fontsel,
- const PangoFontDescription *new_desc)
+ const PangoFontDescription *font_desc)
{
g_return_if_fail (GIMP_IS_FONT_SELECTION (fontsel));
- g_return_if_fail (new_desc != NULL);
+ g_return_if_fail (font_desc != NULL);
if (!fontsel->font_desc)
{
- fontsel->font_desc = pango_font_description_copy (new_desc);
+ fontsel->font_desc = pango_font_description_copy (font_desc);
gimp_font_selection_font_changed (fontsel);
return;
}
- if (pango_font_description_equal (fontsel->font_desc, new_desc))
+ if (pango_font_description_equal (fontsel->font_desc, font_desc))
return;
- pango_font_description_merge (fontsel->font_desc, new_desc, TRUE);
+ pango_font_description_merge (fontsel->font_desc, font_desc, TRUE);
gimp_font_selection_font_changed (fontsel);
}
diff --git a/app/widgets/gimpwidgets-utils.c b/app/widgets/gimpwidgets-utils.c
index 3917533202..f857854bef 100644
--- a/app/widgets/gimpwidgets-utils.c
+++ b/app/widgets/gimpwidgets-utils.c
@@ -522,7 +522,7 @@ gimp_get_screen_resolution (GdkScreen *screen,
/**
* gimp_rgb_get_gdk_color:
- * @color: the source color as #GimpRGB
+ * @rgb: the source color as #GimpRGB
* @gdk_color: pointer to a #GdkColor
*
* Initializes @gdk_color from a #GimpRGB. This function does not
@@ -530,15 +530,15 @@ gimp_get_screen_resolution (GdkScreen *screen,
* you may have to call gdk_colormap_alloc_color().
**/
void
-gimp_rgb_get_gdk_color (const GimpRGB *color,
+gimp_rgb_get_gdk_color (const GimpRGB *rgb,
GdkColor *gdk_color)
{
guchar r, g, b;
- g_return_if_fail (color != NULL);
+ g_return_if_fail (rgb != NULL);
g_return_if_fail (gdk_color != NULL);
- gimp_rgb_get_uchar (color, &r, &g, &b);
+ gimp_rgb_get_uchar (rgb, &r, &g, &b);
gdk_color->red = (r << 8) | r;
gdk_color->green = (g << 8) | g;
diff --git a/libgimpconfig/gimpconfig-deserialize.c b/libgimpconfig/gimpconfig-deserialize.c
index 2d54440205..5cba05ddd8 100644
--- a/libgimpconfig/gimpconfig-deserialize.c
+++ b/libgimpconfig/gimpconfig-deserialize.c
@@ -102,7 +102,7 @@ static inline gboolean scanner_string_utf8_valid (GScanner *scanner,
* gimp_config_deserialize_properties:
* @object: a #GObject.
* @scanner: a #GScanner.
- * @embedded_scope: %TRUE if a trailing ')' should not trigger a parse error.
+ * @nest_level:
* @store_unknown_tokens: %TRUE if you want to store unknown tokens.
*
* This function uses the @scanner to configure the properties of @object.
diff --git a/libgimpconfig/gimpconfig-iface.c b/libgimpconfig/gimpconfig-iface.c
index b903be9c3e..5f7aa66ab4 100644
--- a/libgimpconfig/gimpconfig-iface.c
+++ b/libgimpconfig/gimpconfig-iface.c
@@ -318,13 +318,14 @@ gimp_config_deserialize_file (GObject *object,
* @object: a #GObject that implements the #GimpConfigInterface.
* @text: string to deserialize (in UTF-8 encoding)
* @text_len: length of @text in bytes or -1
+ * @data:
* @error:
*
* Configures @object from @text. Basically this function creates a
* properly configured #GScanner for you and calls the deserialize
* function of the @object's #GimpConfigInterface.
*
- * Return value: %TRUE if deserialization succeeded, %FALSE otherwise.
+ * Returns: %TRUE if deserialization succeeded, %FALSE otherwise.
**/
gboolean
gimp_config_deserialize_string (GObject *object,
@@ -575,6 +576,8 @@ gimp_config_add_unknown_token (GObject *object,
* This function retrieves data that was previously attached using
* gimp_config_add_unknown_token(). You should not free or modify
* the returned string.
+ *
+ * Returns: a pointer to a constant string.
**/
const gchar *
gimp_config_lookup_unknown_token (GObject *object,
diff --git a/libgimpconfig/gimpconfig-serialize.c b/libgimpconfig/gimpconfig-serialize.c
index 69f5333384..ddfda5e464 100644
--- a/libgimpconfig/gimpconfig-serialize.c
+++ b/libgimpconfig/gimpconfig-serialize.c
@@ -58,6 +58,8 @@ static void serialize_unknown_token (const gchar *key,
* @writer: a #GimpConfigWriter.
*
* This function writes all object properties to the @writer.
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_properties (GObject *object,
@@ -100,6 +102,8 @@ gimp_config_serialize_properties (GObject *object,
*
* This function writes all object properties that have been changed from
* their default values to the @writer.
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_changed_properties (GObject *object,
@@ -153,6 +157,8 @@ gimp_config_serialize_changed_properties (GObject *object,
* This function compares @object and @compare and writes all
* properties of @object that have different values than @compare to
* the @writer.
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_properties_diff (GObject *object,
@@ -481,6 +487,8 @@ gimp_config_serialize_value (const GValue *value,
*
* Writes all unknown tokens attached to #object to the @writer. See
* gimp_config_add_unknown_token().
+ *
+ * Returns: %TRUE if serialization succeeded, %FALSE otherwise
**/
gboolean
gimp_config_serialize_unknown_tokens (GObject *object,