Commit 1dda6015 authored by Niels De Graef's avatar Niels De Graef Committed by Jehan

Use "Returns:" to annotate return values

To be able to annotate return values through GObject-introspection, you
need to make sure it is tagged with `Returns:` and not something else.
parent 746a72b9
......@@ -270,7 +270,7 @@ gimp_lang_rc_new (GFile *system_gimprc,
*
* This function looks up the language set in `gimprc`.
*
* Return value: a newly allocated string representing the language or
* Returns: a newly allocated string representing the language or
* %NULL if the key couldn't be found.
**/
gchar *
......
......@@ -382,7 +382,7 @@ gimp_rc_set_autosave (GimpRc *rc,
* is returned. If no property is found, the list of unknown tokens
* attached to the @rc object is searched.
*
* Return value: a newly allocated string representing the value or %NULL
* Returns: a newly allocated string representing the value or %NULL
* if the key couldn't be found.
**/
gchar *
......
......@@ -48,7 +48,7 @@ static gboolean parse_encoding (const gchar *text,
* GimpXmlParser is a thin wrapper around GMarkupParser. This function
* creates one for you and sets up a GMarkupParseContext.
*
* Return value: a new #GimpXmlParser
* Returns: a new #GimpXmlParser
**/
GimpXmlParser *
gimp_xml_parser_new (const GMarkupParser *markup_parser,
......@@ -75,7 +75,7 @@ gimp_xml_parser_new (const GMarkupParser *markup_parser,
* This function creates a GIOChannel for @filename and calls
* gimp_xml_parser_parse_io_channel() for you.
*
* Return value: %TRUE on success, %FALSE otherwise
* Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
gimp_xml_parser_parse_file (GimpXmlParser *parser,
......@@ -109,7 +109,7 @@ gimp_xml_parser_parse_file (GimpXmlParser *parser,
* This function creates a GIOChannel for @file and calls
* gimp_xml_parser_parse_io_channel() for you.
*
* Return value: %TRUE on success, %FALSE otherwise
* Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
gimp_xml_parser_parse_gfile (GimpXmlParser *parser,
......@@ -140,7 +140,7 @@ gimp_xml_parser_parse_gfile (GimpXmlParser *parser,
* This function creates a GIOChannel for @fd and calls
* gimp_xml_parser_parse_io_channel() for you.
*
* Return value: %TRUE on success, %FALSE otherwise
* Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
gimp_xml_parser_parse_fd (GimpXmlParser *parser,
......@@ -183,7 +183,7 @@ gimp_xml_parser_parse_fd (GimpXmlParser *parser,
* will be assumed and parsing may break later if this assumption
* was wrong.
*
* Return value: %TRUE on success, %FALSE otherwise
* Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
gimp_xml_parser_parse_io_channel (GimpXmlParser *parser,
......@@ -269,7 +269,7 @@ gimp_xml_parser_parse_io_channel (GimpXmlParser *parser,
*
* This function uses the given @parser to parse the XML in @buffer.
*
* Return value: %TRUE on success, %FALSE otherwise
* Returns: %TRUE on success, %FALSE otherwise
**/
gboolean
gimp_xml_parser_parse_buffer (GimpXmlParser *parser,
......
......@@ -264,7 +264,7 @@ gimp_get_display_name (Gimp *gimp,
* taken from events caused by user interaction such as key presses or
* pointer movements. See gdk_x11_display_get_user_time().
*
* Return value: the timestamp of the last user interaction
* Returns: the timestamp of the last user interaction
*/
guint32
gimp_get_user_time (Gimp *gimp)
......
......@@ -819,7 +819,7 @@ gimp_restore (Gimp *gimp,
* gimp_is_restored:
* @gimp: a #Gimp object
*
* Return value: %TRUE if GIMP is completely started, %FALSE otherwise.
* Returns: %TRUE if GIMP is completely started, %FALSE otherwise.
**/
gboolean
gimp_is_restored (Gimp *gimp)
......
......@@ -150,7 +150,7 @@ static void simplify_subdivide (const GimpBoundSeg *segs,
* more than 1 bytes/pixel, the last byte of each pixel is used to
* determine the boundary outline.
*
* Return value: the boundary array.
* Returns: the boundary array.
**/
GimpBoundSeg *
gimp_boundary_find (GeglBuffer *buffer,
......@@ -202,7 +202,7 @@ gimp_boundary_find (GeglBuffer *buffer,
* array contains markers consisting of -1 coordinates and is
* @num_groups elements longer than @segs.
*
* Return value: the sorted segs
* Returns: the sorted segs
**/
GimpBoundSeg *
gimp_boundary_sort (const GimpBoundSeg *segs,
......@@ -316,7 +316,7 @@ gimp_boundary_sort (const GimpBoundSeg *segs,
* with gimp_boundary_sort() and reduces the number of segments while
* preserving the general shape as close as possible.
*
* Return value: the simplified segs.
* Returns: the simplified segs.
**/
GimpBoundSeg *
gimp_boundary_simplify (GimpBoundSeg *sorted_segs,
......
......@@ -850,7 +850,7 @@ gimp_container_get_child_by_index (GimpContainer *container,
* gimp_container_get_first_child:
* @container: a #GimpContainer
*
* Return value: the first child object stored in @container or %NULL if the
* Returns: the first child object stored in @container or %NULL if the
* container is empty
*/
GimpObject *
......@@ -869,7 +869,7 @@ gimp_container_get_first_child (GimpContainer *container)
* gimp_container_get_last_child:
* @container: a #GimpContainer
*
* Return value: the last child object stored in @container or %NULL if the
* Returns: the last child object stored in @container or %NULL if the
* container is empty
*/
GimpObject *
......
......@@ -1074,7 +1074,7 @@ gimp_curve_set_curve (GimpCurve *curve,
* If this function returns %TRUE, then the curve maps each value to
* itself. If it returns %FALSE, then this assumption can not be made.
*
* Return value: %TRUE if the curve is an identity mapping, %FALSE otherwise.
* Returns: %TRUE if the curve is an identity mapping, %FALSE otherwise.
**/
gboolean
gimp_curve_is_identity (GimpCurve *curve)
......
......@@ -1214,7 +1214,7 @@ gimp_data_is_internal (GimpData *data)
* files. In these three groups, the objects are sorted alphabetically
* by name, using gimp_object_name_collate().
*
* Return value: -1 if @data1 compares before @data2,
* Returns: -1 if @data1 compares before @data2,
* 0 if they compare equal,
* 1 if @data1 compares after @data2.
**/
......@@ -1236,7 +1236,7 @@ gimp_data_compare (GimpData *data1,
* This function is used to implement the GIMP_DATA_ERROR macro. It
* shouldn't be called directly.
*
* Return value: the #GQuark to identify error in the GimpData error domain.
* Returns: the #GQuark to identify error in the GimpData error domain.
**/
GQuark
gimp_data_error_quark (void)
......
......@@ -27,7 +27,7 @@
*
* This function is never called directly. Use GIMP_ERROR() instead.
*
* Return value: the #GQuark that defines the general GIMP error domain.
* Returns: the #GQuark that defines the general GIMP error domain.
**/
GQuark
gimp_error_quark (void)
......
......@@ -30,7 +30,7 @@
*
* This function is never called directly. Use GIMP_EXTENSION_ERROR() instead.
*
* Return value: the #GQuark that defines the GimpExtension error domain.
* Returns: the #GQuark that defines the GimpExtension error domain.
**/
GQuark
gimp_extension_error_quark (void)
......
......@@ -297,7 +297,7 @@ gimp_filtered_container_real_src_thaw (GimpFilteredContainer *filtered_container
* containing all of the filtering tags. Synchronization with @src_container
* data is performed automatically.
*
* Return value: a new #GimpFilteredContainer object.
* Returns: a new #GimpFilteredContainer object.
**/
GimpContainer *
gimp_filtered_container_new (GimpContainer *src_container,
......
......@@ -442,7 +442,7 @@ gimp_gradient_get_extension (GimpData *data)
* If you are iterating over an gradient, you should pass the the
* return value from the last call for @seg.
*
* Return value: the gradient segment the color is from
* Returns: the gradient segment the color is from
**/
GimpGradientSegment *
gimp_gradient_get_color_at (GimpGradient *gradient,
......
......@@ -243,7 +243,7 @@ gimp_histogram_new (GimpTRCType trc)
* Creates a duplicate of @histogram. The duplicate has a reference
* count of 1 and contains the values from @histogram.
*
* Return value: a newly allocated %GimpHistogram
* Returns: a newly allocated %GimpHistogram
**/
GimpHistogram *
gimp_histogram_duplicate (GimpHistogram *histogram)
......
......@@ -281,7 +281,7 @@ gimp_image_item_list_transform (GimpImage *image,
* This function returns a #GList of #GimpItem<!-- -->s for which the
* @type and @set criterions match.
*
* Return value: The list of items.
* Returns: The list of items.
**/
GList *
gimp_image_item_list_get_list (GimpImage *image,
......
......@@ -190,7 +190,7 @@ gimp_image_scale (GimpImage *image,
* Inventory the layer list in image and check that it may be
* scaled to @new_height and @new_width without problems.
*
* Return value: #GIMP_IMAGE_SCALE_OK if scaling the image will shrink none
* Returns: #GIMP_IMAGE_SCALE_OK if scaling the image will shrink none
* of its layers completely away, and the new image size
* is smaller than @max_memsize.
* #GIMP_IMAGE_SCALE_TOO_SMALL if scaling would remove some
......
......@@ -690,7 +690,7 @@ gimp_image_snap_rectangle (GimpImage *image,
* Finds out if snapping occurs from position to a snapping candidate
* and sets the target accordingly.
*
* Return value: %TRUE if snapping occurred, %FALSE otherwise
* Returns: %TRUE if snapping occurred, %FALSE otherwise
*/
static gboolean
gimp_image_snap_distance (const gdouble unsnapped,
......
......@@ -700,7 +700,7 @@ gimp_item_real_resize (GimpItem *item,
* @width: The width to assign the item.
* @height: The height to assign the item.
*
* Return value: The newly created item.
* Returns: The newly created item.
*/
GimpItem *
gimp_item_new (GType type,
......@@ -2061,7 +2061,7 @@ gimp_item_set_parasites (GimpItem *item,
* fiddle with an item's parasite list directly. This function exists
* for special purposes only, like when saving an item to XCF.
*
* Return value: The @item's #GimpParasiteList.
* Returns: The @item's #GimpParasiteList.
**/
GimpParasiteList *
gimp_item_get_parasites (GimpItem *item)
......
......@@ -86,7 +86,7 @@ gimp_layer_new (GimpImage *image,
* possibility of transforming the contents to meet the requirements
* of the target image type
*
* Return value: The new layer.
* Returns: The new layer.
**/
GimpLayer *
gimp_layer_new_from_buffer (GimpBuffer *buffer,
......@@ -119,7 +119,7 @@ gimp_layer_new_from_buffer (GimpBuffer *buffer,
* possibility of transforming the contents to meet the requirements
* of the target image type
*
* Return value: The new layer.
* Returns: The new layer.
**/
GimpLayer *
gimp_layer_new_from_gegl_buffer (GeglBuffer *buffer,
......@@ -165,7 +165,7 @@ gimp_layer_new_from_gegl_buffer (GeglBuffer *buffer,
* possibility of transforming the contents to meet the requirements
* of the target image type
*
* Return value: The new layer.
* Returns: The new layer.
**/
GimpLayer *
gimp_layer_new_from_pixbuf (GdkPixbuf *pixbuf,
......
......@@ -376,7 +376,7 @@ gimp_list_get_child_index (GimpContainer *container,
*
* The returned list has the #GIMP_CONTAINER_POLICY_STRONG.
*
* Return value: a new #GimpList object
* Returns: a new #GimpList object
**/
GimpContainer *
gimp_list_new (GType children_type,
......@@ -410,7 +410,7 @@ gimp_list_new (GType children_type,
*
* The returned list has the #GIMP_CONTAINER_POLICY_WEAK.
*
* Return value: a new #GimpList object
* Returns: a new #GimpList object
**/
GimpContainer *
gimp_list_new_weak (GType children_type,
......@@ -482,7 +482,7 @@ gimp_list_set_sort_func (GimpList *list,
*
* Returns the @list's sort function, see gimp_list_set_sort_func().
*
* Return Value: The @list's sort function.
* Returns: The @list's sort function.
**/
GCompareFunc
gimp_list_get_sort_func (GimpList*list)
......
......@@ -305,7 +305,7 @@ gimp_object_take_name (GimpObject *object,
* This function gives access to the name of a GimpObject. The
* returned name belongs to the object and must not be freed.
*
* Return value: a pointer to the @object's name
* Returns: a pointer to the @object's name
**/
const gchar *
gimp_object_get_name (gconstpointer object)
......@@ -372,7 +372,7 @@ gimp_object_name_free (GimpObject *object)
* correct rules for the current locale. It caches the normalized
* version of the object name to speed up subsequent calls.
*
* Return value: -1 if object1 compares before object2,
* Returns: -1 if object1 compares before object2,
* 0 if they compare equal,
* 1 if object1 compares after object2.
**/
......
......@@ -160,7 +160,7 @@ gimp_param_spec_enum_desc (GParamSpec *pspec)
* parameter types used in the PDB and should not be used for anything
* else.
*
* Return value: A newly allocated string describing the parameter.
* Returns: A newly allocated string describing the parameter.
*/
gchar *
gimp_param_spec_get_desc (GParamSpec *pspec)
......
......@@ -294,7 +294,7 @@ gimp_projection_get_memsize (GimpObject *object,
* Calculates a rough estimate of the memory that is required for the
* projection of an image with the given @width and @height.
*
* Return value: a rough estimate of the memory requirements.
* Returns: a rough estimate of the memory requirements.
**/
gint64
gimp_projection_estimate_memsize (GimpImageBaseType type,
......
......@@ -64,7 +64,7 @@ struct _GimpScanConvert
*
* Create a new scan conversion context.
*
* Return value: a newly allocated #GimpScanConvert context.
* Returns: a newly allocated #GimpScanConvert context.
*/
GimpScanConvert *
gimp_scan_convert_new (void)
......
......@@ -261,7 +261,7 @@ gimp_sub_progress_message (GimpProgress *progress,
* when an action breaks down into multiple sub-actions that itself
* need a #GimpProgress pointer. See gimp_image_scale() for an example.
*
* Return value: a new #GimpProgress object
* Returns: a new #GimpProgress object
*/
GimpProgress *
gimp_sub_progress_new (GimpProgress *progress)
......
......@@ -55,7 +55,7 @@ gimp_tag_init (GimpTag *tag)
*
* If given tag name is not valid, an attempt will be made to fix it.
*
* Return value: a new #GimpTag object, or NULL if tag string is invalid and
* Returns: a new #GimpTag object, or NULL if tag string is invalid and
* cannot be fixed.
**/
GimpTag *
......@@ -95,7 +95,7 @@ gimp_tag_new (const char *tag_string)
* unneeded comparisons. If tag is created, however, it does not mean that
* it would necessarily match with some other tag.
*
* Return value: new #GimpTag object, or NULL if tag will not match with any
* Returns: new #GimpTag object, or NULL if tag will not match with any
* other #GimpTag.
**/
GimpTag *
......@@ -142,7 +142,7 @@ gimp_tag_try_new (const char *tag_string)
*
* Retrieve internal status of the tag.
*
* Return value: internal status of tag. Internal tags are not saved.
* Returns: internal status of tag. Internal tags are not saved.
**/
gboolean
gimp_tag_get_internal (GimpTag *tag)
......@@ -176,7 +176,7 @@ gimp_tag_set_internal (GimpTag *tag, gboolean internal)
*
* Retrieve name of the tag.
*
* Return value: name of tag.
* Returns: name of tag.
**/
const gchar *
gimp_tag_get_name (GimpTag *tag)
......@@ -193,7 +193,7 @@ gimp_tag_get_name (GimpTag *tag)
* Hashing function which is useful, for example, to store #GimpTag in
* a #GHashTable.
*
* Return value: hash value for tag.
* Returns: hash value for tag.
**/
guint
gimp_tag_get_hash (GimpTag *tag)
......@@ -210,7 +210,7 @@ gimp_tag_get_hash (GimpTag *tag)
*
* Compares tags for equality according to tag comparison rules.
*
* Return value: TRUE if tags are equal, FALSE otherwise.
* Returns: TRUE if tags are equal, FALSE otherwise.
**/
gboolean
gimp_tag_equals (GimpTag *tag,
......@@ -230,7 +230,7 @@ gimp_tag_equals (GimpTag *tag,
* Compares tags according to tag comparison rules. Useful for sorting
* functions.
*
* Return value: meaning of return value is the same as in strcmp().
* Returns: meaning of return value is the same as in strcmp().
**/
int
gimp_tag_compare_func (const void *p1,
......@@ -252,7 +252,7 @@ gimp_tag_compare_func (const void *p1,
* gimp_tag_compare_func(), but can be used without creating temporary tag
* object.
*
* Return value: meaning of return value is the same as in strcmp().
* Returns: meaning of return value is the same as in strcmp().
**/
gint
gimp_tag_compare_with_string (GimpTag *tag,
......@@ -285,7 +285,7 @@ gimp_tag_compare_with_string (GimpTag *tag,
* gimp_tag_compare_with_string(), but does not work on the collate key
* because that can't be matched partially.
*
* Return value: wheher #tag starts with @prefix_string.
* Returns: wheher #tag starts with @prefix_string.
**/
gboolean
gimp_tag_has_prefix (GimpTag *tag,
......@@ -318,7 +318,7 @@ gimp_tag_has_prefix (GimpTag *tag,
*
* Tries to create a valid tag string from given @tag_string.
*
* Return value: a newly allocated tag string in case given @tag_string was
* Returns: a newly allocated tag string in case given @tag_string was
* valid or could be fixed, otherwise NULL. Allocated value should be freed
* using g_free().
**/
......@@ -382,7 +382,7 @@ gimp_tag_string_make_valid (const gchar *tag_string)
* Terminal_Punctuation property as specified in the version 5.1.0 of
* the Unicode Standard.
*
* Return value: %TRUE if the character is a tag separator.
* Returns: %TRUE if the character is a tag separator.
*/
gboolean
gimp_tag_is_tag_separator (gunichar c)
......
......@@ -183,7 +183,7 @@ gimp_tag_cache_get_memsize (GimpObject *object,
/**
* gimp_tag_cache_new:
*
* Return value: creates new GimpTagCache object.
* Returns: creates new GimpTagCache object.
**/
GimpTagCache *
gimp_tag_cache_new (void)
......
......@@ -178,7 +178,7 @@ gimp_tagged_set_tags (GimpTagged *tagged,
* Returns the list of tags assigned to this object. The returned %GList
* is owned by the @tagged object and must not be modified or destroyed.
*
* Return value: a list of tags
* Returns: a list of tags
**/
GList *
gimp_tagged_get_tags (GimpTagged *tagged)
......@@ -199,7 +199,7 @@ gimp_tagged_get_tags (GimpTagged *tagged)
* sessions, so for example an instance pointer cannot be used as an
* identifier.
*
* Return value: a newly allocated string containing unique identifier
* Returns: a newly allocated string containing unique identifier
* of the object. It must be freed using #g_free.
**/
gchar *
......@@ -221,7 +221,7 @@ gimp_tagged_get_identifier (GimpTagged *tagged)
* If the object does not want to support such remapping (objects not
* stored in file for example) it can return %NULL.
*
* Return value: checksum string if object needs identifier remapping,
* Returns: checksum string if object needs identifier remapping,
* %NULL otherwise. Returned string must be freed with #g_free().
**/
gchar *
......@@ -237,7 +237,7 @@ gimp_tagged_get_checksum (GimpTagged *tagged)
* @tagged: an object that implements the %GimpTagged interface
* @tag: a %GimpTag
*
* Return value: %TRUE if the object has @tag, %FALSE otherwise.
* Returns: %TRUE if the object has @tag, %FALSE otherwise.
**/
gboolean
gimp_tagged_has_tag (GimpTagged *tagged,
......
......@@ -257,7 +257,7 @@ gimp_tagged_container_src_thaw (GimpFilteredContainer *filtered_container)
* objects containing all of the filtering tags. Synchronization with
* @src_container data is performed automatically.
*
* Return value: a new #GimpTaggedContainer object.
* Returns: a new #GimpTaggedContainer object.
**/
GimpContainer *
gimp_tagged_container_new (GimpContainer *src_container)
......@@ -332,7 +332,7 @@ gimp_tagged_container_set_filter (GimpTaggedContainer *tagged_container,
* Returns current tag filter. Tag filter is a list of GimpTag objects, which
* must be contained by each object matching filter criteria.
*
* Return value: a list of GimpTag objects used as filter. This value should
* Returns: a list of GimpTag objects used as filter. This value should
* not be modified or freed.
**/
const GList *
......@@ -471,7 +471,7 @@ gimp_tagged_container_tag_count_changed (GimpTaggedContainer *container,
* used filter, it is provided for all available objects (ie. empty
* filter).
*
* Return value: number of distinct tags assigned to all objects in the
* Returns: number of distinct tags assigned to all objects in the
* container.
**/
gint
......
......@@ -555,7 +555,7 @@ gimp_undo_is_weak (GimpUndo *undo)
* gimp_undo_get_age:
* @undo:
*
* Return value: the time in seconds since this undo item was created
* Returns: the time in seconds since this undo item was created
*/
gint
gimp_undo_get_age (GimpUndo *undo)
......
......@@ -163,7 +163,7 @@ gimp_tip_free (GimpTip *tip)
* The message set in @error contains a detailed description
* of the problem.
*
* Return value: a #Glist of #GimpTips.
* Returns: a #Glist of #GimpTips.
**/
GList *
gimp_tips_from_file (GFile *file,
......
......@@ -217,7 +217,7 @@ gimp_canvas_focus (GtkWidget *widget,
* look and work like their #GdkDrawable counterparts. #GimpCanvas
* gracefully handles attempts to draw on the unrealized widget.
*
* Return value: a new #GimpCanvas widget
* Returns: a new #GimpCanvas widget
**/
GtkWidget *
gimp_canvas_new (GimpDisplayConfig *config)
......
......@@ -111,7 +111,7 @@ static void gimp_display_shell_scale_get_zoom_focus (GimpDisplayShell *shel
* Reverts the display to the previously used scale. If no previous
* scale exist, then the call does nothing.
*
* Return value: %TRUE if the scale was reverted, otherwise %FALSE.
* Returns: %TRUE if the scale was reverted, otherwise %FALSE.
**/
gboolean
gimp_display_shell_scale_revert (GimpDisplayShell *shell)
......@@ -137,7 +137,7 @@ gimp_display_shell_scale_revert (GimpDisplayShell *shell)
* gimp_display_shell_scale_can_revert:
* @shell: the #GimpDisplayShell
*
* Return value: %TRUE if a previous display scale exists, otherwise %FALSE.
* Returns: %TRUE if a previous display scale exists, otherwise %FALSE.
**/
gboolean
gimp_display_shell_scale_can_revert (GimpDisplayShell *shell)
......
......@@ -109,7 +109,7 @@ gimp_display_shell_constrain_line (GimpDisplayShell *shell,
* into account the shell unit settings and will use the ideal digit
* precision according to current image resolution.
*
* Return value: a newly allocated string containing the enhanced status.
* Returns: a newly allocated string containing the enhanced status.
**/
gchar *
gimp_display_shell_get_line_status (GimpDisplayShell *shell,
......
......@@ -246,7 +246,7 @@ gimp_motion_buffer_end_stroke (GimpMotionBuffer *buffer)
* each tool. If they were to use this distance, more resources on
* recalculating the same value would be saved.
*
* Return value: %TRUE if the motion was significant enough to be
* Returns: %TRUE if the motion was significant enough to be
* processed, %FALSE otherwise.
**/
gboolean
......
......@@ -419,7 +419,7 @@ gimp_scale_combo_box_mru_remove_last (GimpScaleComboBox *combo_box)
/**
* gimp_scale_combo_box_new:
*
* Return value: a new #GimpScaleComboBox.
* Returns: a new #GimpScaleComboBox.
**/
GtkWidget *
gimp_scale_combo_box_new (void)
......
......@@ -99,7 +99,7 @@ gimp_tool_dialog_dispose (GObject *object)
* information stored in @tool_info. It also registers the tool with
* the "toplevel" dialog factory.
*
* Return value: a new #GimpViewableDialog
* Returns: a new #GimpViewableDialog
**/
GtkWidget *
gimp_tool_dialog_new (GimpToolInfo *tool_info,
......
......@@ -210,7 +210,7 @@ gimp_tool_gui_finalize (GObject *object)
* This function creates a #GimpToolGui using the information stored
* in @tool_info.
*
* Return value: a new #GimpToolGui
* Returns: a new #GimpToolGui
**/
GimpToolGui *
gimp_tool_gui_new (GimpToolInfo *tool_info,
......
......@@ -326,7 +326,7 @@ file_open_image (Gimp *gimp,
*
* Attempts to load a thumbnail by using a registered thumbnail loader.
*
* Return value: the thumbnail image
* Returns: the thumbnail image
*/
GimpImage *
file_open_thumbnail (Gimp *gimp,
......
......@@ -27,7 +27,7 @@
*
* This function is never called directly. Use GIMP_PDB_ERROR() instead.
*
* Return value: the #GQuark that defines the GimpPlugIn error domain.
* Returns: the #GQuark that defines the GimpPlugIn error domain.
**/
GQuark
gimp_pdb_error_quark (void)
......
......@@ -852,7 +852,7 @@ collect_extensions (const gchar *ext,
* gimp_interpreter_db_get_extensions:
* @db:
*
* Return value: a newly allocated string with all registered file
* Returns: a newly allocated string with all registered file
* extensions separated by %G_SEARCHPATH_SEPARATOR;
* or %NULL if no extensions are registered
**/
......
......@@ -27,7 +27,7 @@
*
* This function is never called directly. Use GIMP_PLUG_IN_ERROR() instead.
*
* Return value: the #GQuark that defines the GimpPlugIn error domain.
* Returns: the #GQuark that defines the GimpPlugIn error domain.
**/
GQuark
gimp_plug_in_error_quark (void)
......
......@@ -72,7 +72,7 @@ static gchar * launder_font_name (gchar *name);
* "weight", "slant" and "stretch" fields of an X Logical Font
* Description.
*
* Return value: a newly allocated string.
* Returns: a newly allocated string.
**/
gchar *
gimp_text_font_name_from_xlfd (const gchar *xlfd)
......@@ -133,7 +133,7 @@ gimp_text_font_name_from_xlfd (const gchar *xlfd)
* Attempts to extract the font size from an X Logical Font
* Description.
*
* Return value: %TRUE on success, %FALSE otherwise.
* Returns: %TRUE on success, %FALSE otherwise.
**/
gboolean
gimp_text_font_size_from_xlfd (const gchar *xlfd,
......
......@@ -176,7 +176,7 @@ gimp_text_layer_set_xcf_flags (GimpTextLayer *text_layer,
* from XCF files in a backwards-compatible way. Please don't use it
* for anything else!
*
* Return value: a newly allocated #GimpTextLayer object
* Returns: a newly allocated #GimpTextLayer object
**/
static GimpLayer *
gimp_text_layer_from_layer (GimpLayer *layer,
......
......@@ -429,7 +429,7 @@ gimp_text_layer_convert_type (GimpLayer *layer,
*
* Creates a new text layer.
*
* Return value: a new #GimpTextLayer or %NULL in case of a problem