diff --git a/app/config/gimplangrc.c b/app/config/gimplangrc.c index 34e26f47ab..e2e1267fde 100644 --- a/app/config/gimplangrc.c +++ b/app/config/gimplangrc.c @@ -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 * diff --git a/app/config/gimprc.c b/app/config/gimprc.c index 53d54e5e5f..513ab467b4 100644 --- a/app/config/gimprc.c +++ b/app/config/gimprc.c @@ -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 * diff --git a/app/config/gimpxmlparser.c b/app/config/gimpxmlparser.c index 1bec8f8905..77437c0894 100644 --- a/app/config/gimpxmlparser.c +++ b/app/config/gimpxmlparser.c @@ -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, diff --git a/app/core/gimp-gui.c b/app/core/gimp-gui.c index a148efb6da..57940e31c3 100644 --- a/app/core/gimp-gui.c +++ b/app/core/gimp-gui.c @@ -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) diff --git a/app/core/gimp.c b/app/core/gimp.c index 6a12fa877c..0d4b30d585 100644 --- a/app/core/gimp.c +++ b/app/core/gimp.c @@ -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) diff --git a/app/core/gimpboundary.c b/app/core/gimpboundary.c index 995242c2d2..939c671084 100644 --- a/app/core/gimpboundary.c +++ b/app/core/gimpboundary.c @@ -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, diff --git a/app/core/gimpcontainer.c b/app/core/gimpcontainer.c index 6fda1fb1fc..8540e49da8 100644 --- a/app/core/gimpcontainer.c +++ b/app/core/gimpcontainer.c @@ -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 * diff --git a/app/core/gimpcurve.c b/app/core/gimpcurve.c index 10b2be6bda..31b357b435 100644 --- a/app/core/gimpcurve.c +++ b/app/core/gimpcurve.c @@ -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) diff --git a/app/core/gimpdata.c b/app/core/gimpdata.c index e4640f3970..63421b85dd 100644 --- a/app/core/gimpdata.c +++ b/app/core/gimpdata.c @@ -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) diff --git a/app/core/gimperror.c b/app/core/gimperror.c index 29394cbfb1..6101c3ec3f 100644 --- a/app/core/gimperror.c +++ b/app/core/gimperror.c @@ -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) diff --git a/app/core/gimpextension-error.c b/app/core/gimpextension-error.c index 7d4ec14c52..f074e1c4a8 100644 --- a/app/core/gimpextension-error.c +++ b/app/core/gimpextension-error.c @@ -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) diff --git a/app/core/gimpfilteredcontainer.c b/app/core/gimpfilteredcontainer.c index 1d4b562fd0..500dbf47f6 100644 --- a/app/core/gimpfilteredcontainer.c +++ b/app/core/gimpfilteredcontainer.c @@ -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, diff --git a/app/core/gimpgradient.c b/app/core/gimpgradient.c index 8265225c85..95fa7025cc 100644 --- a/app/core/gimpgradient.c +++ b/app/core/gimpgradient.c @@ -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, diff --git a/app/core/gimphistogram.c b/app/core/gimphistogram.c index 868f995d6e..7c9a4441e1 100644 --- a/app/core/gimphistogram.c +++ b/app/core/gimphistogram.c @@ -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) diff --git a/app/core/gimpimage-item-list.c b/app/core/gimpimage-item-list.c index 3a801d5405..a8a8714042 100644 --- a/app/core/gimpimage-item-list.c +++ b/app/core/gimpimage-item-list.c @@ -281,7 +281,7 @@ gimp_image_item_list_transform (GimpImage *image, * This function returns a #GList of #GimpItems 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, diff --git a/app/core/gimpimage-scale.c b/app/core/gimpimage-scale.c index 04ae6fb0a8..67eeddf8d6 100644 --- a/app/core/gimpimage-scale.c +++ b/app/core/gimpimage-scale.c @@ -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 diff --git a/app/core/gimpimage-snap.c b/app/core/gimpimage-snap.c index b4b1af6822..0b9e87007e 100644 --- a/app/core/gimpimage-snap.c +++ b/app/core/gimpimage-snap.c @@ -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, diff --git a/app/core/gimpitem.c b/app/core/gimpitem.c index 03283b383e..507905c152 100644 --- a/app/core/gimpitem.c +++ b/app/core/gimpitem.c @@ -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) diff --git a/app/core/gimplayer-new.c b/app/core/gimplayer-new.c index f1807ba5e1..3634d522e8 100644 --- a/app/core/gimplayer-new.c +++ b/app/core/gimplayer-new.c @@ -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, diff --git a/app/core/gimplist.c b/app/core/gimplist.c index 0f8aa7be14..018ee85fda 100644 --- a/app/core/gimplist.c +++ b/app/core/gimplist.c @@ -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) diff --git a/app/core/gimpobject.c b/app/core/gimpobject.c index 0f3baf72df..3399647662 100644 --- a/app/core/gimpobject.c +++ b/app/core/gimpobject.c @@ -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. **/ diff --git a/app/core/gimpparamspecs-desc.c b/app/core/gimpparamspecs-desc.c index a59f14fcef..892b8ef0e3 100644 --- a/app/core/gimpparamspecs-desc.c +++ b/app/core/gimpparamspecs-desc.c @@ -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) diff --git a/app/core/gimpprojection.c b/app/core/gimpprojection.c index 697414adf3..f29bd008f6 100644 --- a/app/core/gimpprojection.c +++ b/app/core/gimpprojection.c @@ -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, diff --git a/app/core/gimpscanconvert.c b/app/core/gimpscanconvert.c index 78b73461b1..949db5e590 100644 --- a/app/core/gimpscanconvert.c +++ b/app/core/gimpscanconvert.c @@ -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) diff --git a/app/core/gimpsubprogress.c b/app/core/gimpsubprogress.c index 3183f613dc..82fb1ecff2 100644 --- a/app/core/gimpsubprogress.c +++ b/app/core/gimpsubprogress.c @@ -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) diff --git a/app/core/gimptag.c b/app/core/gimptag.c index 063b908a7c..e3eb6328aa 100644 --- a/app/core/gimptag.c +++ b/app/core/gimptag.c @@ -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) diff --git a/app/core/gimptagcache.c b/app/core/gimptagcache.c index a0e4534d8f..e4ef0da287 100644 --- a/app/core/gimptagcache.c +++ b/app/core/gimptagcache.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) diff --git a/app/core/gimptagged.c b/app/core/gimptagged.c index 4006f0960c..f706865bfb 100644 --- a/app/core/gimptagged.c +++ b/app/core/gimptagged.c @@ -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, diff --git a/app/core/gimptaggedcontainer.c b/app/core/gimptaggedcontainer.c index 93ea58b8c2..70258c9da7 100644 --- a/app/core/gimptaggedcontainer.c +++ b/app/core/gimptaggedcontainer.c @@ -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 diff --git a/app/core/gimpundo.c b/app/core/gimpundo.c index 68bbae047b..b68476b124 100644 --- a/app/core/gimpundo.c +++ b/app/core/gimpundo.c @@ -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) diff --git a/app/dialogs/tips-parser.c b/app/dialogs/tips-parser.c index 9e94f0f748..f78d631ac6 100644 --- a/app/dialogs/tips-parser.c +++ b/app/dialogs/tips-parser.c @@ -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, diff --git a/app/display/gimpcanvas.c b/app/display/gimpcanvas.c index c741e143d1..a500d45d73 100644 --- a/app/display/gimpcanvas.c +++ b/app/display/gimpcanvas.c @@ -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) diff --git a/app/display/gimpdisplayshell-scale.c b/app/display/gimpdisplayshell-scale.c index dec74fb885..440c304639 100644 --- a/app/display/gimpdisplayshell-scale.c +++ b/app/display/gimpdisplayshell-scale.c @@ -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) diff --git a/app/display/gimpdisplayshell-utils.c b/app/display/gimpdisplayshell-utils.c index 1d4854f93f..912bcc8a66 100644 --- a/app/display/gimpdisplayshell-utils.c +++ b/app/display/gimpdisplayshell-utils.c @@ -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, diff --git a/app/display/gimpmotionbuffer.c b/app/display/gimpmotionbuffer.c index 549f6f0445..1a5f6e7dcc 100644 --- a/app/display/gimpmotionbuffer.c +++ b/app/display/gimpmotionbuffer.c @@ -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 diff --git a/app/display/gimpscalecombobox.c b/app/display/gimpscalecombobox.c index 104952d4cc..8ae8daef31 100644 --- a/app/display/gimpscalecombobox.c +++ b/app/display/gimpscalecombobox.c @@ -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) diff --git a/app/display/gimptooldialog.c b/app/display/gimptooldialog.c index ccb057f31e..1fae1806c5 100644 --- a/app/display/gimptooldialog.c +++ b/app/display/gimptooldialog.c @@ -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, diff --git a/app/display/gimptoolgui.c b/app/display/gimptoolgui.c index db56935b33..2ef01664e8 100644 --- a/app/display/gimptoolgui.c +++ b/app/display/gimptoolgui.c @@ -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, diff --git a/app/file/file-open.c b/app/file/file-open.c index 0f11f0b354..1067036cbe 100644 --- a/app/file/file-open.c +++ b/app/file/file-open.c @@ -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, diff --git a/app/pdb/gimppdberror.c b/app/pdb/gimppdberror.c index a554ca0436..2b3f43cc20 100644 --- a/app/pdb/gimppdberror.c +++ b/app/pdb/gimppdberror.c @@ -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) diff --git a/app/plug-in/gimpinterpreterdb.c b/app/plug-in/gimpinterpreterdb.c index 14b1f7905d..3df9ea6481 100644 --- a/app/plug-in/gimpinterpreterdb.c +++ b/app/plug-in/gimpinterpreterdb.c @@ -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 **/ diff --git a/app/plug-in/gimppluginerror.c b/app/plug-in/gimppluginerror.c index e73e1e5a27..31c358aa14 100644 --- a/app/plug-in/gimppluginerror.c +++ b/app/plug-in/gimppluginerror.c @@ -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) diff --git a/app/text/gimptext-xlfd.c b/app/text/gimptext-xlfd.c index 16245b59e0..287e39213c 100644 --- a/app/text/gimptext-xlfd.c +++ b/app/text/gimptext-xlfd.c @@ -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, diff --git a/app/text/gimptextlayer-xcf.c b/app/text/gimptextlayer-xcf.c index 33452a100a..d0961ee148 100644 --- a/app/text/gimptextlayer-xcf.c +++ b/app/text/gimptextlayer-xcf.c @@ -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, diff --git a/app/text/gimptextlayer.c b/app/text/gimptextlayer.c index d473569273..0f35332438 100644 --- a/app/text/gimptextlayer.c +++ b/app/text/gimptextlayer.c @@ -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 + * Returns: a new #GimpTextLayer or %NULL in case of a problem **/ GimpLayer * gimp_text_layer_new (GimpImage *image, diff --git a/app/tools/gimphandletransformoptions.c b/app/tools/gimphandletransformoptions.c index 8f5d664182..14fc873383 100644 --- a/app/tools/gimphandletransformoptions.c +++ b/app/tools/gimphandletransformoptions.c @@ -129,7 +129,7 @@ gimp_handle_transform_options_get_property (GObject *object, * * Build the Transform Tool Options. * - * Return value: a container holding the transform tool options + * Returns: a container holding the transform tool options **/ GtkWidget * gimp_handle_transform_options_gui (GimpToolOptions *tool_options) diff --git a/app/tools/gimprectangleoptions.c b/app/tools/gimprectangleoptions.c index ffa781bedc..d1f37b311c 100644 --- a/app/tools/gimprectangleoptions.c +++ b/app/tools/gimprectangleoptions.c @@ -1165,7 +1165,7 @@ gimp_rectangle_options_disconnect (GimpRectangleOptions *options, * @rectangle_options: * @fixed_rule: * - * Return value: %TRUE if @fixed_rule is active, %FALSE otherwise. + * Returns: %TRUE if @fixed_rule is active, %FALSE otherwise. */ gboolean gimp_rectangle_options_fixed_rule_active (GimpRectangleOptions *rectangle_options, diff --git a/app/tools/gimptransformgridoptions.c b/app/tools/gimptransformgridoptions.c index 7aed02502b..95e6c4240c 100644 --- a/app/tools/gimptransformgridoptions.c +++ b/app/tools/gimptransformgridoptions.c @@ -344,7 +344,7 @@ gimp_transform_grid_options_get_property (GObject *object, * * Build the TransformGrid Tool Options. * - * Return value: a container holding the transform_grid tool options + * Returns: a container holding the transform_grid tool options **/ GtkWidget * gimp_transform_grid_options_gui (GimpToolOptions *tool_options) diff --git a/app/tools/gimptransformoptions.c b/app/tools/gimptransformoptions.c index f731c302fd..3fbe678085 100644 --- a/app/tools/gimptransformoptions.c +++ b/app/tools/gimptransformoptions.c @@ -207,7 +207,7 @@ gimp_transform_options_reset (GimpConfig *config) * * Build the Transform Tool Options. * - * Return value: a container holding the transform tool options + * Returns: a container holding the transform tool options **/ GtkWidget * gimp_transform_options_gui (GimpToolOptions *tool_options, diff --git a/app/vectors/gimpvectors-export.c b/app/vectors/gimpvectors-export.c index f8a33e80a8..0e72d92f91 100644 --- a/app/vectors/gimpvectors-export.c +++ b/app/vectors/gimpvectors-export.c @@ -54,7 +54,7 @@ static gchar * gimp_vectors_export_path_data (GimpVectors *vectors); * * Exports one or more vectors to a SVG file. * - * Return value: %TRUE on success, + * Returns: %TRUE on success, * %FALSE if there was an error writing the file **/ gboolean @@ -113,7 +113,7 @@ gimp_vectors_export_file (GimpImage *image, * * Exports one or more vectors to a SVG string. * - * Return value: a %NUL-terminated string that holds a complete XML document + * Returns: a %NUL-terminated string that holds a complete XML document **/ gchar * gimp_vectors_export_string (GimpImage *image, diff --git a/app/vectors/gimpvectors-import.c b/app/vectors/gimpvectors-import.c index fa631eed5a..4ae381c621 100644 --- a/app/vectors/gimpvectors-import.c +++ b/app/vectors/gimpvectors-import.c @@ -206,7 +206,7 @@ static GList * parse_path_data (const gchar *data); * * Imports one or more paths and basic shapes from a SVG file. * - * Return value: %TRUE on success, %FALSE if an error occurred + * Returns: %TRUE on success, %FALSE if an error occurred **/ gboolean gimp_vectors_import_file (GimpImage *image, @@ -253,7 +253,7 @@ gimp_vectors_import_file (GimpImage *image, * * Imports one or more paths and basic shapes from a SVG file. * - * Return value: %TRUE on success, %FALSE if an error occurred + * Returns: %TRUE on success, %FALSE if an error occurred **/ gboolean gimp_vectors_import_buffer (GimpImage *image, diff --git a/app/widgets/gimpclipboard.c b/app/widgets/gimpclipboard.c index 7f3e58b6a9..1b599f0bb7 100644 --- a/app/widgets/gimpclipboard.c +++ b/app/widgets/gimpclipboard.c @@ -144,7 +144,7 @@ gimp_clipboard_exit (Gimp *gimp) * Tests if there's an image in the clipboard. If the global image cut * buffer of @gimp is empty, this function returns %NULL. * - * Return value: %TRUE if there's an image in the clipboard, %FALSE otherwise + * Returns: %TRUE if there's an image in the clipboard, %FALSE otherwise **/ gboolean gimp_clipboard_has_image (Gimp *gimp) @@ -183,7 +183,7 @@ gimp_clipboard_has_image (Gimp *gimp) * similar to gtk_clipboard_wait_is_text_available(). The same caveats * apply here. * - * Return value: %TRUE if there's image data in the clipboard, %FALSE otherwise + * Returns: %TRUE if there's image data in the clipboard, %FALSE otherwise **/ gboolean gimp_clipboard_has_buffer (Gimp *gimp) @@ -220,7 +220,7 @@ gimp_clipboard_has_buffer (Gimp *gimp) * This is done in a main-loop similar to * gtk_clipboard_wait_is_text_available(). The same caveats apply here. * - * Return value: %TRUE if there's SVG data in the clipboard, %FALSE otherwise + * Returns: %TRUE if there's SVG data in the clipboard, %FALSE otherwise **/ gboolean gimp_clipboard_has_svg (Gimp *gimp) @@ -257,7 +257,7 @@ gimp_clipboard_has_svg (Gimp *gimp) * This is done in a main-loop similar to * gtk_clipboard_wait_is_text_available(). The same caveats apply here. * - * Return value: %TRUE if there's curve data in the clipboard, %FALSE otherwise + * Returns: %TRUE if there's curve data in the clipboard, %FALSE otherwise **/ gboolean gimp_clipboard_has_curve (Gimp *gimp) @@ -296,7 +296,7 @@ gimp_clipboard_has_curve (Gimp *gimp) * The returned #GimpObject needs to be unref'ed when it's no longer * needed. * - * Return value: a reference to a #GimpObject or %NULL if there's no + * Returns: a reference to a #GimpObject or %NULL if there's no * image or buffer in the clipboard **/ GimpObject * @@ -323,7 +323,7 @@ gimp_clipboard_get_object (Gimp *gimp) * The returned #GimpImage needs to be unref'ed when it's no longer * needed. * - * Return value: a reference to a #GimpImage or %NULL if there's no + * Returns: a reference to a #GimpImage or %NULL if there's no * image in the clipboard **/ GimpImage * @@ -382,7 +382,7 @@ gimp_clipboard_get_image (Gimp *gimp) * The returned #GimpBuffer needs to be unref'ed when it's no longer * needed. * - * Return value: a reference to a #GimpBuffer or %NULL if there's no + * Returns: a reference to a #GimpBuffer or %NULL if there's no * image data **/ GimpBuffer * @@ -448,7 +448,7 @@ gimp_clipboard_get_buffer (Gimp *gimp) * * The returned data needs to be freed when it's no longer needed. * - * Return value: a reference to a #GimpBuffer or %NULL if there's no + * Returns: a reference to a #GimpBuffer or %NULL if there's no * image data **/ gchar * @@ -518,7 +518,7 @@ gimp_clipboard_get_svg (Gimp *gimp, * * The returned curve needs to be unref'ed when it's no longer needed. * - * Return value: a reference to a #GimpCurve or %NULL if there's no + * Returns: a reference to a #GimpCurve or %NULL if there's no * curve data **/ GimpCurve * diff --git a/app/widgets/gimpcolorbar.c b/app/widgets/gimpcolorbar.c index 5c4bc96091..a42f711b7c 100644 --- a/app/widgets/gimpcolorbar.c +++ b/app/widgets/gimpcolorbar.c @@ -225,7 +225,7 @@ gimp_color_bar_draw (GtkWidget *widget, * * Creates a new #GimpColorBar widget. * - * Return value: The new #GimpColorBar widget. + * Returns: The new #GimpColorBar widget. **/ GtkWidget * gimp_color_bar_new (GtkOrientation orientation) diff --git a/app/widgets/gimpcolorframe.c b/app/widgets/gimpcolorframe.c index 617515e09d..dccc8b21d8 100644 --- a/app/widgets/gimpcolorframe.c +++ b/app/widgets/gimpcolorframe.c @@ -425,7 +425,7 @@ gimp_color_frame_draw (GtkWidget *widget, * * Creates a new #GimpColorFrame widget. * - * Return value: The new #GimpColorFrame widget. + * Returns: The new #GimpColorFrame widget. **/ GtkWidget * gimp_color_frame_new (void) diff --git a/app/widgets/gimpcombotagentry.c b/app/widgets/gimpcombotagentry.c index 59e3ea2fc2..879ed95c45 100644 --- a/app/widgets/gimpcombotagentry.c +++ b/app/widgets/gimpcombotagentry.c @@ -137,7 +137,7 @@ gimp_combo_tag_entry_draw (GtkWidget *widget, * Creates a new #GimpComboTagEntry widget which extends #GimpTagEntry by * adding ability to pick tags using popup window (similar to combo box). * - * Return value: a new #GimpComboTagEntry widget. + * Returns: a new #GimpComboTagEntry widget. **/ GtkWidget * gimp_combo_tag_entry_new (GimpTaggedContainer *container, diff --git a/app/widgets/gimpdialogfactory.c b/app/widgets/gimpdialogfactory.c index fb5f22eabe..aa3084b62e 100644 --- a/app/widgets/gimpdialogfactory.c +++ b/app/widgets/gimpdialogfactory.c @@ -693,7 +693,7 @@ gimp_dialog_factory_dialog_new_internal (GimpDialogFactory *factory, * Creates a new toplevel dialog or a #GimpDockable, depending on whether * %factory is a toplevel of dockable factory. * - * Return value: the newly created dialog or an already existing singleton + * Returns: the newly created dialog or an already existing singleton * dialog. **/ GtkWidget * @@ -783,7 +783,7 @@ gimp_dialog_factory_add_session_info (GimpDialogFactory *factory, * Implicitly creates the first dialog in the list if none of the dialogs * were found. * - * Return value: the raised or newly created dialog. + * Returns: the raised or newly created dialog. **/ GtkWidget * gimp_dialog_factory_dialog_raise (GimpDialogFactory *factory, @@ -843,7 +843,7 @@ gimp_dialog_factory_dialog_raise (GimpDialogFactory *factory, * so callers should check that gimp_dockable_get_dockbook (dockable) * is NULL before trying to add it to it's #GimpDockbook. * - * Return value: the newly created #GimpDockable or an already existing + * Returns: the newly created #GimpDockable or an already existing * singleton dockable. **/ GtkWidget * diff --git a/app/widgets/gimphandlebar.c b/app/widgets/gimphandlebar.c index 8331ee78e8..be13601d7b 100644 --- a/app/widgets/gimphandlebar.c +++ b/app/widgets/gimphandlebar.c @@ -296,7 +296,7 @@ gimp_handle_bar_motion_notify (GtkWidget *widget, * * Creates a new #GimpHandleBar widget. * - * Return value: The new #GimpHandleBar widget. + * Returns: The new #GimpHandleBar widget. **/ GtkWidget * gimp_handle_bar_new (GtkOrientation orientation) diff --git a/app/widgets/gimplayermodebox.c b/app/widgets/gimplayermodebox.c index aa35f8f5eb..94e1a431ae 100644 --- a/app/widgets/gimplayermodebox.c +++ b/app/widgets/gimplayermodebox.c @@ -225,7 +225,7 @@ gimp_layer_mode_box_get_property (GObject *object, * gimp_layer_mode_box_new: * Foo. * - * Return value: a new #GimpLayerModeBox. + * Returns: a new #GimpLayerModeBox. **/ GtkWidget * gimp_layer_mode_box_new (GimpLayerModeContext context) diff --git a/app/widgets/gimplayermodecombobox.c b/app/widgets/gimplayermodecombobox.c index 2062486d19..07dd01e25f 100644 --- a/app/widgets/gimplayermodecombobox.c +++ b/app/widgets/gimplayermodecombobox.c @@ -221,7 +221,7 @@ gimp_layer_mode_combo_box_changed (GtkComboBox *gtk_combo) * gimp_layer_mode_combo_box_new: * Foo. * - * Return value: a new #GimpLayerModeComboBox. + * Returns: a new #GimpLayerModeComboBox. **/ GtkWidget * gimp_layer_mode_combo_box_new (GimpLayerModeContext context) diff --git a/app/widgets/gimpoverlaybox.c b/app/widgets/gimpoverlaybox.c index d47bf0c02f..ef879e54ed 100644 --- a/app/widgets/gimpoverlaybox.c +++ b/app/widgets/gimpoverlaybox.c @@ -370,7 +370,7 @@ gimp_overlay_box_pick_embedded_child (GdkWindow *parent, * * Creates a new #GimpOverlayBox widget. * - * Return value: a new #GimpOverlayBox widget + * Returns: a new #GimpOverlayBox widget **/ GtkWidget * gimp_overlay_box_new (void) diff --git a/app/widgets/gimppropwidgets.c b/app/widgets/gimppropwidgets.c index 6e6e012eee..81d187e34f 100644 --- a/app/widgets/gimppropwidgets.c +++ b/app/widgets/gimppropwidgets.c @@ -99,7 +99,7 @@ static void connect_notify (GObject *config, * If @button_label is %NULL, the @property_name's nick will be used as * label of the #GtkCheckButton title. * - * Return value: A new #GimpFrame widget. + * Returns: A new #GimpFrame widget. * * Since GIMP 2.4 */ @@ -293,7 +293,7 @@ gimp_prop_radio_button_notify (GObject *config, * Creates a #GimpLayerModeBox widget to display and set the specified * Enum property, for which the enum must be #GimpLayerMode. * - * Return value: The newly created #GimpLayerModeBox widget. + * Returns: The newly created #GimpLayerModeBox widget. * * Since GIMP 2.10 */ @@ -345,7 +345,7 @@ static void gimp_prop_color_button_notify (GObject *config, * If @title is %NULL, the @property_name's nick will be used as label * of the returned widget. * - * Return value: A new #GimpColorPanel widget. + * Returns: A new #GimpColorPanel widget. * * Since GIMP 2.4 */ @@ -466,7 +466,7 @@ static void gimp_prop_adjustment_notify (GObject *config, * The property's lower and upper values will be used as min/max of the * #GimpSpinScale. * - * Return value: A new #GimpSpinScale widget. + * Returns: A new #GimpSpinScale widget. * * Since GIMP 2.8 */ @@ -824,7 +824,7 @@ rad_to_deg (GBinding *binding, * Creates a #GimpDial to set and display the value of a * gdouble property that represents an angle. * - * Return value: A new #GimpDial widget. + * Returns: A new #GimpDial widget. * * Since GIMP 2.10 */ @@ -1001,7 +1001,7 @@ static void gimp_prop_view_notify (GObject *config, * * Creates a widget to display the value of a #GimpViewable property. * - * Return value: A new #GimpView widget. + * Returns: A new #GimpView widget. * * Since GIMP 2.4 */ @@ -1152,7 +1152,7 @@ static void gimp_prop_number_pair_entry_number_pair_user_override_notify * @min_valid_value: * @max_valid_value: What to pass to gimp_number_pair_entry_new (). * - * Return value: A #GimpNumberPairEntry widget. + * Returns: A #GimpNumberPairEntry widget. */ GtkWidget * gimp_prop_number_pair_entry_new (GObject *config, diff --git a/app/widgets/gimptagentry.c b/app/widgets/gimptagentry.c index a2c00b0f4e..83c3093c20 100644 --- a/app/widgets/gimptagentry.c +++ b/app/widgets/gimptagentry.c @@ -322,7 +322,7 @@ gimp_tag_entry_get_property (GObject *object, * tags selected. When operating in assignment mode, tags are assigned to * objects selected and visible in @container. * - * Return value: a new GimpTagEntry widget. + * Returns: a new GimpTagEntry widget. **/ GtkWidget * gimp_tag_entry_new (GimpTaggedContainer *container, @@ -814,7 +814,7 @@ gimp_tag_entry_assign_tags (GimpTagEntry *tag_entry) * valid as they are fixed when necessary. Only valid tags are * returned. * - * Return value: a newly allocated NULL terminated list of strings. It + * Returns: a newly allocated NULL terminated list of strings. It * should be freed using g_strfreev(). **/ gchar ** @@ -1729,7 +1729,7 @@ gimp_tag_entry_add_to_recent (GimpTagEntry *entry, * Tag separator is a single Unicode terminal punctuation * character. * - * Return value: returns locale dependent tag separator. + * Returns: returns locale dependent tag separator. **/ const gchar * gimp_tag_entry_get_separator (void) diff --git a/app/widgets/gimptagpopup.c b/app/widgets/gimptagpopup.c index 5325555e53..38a2eb9656 100644 --- a/app/widgets/gimptagpopup.c +++ b/app/widgets/gimptagpopup.c @@ -450,7 +450,7 @@ gimp_tag_popup_get_property (GObject *object, * Tag popup widget is only useful for for #GimpComboTagEntry and * should not be used elsewhere. * - * Return value: a newly created #GimpTagPopup widget. + * Returns: a newly created #GimpTagPopup widget. **/ GtkWidget * gimp_tag_popup_new (GimpComboTagEntry *combo_entry) diff --git a/app/widgets/gimpwidgets-utils.c b/app/widgets/gimpwidgets-utils.c index 8488ed060e..986276e6a4 100644 --- a/app/widgets/gimpwidgets-utils.c +++ b/app/widgets/gimpwidgets-utils.c @@ -339,7 +339,7 @@ gimp_enum_radio_frame_add (GtkFrame *frame, * returned, so this function is guaranteed to always return a * #GdkPixbuf. * - * Return value: a newly allocated #GdkPixbuf containing @icon_name at + * Returns: a newly allocated #GdkPixbuf containing @icon_name at * size @size or a fallback icon/size. **/ GdkPixbuf * @@ -533,7 +533,7 @@ gimp_get_mod_string (GdkModifierType modifiers) * of the modifier. They can also be %NULL if the modifier name * should be left alone. * - * Return value: a newly allocated string containing the message. + * Returns: a newly allocated string containing the message. **/ gchar * gimp_suggest_modifiers (const gchar *message, @@ -871,7 +871,7 @@ gimp_window_set_hint (GtkWindow *window, * This function is used to pass a window handle to plug-ins so that * they can set their dialog windows transient to the parent window. * - * Return value: a native window ID of the window's #GdkWindow or 0 + * Returns: a native window ID of the window's #GdkWindow or 0 * if the window isn't realized yet */ guint32 diff --git a/devel-docs/README.gtkdoc b/devel-docs/README.gtkdoc index b571a7b545..8e8e31b5c3 100644 --- a/devel-docs/README.gtkdoc +++ b/devel-docs/README.gtkdoc @@ -94,7 +94,7 @@ functions (and macros, signals and properties, if you want). * #GtkWidget for links to other declarations (which may be documented * elsewhere). * - * Return value: an integer. + * Returns: an integer. **/ The block starts with '/**'. diff --git a/libgimp/gimp.c b/libgimp/gimp.c index 09a446a9fd..2e693f8dc0 100644 --- a/libgimp/gimp.c +++ b/libgimp/gimp.c @@ -887,7 +887,7 @@ gimp_run_procedure_with_array (const gchar *name, * The returned string is owned by libgimp and must not be freed or * modified. * - * Return value: the error message + * Returns: the error message * * Since: 2.6 **/ @@ -925,7 +925,7 @@ gimp_get_pdb_error (void) * * Retrieves the status from the last procedure call. * - * Return value: the #GimpPDBStatusType. + * Returns: the #GimpPDBStatusType. * * Since: 2.10 **/ @@ -942,7 +942,7 @@ gimp_get_pdb_status (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the tile_width + * Returns: the tile_width **/ guint gimp_tile_width (void) @@ -957,7 +957,7 @@ gimp_tile_width (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the tile_height + * Returns: the tile_height **/ guint gimp_tile_height (void) @@ -973,7 +973,7 @@ gimp_tile_height (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the shared memory ID + * Returns: the shared memory ID **/ gint gimp_shm_ID (void) @@ -989,7 +989,7 @@ gimp_shm_ID (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the shared memory address + * Returns: the shared memory address **/ guchar * gimp_shm_addr (void) @@ -1005,7 +1005,7 @@ gimp_shm_addr (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the show_help_button boolean + * Returns: the show_help_button boolean * * Since: 2.2 **/ @@ -1021,7 +1021,7 @@ gimp_show_help_button (void) * Returns whether file plug-ins should default to exporting the * image's color profile. * - * Return value: TRUE if preferences are set to export the color profile. + * Returns: TRUE if preferences are set to export the color profile. * * Since: 2.10.4 **/ @@ -1038,7 +1038,7 @@ gimp_export_color_profile (void) * metadata, according preferences (original settings is %FALSE since * metadata can contain sensitive information). * - * Return value: TRUE if preferences are set to export Exif. + * Returns: TRUE if preferences are set to export Exif. * * Since: 2.10 **/ @@ -1055,7 +1055,7 @@ gimp_export_exif (void) * metadata, according preferences (original settings is %FALSE since * metadata can contain sensitive information). * - * Return value: TRUE if preferences are set to export XMP. + * Returns: TRUE if preferences are set to export XMP. * * Since: 2.10 **/ @@ -1072,7 +1072,7 @@ gimp_export_xmp (void) * metadata, according preferences (original settings is %FALSE since * metadata can contain sensitive information). * - * Return value: TRUE if preferences are set to export IPTC. + * Returns: TRUE if preferences are set to export IPTC. * * Since: 2.10 **/ @@ -1089,7 +1089,7 @@ gimp_export_iptc (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the check_size value + * Returns: the check_size value * * Since: 2.2 **/ @@ -1106,7 +1106,7 @@ gimp_check_size (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the check_type value + * Returns: the check_type value * * Since: 2.2 **/ @@ -1124,7 +1124,7 @@ gimp_check_type (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the default display ID + * Returns: the default display ID **/ gint32 gimp_default_display (void) @@ -1139,7 +1139,7 @@ gimp_default_display (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the window manager class + * Returns: the window manager class **/ const gchar * gimp_wm_class (void) @@ -1156,7 +1156,7 @@ gimp_wm_class (void) * Will return %NULL if GIMP has been started with no GUI, either * via "--no-interface" flag, or a console build. * - * Return value: the display name + * Returns: the display name **/ const gchar * gimp_display_name (void) @@ -1171,7 +1171,7 @@ gimp_display_name (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the monitor number + * Returns: the monitor number **/ gint gimp_monitor_number (void) @@ -1188,7 +1188,7 @@ gimp_monitor_number (void) * * This is a constant value given at plug-in configuration time. * - * Return value: timestamp for plug-in window + * Returns: timestamp for plug-in window * * Since: 2.6 **/ @@ -1205,7 +1205,7 @@ gimp_user_time (void) * * This is a constant value given at plug-in configuration time. * - * Return value: the icon theme directory + * Returns: the icon theme directory * * Since: 2.10.4 **/ @@ -1220,7 +1220,7 @@ gimp_icon_theme_dir (void) * * Returns the plug-in's executable name. * - * Return value: the executable name + * Returns: the executable name **/ const gchar * gimp_get_progname (void) diff --git a/libgimp/gimpdrawable.c b/libgimp/gimpdrawable.c index 7fe6c63bea..196f36001d 100644 --- a/libgimp/gimpdrawable.c +++ b/libgimp/gimpdrawable.c @@ -94,7 +94,7 @@ gimp_drawable_get_sub_thumbnail_data (gint32 drawable_ID, * drawable when the buffer gets destroyed, or when gegl_buffer_flush() * is called. * - * Return value: (transfer full): The #GeglBuffer. + * Returns: (transfer full): The #GeglBuffer. * * See Also: gimp_drawable_get_shadow_buffer() * @@ -127,7 +127,7 @@ gimp_drawable_get_buffer (gint32 drawable_ID) * synced back with the core drawable's shadow tiles when the buffer * gets destroyed, or when gegl_buffer_flush() is called. * - * Return value: (transfer full): The #GeglBuffer. + * Returns: (transfer full): The #GeglBuffer. * * See Also: gimp_drawable_get_shadow_buffer() * @@ -157,7 +157,7 @@ gimp_drawable_get_shadow_buffer (gint32 drawable_ID) * * Returns the #Babl format of the drawable. * - * Return value: The #Babl format. + * Returns: The #Babl format. * * Since: 2.10 */ @@ -243,7 +243,7 @@ gimp_drawable_get_format (gint32 drawable_ID) * * Returns the #Babl thumbnail format of the drawable. * - * Return value: The #Babl thumbnail format. + * Returns: The #Babl thumbnail format. * * Since: 2.10.14 */ diff --git a/libgimp/gimpdrawablepreview.c b/libgimp/gimpdrawablepreview.c index 8a200902e5..c88a02eda7 100644 --- a/libgimp/gimpdrawablepreview.c +++ b/libgimp/gimpdrawablepreview.c @@ -613,7 +613,7 @@ gimp_drawable_preview_new_from_drawable_id (gint32 drawable_ID) * gimp_drawable_preview_get_drawable_id: * @preview: a #GimpDrawablePreview widget * - * Return value: the drawable_ID that has been passed to + * Returns: the drawable_ID that has been passed to * gimp_drawable_preview_new_from_drawable_id(). * * Since: 2.10 diff --git a/libgimp/gimpenums.c.tail b/libgimp/gimpenums.c.tail index 761c516316..722196836a 100644 --- a/libgimp/gimpenums.c.tail +++ b/libgimp/gimpenums.c.tail @@ -192,7 +192,7 @@ gimp_enums_init (void) * This function gives access to the list of enums registered by libgimp. * The returned array is static and must not be modified. * - * Return value: an array with type names + * Returns: an array with type names * * Since: 2.2 **/ diff --git a/libgimp/gimpimagecombobox.c b/libgimp/gimpimagecombobox.c index 99aee7e454..b0e9b0468e 100644 --- a/libgimp/gimpimagecombobox.c +++ b/libgimp/gimpimagecombobox.c @@ -122,7 +122,7 @@ gimp_image_combo_box_init (GimpImageComboBox *combo_box) * active image ID and gimp_int_combo_box_get_active() to retrieve the * ID of the selected image. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ diff --git a/libgimp/gimpimagemetadata.c b/libgimp/gimpimagemetadata.c index a9ee960bff..125d94d39f 100644 --- a/libgimp/gimpimagemetadata.c +++ b/libgimp/gimpimagemetadata.c @@ -417,7 +417,7 @@ gimp_image_metadata_copy_tag (GExiv2Metadata *src, * gimp_image_metadata_save_prepare() to @file, taking into account * the passed @flags. * - * Return value: Whether the save was successful. + * Returns: Whether the save was successful. * * Since: 2.10 */ diff --git a/libgimp/gimpitemcombobox.c b/libgimp/gimpitemcombobox.c index 07d50071d3..4e4f0ed837 100644 --- a/libgimp/gimpitemcombobox.c +++ b/libgimp/gimpitemcombobox.c @@ -180,7 +180,7 @@ gimp_drawable_combo_box_init (GimpDrawableComboBox *combo_box) * drawable ID and gimp_int_combo_box_get_active() to retrieve the ID * of the selected drawable. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ @@ -227,7 +227,7 @@ gimp_channel_combo_box_init (GimpChannelComboBox *combo_box) * Creates a new #GimpIntComboBox filled with all currently opened * channels. See gimp_drawable_combo_box_new() for more information. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ @@ -274,7 +274,7 @@ gimp_layer_combo_box_init (GimpLayerComboBox *combo_box) * Creates a new #GimpIntComboBox filled with all currently opened * layers. See gimp_drawable_combo_box_new() for more information. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ @@ -329,7 +329,7 @@ gimp_vectors_combo_box_init (GimpVectorsComboBox *combo_box) * vectors ID and gimp_int_combo_box_get_active() to retrieve the ID * of the selected vectors object. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.4 **/ diff --git a/libgimp/gimplegacy.c b/libgimp/gimplegacy.c index 9ab1eadfcf..7b3ca1740c 100644 --- a/libgimp/gimplegacy.c +++ b/libgimp/gimplegacy.c @@ -454,7 +454,7 @@ gimp_extension_process (guint timeout) * passes them to gimp_run_procedure2(). Please look there for further * information. * - * Return value: the procedure's return values unless there was an error, + * Returns: the procedure's return values unless there was an error, * in which case the zero-th return value will be the error status, and * the first return value will be a string detailing the error. **/ @@ -657,7 +657,7 @@ gimp_run_procedure (const gchar *name, * As soon as you don't need the return values any longer, you should * free them using gimp_destroy_params(). * - * Return value: the procedure's return values unless there was an error, + * Returns: the procedure's return values unless there was an error, * in which case the zero-th return value will be the error status, and * if there are two values returned, the other return value will be a * string detailing the error. diff --git a/libgimp/gimppixbuf.c b/libgimp/gimppixbuf.c index 455e5bd01b..1c509e4614 100644 --- a/libgimp/gimppixbuf.c +++ b/libgimp/gimppixbuf.c @@ -52,7 +52,7 @@ static GdkPixbuf * gimp_pixbuf_from_data (guchar *data, * Retrieves a thumbnail pixbuf for the image identified by @image_ID. * The thumbnail will be not larger than the requested size. * - * Return value: (transfer full): a new #GdkPixbuf + * Returns: (transfer full): a new #GdkPixbuf * * Since: 2.2 **/ @@ -93,7 +93,7 @@ gimp_image_get_thumbnail (gint32 image_ID, * @drawable_ID. The thumbnail will be not larger than the requested * size. * - * Return value: (transfer full): a new #GdkPixbuf + * Returns: (transfer full): a new #GdkPixbuf * * Since: 2.2 **/ @@ -139,7 +139,7 @@ gimp_drawable_get_thumbnail (gint32 drawable_ID, * @drawable_ID. The thumbnail will be not larger than the requested * size. * - * Return value: (transfer full): a new #GdkPixbuf + * Returns: (transfer full): a new #GdkPixbuf * * Since: 2.2 **/ diff --git a/libgimp/gimpprocbrowserdialog.c b/libgimp/gimpprocbrowserdialog.c index cc5bfb88a7..1c19acd895 100644 --- a/libgimp/gimpprocbrowserdialog.c +++ b/libgimp/gimpprocbrowserdialog.c @@ -238,7 +238,7 @@ gimp_proc_browser_dialog_init (GimpProcBrowserDialog *dialog) * * Create a new #GimpProcBrowserDialog. * - * Return Value: a newly created #GimpProcBrowserDialog. + * Returns: a newly created #GimpProcBrowserDialog. * * Since: 2.4 **/ @@ -284,7 +284,7 @@ gimp_proc_browser_dialog_new (const gchar *title, * * Retrieves the name of the currently selected procedure. * - * Return Value: The name of the selected procedure of %NULL if no + * Returns: The name of the selected procedure of %NULL if no * procedure is selected. * * Since: 2.4 diff --git a/libgimp/gimpprocview.c b/libgimp/gimpprocview.c index 04fcc18696..9bbeb50063 100644 --- a/libgimp/gimpprocview.c +++ b/libgimp/gimpprocview.c @@ -79,7 +79,7 @@ static GtkWidget * gimp_proc_view_create_params (const GimpParamDef *params, * @params: * @return_vals: * - * Return value: (transfer full): a new widget providing a view on a + * Returns: (transfer full): a new widget providing a view on a * GIMP procedure * * Since: 2.4 diff --git a/libgimp/gimpprogress.c b/libgimp/gimpprogress.c index e8de107e8c..01e9a8b91a 100644 --- a/libgimp/gimpprogress.c +++ b/libgimp/gimpprogress.c @@ -62,7 +62,7 @@ static const gdouble gimp_progress_step = (1.0 / 256.0); * @vtable: a pointer to a @GimpProgressVtable. * @user_data: a pointer that is passed as user_data to all vtable functions. * - * Return value: the name of the temporary procedure that's been installed + * Returns: the name of the temporary procedure that's been installed * * Since: 2.4 **/ @@ -149,7 +149,7 @@ gimp_progress_install_vtable (const GimpProgressVtable *vtable, * Uninstalls a temporary progress procedure that was installed using * gimp_progress_install(). * - * Return value: the @user_data that was passed to gimp_progress_install(). + * Returns: the @user_data that was passed to gimp_progress_install(). * * Since: 2.2 **/ diff --git a/libgimp/gimpprogressbar.c b/libgimp/gimpprogressbar.c index f989d2ac73..dba07d3f53 100644 --- a/libgimp/gimpprogressbar.c +++ b/libgimp/gimpprogressbar.c @@ -219,7 +219,7 @@ gimp_progress_bar_get_window (gpointer user_data) * * Creates a new #GimpProgressBar widget. * - * Return value: the new widget. + * Returns: the new widget. * * Since: 2.2 **/ diff --git a/libgimp/gimpui.c b/libgimp/gimpui.c index 9118e0e0cf..66d227f422 100644 --- a/libgimp/gimpui.c +++ b/libgimp/gimpui.c @@ -204,7 +204,7 @@ gimp_ui_get_foreign_window (guint32 window) * You shouldn't have to call this function directly. Use * gimp_window_set_transient_for_display() instead. * - * Return value: (transfer full): A reference to a #GdkWindow or %NULL. + * Returns: (transfer full): A reference to a #GdkWindow or %NULL. * You should unref the window using g_object_unref() as * soon as you don't need it any longer. * @@ -234,7 +234,7 @@ gimp_ui_get_display_window (guint32 gdisp_ID) * You shouldn't have to call this function directly. Use * gimp_window_set_transient() instead. * - * Return value: (transfer full): A reference to a #GdkWindow or %NULL. + * Returns: (transfer full): A reference to a #GdkWindow or %NULL. * You should unref the window using g_object_unref() as * soon as you don't need it any longer. * diff --git a/libgimp/gimpzoompreview.c b/libgimp/gimpzoompreview.c index cfdc47a8be..536156c34f 100644 --- a/libgimp/gimpzoompreview.c +++ b/libgimp/gimpzoompreview.c @@ -817,7 +817,7 @@ gimp_zoom_preview_new_with_model_from_drawable_id (gint32 drawable_ID, * * Returns the drawable_ID the #GimpZoomPreview is attached to. * - * Return Value: the drawable_ID that was passed to + * Returns: the drawable_ID that was passed to * gimp_zoom_preview_new_from_drawable_id(). * * Since: 2.10 @@ -836,7 +836,7 @@ gimp_zoom_preview_get_drawable_id (GimpZoomPreview *preview) * * Returns the #GimpZoomModel the preview is using. * - * Return Value: (transfer none): a pointer to the #GimpZoomModel owned + * Returns: (transfer none): a pointer to the #GimpZoomModel owned * by the @preview * * Since: 2.4 @@ -855,7 +855,7 @@ gimp_zoom_preview_get_model (GimpZoomPreview *preview) * * Returns the zoom factor the preview is currently using. * - * Return Value: the current zoom factor + * Returns: the current zoom factor * * Since: 2.4 **/ @@ -885,7 +885,7 @@ gimp_zoom_preview_get_factor (GimpZoomPreview *preview) * This function also allow to get the current width, height and bpp of the * #GimpZoomPreview. * - * Return Value: newly allocated data that should be released using g_free() + * Returns: newly allocated data that should be released using g_free() * when it is not any longer needed * * Since: 2.4 diff --git a/libgimpbase/gimpbasetypes.c b/libgimpbase/gimpbasetypes.c index fe22464b82..fafb087f3e 100644 --- a/libgimpbase/gimpbasetypes.c +++ b/libgimpbase/gimpbasetypes.c @@ -71,7 +71,7 @@ gimp_type_set_translation_domain (GType type, * not need to use this function directly, use gimp_enum_get_value() * or gimp_enum_value_get_desc() instead. * - * Return value: the translation domain associated with @type + * Returns: the translation domain associated with @type * or %NULL if no domain was set * * Since: 2.2 @@ -111,7 +111,7 @@ gimp_type_set_translation_context (GType type, * use this function directly, use gimp_enum_get_value() or * gimp_enum_value_get_desc() instead. * - * Return value: the translation context associated with @type + * Returns: the translation context associated with @type * or %NULL if no context was set * * Since: 2.8 diff --git a/libgimpbase/gimpcpuaccel.c b/libgimpbase/gimpcpuaccel.c index 86a2d4970b..2c864dc886 100644 --- a/libgimpbase/gimpcpuaccel.c +++ b/libgimpbase/gimpcpuaccel.c @@ -58,7 +58,7 @@ static gboolean use_cpu_accel = TRUE; * * Query for CPU acceleration support. * - * Return value: #GimpCpuAccelFlags as supported by the CPU. + * Returns: #GimpCpuAccelFlags as supported by the CPU. * * Since: 2.4 */ diff --git a/libgimpbase/gimpmemsize.c b/libgimpbase/gimpmemsize.c index 8d91c140f1..d91b2f160a 100644 --- a/libgimpbase/gimpmemsize.c +++ b/libgimpbase/gimpmemsize.c @@ -74,7 +74,7 @@ gimp_memsize_get_type (void) * config files. It should not be displayed to the user. If you need a * nice human-readable string please use g_format_size(). * - * Return value: A newly allocated string representation of @memsize. + * Returns: A newly allocated string representation of @memsize. * * Since: 2.2 **/ @@ -99,7 +99,7 @@ gimp_memsize_serialize (guint64 memsize) * Parses a string representation of a memory size as returned by * gimp_memsize_serialize(). * - * Return value: %TRUE if the @string was successfully parsed and + * Returns: %TRUE if the @string was successfully parsed and * @memsize has been set, %FALSE otherwise. * * Since: 2.2 diff --git a/libgimpbase/gimpmetadata.c b/libgimpbase/gimpmetadata.c index 680f2767fe..44cf87e794 100644 --- a/libgimpbase/gimpmetadata.c +++ b/libgimpbase/gimpmetadata.c @@ -213,7 +213,7 @@ gimp_metadata_init (GimpMetadata *metadata) * * Generate Version 4 UUID/GUID. * - * Return value: The new GUID/UUID string. + * Returns: The new GUID/UUID string. * * Since: 2.10 */ @@ -473,7 +473,7 @@ gimp_metadata_add_xmp_history (GimpMetadata *metadata, * * Creates a new #GimpMetadata instance. * - * Return value: (transfer full): The new #GimpMetadata. + * Returns: (transfer full): The new #GimpMetadata. * * Since: 2.10 */ @@ -505,7 +505,7 @@ gimp_metadata_new (void) * * Duplicates a #GimpMetadata instance. * - * Return value: (transfer full): + * Returns: (transfer full): * The new #GimpMetadata, or %NULL if @metadata is %NULL. * * Since: 2.10 @@ -681,7 +681,7 @@ gimp_metadata_deserialize_error (GMarkupParseContext *context, * Deserializes a string of XML that has been created by * gimp_metadata_serialize(). * - * Return value: (transfer full): The new #GimpMetadata. + * Returns: (transfer full): The new #GimpMetadata. * * Since: 2.10 */ @@ -770,7 +770,7 @@ gimp_metadata_append_tag (GString *string, * Serializes @metadata into an XML string that can later be deserialized * using gimp_metadata_deserialize(). * - * Return value: The serialized XML string. + * Returns: The serialized XML string. * * Since: 2.10 */ @@ -856,7 +856,7 @@ gimp_metadata_serialize (GimpMetadata *metadata) * * Loads #GimpMetadata from @file. * - * Return value: (transfer full): The loaded #GimpMetadata. + * Returns: (transfer full): The loaded #GimpMetadata. * * Since: 2.10 */ @@ -925,7 +925,7 @@ gimp_metadata_load_from_file (GFile *file, * * Saves @metadata to @file. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.10 */ @@ -986,7 +986,7 @@ gimp_metadata_save_to_file (GimpMetadata *metadata, * * Sets the tags from a piece of Exif data on @metadata. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.10 */ @@ -1060,7 +1060,7 @@ gimp_metadata_set_from_exif (GimpMetadata *metadata, * * Sets the tags from a piece of IPTC data on @metadata. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.10 */ @@ -1108,7 +1108,7 @@ gimp_metadata_set_from_iptc (GimpMetadata *metadata, * * Sets the tags from a piece of XMP data on @metadata. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.10 */ @@ -1208,7 +1208,7 @@ gimp_metadata_set_bits_per_sample (GimpMetadata *metadata, * Returns values based on Exif.Image.XResolution, * Exif.Image.YResolution and Exif.Image.ResolutionUnit of @metadata. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.10 */ @@ -1344,7 +1344,7 @@ gimp_metadata_set_resolution (GimpMetadata *metadata, * Exif.Iop.InteroperabilityIndex, Exif.Nikon3.ColorSpace, * Exif.Canon.ColorSpace of @metadata. * - * Return value: The colorspace specified by above tags. + * Returns: The colorspace specified by above tags. * * Since: 2.10 */ @@ -1526,7 +1526,7 @@ gimp_metadata_set_colorspace (GimpMetadata *metadata, * * Returns whether @tag is supported in a file of type @mime_type. * - * Return value: %TRUE if the @tag supported with @mime_type, %FALSE otherwise. + * Returns: %TRUE if the @tag supported with @mime_type, %FALSE otherwise. * * Since: 2.10 */ diff --git a/libgimpbase/gimprectangle.c b/libgimpbase/gimprectangle.c index 678ff8244b..c5cb0ae3ac 100644 --- a/libgimpbase/gimprectangle.c +++ b/libgimpbase/gimprectangle.c @@ -51,7 +51,7 @@ * * Calculates the intersection of two rectangles. * - * Return value: %TRUE if the intersection is non-empty, %FALSE otherwise + * Returns: %TRUE if the intersection is non-empty, %FALSE otherwise * * Since: 2.4 **/ diff --git a/libgimpbase/gimputils.c b/libgimpbase/gimputils.c index 3c0e093de7..0f55be4ae7 100644 --- a/libgimpbase/gimputils.c +++ b/libgimpbase/gimputils.c @@ -172,7 +172,7 @@ gimp_utf8_strtrim (const gchar *str, * with "(invalid UTF-8 string)" is returned. If not even the start * of @str is valid UTF-8, only "(invalid UTF-8 string)" is returned. * - * Return value: The UTF-8 string as described above. + * Returns: The UTF-8 string as described above. **/ gchar * gimp_any_to_utf8 (const gchar *str, @@ -241,7 +241,7 @@ gimp_any_to_utf8 (const gchar *str, * a filename in the filesystem encoding to a function that expects an * UTF-8 encoded filename. * - * Return value: A temporarily valid UTF-8 representation of @filename. + * Returns: A temporarily valid UTF-8 representation of @filename. * This string must not be changed or freed. **/ const gchar * @@ -293,7 +293,7 @@ gimp_filename_to_utf8 (const gchar *filename) * * Since: 2.10 * - * Return value: A temporarily valid UTF-8 representation of @file's name. + * Returns: A temporarily valid UTF-8 representation of @file's name. * This string must not be changed or freed. **/ const gchar * @@ -322,7 +322,7 @@ gimp_file_get_utf8_name (GFile *file) * * Since: 2.10 * - * Return value: %TRUE if @file's URI ends with @extension, + * Returns: %TRUE if @file's URI ends with @extension, * %FALSE otherwise. **/ gboolean @@ -362,7 +362,7 @@ gimp_file_has_extension (GFile *file, * * Since: 2.10 * - * Return value: %TRUE on success, %FALSE otherwise. On %FALSE, @error + * Returns: %TRUE on success, %FALSE otherwise. On %FALSE, @error * is set. **/ gboolean @@ -533,7 +533,7 @@ gimp_file_show_in_file_manager (GFile *file, * this construct and removes the whole bracket construction to get * rid of the mnemonic (see bug 157561). * - * Return value: A (possibly stripped) copy of @str which should be + * Returns: A (possibly stripped) copy of @str which should be * freed using g_free() when it is not needed any longer. **/ gchar * @@ -593,7 +593,7 @@ gimp_strip_uline (const gchar *str) * strings with underlines (like filenames) in a place that would convert * them to mnemonics. * - * Return value: A (possibly escaped) copy of @str which should be + * Returns: A (possibly escaped) copy of @str which should be * freed using g_free() when it is not needed any longer. * * Since: 2.2 @@ -637,7 +637,7 @@ gimp_escape_uline (const gchar *str) * and parameter names. Every character of the input string that is * not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'. * - * Return value: The canonicalized identifier. This is a newly + * Returns: The canonicalized identifier. This is a newly * allocated string that should be freed with g_free() * when no longer needed. * @@ -676,7 +676,7 @@ gimp_canonicalize_identifier (const gchar *identifier) * * Retrieves #GimpEnumDesc associated with the given value, or %NULL. * - * Return value: the value's #GimpEnumDesc. + * Returns: the value's #GimpEnumDesc. * * Since: 2.2 **/ @@ -719,7 +719,7 @@ gimp_enum_get_desc (GEnumClass *enum_class, * description and help are returned (if @value_name, @value_nick, * @value_desc and @value_help are not %NULL). * - * Return value: %TRUE if @value is valid for the @enum_type, + * Returns: %TRUE if @value is valid for the @enum_type, * %FALSE otherwise * * Since: 2.2 @@ -802,7 +802,7 @@ gimp_enum_get_value (GType enum_type, * * Retrieves the translated description for a given @enum_value. * - * Return value: the translated description of the enum value + * Returns: the translated description of the enum value * * Since: 2.2 **/ @@ -841,7 +841,7 @@ gimp_enum_value_get_desc (GEnumClass *enum_class, * * Retrieves the translated help for a given @enum_value. * - * Return value: the translated help of the enum value + * Returns: the translated help of the enum value * * Since: 2.2 **/ @@ -868,7 +868,7 @@ gimp_enum_value_get_help (GEnumClass *enum_class, * * Retrieves the translated abbreviation for a given @enum_value. * - * Return value: the translated abbreviation of the enum value + * Returns: the translated abbreviation of the enum value * * Since: 2.10 **/ @@ -900,7 +900,7 @@ gimp_enum_value_get_abbrev (GEnumClass *enum_class, * * Retrieves the first #GimpFlagsDesc that matches the given value, or %NULL. * - * Return value: the value's #GimpFlagsDesc. + * Returns: the value's #GimpFlagsDesc. * * Since: 2.2 **/ @@ -943,7 +943,7 @@ gimp_flags_get_first_desc (GFlagsClass *flags_class, * translated description and help are returned (if @value_name, * @value_nick, @value_desc and @value_help are not %NULL). * - * Return value: %TRUE if @value is valid for the @flags_type, + * Returns: %TRUE if @value is valid for the @flags_type, * %FALSE otherwise * * Since: 2.2 @@ -1004,7 +1004,7 @@ gimp_flags_get_first_value (GType flags_type, * * Retrieves the translated description for a given @flags_value. * - * Return value: the translated description of the flags value + * Returns: the translated description of the flags value * * Since: 2.2 **/ @@ -1043,7 +1043,7 @@ gimp_flags_value_get_desc (GFlagsClass *flags_class, * * Retrieves the translated help for a given @flags_value. * - * Return value: the translated help of the flags value + * Returns: the translated help of the flags value * * Since: 2.2 **/ @@ -1070,7 +1070,7 @@ gimp_flags_value_get_help (GFlagsClass *flags_class, * * Retrieves the translated abbreviation for a given @flags_value. * - * Return value: the translated abbreviation of the flags value + * Returns: the translated abbreviation of the flags value * * Since: 2.10 **/ @@ -1173,7 +1173,7 @@ gimp_stack_trace_available (gboolean optimal) * our error handling (which is just wrong). Therefore printing to a * file description is an implementation without any memory allocation. - * Return value: %TRUE if a stack trace could be generated, %FALSE + * Returns: %TRUE if a stack trace could be generated, %FALSE * otherwise. * * Since: 2.10 diff --git a/libgimpbase/gimpvaluearray.c b/libgimpbase/gimpvaluearray.c index dcc819ad18..19c3921592 100644 --- a/libgimpbase/gimpvaluearray.c +++ b/libgimpbase/gimpvaluearray.c @@ -217,7 +217,7 @@ gimp_value_array_new_from_types_valist (GType first_type, * * Adds a reference to a #GimpValueArray. * - * Return value: the same @value_array + * Returns: the same @value_array * * Since: 2.10 */ diff --git a/libgimpcolor/gimpcairo.c b/libgimpcolor/gimpcairo.c index 2d05213c92..756b62fcf8 100644 --- a/libgimpcolor/gimpcairo.c +++ b/libgimpcolor/gimpcairo.c @@ -90,7 +90,7 @@ gimp_cairo_set_source_rgba (cairo_t *cr, * * Create a repeating checkerboard pattern. * - * Return value: a new Cairo pattern that can be used as a source on @cr. + * Returns: a new Cairo pattern that can be used as a source on @cr. * * Since: 2.6 **/ @@ -149,7 +149,7 @@ gimp_cairo_checkerboard_create (cairo_t *cr, * This function returns a #Babl format that corresponds to @surface's * pixel format. * - * Return value: the #Babl format of @surface. + * Returns: the #Babl format of @surface. * * Since: 2.10 **/ @@ -181,7 +181,7 @@ gimp_cairo_surface_get_format (cairo_surface_t *surface) * It must only be called on image surfaces, calling it on other surface * types is an error. * - * Return value: (transfer full): a #GeglBuffer + * Returns: (transfer full): a #GeglBuffer * * Since: 2.10 **/ diff --git a/libgimpcolor/gimpcolormanaged.c b/libgimpcolor/gimpcolormanaged.c index bddf312ca0..da00142bc2 100644 --- a/libgimpcolor/gimpcolormanaged.c +++ b/libgimpcolor/gimpcolormanaged.c @@ -78,7 +78,7 @@ gimp_color_managed_default_init (GimpColorManagedInterface *iface) * @managed: an object the implements the #GimpColorManaged interface * @len: return location for the number of bytes in the profile data * - * Return value: A pointer to a blob of data that represents an ICC + * Returns: A pointer to a blob of data that represents an ICC * color profile. * * Since: 2.4 @@ -109,7 +109,7 @@ gimp_color_managed_get_icc_profile (GimpColorManaged *managed, * This function always returns a #GimpColorProfile and falls back to * gimp_color_profile_new_rgb_srgb() if the method is not implemented. * - * Return value: (transfer full): The @managed's #GimpColorProfile. + * Returns: (transfer full): The @managed's #GimpColorProfile. * * Since: 2.10 **/ diff --git a/libgimpcolor/gimpcolorprofile.c b/libgimpcolor/gimpcolorprofile.c index eccd160816..1c8f9a8d8d 100644 --- a/libgimpcolor/gimpcolorprofile.c +++ b/libgimpcolor/gimpcolorprofile.c @@ -167,7 +167,7 @@ gimp_color_profile_finalize (GObject *object) * * This function opens an ICC color profile from @file. * - * Return value: the #GimpColorProfile, or %NULL. On error, %NULL is + * Returns: the #GimpColorProfile, or %NULL. On error, %NULL is * returned and @error is set. * * Since: 2.10 @@ -272,7 +272,7 @@ gimp_color_profile_new_from_file (GFile *file, * This function opens an ICC color profile from memory. On error, * %NULL is returned and @error is set. * - * Return value: the #GimpColorProfile, or %NULL. + * Returns: the #GimpColorProfile, or %NULL. * * Since: 2.10 **/ @@ -317,7 +317,7 @@ gimp_color_profile_new_from_icc_profile (const guint8 *data, * @lcms_profile pointer is not retained by the created * #GimpColorProfile. * - * Return value: the #GimpColorProfile, or %NULL. + * Returns: the #GimpColorProfile, or %NULL. * * Since: 2.10 **/ @@ -371,7 +371,7 @@ gimp_color_profile_new_from_lcms_profile (gpointer lcms_profile, * * This function saves @profile to @file as ICC profile. * - * Return value: %TRUE on success, %FALSE if an error occurred. + * Returns: %TRUE on success, %FALSE if an error occurred. * * Since: 2.10 **/ @@ -402,7 +402,7 @@ gimp_color_profile_save_to_file (GimpColorProfile *profile, * This function returns @profile as ICC profile data. The returned * memory belongs to @profile and must not be modified or freed. * - * Return value: a pointer to the IIC profile data. + * Returns: a pointer to the IIC profile data. * * Since: 2.10 **/ @@ -425,7 +425,7 @@ gimp_color_profile_get_icc_profile (GimpColorProfile *profile, * This function returns @profile's cmsHPROFILE. The returned * value belongs to @profile and must not be modified or freed. * - * Return value: a pointer to the cmsHPROFILE. + * Returns: a pointer to the cmsHPROFILE. * * Since: 2.10 **/ @@ -465,7 +465,7 @@ gimp_color_profile_get_info (GimpColorProfile *profile, * gimp_color_profile_get_description: * @profile: a #GimpColorProfile * - * Return value: a string containing @profile's description. The + * Returns: a string containing @profile's description. The * returned value belongs to @profile and must not be * modified or freed. * @@ -487,7 +487,7 @@ gimp_color_profile_get_description (GimpColorProfile *profile) * gimp_color_profile_get_manufacturer: * @profile: a #GimpColorProfile * - * Return value: a string containing @profile's manufacturer. The + * Returns: a string containing @profile's manufacturer. The * returned value belongs to @profile and must not be * modified or freed. * @@ -509,7 +509,7 @@ gimp_color_profile_get_manufacturer (GimpColorProfile *profile) * gimp_color_profile_get_model: * @profile: a #GimpColorProfile * - * Return value: a string containing @profile's model. The returned + * Returns: a string containing @profile's model. The returned * value belongs to @profile and must not be modified or * freed. * @@ -531,7 +531,7 @@ gimp_color_profile_get_model (GimpColorProfile *profile) * gimp_color_profile_get_copyright: * @profile: a #GimpColorProfile * - * Return value: a string containing @profile's copyright. The + * Returns: a string containing @profile's copyright. The * returned value belongs to @profile and must not be * modified or freed. * @@ -559,7 +559,7 @@ gimp_color_profile_get_copyright (GimpColorProfile *profile) * Unlike gimp_color_profile_get_description(), this function always * returns a string (as a fallback, it returns "(unnamed profile)"). * - * Return value: the @profile's label. The returned value belongs to + * Returns: the @profile's label. The returned value belongs to * @profile and must not be modified or freed. * * Since: 2.10 @@ -592,7 +592,7 @@ gimp_color_profile_get_label (GimpColorProfile *profile) * used as detailed information about the profile in a user * interface. * - * Return value: the @profile's summary. The returned value belongs to + * Returns: the @profile's summary. The returned value belongs to * @profile and must not be modified or freed. * * Since: 2.10 @@ -651,7 +651,7 @@ gimp_color_profile_get_summary (GimpColorProfile *profile) * * Compares two profiles. * - * Return value: %TRUE if the profiles are equal, %FALSE otherwise. + * Returns: %TRUE if the profiles are equal, %FALSE otherwise. * * Since: 2.10 **/ @@ -675,7 +675,7 @@ gimp_color_profile_is_equal (GimpColorProfile *profile1, * gimp_color_profile_is_rgb: * @profile: a #GimpColorProfile * - * Return value: %TRUE if the profile's color space is RGB, %FALSE + * Returns: %TRUE if the profile's color space is RGB, %FALSE * otherwise. * * Since: 2.10 @@ -692,7 +692,7 @@ gimp_color_profile_is_rgb (GimpColorProfile *profile) * gimp_color_profile_is_gray: * @profile: a #GimpColorProfile * - * Return value: %TRUE if the profile's color space is grayscale, %FALSE + * Returns: %TRUE if the profile's color space is grayscale, %FALSE * otherwise. * * Since: 2.10 @@ -709,7 +709,7 @@ gimp_color_profile_is_gray (GimpColorProfile *profile) * gimp_color_profile_is_cmyk: * @profile: a #GimpColorProfile * - * Return value: %TRUE if the profile's color space is CMYK, %FALSE + * Returns: %TRUE if the profile's color space is CMYK, %FALSE * otherwise. * * Since: 2.10 @@ -731,7 +731,7 @@ gimp_color_profile_is_cmyk (GimpColorProfile *profile) * is a linear RGB profile or not, some profiles that are LUTs though linear * will also return FALSE; * - * Return value: %TRUE if the profile is a matrix shaping profile with linear + * Returns: %TRUE if the profile is a matrix shaping profile with linear * TRCs, %FALSE otherwise. * * Since: 2.10 @@ -1010,7 +1010,7 @@ gimp_color_profile_new_from_color_profile (GimpColorProfile *profile, * This function creates a new RGB #GimpColorProfile with a sRGB gamma * TRC and @profile's RGB chromacities and whitepoint. * - * Return value: (transfer full): the new #GimpColorProfile, or %NULL if + * Returns: (transfer full): the new #GimpColorProfile, or %NULL if * @profile is not an RGB profile or not matrix-based. * * Since: 2.10 @@ -1030,7 +1030,7 @@ gimp_color_profile_new_srgb_trc_from_color_profile (GimpColorProfile *profile) * This function creates a new RGB #GimpColorProfile with a linear TRC * and @profile's RGB chromacities and whitepoint. * - * Return value: (transfer full): the new #GimpColorProfile, or %NULL if + * Returns: (transfer full): the new #GimpColorProfile, or %NULL if * @profile is not an RGB profile or not matrix-based. * * Since: 2.10 @@ -1127,7 +1127,7 @@ gimp_color_profile_new_rgb_srgb_internal (void) * ArgyllCMS sRGB.icm profile. The resulting sRGB profile's colorants * exactly matches the ArgyllCMS sRGB.icm profile colorants. * - * Return value: the sRGB #GimpColorProfile. + * Returns: the sRGB #GimpColorProfile. * * Since: 2.10 **/ @@ -1202,7 +1202,7 @@ gimp_color_profile_new_rgb_srgb_linear_internal (void) * This function creates a profile for babl_model("RGB"). Please * somebody write something smarter here. * - * Return value: the linear RGB #GimpColorProfile. + * Returns: the linear RGB #GimpColorProfile. * * Since: 2.10 **/ @@ -1281,7 +1281,7 @@ gimp_color_profile_new_rgb_adobe_internal (void) * * This function creates a profile compatible with AbobeRGB (1998). * - * Return value: the AdobeRGB-compatible #GimpColorProfile. + * Returns: the AdobeRGB-compatible #GimpColorProfile. * * Since: 2.10 **/ @@ -1343,7 +1343,7 @@ gimp_color_profile_new_d65_gray_srgb_trc_internal (void) * This function creates a grayscale #GimpColorProfile with an * sRGB TRC. See gimp_color_profile_new_rgb_srgb(). * - * Return value: the sRGB-gamma grayscale #GimpColorProfile. + * Returns: the sRGB-gamma grayscale #GimpColorProfile. * * Since: 2.10 **/ @@ -1401,7 +1401,7 @@ gimp_color_profile_new_d65_gray_linear_internal (void) * This function creates a profile for babl_model("Y"). Please * somebody write something smarter here. * - * Return value: the linear grayscale #GimpColorProfile. + * Returns: the linear grayscale #GimpColorProfile. * * Since: 2.10 **/ @@ -1465,7 +1465,7 @@ gimp_color_profile_new_d50_gray_lab_trc_internal (void) * D50 ICC profile illuminant as the profile white point and the * LAB companding curve as the TRC. * - * Return value: a gray profile with the D50 ICC profile illuminant + * Returns: a gray profile with the D50 ICC profile illuminant * as the profile white point and the LAB companding curve as the TRC. * as the TRC. * @@ -1502,7 +1502,7 @@ gimp_color_profile_new_d50_gray_lab_trc (void) * This function returns the #Babl space of @profile, for the * specified @intent. * - * Return value: the new #Babl space. + * Returns: the new #Babl space. * * Since: 2.10.6 **/ @@ -1541,7 +1541,7 @@ gimp_color_profile_get_space (GimpColorProfile *profile, * returns a new #Babl format with @profile's RGB primaries and TRC, * and @format's pixel layout. * - * Return value: the new #Babl format. + * Returns: the new #Babl format. * * Since: 2.10 **/ @@ -1578,7 +1578,7 @@ gimp_color_profile_get_format (GimpColorProfile *profile, * Note that this function currently only supports RGB, RGBA, R'G'B', * R'G'B'A, Y, YA, Y', Y'A and the cairo-RGB24 and cairo-ARGB32 formats. * - * Return value: the #Babl format to be used instead of @format, or %NULL + * Returns: the #Babl format to be used instead of @format, or %NULL * if the passed @format is not supported at all. * * Since: 2.10 diff --git a/libgimpcolor/gimpcolortransform.c b/libgimpcolor/gimpcolortransform.c index ff9d7c26f5..f3817ea3cd 100644 --- a/libgimpcolor/gimpcolortransform.c +++ b/libgimpcolor/gimpcolortransform.c @@ -176,7 +176,7 @@ gimp_color_transform_finalize (GObject *object) * returns a non-%NULL transform and the code takes care of doing only * exactly the requested color transform. * - * Return value: the #GimpColorTransform, or %NULL if there was an error. + * Returns: the #GimpColorTransform, or %NULL if there was an error. * * Since: 2.10 **/ @@ -306,7 +306,7 @@ gimp_color_transform_new (GimpColorProfile *src_profile, * See gimp_color_transform_new() about the color spaces to transform * between. * - * Return value: the #GimpColorTransform, or %NULL if there was an error. + * Returns: the #GimpColorTransform, or %NULL if there was an error. * * Since: 2.10 **/ @@ -613,7 +613,7 @@ gimp_color_transform_process_buffer (GimpColorTransform *transform, * * This function checks if a GimpColorTransform is needed at all. * - * Return value: %TRUE if pixels can be correctly converted between + * Returns: %TRUE if pixels can be correctly converted between * @src_profile and @dest_profile by simply using * gegl_buffer_copy(), babl_process() or similar. * diff --git a/libgimpcolor/gimppixbuf.c b/libgimpcolor/gimppixbuf.c index 682c896055..a0738f8b47 100644 --- a/libgimpcolor/gimppixbuf.c +++ b/libgimpcolor/gimppixbuf.c @@ -43,7 +43,7 @@ * * Returns the Babl format that corresponds to the @pixbuf's pixel format. * - * Return value: the @pixbuf's pixel format + * Returns: the @pixbuf's pixel format * * Since: 2.10 **/ @@ -72,7 +72,7 @@ gimp_pixbuf_get_format (GdkPixbuf *pixbuf) * be kept around for as long as the buffer exists; otherwise the * pixels are copied. * - * Return value: (transfer full): a new #GeglBuffer. + * Returns: (transfer full): a new #GeglBuffer. * * Since: 2.10 **/ @@ -123,7 +123,7 @@ gimp_pixbuf_create_buffer (GdkPixbuf *pixbuf) * Returns the ICC profile attached to the @pixbuf, or %NULL if there * is none. * - * Return value: The ICC profile data, or %NULL. The value should be freed + * Returns: The ICC profile data, or %NULL. The value should be freed * with g_free(). * * Since: 2.10 diff --git a/libgimpcolor/gimprgb-parse.c b/libgimpcolor/gimprgb-parse.c index ba16432864..38807daab7 100644 --- a/libgimpcolor/gimprgb-parse.c +++ b/libgimpcolor/gimprgb-parse.c @@ -222,7 +222,7 @@ static const ColorEntry named_colors[] = * * This function does not touch the alpha component of @rgb. * - * Return value: %TRUE if @name was parsed successfully and @rgb has + * Returns: %TRUE if @name was parsed successfully and @rgb has * been set, %FALSE otherwise * * Since: 2.2 @@ -258,7 +258,7 @@ gimp_rgb_parse_name (GimpRGB *rgb, * * This function does not touch the alpha component of @rgb. * - * Return value: %TRUE if @hex was parsed successfully and @rgb has + * Returns: %TRUE if @hex was parsed successfully and @rgb has * been set, %FALSE otherwise * * Since: 2.2 @@ -298,7 +298,7 @@ gimp_rgb_parse_hex (GimpRGB *rgb, * * This function does not touch the alpha component of @rgb. * - * Return value: %TRUE if @css was parsed successfully and @rgb has been + * Returns: %TRUE if @css was parsed successfully and @rgb has been * set, %FALSE otherwise * * Since: 2.2 @@ -336,7 +336,7 @@ gimp_rgb_parse_css (GimpRGB *rgb, * It doesn't handle the hexadecimal notation or color names because * they leave the alpha channel unspecified. * - * Return value: %TRUE if @css was parsed successfully and @rgb has been + * Returns: %TRUE if @css was parsed successfully and @rgb has been * set, %FALSE otherwise * * Since: 2.2 @@ -386,7 +386,7 @@ gimp_rgba_parse_css (GimpRGB *rgba, * arrays are allocated dynamically. You must call g_free() on the * @names and @colors arrays when they are not any longer needed. * - * Return value: the number of named colors + * Returns: the number of named colors * (i.e. the length of the returned arrays) * * Since: 2.2 diff --git a/libgimpcolor/gimprgb.c b/libgimpcolor/gimprgb.c index 2545959dbd..83749078b3 100644 --- a/libgimpcolor/gimprgb.c +++ b/libgimpcolor/gimprgb.c @@ -319,7 +319,7 @@ gimp_rgb_gamma (GimpRGB *rgb, * gimp_rgb_luminance: * @rgb: a #GimpRGB struct * - * Return value: the luminous intensity of the range from 0.0 to 1.0. + * Returns: the luminous intensity of the range from 0.0 to 1.0. * * Since: 2.4 **/ @@ -339,7 +339,7 @@ gimp_rgb_luminance (const GimpRGB *rgb) * gimp_rgb_luminance_uchar: * @rgb: a #GimpRGB struct * - * Return value: the luminous intensity in the range from 0 to 255. + * Returns: the luminous intensity in the range from 0 to 255. * * Since: 2.4 **/ diff --git a/libgimpconfig/gimpcolorconfig.c b/libgimpconfig/gimpcolorconfig.c index 24139f0157..36d4dec991 100644 --- a/libgimpconfig/gimpcolorconfig.c +++ b/libgimpconfig/gimpcolorconfig.c @@ -631,7 +631,7 @@ gimp_color_config_get_out_of_gamut_color (GimpColorConfig *config, * @config: a #GimpColorConfig * @error: return location for a #GError * - * Return value: (transfer full): the default RGB color profile. + * Returns: (transfer full): the default RGB color profile. * * Since: 2.10 **/ @@ -675,7 +675,7 @@ gimp_color_config_get_rgb_color_profile (GimpColorConfig *config, * @config: a #GimpColorConfig * @error: return location for a #GError * - * Return value: (transfer full): the default grayscale color profile. + * Returns: (transfer full): the default grayscale color profile. * * Since: 2.10 **/ @@ -719,7 +719,7 @@ gimp_color_config_get_gray_color_profile (GimpColorConfig *config, * @config: a #GimpColorConfig * @error: return location for a #GError * - * Return value: (transfer full): the default CMYK color profile. + * Returns: (transfer full): the default CMYK color profile. * * Since: 2.10 **/ @@ -763,7 +763,7 @@ gimp_color_config_get_cmyk_color_profile (GimpColorConfig *config, * @config: a #GimpColorConfig * @error: return location for a #GError * - * Return value: (transfer full): the default display color profile. + * Returns: (transfer full): the default display color profile. * * Since: 2.10 **/ @@ -797,7 +797,7 @@ gimp_color_config_get_display_color_profile (GimpColorConfig *config, * @config: a #GimpColorConfig * @error: return location for a #GError * - * Return value: (transfer full): the default soft-proofing color + * Returns: (transfer full): the default soft-proofing color * profile. * * Since: 2.10 diff --git a/libgimpconfig/gimpconfig-deserialize.c b/libgimpconfig/gimpconfig-deserialize.c index 5d7707c779..e6d3abd139 100644 --- a/libgimpconfig/gimpconfig-deserialize.c +++ b/libgimpconfig/gimpconfig-deserialize.c @@ -124,7 +124,7 @@ scanner_string_utf8_valid (GScanner *scanner, * * This function uses the @scanner to configure the properties of @config. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.4 **/ @@ -229,7 +229,7 @@ gimp_config_deserialize_properties (GimpConfig *config, * shouldn't need to call this function directly. If possible, use * gimp_config_deserialize_properties() instead. * - * Return value: %G_TOKEN_RIGHT_PAREN on success, otherwise the + * Returns: %G_TOKEN_RIGHT_PAREN on success, otherwise the * expected #GTokenType or %G_TOKEN_NONE if the expected token was * found but couldn't be parsed. * diff --git a/libgimpconfig/gimpconfig-error.c b/libgimpconfig/gimpconfig-error.c index ed57cb0184..75b36359c9 100644 --- a/libgimpconfig/gimpconfig-error.c +++ b/libgimpconfig/gimpconfig-error.c @@ -40,7 +40,7 @@ * * This function is never called directly. Use GIMP_CONFIG_ERROR() instead. * - * Return value: the #GQuark that defines the GimpConfig error domain. + * Returns: the #GQuark that defines the GimpConfig error domain. * * Since: 2.4 **/ diff --git a/libgimpconfig/gimpconfig-iface.c b/libgimpconfig/gimpconfig-iface.c index 409f4faebd..559356d1a6 100644 --- a/libgimpconfig/gimpconfig-iface.c +++ b/libgimpconfig/gimpconfig-iface.c @@ -288,7 +288,7 @@ gimp_config_iface_copy (GimpConfig *src, * overwritten. Basically this function opens @filename for you and * calls the serialize function of the @config's #GimpConfigInterface. * - * Return value: %TRUE if serialization succeeded, %FALSE otherwise. + * Returns: %TRUE if serialization succeeded, %FALSE otherwise. * * Since: 2.4 **/ @@ -329,7 +329,7 @@ gimp_config_serialize_to_file (GimpConfig *config, * overwritten. Basically this function opens @file for you and calls * the serialize function of the @config's #GimpConfigInterface. * - * Return value: %TRUE if serialization succeeded, %FALSE otherwise. + * Returns: %TRUE if serialization succeeded, %FALSE otherwise. * * Since: 2.10 **/ @@ -368,7 +368,7 @@ gimp_config_serialize_to_gfile (GimpConfig *config, * Serializes the object properties of @config to the stream specified * by @output. * - * Return value: %TRUE if serialization succeeded, %FALSE otherwise. + * Returns: %TRUE if serialization succeeded, %FALSE otherwise. * * Since: 2.10 **/ @@ -404,7 +404,7 @@ gimp_config_serialize_to_stream (GimpConfig *config, * Serializes the object properties of @config to the given file * descriptor. * - * Return value: %TRUE if serialization succeeded, %FALSE otherwise. + * Returns: %TRUE if serialization succeeded, %FALSE otherwise. * * Since: 2.4 **/ @@ -434,7 +434,7 @@ gimp_config_serialize_to_fd (GimpConfig *config, * * Serializes the object properties of @config to a string. * - * Return value: a newly allocated NUL-terminated string. + * Returns: a newly allocated NUL-terminated string. * * Since: 2.4 **/ @@ -469,7 +469,7 @@ gimp_config_serialize_to_string (GimpConfig *config, * creates a properly configured #GScanner for you and calls the * deserialize function of the @config's #GimpConfigInterface. * - * Return value: %TRUE if deserialization succeeded, %FALSE otherwise. + * Returns: %TRUE if deserialization succeeded, %FALSE otherwise. * * Since: 2.4 **/ @@ -517,7 +517,7 @@ gimp_config_deserialize_file (GimpConfig *config, * a properly configured #GScanner for you and calls the deserialize * function of the @config's #GimpConfigInterface. * - * Return value: %TRUE if deserialization succeeded, %FALSE otherwise. + * Returns: %TRUE if deserialization succeeded, %FALSE otherwise. * * Since: 2.10 **/ @@ -565,7 +565,7 @@ gimp_config_deserialize_gfile (GimpConfig *config, * #GScanner for you and calls the deserialize function of the * @config's #GimpConfigInterface. * - * Return value: %TRUE if deserialization succeeded, %FALSE otherwise. + * Returns: %TRUE if deserialization succeeded, %FALSE otherwise. * * Since: 2.10 **/ @@ -755,7 +755,7 @@ gimp_config_deserialize (GimpConfig *config, * only works for objects that are completely defined by their * properties. * - * Return value: the duplicated #GimpConfig object + * Returns: the duplicated #GimpConfig object * * Since: 2.4 **/ @@ -777,7 +777,7 @@ gimp_config_duplicate (GimpConfig *config) * works for objects that are completely defined by their * properties. * - * Return value: %TRUE if the two objects are equal. + * Returns: %TRUE if the two objects are equal. * * Since: 2.4 **/ @@ -827,7 +827,7 @@ gimp_config_reset (GimpConfig *config) * * Properties marked as "construct-only" are not touched. * - * Return value: %TRUE if @dest was modified, %FALSE otherwise + * Returns: %TRUE if @dest was modified, %FALSE otherwise * * Since: 2.6 **/ diff --git a/libgimpconfig/gimpconfig-path.c b/libgimpconfig/gimpconfig-path.c index f7f7e32125..0e83fa3d2b 100644 --- a/libgimpconfig/gimpconfig-path.c +++ b/libgimpconfig/gimpconfig-path.c @@ -305,7 +305,7 @@ gimp_config_build_system_path (const gchar *name) * * To reverse the expansion, use gimp_config_path_unexpand(). * - * Return value: a newly allocated NUL-terminated string + * Returns: a newly allocated NUL-terminated string * * Since: 2.4 **/ @@ -350,7 +350,7 @@ gimp_config_path_expand (const gchar *path, * gimp_path_parse(), then turns the filenames returned by * gimp_path_parse() into GFile using g_file_new_for_path(). * - * Return value: (element-type GFile) (transfer full): + * Returns: (element-type GFile) (transfer full): a #GList of newly allocated #GFile objects. * * Since: 2.10 @@ -402,7 +402,7 @@ gimp_config_path_expand_to_files (const gchar *path, * If @recode is %TRUE then @path is in local filesystem encoding, * if @recode is %FALSE then @path is assumed to be UTF-8. * - * Return value: a newly allocated NUL-terminated UTF-8 string + * Returns: a newly allocated NUL-terminated UTF-8 string * * Since: 2.10 **/ @@ -442,7 +442,7 @@ gimp_config_path_unexpand (const gchar *path, * * To reverse the expansion, use gimp_file_get_config_path(). * - * Return value: (transfer full): a newly allocated #GFile, or %NULL if the expansion failed. + * Returns: (transfer full): a newly allocated #GFile, or %NULL if the expansion failed. * * Since: 2.10 **/ @@ -477,7 +477,7 @@ gimp_file_new_for_config_path (const gchar *path, * * The inverse operation of gimp_file_new_for_config_path(). * - * Return value: a newly allocated NUL-terminated UTF-8 string, or %NULL if + * Returns: a newly allocated NUL-terminated UTF-8 string, or %NULL if * unexpanding failed. * * Since: 2.10 diff --git a/libgimpconfig/gimpconfig-serialize.c b/libgimpconfig/gimpconfig-serialize.c index 0df5bbcd02..288723ce5e 100644 --- a/libgimpconfig/gimpconfig-serialize.c +++ b/libgimpconfig/gimpconfig-serialize.c @@ -356,7 +356,7 @@ gimp_config_serialize_property_by_name (GimpConfig *config, * * This utility function appends a string representation of #GValue to @str. * - * Return value: %TRUE if serialization succeeded, %FALSE otherwise. + * Returns: %TRUE if serialization succeeded, %FALSE otherwise. * * Since: 2.4 **/ diff --git a/libgimpconfig/gimpconfig-utils.c b/libgimpconfig/gimpconfig-utils.c index 4ccd677f5a..7461e784b2 100644 --- a/libgimpconfig/gimpconfig-utils.c +++ b/libgimpconfig/gimpconfig-utils.c @@ -158,7 +158,7 @@ gimp_config_diff_other (GObject *a, * exist in both object classes and are of the same value_type are * compared. * - * Return value: (transfer container) (element-type GParamSpec): a GList of differing GParamSpecs. + * Returns: (transfer container) (element-type GParamSpec): a GList of differing GParamSpecs. * * Since: 2.4 **/ @@ -196,7 +196,7 @@ gimp_config_diff (GObject *a, * exist in both object classes and are of the same value_type are * synchronized * - * Return value: %TRUE if @dest was modified, %FALSE otherwise + * Returns: %TRUE if @dest was modified, %FALSE otherwise * * Since: 2.4 **/ diff --git a/libgimpconfig/gimpconfigwriter.c b/libgimpconfig/gimpconfigwriter.c index bac83f3667..f33096752f 100644 --- a/libgimpconfig/gimpconfigwriter.c +++ b/libgimpconfig/gimpconfigwriter.c @@ -121,7 +121,7 @@ gimp_config_writer_newline (GimpConfigWriter *writer) * possible race conditions. The temporary file is then moved to * @filename when the writer is closed. * - * Return value: a new #GimpConfigWriter or %NULL in case of an error + * Returns: a new #GimpConfigWriter or %NULL in case of an error * * Since: 2.4 **/ @@ -158,7 +158,7 @@ gimp_config_writer_new_file (const gchar *filename, * possible race conditions. The temporary file is then moved to @file * when the writer is closed. * - * Return value: a new #GimpConfigWriter or %NULL in case of an error + * Returns: a new #GimpConfigWriter or %NULL in case of an error * * Since: 2.10 **/ @@ -234,7 +234,7 @@ gimp_config_writer_new_gfile (GFile *file, * Creates a new #GimpConfigWriter and sets it up to write to * @output. * - * Return value: a new #GimpConfigWriter or %NULL in case of an error + * Returns: a new #GimpConfigWriter or %NULL in case of an error * * Since: 2.10 **/ @@ -266,7 +266,7 @@ gimp_config_writer_new_stream (GOutputStream *output, * gimp_config_writer_new_fd: * @fd: * - * Return value: a new #GimpConfigWriter or %NULL in case of an error + * Returns: a new #GimpConfigWriter or %NULL in case of an error * * Since: 2.4 **/ @@ -294,7 +294,7 @@ gimp_config_writer_new_fd (gint fd) * gimp_config_writer_new_string: * @string: * - * Return value: a new #GimpConfigWriter or %NULL in case of an error + * Returns: a new #GimpConfigWriter or %NULL in case of an error * * Since: 2.4 **/ @@ -598,7 +598,7 @@ gimp_config_writer_close (GimpConfigWriter *writer) * releases all resources allocated by @writer. You must not access * the @writer afterwards. * - * Return value: %TRUE if everything could be successfully written, + * Returns: %TRUE if everything could be successfully written, * %FALSE otherwise * * Since: 2.4 diff --git a/libgimpconfig/gimpscanner.c b/libgimpconfig/gimpscanner.c index 36f05847cd..937a6e2032 100644 --- a/libgimpconfig/gimpscanner.c +++ b/libgimpconfig/gimpscanner.c @@ -75,7 +75,7 @@ static void gimp_scanner_message (GScanner *scanner, * @filename: * @error: * - * Return value: + * Returns: * * Since: 2.4 **/ @@ -101,7 +101,7 @@ gimp_scanner_new_file (const gchar *filename, * @file: a #GFile * @error: return location for #GError, or %NULL * - * Return value: The new #GScanner. + * Returns: The new #GScanner. * * Since: 2.10 **/ @@ -179,7 +179,7 @@ gimp_scanner_new_gfile (GFile *file, * @input: a #GInputStream * @error: return location for #GError, or %NULL * - * Return value: The new #GScanner. + * Returns: The new #GScanner. * * Since: 2.10 **/ @@ -252,7 +252,7 @@ gimp_scanner_new_stream (GInputStream *input, * @text_len: * @error: * - * Return value: + * Returns: * * Since: 2.4 **/ @@ -341,7 +341,7 @@ gimp_scanner_destroy (GScanner *scanner) * gimp_scanner_new_string() * @token: the #GTokenType expected as next token. * - * Return value: %TRUE if the next token is @token, %FALSE otherwise. + * Returns: %TRUE if the next token is @token, %FALSE otherwise. * * Since: 2.4 **/ @@ -363,7 +363,7 @@ gimp_scanner_parse_token (GScanner *scanner, * gimp_scanner_new_string() * @identifier: the expected identifier. * - * Return value: %TRUE if the next token is an identifier and if its + * Returns: %TRUE if the next token is an identifier and if its * value matches @identifier. * * Since: 2.4 @@ -389,7 +389,7 @@ gimp_scanner_parse_identifier (GScanner *scanner, * gimp_scanner_new_string() * @dest: Return location for the parsed string * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -426,7 +426,7 @@ gimp_scanner_parse_string (GScanner *scanner, * gimp_scanner_new_string() * @dest: Return location for the parsed string * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -454,7 +454,7 @@ gimp_scanner_parse_string_no_validate (GScanner *scanner, * @length: Length of the data to parse * @dest: Return location for the parsed data * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -482,7 +482,7 @@ gimp_scanner_parse_data (GScanner *scanner, * gimp_scanner_new_string() * @dest: Return location for the parsed integer * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -517,7 +517,7 @@ gimp_scanner_parse_int (GScanner *scanner, * gimp_scanner_new_string() * @dest: Return location for the parsed integer * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.8 **/ @@ -552,7 +552,7 @@ gimp_scanner_parse_int64 (GScanner *scanner, * gimp_scanner_new_string() * @dest: Return location for the parsed float * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -600,7 +600,7 @@ gimp_scanner_parse_float (GScanner *scanner, * gimp_scanner_new_string() * @dest: Return location for the parsed boolean * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -651,7 +651,7 @@ enum * gimp_scanner_new_string() * @dest: (out caller-allocates): Pointer to a color to store the result * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ @@ -771,7 +771,7 @@ gimp_scanner_parse_color (GScanner *scanner, * gimp_scanner_new_string() * @dest: Pointer to a matrix to store the result * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.4 **/ diff --git a/libgimpmodule/gimpmodule.c b/libgimpmodule/gimpmodule.c index c47da81d1f..3bd8f67834 100644 --- a/libgimpmodule/gimpmodule.c +++ b/libgimpmodule/gimpmodule.c @@ -204,7 +204,7 @@ gimp_module_unload (GTypeModule *module) * * Creates a new #GimpModule instance. * - * Return value: The new #GimpModule object. + * Returns: The new #GimpModule object. **/ GimpModule * gimp_module_new (const gchar *filename, @@ -247,7 +247,7 @@ gimp_module_new (const gchar *filename, * may implement. After successful query, the @info field of the * #GimpModule struct will be available for further inspection. * - * Return value: %TRUE on success. + * Returns: %TRUE on success. **/ gboolean gimp_module_query_module (GimpModule *module) @@ -360,7 +360,7 @@ gimp_module_set_load_inhibit (GimpModule *module, * Returns the translated textual representation of a #GimpModuleState. * The returned string must not be freed. * - * Return value: The @state's name. + * Returns: The @state's name. **/ const gchar * gimp_module_state_name (GimpModuleState state) @@ -384,7 +384,7 @@ gimp_module_state_name (GimpModuleState state) * * This function is never called directly. Use GIMP_MODULE_ERROR() instead. * - * Return value: the #GQuark that defines the GIMP module error domain. + * Returns: the #GQuark that defines the GIMP module error domain. * * Since: 2.8 **/ @@ -454,7 +454,7 @@ gimp_module_set_last_error (GimpModule *module, * * Creates a newly allocated #GimpModuleInfo struct. * - * Return value: The new #GimpModuleInfo struct. + * Returns: The new #GimpModuleInfo struct. **/ GimpModuleInfo * gimp_module_info_new (guint32 abi_version, @@ -482,7 +482,7 @@ gimp_module_info_new (guint32 abi_version, * * Copies a #GimpModuleInfo struct. * - * Return value: The new copy. + * Returns: The new copy. **/ GimpModuleInfo * gimp_module_info_copy (const GimpModuleInfo *info) diff --git a/libgimpmodule/gimpmoduledb.c b/libgimpmodule/gimpmoduledb.c index 30020e587d..00539a5baf 100644 --- a/libgimpmodule/gimpmoduledb.c +++ b/libgimpmodule/gimpmoduledb.c @@ -174,7 +174,7 @@ gimp_module_db_finalize (GObject *object) * Creates a new #GimpModuleDB instance. The @verbose parameter will be * passed to the created #GimpModule instances using gimp_module_new(). * - * Return value: The new #GimpModuleDB instance. + * Returns: The new #GimpModuleDB instance. **/ GimpModuleDB * gimp_module_db_new (gboolean verbose) @@ -195,7 +195,7 @@ gimp_module_db_new (gboolean verbose) * Returns a #GList of the modules kept by @db. The list must not be * modified or freed. * - * Return value: (element-type GimpModule) (transfer none): a #GList + * Returns: (element-type GimpModule) (transfer none): a #GList * of #GimpModule instances. * * Since: 3.0 @@ -232,7 +232,7 @@ gimp_module_db_set_verbose (GimpModuleDB *db, * * Returns the 'verbose' setting of @db. * - * Return value: the 'verbose' setting. + * Returns: the 'verbose' setting. * * Since: 3.0 **/ @@ -322,7 +322,7 @@ gimp_module_db_set_load_inhibit (GimpModuleDB *db, * Return the #G_SEARCHPATH_SEPARATOR delimited list of module filenames * which are excluded from auto-loading. * - * Return value: the @db's @load_inhibit string. + * Returns: the @db's @load_inhibit string. **/ const gchar * gimp_module_db_get_load_inhibit (GimpModuleDB *db) diff --git a/libgimpthumb/gimpthumb-error.c b/libgimpthumb/gimpthumb-error.c index f4ab620221..0dd72c0a2e 100644 --- a/libgimpthumb/gimpthumb-error.c +++ b/libgimpthumb/gimpthumb-error.c @@ -43,7 +43,7 @@ * * This function is never called directly. Use GIMP_THUMB_ERROR() instead. * - * Return value: the #GQuark that defines the GimpThumb error domain. + * Returns: the #GQuark that defines the GimpThumb error domain. **/ GQuark gimp_thumb_error_quark (void) diff --git a/libgimpthumb/gimpthumb-utils.c b/libgimpthumb/gimpthumb-utils.c index 59dd83060d..833d684bf1 100644 --- a/libgimpthumb/gimpthumb-utils.c +++ b/libgimpthumb/gimpthumb-utils.c @@ -95,7 +95,7 @@ static gchar *thumb_fail_subdir = NULL; * application-specific thumbnails, you can specify a different base * directory here. * - * Return value: %TRUE if the library was successfully initialized. + * Returns: %TRUE if the library was successfully initialized. **/ gboolean gimp_thumb_init (const gchar *creator, @@ -216,7 +216,7 @@ gimp_thumb_get_thumb_base_dir (void) * returned pointer will become invalid if gimp_thumb_init() is used * again. It must not be changed or freed. * - * Return value: the thumbnail directory in the encoding of the filesystem + * Returns: the thumbnail directory in the encoding of the filesystem **/ const gchar * gimp_thumb_get_thumb_dir (GimpThumbSize size) @@ -237,7 +237,7 @@ gimp_thumb_get_thumb_dir (GimpThumbSize size) * size. Unlike gimp_thumb_get_thumb_dir() the returned string is not * constant and should be free'd when it is not any longer needed. * - * Return value: the thumbnail directory in the encoding of the filesystem + * Returns: the thumbnail directory in the encoding of the filesystem * * Since: 2.2 **/ @@ -267,7 +267,7 @@ gimp_thumb_get_thumb_dir_local (const gchar *dirname, * gimp_thumbnail_save_thumb() and gimp_thumbnail_save_failure() will * do this for you. * - * Return value: %TRUE is the directory exists, %FALSE if it could not + * Returns: %TRUE is the directory exists, %FALSE if it could not * be created **/ gboolean @@ -315,7 +315,7 @@ gimp_thumb_ensure_thumb_dir (GimpThumbSize size, * You shouldn't have to call this function directly since * gimp_thumbnail_save_thumb_local() will do this for you. * - * Return value: %TRUE is the directory exists, %FALSE if it could not + * Returns: %TRUE is the directory exists, %FALSE if it could not * be created * * Since: 2.2 @@ -379,7 +379,7 @@ gimp_thumb_ensure_thumb_dir_local (const gchar *dirname, * Creates the name of the thumbnail file of the specified @size that * belongs to an image file located at the given @uri. * - * Return value: a newly allocated filename in the encoding of the + * Returns: a newly allocated filename in the encoding of the * filesystem or %NULL if @uri points to the user's * thumbnail repository. **/ @@ -409,7 +409,7 @@ gimp_thumb_name_from_uri (const gchar *uri, * that belongs to an image file located at the given @uri. Local * thumbnails have been introduced with version 0.7 of the spec. * - * Return value: a newly allocated filename in the encoding of the + * Returns: a newly allocated filename in the encoding of the * filesystem or %NULL if @uri is a remote file or * points to the user's thumbnail repository. * @@ -472,7 +472,7 @@ gimp_thumb_name_from_uri_local (const gchar *uri, * If a thumbnail is found, it's size is written to the variable * pointer to by @size and the file location is returned. * - * Return value: a newly allocated string in the encoding of the + * Returns: a newly allocated string in the encoding of the * filesystem or %NULL if no thumbnail for @uri was found **/ gchar * @@ -524,7 +524,7 @@ gimp_thumb_find_thumb (const gchar *uri, * checks if the given @filename exists and returns modification time * and file size in 64bit integer values. * - * Return value: The type of the file, or #GIMP_THUMB_FILE_TYPE_NONE if + * Returns: The type of the file, or #GIMP_THUMB_FILE_TYPE_NONE if * the file doesn't exist. **/ GimpThumbFileType diff --git a/libgimpthumb/gimpthumbnail.c b/libgimpthumb/gimpthumbnail.c index 99124eb82c..26698aaaa7 100644 --- a/libgimpthumb/gimpthumbnail.c +++ b/libgimpthumb/gimpthumbnail.c @@ -355,7 +355,7 @@ gimp_thumbnail_get_property (GObject *object, * * Creates a new #GimpThumbnail object. * - * Return value: a newly allocated GimpThumbnail object + * Returns: a newly allocated GimpThumbnail object **/ GimpThumbnail * gimp_thumbnail_new (void) @@ -413,7 +413,7 @@ gimp_thumbnail_set_uri (GimpThumbnail *thumbnail, * * Sets the location of the image file associated with the #thumbnail. * - * Return value: %TRUE if the filename was successfully set, + * Returns: %TRUE if the filename was successfully set, * %FALSE otherwise **/ gboolean @@ -452,7 +452,7 @@ gimp_thumbnail_set_filename (GimpThumbnail *thumbnail, * This will only work with thumbnails from the global thumbnail * directory that contain a valid Thumb::URI tag. * - * Return value: %TRUE if the pixbuf could be loaded, %FALSE otherwise + * Returns: %TRUE if the pixbuf could be loaded, %FALSE otherwise **/ gboolean gimp_thumbnail_set_from_thumb (GimpThumbnail *thumbnail, @@ -494,7 +494,7 @@ gimp_thumbnail_set_from_thumb (GimpThumbnail *thumbnail, * Checks the image file associated with the @thumbnail and updates * information such as state, filesize and modification time. * - * Return value: the image's #GimpThumbState after the update + * Returns: the image's #GimpThumbState after the update **/ GimpThumbState gimp_thumbnail_peek_image (GimpThumbnail *thumbnail) @@ -527,7 +527,7 @@ gimp_thumbnail_peek_image (GimpThumbnail *thumbnail) * gimp_thumbnail_load_thumb(), or, if you don't need the resulting * thumbnail pixbuf, use gimp_thumbnail_check_thumb(). * - * Return value: the thumbnail's #GimpThumbState after the update + * Returns: the thumbnail's #GimpThumbState after the update **/ GimpThumbState gimp_thumbnail_peek_thumb (GimpThumbnail *thumbnail, @@ -557,7 +557,7 @@ gimp_thumbnail_peek_thumb (GimpThumbnail *thumbnail, * verifies it is valid and uptodate for the image file asosciated * with the @thumbnail. * - * Return value: the thumbnail's #GimpThumbState after the update + * Returns: the thumbnail's #GimpThumbState after the update * * Since: 2.2 **/ @@ -969,7 +969,7 @@ gimp_thumbnail_debug_notify (GObject *object, * In order to verify if the preview is uptodate, you should check the * "thumb_state" property after calling this function. * - * Return value: (transfer full): a preview pixbuf or %NULL if no + * Returns: (transfer full): a preview pixbuf or %NULL if no * thumbnail was found **/ GdkPixbuf * @@ -1081,7 +1081,7 @@ gimp_thumbnail_load_thumb (GimpThumbnail *thumbnail, * The image format type and the number of layers can optionally be * set in order to be stored with the preview image. * - * Return value: %TRUE if a thumbnail was successfully written, + * Returns: %TRUE if a thumbnail was successfully written, * %FALSE otherwise **/ gboolean @@ -1138,7 +1138,7 @@ gimp_thumbnail_save_thumb (GimpThumbnail *thumbnail, * Please see also gimp_thumbnail_save_thumb(). The notes made there * apply here as well. * - * Return value: %TRUE if a thumbnail was successfully written, + * Returns: %TRUE if a thumbnail was successfully written, * %FALSE otherwise * * Since: 2.2 @@ -1209,7 +1209,7 @@ gimp_thumbnail_save_thumb_local (GimpThumbnail *thumbnail, * to create a preview for the image file failed. It should be used to * prevent the software from further attempts to create this thumbnail. * - * Return value: %TRUE if a failure thumbnail was successfully written, + * Returns: %TRUE if a failure thumbnail was successfully written, * %FALSE otherwise **/ gboolean @@ -1341,7 +1341,7 @@ gimp_thumbnail_delete_others (GimpThumbnail *thumbnail, * The application should not attempt to create the thumbnail if a * valid failure thumbnail exists. * - * Return value: %TRUE if a failure thumbnail exists or + * Returns: %TRUE if a failure thumbnail exists or * * Since: 2.2 **/ diff --git a/libgimpwidgets/gimpbrowser.c b/libgimpwidgets/gimpbrowser.c index b5de24d5cd..e37320365c 100644 --- a/libgimpwidgets/gimpbrowser.c +++ b/libgimpwidgets/gimpbrowser.c @@ -218,7 +218,7 @@ gimp_browser_dispose (GObject *object) * * Create a new #GimpBrowser widget. * - * Return Value: a newly created #GimpBrowser. + * Returns: a newly created #GimpBrowser. * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpcairo-utils.c b/libgimpwidgets/gimpcairo-utils.c index a956f28d11..0ed72ea13f 100644 --- a/libgimpwidgets/gimpcairo-utils.c +++ b/libgimpwidgets/gimpcairo-utils.c @@ -50,7 +50,7 @@ * Sets color and dash pattern for stroking a focus line on the given * @cr. The line pattern is taken from @widget. * - * Return value: %TRUE if the widget style has a focus line pattern, + * Returns: %TRUE if the widget style has a focus line pattern, * %FALSE otherwise * * Since: 2.6 diff --git a/libgimpwidgets/gimpcellrenderercolor.c b/libgimpwidgets/gimpcellrenderercolor.c index b644779394..b98e9f74af 100644 --- a/libgimpwidgets/gimpcellrenderercolor.c +++ b/libgimpwidgets/gimpcellrenderercolor.c @@ -321,7 +321,7 @@ gimp_cell_renderer_color_render (GtkCellRenderer *cell, * * Creates a #GtkCellRenderer that displays a color. * - * Return value: a new #GimpCellRendererColor + * Returns: a new #GimpCellRendererColor * * Since: 2.2 **/ diff --git a/libgimpwidgets/gimpcellrenderertoggle.c b/libgimpwidgets/gimpcellrenderertoggle.c index 9e288329b3..083f56201a 100644 --- a/libgimpwidgets/gimpcellrenderertoggle.c +++ b/libgimpwidgets/gimpcellrenderertoggle.c @@ -533,7 +533,7 @@ gimp_cell_renderer_toggle_create_pixbuf (GimpCellRendererToggle *toggle, * example used in the Layers treeview to indicate and control the * layer's visibility by showing %GIMP_STOCK_VISIBLE. * - * Return value: a new #GimpCellRendererToggle + * Returns: a new #GimpCellRendererToggle * * Since: 2.2 **/ diff --git a/libgimpwidgets/gimpcolorbutton.c b/libgimpwidgets/gimpcolorbutton.c index 8e03853d85..97f620021a 100644 --- a/libgimpwidgets/gimpcolorbutton.c +++ b/libgimpwidgets/gimpcolorbutton.c @@ -793,7 +793,7 @@ gimp_color_button_set_type (GimpColorButton *button, * * Returns the color button's @continuous_update property. * - * Return value: the @continuous_update property. + * Returns: the @continuous_update property. **/ gboolean gimp_color_button_get_update (GimpColorButton *button) diff --git a/libgimpwidgets/gimpcolordisplay.c b/libgimpwidgets/gimpcolordisplay.c index 7a0e981e9d..8f5e385e98 100644 --- a/libgimpwidgets/gimpcolordisplay.c +++ b/libgimpwidgets/gimpcolordisplay.c @@ -457,7 +457,7 @@ gimp_color_display_get_enabled (GimpColorDisplay *display) * gimp_color_display_get_config: * @display: * - * Return value: (transfer none): a pointer to the #GimpColorConfig + * Returns: (transfer none): a pointer to the #GimpColorConfig * object or %NULL. * * Since: 2.4 @@ -474,7 +474,7 @@ gimp_color_display_get_config (GimpColorDisplay *display) * gimp_color_display_get_managed: * @display: * - * Return value: (transfer none): a pointer to the #GimpColorManaged + * Returns: (transfer none): a pointer to the #GimpColorManaged * object or %NULL. * * Since: 2.4 diff --git a/libgimpwidgets/gimpcolorhexentry.c b/libgimpwidgets/gimpcolorhexentry.c index bd8f3ab965..ba6a560c2e 100644 --- a/libgimpwidgets/gimpcolorhexentry.c +++ b/libgimpwidgets/gimpcolorhexentry.c @@ -195,7 +195,7 @@ gimp_color_hex_entry_constructed (GObject *object) /** * gimp_color_hex_entry_new: * - * Return value: a new #GimpColorHexEntry widget + * Returns: a new #GimpColorHexEntry widget * * Since: 2.2 **/ diff --git a/libgimpwidgets/gimpcolornotebook.c b/libgimpwidgets/gimpcolornotebook.c index 4e8afefe9a..7eb6addc57 100644 --- a/libgimpwidgets/gimpcolornotebook.c +++ b/libgimpwidgets/gimpcolornotebook.c @@ -510,7 +510,7 @@ gimp_color_notebook_remove_selector (GtkContainer *container, * This function adds and removed pages to / from a #GimpColorNotebook. * The @page_type passed must be a #GimpColorSelector subtype. * - * Return value: (transfer none): The new page widget, if @has_page was + * Returns: (transfer none): The new page widget, if @has_page was * %TRUE, or %NULL if @has_page was %FALSE. **/ GtkWidget * @@ -552,7 +552,7 @@ gimp_color_notebook_set_has_page (GimpColorNotebook *notebook, * gimp_color_notebook_get_notebook: * @notebook: A #GimpColorNotebook widget. * - * Return value: (transfer none): The #GtkNotebook inside. + * Returns: (transfer none): The #GtkNotebook inside. * * Since: 3.0 **/ @@ -568,7 +568,7 @@ gimp_color_notebook_get_notebook (GimpColorNotebook *notebook) * gimp_color_notebook_get_selectors: * @notebook: A #GimpColorNotebook widget. * - * Return value: (element-type GimpColorSelector) (transfer none): The + * Returns: (element-type GimpColorSelector) (transfer none): The * notebook's list of #GimpColorSelector's. * * Since: 3.0 @@ -585,7 +585,7 @@ gimp_color_notebook_get_selectors (GimpColorNotebook *notebook) * gimp_color_notebook_get_current_selector: * @notebook: A #GimpColorNotebook widget. * - * Return value: (transfer none): The active page's #GimpColorSelector. + * Returns: (transfer none): The active page's #GimpColorSelector. * * Since: 3.0 **/ diff --git a/libgimpwidgets/gimpcolorprofilecombobox.c b/libgimpwidgets/gimpcolorprofilecombobox.c index c21afc6430..1459ddf18c 100644 --- a/libgimpwidgets/gimpcolorprofilecombobox.c +++ b/libgimpwidgets/gimpcolorprofilecombobox.c @@ -308,7 +308,7 @@ gimp_color_profile_combo_box_changed (GtkComboBox *combo) * * See also gimp_color_profile_combo_box_new_with_model(). * - * Return value: a new #GimpColorProfileComboBox. + * Returns: a new #GimpColorProfileComboBox. * * Since: 2.4 **/ @@ -342,7 +342,7 @@ gimp_color_profile_combo_box_new (GtkWidget *dialog, * * See also gimp_color_profile_combo_box_new(). * - * Return value: a new #GimpColorProfileComboBox. + * Returns: a new #GimpColorProfileComboBox. * * Since: 2.4 **/ @@ -446,7 +446,7 @@ gimp_color_profile_combo_box_set_active_file (GimpColorProfileComboBox *combo, * gimp_color_profile_combo_box_get_active_file: * @combo: a #GimpColorProfileComboBox * - * Return value: (transfer none): The file of the currently selected + * Returns: (transfer none): The file of the currently selected * color profile, release using g_object_unref() when it * is not any longer needed. * diff --git a/libgimpwidgets/gimpcolorprofilestore.c b/libgimpwidgets/gimpcolorprofilestore.c index af33b21d38..498b42f9e6 100644 --- a/libgimpwidgets/gimpcolorprofilestore.c +++ b/libgimpwidgets/gimpcolorprofilestore.c @@ -240,7 +240,7 @@ gimp_color_profile_store_get_property (GObject *object, * gchar *history = gimp_personal_rc_file ("profilerc"); * * - * Return value: a new #GimpColorProfileStore + * Returns: a new #GimpColorProfileStore * * Since: 2.4 **/ @@ -303,7 +303,7 @@ gimp_color_profile_store_add_file (GimpColorProfileStore *store, * @label: label to use for the profile (or %NULL) * @iter: a #GtkTreeIter * - * Return value: %TRUE if the iter is valid and pointing to the item + * Returns: %TRUE if the iter is valid and pointing to the item * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpcolorscale.c b/libgimpwidgets/gimpcolorscale.c index 7bcd09e54b..017508cdeb 100644 --- a/libgimpwidgets/gimpcolorscale.c +++ b/libgimpwidgets/gimpcolorscale.c @@ -500,7 +500,7 @@ gimp_color_scale_draw (GtkWidget *widget, * * Creates a new #GimpColorScale widget. * - * Return value: a new #GimpColorScale widget + * Returns: a new #GimpColorScale widget **/ GtkWidget * gimp_color_scale_new (GtkOrientation orientation, diff --git a/libgimpwidgets/gimpcolorselection.c b/libgimpwidgets/gimpcolorselection.c index 7ef6e8971e..397f2fb8af 100644 --- a/libgimpwidgets/gimpcolorselection.c +++ b/libgimpwidgets/gimpcolorselection.c @@ -381,7 +381,7 @@ gimp_color_selection_set_property (GObject *object, * * Creates a new #GimpColorSelection widget. * - * Return value: The new #GimpColorSelection widget. + * Returns: The new #GimpColorSelection widget. **/ GtkWidget * gimp_color_selection_new (void) @@ -432,7 +432,7 @@ gimp_color_selection_set_show_alpha (GimpColorSelection *selection, * * Returns the @selection's @show_alpha property. * - * Return value: %TRUE if the #GimpColorSelection has alpha controls. + * Returns: %TRUE if the #GimpColorSelection has alpha controls. **/ gboolean gimp_color_selection_get_show_alpha (GimpColorSelection *selection) diff --git a/libgimpwidgets/gimpcolorselector.c b/libgimpwidgets/gimpcolorselector.c index e59601bd06..ede81c5334 100644 --- a/libgimpwidgets/gimpcolorselector.c +++ b/libgimpwidgets/gimpcolorselector.c @@ -241,7 +241,7 @@ gimp_color_selector_set_toggles_visible (GimpColorSelector *selector, * * Returns the @visible property of the @selector's toggles. * - * Return value: %TRUE if the #GimpColorSelector's toggles are visible. + * Returns: %TRUE if the #GimpColorSelector's toggles are visible. * * Since: 2.10 **/ @@ -288,7 +288,7 @@ gimp_color_selector_set_toggles_sensitive (GimpColorSelector *selector, * * Returns the @sensitive property of the @selector's toggles. * - * Return value: %TRUE if the #GimpColorSelector's toggles are sensitive. + * Returns: %TRUE if the #GimpColorSelector's toggles are sensitive. * * Since: 2.10 **/ @@ -332,7 +332,7 @@ gimp_color_selector_set_show_alpha (GimpColorSelector *selector, * * Returns the @selector's @show_alpha property. * - * Return value: %TRUE if the #GimpColorSelector has alpha controls. + * Returns: %TRUE if the #GimpColorSelector has alpha controls. * * Since: 2.10 **/ @@ -486,7 +486,7 @@ gimp_color_selector_set_channel (GimpColorSelector *selector, * * Returns the @selector's current channel. * - * Return value: The #GimpColorSelectorChannel currently shown by the + * Returns: The #GimpColorSelectorChannel currently shown by the * @selector. * * Since: 2.10 @@ -546,7 +546,7 @@ gimp_color_selector_set_model_visible (GimpColorSelector *selector, * @selector: A #GimpColorSelector widget. * @model: The #GimpColorSelectorModel. * - * Return value: whether @model is visible in @selector. + * Returns: whether @model is visible in @selector. * * Since: 2.10 **/ diff --git a/libgimpwidgets/gimpdialog.c b/libgimpwidgets/gimpdialog.c index 8be9fc0863..7315ce9118 100644 --- a/libgimpwidgets/gimpdialog.c +++ b/libgimpwidgets/gimpdialog.c @@ -469,7 +469,7 @@ gimp_dialog_new_valist (const gchar *title, * except it ensures there is only one help button and automatically * sets the RESPONSE_OK widget as the default response. * - * Return value: (type Gtk.Widget) (transfer none): the button widget that was added. + * Returns: (type Gtk.Widget) (transfer none): the button widget that was added. **/ GtkWidget * gimp_dialog_add_button (GimpDialog *dialog, @@ -622,7 +622,7 @@ run_destroy_handler (GtkDialog *dialog, * This function does exactly the same as gtk_dialog_run() except it * does not make the dialog modal while the #GMainLoop is running. * - * Return value: response ID + * Returns: response ID **/ gint gimp_dialog_run (GimpDialog *dialog) diff --git a/libgimpwidgets/gimpenumcombobox.c b/libgimpwidgets/gimpenumcombobox.c index bd6b28255b..a3c46e7aa8 100644 --- a/libgimpwidgets/gimpenumcombobox.c +++ b/libgimpwidgets/gimpenumcombobox.c @@ -143,7 +143,7 @@ gimp_enum_combo_box_get_property (GObject *object, * the enum values that appear in the combo_box, you can create your * own #GimpEnumStore and use gimp_enum_combo_box_new_with_model(). * - * Return value: a new #GimpEnumComboBox. + * Returns: a new #GimpEnumComboBox. * * Since: 2.4 **/ @@ -172,7 +172,7 @@ gimp_enum_combo_box_new (GType enum_type) * * Creates a #GtkComboBox for the given @enum_store. * - * Return value: a new #GimpEnumComboBox. + * Returns: a new #GimpEnumComboBox. * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpenumlabel.c b/libgimpwidgets/gimpenumlabel.c index 956520433c..5a3d603bce 100644 --- a/libgimpwidgets/gimpenumlabel.c +++ b/libgimpwidgets/gimpenumlabel.c @@ -180,7 +180,7 @@ gimp_enum_label_set_property (GObject *object, * @enum_type: the #GType of an enum * @value: an enum value * - * Return value: a new #GimpEnumLabel. + * Returns: a new #GimpEnumLabel. * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpenumstore.c b/libgimpwidgets/gimpenumstore.c index 8751076872..5c771932e3 100644 --- a/libgimpwidgets/gimpenumstore.c +++ b/libgimpwidgets/gimpenumstore.c @@ -193,7 +193,7 @@ gimp_enum_store_add_value (GtkListStore *store, * it with enum values. The enum needs to be registered to the type * system and should have translatable value names. * - * Return value: a new #GimpEnumStore. + * Returns: a new #GimpEnumStore. * * Since: 2.4 **/ @@ -226,7 +226,7 @@ gimp_enum_store_new (GType enum_type) * to limit the enum values to a certain range. Values smaller than * @minimum or larger than @maximum are not added to the store. * - * Return value: a new #GimpEnumStore. + * Returns: a new #GimpEnumStore. * * Since: 2.4 **/ @@ -270,7 +270,7 @@ gimp_enum_store_new_with_range (GType enum_type, * to explicitly list the enum values that should be added to the * store. * - * Return value: a new #GimpEnumStore. + * Returns: a new #GimpEnumStore. * * Since: 2.4 **/ @@ -299,7 +299,7 @@ gimp_enum_store_new_with_values (GType enum_type, * * See gimp_enum_store_new_with_values(). * - * Return value: a new #GimpEnumStore. + * Returns: a new #GimpEnumStore. * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpenumwidgets.c b/libgimpwidgets/gimpenumwidgets.c index c08ee0ca78..c7cc26d028 100644 --- a/libgimpwidgets/gimpenumwidgets.c +++ b/libgimpwidgets/gimpenumwidgets.c @@ -55,7 +55,7 @@ * with up to three or four values. Often it is better to use a * #GimpEnumComboBox instead. * - * Return value: (transfer full): a new #GtkVBox holding a group of #GtkRadioButtons. + * Returns: (transfer full): a new #GtkVBox holding a group of #GtkRadioButtons. * * Since: 2.4 **/ @@ -97,7 +97,7 @@ gimp_enum_radio_box_new (GType enum_type, * of radio buttons, but additionally it supports limiting the range * of available enum values. * - * Return value: (transfer full): a new #GtkVBox holding a group of #GtkRadioButtons. + * Returns: (transfer full): a new #GtkVBox holding a group of #GtkRadioButtons. * * Since: 2.4 **/ @@ -169,7 +169,7 @@ gimp_enum_radio_box_new_with_range (GType enum_type, * Calls gimp_enum_radio_box_new() and puts the resulting vbox into a * #GtkFrame. * - * Return value: (transfer full): a new #GtkFrame holding a group of #GtkRadioButtons. + * Returns: (transfer full): a new #GtkFrame holding a group of #GtkRadioButtons. * * Since: 2.4 **/ @@ -218,7 +218,7 @@ gimp_enum_radio_frame_new (GType enum_type, * Calls gimp_enum_radio_box_new_with_range() and puts the resulting * vbox into a #GtkFrame. * - * Return value: (transfer full): a new #GtkFrame holding a group of #GtkRadioButtons. + * Returns: (transfer full): a new #GtkFrame holding a group of #GtkRadioButtons. * * Since: 2.4 **/ @@ -271,7 +271,7 @@ gimp_enum_radio_frame_new_with_range (GType enum_type, * icon name for each icon is created by appending the enum_value's * nick to the given @icon_prefix. * - * Return value: (transfer full): a new horizontal #GtkBox holding a group of #GtkRadioButtons. + * Returns: (transfer full): a new horizontal #GtkBox holding a group of #GtkRadioButtons. * * Since: 2.10 **/ @@ -318,7 +318,7 @@ gimp_enum_icon_box_new (GType enum_type, * of radio buttons, but additionally it supports limiting the range * of available enum values. * - * Return value: (transfer full): a new horizontal #GtkBox holding a group of #GtkRadioButtons. + * Returns: (transfer full): a new horizontal #GtkBox holding a group of #GtkRadioButtons. * * Since: 2.10 **/ diff --git a/libgimpwidgets/gimpframe.c b/libgimpwidgets/gimpframe.c index 043be2152f..8fd66f2f32 100644 --- a/libgimpwidgets/gimpframe.c +++ b/libgimpwidgets/gimpframe.c @@ -224,7 +224,7 @@ gimp_frame_get_label_spacing (GimpFrame *frame) * bold and the frame content is indented four spaces as suggested by * the GNOME HIG (see https://developer.gnome.org/hig/stable/). * - * Return value: a new #GimpFrame widget + * Returns: a new #GimpFrame widget * * Since: 2.2 **/ diff --git a/libgimpwidgets/gimphelpui.c b/libgimpwidgets/gimphelpui.c index 418871b735..236ee2a40e 100644 --- a/libgimpwidgets/gimphelpui.c +++ b/libgimpwidgets/gimphelpui.c @@ -241,7 +241,7 @@ gimp_context_help (GtkWidget *widget) * This function returns the #GQuark which should be used as key when * attaching help IDs to widgets and objects. * - * Return value: The #GQuark. + * Returns: The #GQuark. * * Since: 2.2 **/ diff --git a/libgimpwidgets/gimphintbox.c b/libgimpwidgets/gimphintbox.c index 0cb6fb1aa7..279b02e25c 100644 --- a/libgimpwidgets/gimphintbox.c +++ b/libgimpwidgets/gimphintbox.c @@ -209,7 +209,7 @@ gimp_hint_box_get_property (GObject *object, * Creates a new widget that shows a text label showing @hint, * decorated with a GIMP_ICON_INFO wilber icon. * - * Return value: a new widget + * Returns: a new widget * * Since GIMP 2.4 **/ diff --git a/libgimpwidgets/gimpintcombobox.c b/libgimpwidgets/gimpintcombobox.c index 768d36cdff..95b64dbfaa 100644 --- a/libgimpwidgets/gimpintcombobox.c +++ b/libgimpwidgets/gimpintcombobox.c @@ -264,7 +264,7 @@ gimp_int_combo_box_get_property (GObject *object, * If you need to construct an empty #GimpIntComboBox, it's best to use * g_object_new (GIMP_TYPE_INT_COMBO_BOX, NULL). * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ @@ -294,7 +294,7 @@ gimp_int_combo_box_new (const gchar *first_label, * A variant of gimp_int_combo_box_new() that takes a va_list of * label/value pairs. Probably only useful for language bindings. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ @@ -336,7 +336,7 @@ gimp_int_combo_box_new_valist (const gchar *first_label, * A variant of gimp_int_combo_box_new() that takes an array of labels. * The array indices are used as values. * - * Return value: a new #GimpIntComboBox. + * Returns: a new #GimpIntComboBox. * * Since: 2.2 **/ @@ -446,7 +446,7 @@ gimp_int_combo_box_append (GimpIntComboBox *combo_box, * Looks up the item that belongs to the given @value and makes it the * selected item in the @combo_box. * - * Return value: %TRUE on success or %FALSE if there was no item for + * Returns: %TRUE on success or %FALSE if there was no item for * this value. * * Since: 2.2 @@ -478,7 +478,7 @@ gimp_int_combo_box_set_active (GimpIntComboBox *combo_box, * * Retrieves the value of the selected (active) item in the @combo_box. * - * Return value: %TRUE if @value has been set or %FALSE if no item was + * Returns: %TRUE if @value has been set or %FALSE if no item was * active. * * Since: 2.2 @@ -512,7 +512,7 @@ gimp_int_combo_box_get_active (GimpIntComboBox *combo_box, * Looks up the item that has the given @user_data and makes it the * selected item in the @combo_box. * - * Return value: %TRUE on success or %FALSE if there was no item for + * Returns: %TRUE on success or %FALSE if there was no item for * this user-data. * * Since: 2.10 @@ -544,7 +544,7 @@ gimp_int_combo_box_set_active_by_user_data (GimpIntComboBox *combo_box, * * Retrieves the user-data of the selected (active) item in the @combo_box. * - * Return value: %TRUE if @user_data has been set or %FALSE if no item was + * Returns: %TRUE if @user_data has been set or %FALSE if no item was * active. * * Since: 2.10 @@ -587,7 +587,7 @@ gimp_int_combo_box_get_active_user_data (GimpIntComboBox *combo_box, * gimp_drawable_combo_box_new(). If you pass an invalid initial * @value, the @callback will be called with the default item active. * - * Return value: the signal handler ID as returned by g_signal_connect() + * Returns: the signal handler ID as returned by g_signal_connect() * * Since: 2.2 **/ @@ -666,7 +666,7 @@ gimp_int_combo_box_set_label (GimpIntComboBox *combo_box, * Returns the label previously set with gimp_int_combo_box_set_label(), * or %NULL, * - * Return value: the @combo_box' label. + * Returns: the @combo_box' label. * * Since: 2.10 **/ @@ -713,7 +713,7 @@ gimp_int_combo_box_set_layout (GimpIntComboBox *combo_box, * * Returns the layout of @combo_box * - * Return value: the @combo_box's layout. + * Returns: the @combo_box's layout. * * Since: 2.10 **/ diff --git a/libgimpwidgets/gimpintstore.c b/libgimpwidgets/gimpintstore.c index d65f6a9b71..45bd0ca7ea 100644 --- a/libgimpwidgets/gimpintstore.c +++ b/libgimpwidgets/gimpintstore.c @@ -265,7 +265,7 @@ gimp_int_store_add_empty (GimpIntStore *store) * #GimpIntStore is especially useful if the items you want to store * are identified using an integer value. * - * Return value: a new #GimpIntStore. + * Returns: a new #GimpIntStore. * * Since: 2.2 **/ @@ -283,7 +283,7 @@ gimp_int_store_new (void) * * Iterate over the @model looking for @value. * - * Return value: %TRUE if the value has been located and @iter is + * Returns: %TRUE if the value has been located and @iter is * valid, %FALSE otherwise. * * Since: 2.2 @@ -322,7 +322,7 @@ gimp_int_store_lookup_by_value (GtkTreeModel *model, * * Iterate over the @model looking for @user_data. * - * Return value: %TRUE if the user-data has been located and @iter is + * Returns: %TRUE if the user-data has been located and @iter is * valid, %FALSE otherwise. * * Since: 2.10 diff --git a/libgimpwidgets/gimpnumberpairentry.c b/libgimpwidgets/gimpnumberpairentry.c index 3bbb4132c1..fe86823134 100644 --- a/libgimpwidgets/gimpnumberpairentry.c +++ b/libgimpwidgets/gimpnumberpairentry.c @@ -381,7 +381,7 @@ gimp_number_pair_entry_finalize (GObject *object) * The first separator of @separators is used to display the current * value. * - * Return value: The new #GimpNumberPairEntry widget. + * Returns: The new #GimpNumberPairEntry widget. * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpoffsetarea.c b/libgimpwidgets/gimpoffsetarea.c index 8a06fb4031..0980a989be 100644 --- a/libgimpwidgets/gimpoffsetarea.c +++ b/libgimpwidgets/gimpoffsetarea.c @@ -131,7 +131,7 @@ gimp_offset_area_init (GimpOffsetArea *area) * when resizing an image or a drawable to allow the user to interactively * specify the new offsets. * - * Return value: the new #GimpOffsetArea widget. + * Returns: the new #GimpOffsetArea widget. **/ GtkWidget * gimp_offset_area_new (gint orig_width, diff --git a/libgimpwidgets/gimppreview.c b/libgimpwidgets/gimppreview.c index 9980442137..00a1b4a8c6 100644 --- a/libgimpwidgets/gimppreview.c +++ b/libgimpwidgets/gimppreview.c @@ -567,7 +567,7 @@ gimp_preview_set_update (GimpPreview *preview, * gimp_preview_get_update: * @preview: a #GimpPreview widget * - * Return value: the state of the "Preview" check button. + * Returns: the state of the "Preview" check button. * * Since: 2.2 **/ @@ -786,7 +786,7 @@ gimp_preview_untransform (GimpPreview *preview, * gimp_preview_get_frame: * @preview: a #GimpPreview widget * - * Return value: (transfer none): a pointer to the #GtkAspectFrame used in the @preview. + * Returns: (transfer none): a pointer to the #GtkAspectFrame used in the @preview. * * Since: 3.0 **/ @@ -802,7 +802,7 @@ gimp_preview_get_frame (GimpPreview *preview) * gimp_preview_get_grid: * @preview: a #GimpPreview widget * - * Return value: (transfer none): a pointer to the #GtkGrid used in the @preview. + * Returns: (transfer none): a pointer to the #GtkGrid used in the @preview. * * Since: 3.0 **/ @@ -823,7 +823,7 @@ gimp_preview_get_grid (GimpPreview *preview) * For example if you want to receive mouse events from the area. In * such cases, use gimp_preview_get_area(). * - * Return value: (transfer none): a pointer to the #GimpPreviewArea used in the @preview. + * Returns: (transfer none): a pointer to the #GimpPreviewArea used in the @preview. * * Since: 2.4 **/ @@ -957,7 +957,7 @@ gimp_preview_get_default_cursor (GimpPreview *preview) * contains the update toggle. Derived widgets can use this function * if they need to add controls to this area. * - * Return value: (transfer none): the #GtkHBox at the bottom of the preview. + * Returns: (transfer none): the #GtkHBox at the bottom of the preview. * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimppreviewarea.c b/libgimpwidgets/gimppreviewarea.c index 9f9f8d0cb8..12419d9067 100644 --- a/libgimpwidgets/gimppreviewarea.c +++ b/libgimpwidgets/gimppreviewarea.c @@ -421,7 +421,7 @@ gimp_preview_area_destroy_transform (GimpPreviewArea *area) * * Creates a new #GimpPreviewArea widget. * - * Return value: a new #GimpPreviewArea widget. + * Returns: a new #GimpPreviewArea widget. * * Since GIMP 2.2 **/ diff --git a/libgimpwidgets/gimppropwidgets.c b/libgimpwidgets/gimppropwidgets.c index 3a73e32d92..296b675750 100644 --- a/libgimpwidgets/gimppropwidgets.c +++ b/libgimpwidgets/gimppropwidgets.c @@ -96,7 +96,7 @@ static void gimp_prop_check_button_notify (GObject *config, * If @label is %NULL, the @property_name's nick will be used as label * of the returned button. * - * Return value: (transfer full): The newly created #GtkCheckButton widget. + * Returns: (transfer full): The newly created #GtkCheckButton widget. * * Since: 2.4 */ @@ -207,7 +207,7 @@ static void gimp_prop_enum_check_button_notify (GObject *config, * If @label is %NULL, the @property_name's nick will be used as label * of the returned button. * - * Return value: (transfer full): The newly created #GtkCheckButton widget. + * Returns: (transfer full): The newly created #GtkCheckButton widget. * * Since: 2.4 */ @@ -363,7 +363,7 @@ static void gimp_prop_pointer_combo_box_notify (GObject *config, * property. The contents of the widget are determined by @store, * which should be created using gimp_int_store_new(). * - * Return value: (transfer full): The newly created #GimpIntComboBox widget. + * Returns: (transfer full): The newly created #GimpIntComboBox widget. * * Since: 2.4 */ @@ -419,7 +419,7 @@ gimp_prop_int_combo_box_new (GObject *config, * Values are GType/gpointer data, and therefore must be stored in the * "user-data" column, instead of the usual "value" column. * - * Return value: (transfer full): The newly created #GimpIntComboBox widget. + * Returns: (transfer full): The newly created #GimpIntComboBox widget. * * Since: 2.10 */ @@ -486,7 +486,7 @@ gimp_prop_pointer_combo_box_new (GObject *config, * enum. If the two values are equal (e.g., 0, 0), then the full * range of the Enum is used. * - * Return value: (transfer full): The newly created #GimpEnumComboBox widget. + * Returns: (transfer full): The newly created #GimpEnumComboBox widget. * * Since: 2.4 */ @@ -689,7 +689,7 @@ static void gimp_prop_boolean_combo_box_notify (GObject *config, * displaying the @true_text label, the other displaying the * @false_text label. * - * Return value: (transfer full): The newly created #GtkComboBox widget. + * Returns: (transfer full): The newly created #GtkComboBox widget. * * Since: 2.4 */ @@ -805,7 +805,7 @@ static void gimp_prop_radio_button_notify (GObject *config, * If @title is %NULL, the @property_name's nick will be used as label * of the returned frame. * - * Return value: (transfer full): A #GimpFrame containing the radio buttons. + * Returns: (transfer full): A #GimpFrame containing the radio buttons. * * Since: 2.4 */ @@ -881,7 +881,7 @@ gimp_prop_enum_radio_frame_new (GObject *config, * If you want to assign a label to the group of radio buttons, use * gimp_prop_enum_radio_frame_new() instead of this function. * - * Return value: (transfer full): A #GtkVBox containing the radio buttons. + * Returns: (transfer full): A #GtkVBox containing the radio buttons. * * Since: 2.4 */ @@ -951,7 +951,7 @@ static void gimp_prop_enum_label_notify (GObject *config, * @config: Object to which property is attached. * @property_name: Name of enum property to be displayed. * - * Return value: (transfer full): The newly created #GimpEnumLabel widget. + * Returns: (transfer full): The newly created #GimpEnumLabel widget. * * Since: 2.4 */ @@ -1015,7 +1015,7 @@ gimp_prop_enum_label_notify (GObject *config, * If @title is %NULL, the @property_name's nick will be used as label * of the returned frame. * - * Return value: (transfer full): A #GimpFrame containing the radio buttons. + * Returns: (transfer full): A #GimpFrame containing the radio buttons. * * Since: 2.4 */ @@ -1081,7 +1081,7 @@ gimp_prop_boolean_radio_frame_new (GObject *config, * enum_value's nick to the given @icon_prefix. See * gimp_enum_icon_box_new() for more information. * - * Return value: (transfer full): A #libgimpwidgets-gimpenumiconbox containing the radio buttons. + * Returns: (transfer full): A #libgimpwidgets-gimpenumiconbox containing the radio buttons. * * Since: 2.10 */ @@ -1200,7 +1200,7 @@ static void gimp_prop_adjustment_notify (GObject *config, * Creates a spin button to set and display the value of the * specified double property. * - * Return value: (transfer full): A new #libgimpwidgets-gimpspinbutton. + * Returns: (transfer full): A new #libgimpwidgets-gimpspinbutton. * * Since: 2.4 */ @@ -1259,7 +1259,7 @@ gimp_prop_spin_button_new (GObject *config, * Creates a horizontal scale to control the value of the specified * integer or double property. * - * Return value: (transfer full): A new #GtkScale. + * Returns: (transfer full): A new #GtkScale. * * Since: 2.4 */ @@ -1336,7 +1336,7 @@ gimp_prop_hscale_new (GObject *config, * Note that the @scale_limits boolean is the inverse of * gimp_scale_entry_new()'s "constrain" parameter. * - * Return value: (transfer full): The #GtkSpinButton's #GtkAdjustment. + * Returns: (transfer full): The #GtkSpinButton's #GtkAdjustment. * * Since: 2.4 */ @@ -1482,7 +1482,7 @@ gimp_prop_widget_set_factor (GtkWidget *widget, * which should represent an "opacity" variable with range 0 to 100. * See gimp_scale_entry_new() for more information. * - * Return value: (transfer full): The #GtkSpinButton's #GtkAdjustment. + * Returns: (transfer full): The #GtkSpinButton's #GtkAdjustment. * * Since: 2.4 */ @@ -1709,7 +1709,7 @@ static void gimp_prop_memsize_notify (GObject *config, * and display the value of the specified memsize property. See * gimp_memsize_entry_new() for more information. * - * Return value: (transfer full): A new #GimpMemsizeEntry. + * Returns: (transfer full): A new #GimpMemsizeEntry. * * Since: 2.4 */ @@ -1827,7 +1827,7 @@ static void gimp_prop_label_notify (GObject *config, * to a string. If the user should be able to edit the string, use * gimp_prop_entry_new() instead. * - * Return value: (transfer full): A new #GtkLabel widget. + * Returns: (transfer full): A new #GtkLabel widget. * * Since: 2.4 */ @@ -1924,7 +1924,7 @@ static void gimp_prop_entry_notify (GObject *config, * Creates a #GtkEntry to set and display the value of the specified * string property. * - * Return value: (transfer full): A new #GtkEntry widget. + * Returns: (transfer full): A new #GtkEntry widget. * * Since: 2.4 */ @@ -2055,7 +2055,7 @@ static void gimp_prop_text_buffer_notify (GObject *config, * If @max_len is 0 or negative, the text buffer allows an unlimited * number of characters to be entered. * - * Return value: (transfer full): A new #GtkTextBuffer. + * Returns: (transfer full): A new #GtkTextBuffer. * * Since: 2.4 */ @@ -2208,7 +2208,7 @@ static void gimp_prop_string_combo_box_notify (GObject *config, * specified property. The contents of the widget are determined by * @store. * - * Return value: (transfer full): The newly created #GimpStringComboBox widget. + * Returns: (transfer full): The newly created #GimpStringComboBox widget. * * Since: 2.4 */ @@ -2328,7 +2328,7 @@ static void gimp_prop_file_chooser_button_notify (GObject *confi * Note that #GtkFileChooserButton implements the #GtkFileChooser * interface; you can use the #GtkFileChooser API with it. * - * Return value: (transfer full): A new #GtkFileChooserButton. + * Returns: (transfer full): A new #GtkFileChooserButton. * * Since: 2.4 */ @@ -2369,7 +2369,7 @@ gimp_prop_file_chooser_button_new (GObject *config, * Note that #GtkFileChooserButton implements the #GtkFileChooser * interface; you can use the #GtkFileChooser API with it. * - * Return value: (transfer full): A new #GtkFileChooserButton. + * Returns: (transfer full): A new #GtkFileChooserButton. * * Since: 2.4 */ @@ -2792,7 +2792,7 @@ static gint gimp_prop_size_entry_num_chars (gdouble lower, * single value. Use gimp_prop_coordinates_new() to create a size * entry holding two values. * - * Return value: (transfer full): A new #GimpSizeEntry widget. + * Returns: (transfer full): A new #GimpSizeEntry widget. * * Since: 2.4 */ @@ -3108,7 +3108,7 @@ static void gimp_prop_coordinates_notify_unit (GObject *config, * properties, which will usually represent X and Y coordinates, and * their associated unit property. * - * Return value: (transfer full): A new #GimpSizeEntry widget. + * Returns: (transfer full): A new #GimpSizeEntry widget. * * Since: 2.4 */ @@ -3563,7 +3563,7 @@ static void gimp_prop_color_area_notify (GObject *config, * Creates a #GimpColorArea to set and display the value of an RGB * property. * - * Return value: (transfer full): A new #GimpColorArea widget. + * Returns: (transfer full): A new #GimpColorArea widget. * * Since: 2.4 */ @@ -3675,7 +3675,7 @@ static void gimp_prop_unit_combo_box_notify (GObject *config, * Creates a #GimpUnitComboBox to set and display the value of a Unit * property. See gimp_unit_combo_box_new() for more information. * - * Return value: (transfer full): A new #GimpUnitComboBox widget. + * Returns: (transfer full): A new #GimpUnitComboBox widget. * * Since: 2.8 */ @@ -3805,7 +3805,7 @@ static void gimp_prop_icon_image_notify (GObject *config, * specified string property, which should encode an icon name. * See gtk_image_new_from_icon_name() for more information. * - * Return value: (transfer full): A new #GtkImage widget. + * Returns: (transfer full): A new #GtkImage widget. * * Since: 2.10 */ @@ -3885,7 +3885,7 @@ static void gimp_prop_expander_notify (GObject *config, * If @label is %NULL, the @property_name's nick will be used as label * of the returned widget. * - * Return value: (transfer full): A new #GtkExpander widget. + * Returns: (transfer full): A new #GtkExpander widget. * * Since: 2.4 */ diff --git a/libgimpwidgets/gimpruler.c b/libgimpwidgets/gimpruler.c index 63f6502e19..c4307b5572 100644 --- a/libgimpwidgets/gimpruler.c +++ b/libgimpwidgets/gimpruler.c @@ -381,7 +381,7 @@ gimp_ruler_get_property (GObject *object, * * Creates a new ruler. * - * Return value: a new #GimpRuler widget. + * Returns: a new #GimpRuler widget. * * Since: 2.8 **/ @@ -616,7 +616,7 @@ gimp_ruler_set_unit (GimpRuler *ruler, * gimp_ruler_get_unit: * @ruler: a #GimpRuler * - * Return value: (transfer none): the unit currently used in the @ruler widget. + * Returns: (transfer none): the unit currently used in the @ruler widget. * * Since: 2.8 **/ @@ -695,7 +695,7 @@ gimp_ruler_set_position (GimpRuler *ruler, * gimp_ruler_get_position: * @ruler: a #GimpRuler * - * Return value: the current position of the @ruler widget. + * Returns: the current position of the @ruler widget. * * Since: 2.8 **/ diff --git a/libgimpwidgets/gimpscaleentry.c b/libgimpwidgets/gimpscaleentry.c index 9bc0f97b86..46d96af156 100644 --- a/libgimpwidgets/gimpscaleentry.c +++ b/libgimpwidgets/gimpscaleentry.c @@ -424,7 +424,7 @@ gimp_scale_entry_set_logarithmic (GtkAdjustment *adjustment, * gimp_scale_entry_get_logarithmic: * @adjustment: a #GtkAdjustment as returned by gimp_scale_entry_new() * - * Return value: %TRUE if the the entry's scale widget will behave in + * Returns: %TRUE if the the entry's scale widget will behave in * logharithmic fashion, %FALSE for linear behaviour. * * Since: 2.2 diff --git a/libgimpwidgets/gimpsizeentry.c b/libgimpwidgets/gimpsizeentry.c index b2826104a7..afb4668ba9 100644 --- a/libgimpwidgets/gimpsizeentry.c +++ b/libgimpwidgets/gimpsizeentry.c @@ -1662,7 +1662,7 @@ gimp_size_entry_set_activates_default (GimpSizeEntry *gse, * if you want to set tooltips using gimp_help_set_help_data() you * can use this function to get a pointer to the spinbuttons. * - * Return value: (transfer none): a #GtkWidget pointer that you can attach a tooltip to. + * Returns: (transfer none): a #GtkWidget pointer that you can attach a tooltip to. **/ GtkWidget * gimp_size_entry_get_help_widget (GimpSizeEntry *gse, diff --git a/libgimpwidgets/gimpstringcombobox.c b/libgimpwidgets/gimpstringcombobox.c index 0a35fdf8f5..42321ed763 100644 --- a/libgimpwidgets/gimpstringcombobox.c +++ b/libgimpwidgets/gimpstringcombobox.c @@ -261,7 +261,7 @@ gimp_string_model_lookup (GtkTreeModel *model, * @id_column: the model column of the ID * @label_column: the modl column of the label * - * Return value: a new #GimpStringComboBox. + * Returns: a new #GimpStringComboBox. * * Since: 2.4 **/ @@ -291,7 +291,7 @@ gimp_string_combo_box_new (GtkTreeModel *model, * Looks up the item that belongs to the given @id and makes it the * selected item in the @combo_box. * - * Return value: %TRUE on success or %FALSE if there was no item for + * Returns: %TRUE on success or %FALSE if there was no item for * this value. * * Since: 2.4 @@ -334,7 +334,7 @@ gimp_string_combo_box_set_active (GimpStringComboBox *combo_box, * * Retrieves the value of the selected (active) item in the @combo_box. * - * Return value: newly allocated ID string or %NULL if nothing was selected + * Returns: newly allocated ID string or %NULL if nothing was selected * * Since: 2.4 **/ diff --git a/libgimpwidgets/gimpunitcombobox.c b/libgimpwidgets/gimpunitcombobox.c index ac0840b9de..759fc26ba3 100644 --- a/libgimpwidgets/gimpunitcombobox.c +++ b/libgimpwidgets/gimpunitcombobox.c @@ -118,7 +118,7 @@ gimp_unit_combo_box_popup_shown (GtkWidget *widget, /** * gimp_unit_combo_box_new: * - * Return value: a new #GimpUnitComboBox. + * Returns: a new #GimpUnitComboBox. **/ GtkWidget * gimp_unit_combo_box_new (void) @@ -141,7 +141,7 @@ gimp_unit_combo_box_new (void) * gimp_unit_combo_box_new_with_model: * @model: a GimpUnitStore * - * Return value: a new #GimpUnitComboBox. + * Returns: a new #GimpUnitComboBox. **/ GtkWidget * gimp_unit_combo_box_new_with_model (GimpUnitStore *model) diff --git a/libgimpwidgets/gimpwidgets-error.c b/libgimpwidgets/gimpwidgets-error.c index bda4187d5e..60b7c681e7 100644 --- a/libgimpwidgets/gimpwidgets-error.c +++ b/libgimpwidgets/gimpwidgets-error.c @@ -31,7 +31,7 @@ * * This function is never called directly. Use GIMP_WIDGETS_ERROR() instead. * - * Return value: the #GQuark that defines the GIMP widgets error domain. + * Returns: the #GQuark that defines the GIMP widgets error domain. **/ GQuark gimp_widgets_error_quark (void) diff --git a/libgimpwidgets/gimpwidgetsutils.c b/libgimpwidgets/gimpwidgetsutils.c index 7fc31c7b68..12062ae35f 100644 --- a/libgimpwidgets/gimpwidgetsutils.c +++ b/libgimpwidgets/gimpwidgetsutils.c @@ -474,7 +474,7 @@ monitor_number (GdkMonitor *monitor) * * Since: 3.0 * - * Return value: (transfer full): the monitor's #GimpColorProfile, or %NULL. + * Returns: (transfer full): the monitor's #GimpColorProfile, or %NULL. **/ GimpColorProfile * gimp_monitor_get_color_profile (GdkMonitor *monitor) @@ -590,7 +590,7 @@ gimp_monitor_get_color_profile (GdkMonitor *monitor) * * Since: 3.0 * - * Return value: (transfer full): @widget's monitor's #GimpColorProfile, or %NULL. + * Returns: (transfer full): @widget's monitor's #GimpColorProfile, or %NULL. **/ GimpColorProfile * gimp_widget_get_color_profile (GtkWidget *widget) diff --git a/libgimpwidgets/gimpzoommodel.c b/libgimpwidgets/gimpzoommodel.c index 33db9e7d88..0f64ea38ae 100644 --- a/libgimpwidgets/gimpzoommodel.c +++ b/libgimpwidgets/gimpzoommodel.c @@ -317,7 +317,7 @@ gimp_zoom_model_zoom_out (GimpZoomModel *model) * * Creates a new #GimpZoomModel. * - * Return value: a new #GimpZoomModel. + * Returns: a new #GimpZoomModel. * * Since GIMP 2.4 **/ @@ -388,7 +388,7 @@ gimp_zoom_model_zoom (GimpZoomModel *model, * * Retrieves the current zoom factor of @model. * - * Return value: the current scale factor + * Returns: the current scale factor * * Since GIMP 2.4 **/ @@ -540,7 +540,7 @@ zoom_out_button_callback (GimpZoomModel *model, * @zoom_type: * @icon_size: use 0 for a button with text labels * - * Return value: (transfer full): a newly created GtkButton + * Returns: (transfer full): a newly created GtkButton * * Since GIMP 2.4 **/ @@ -610,7 +610,7 @@ gimp_zoom_button_new (GimpZoomModel *model, * * Utility function to calculate a new scale factor. * - * Return value: the new scale factor + * Returns: the new scale factor * * Since GIMP 2.4 **/ diff --git a/modules/gimpcolorwheel.c b/modules/gimpcolorwheel.c index af8a8d026c..b11baea3d0 100644 --- a/modules/gimpcolorwheel.c +++ b/modules/gimpcolorwheel.c @@ -1314,7 +1314,7 @@ gimp_color_wheel_focus (GtkWidget *widget, * * Creates a new HSV color selector. * - * Return value: A newly-created HSV color selector. + * Returns: A newly-created HSV color selector. * * Since: 2.10 */ @@ -1484,7 +1484,7 @@ gimp_color_wheel_set_color_config (GimpColorWheel *wheel, * adjusting the value with the mouse. This function queries whether * the HSV color selector is being adjusted or not. * - * Return value: %TRUE if clients can ignore changes to the color value, + * Returns: %TRUE if clients can ignore changes to the color value, * since they may be transitory, or %FALSE if they should consider * the color value status to be final. * diff --git a/pdb/enumcode.pl b/pdb/enumcode.pl index f253862cb6..09d00dbac5 100755 --- a/pdb/enumcode.pl +++ b/pdb/enumcode.pl @@ -241,7 +241,7 @@ gimp_enums_init (void) * This function gives access to the list of enums registered by libgimp. * The returned array is static and must not be modified. * - * Return value: an array with type names + * Returns: an array with type names * * Since: 2.2 **/ diff --git a/plug-ins/common/file-dicom.c b/plug-ins/common/file-dicom.c index 3cbf23f9aa..4b51a789bc 100644 --- a/plug-ins/common/file-dicom.c +++ b/plug-ins/common/file-dicom.c @@ -827,7 +827,7 @@ typedef struct * * Creates a DICOMELEMENT object and inserts it into @elements. * - * Return value: the new head of @elements + * Returns: the new head of @elements **/ static GSList * dicom_add_element (GSList *elements, @@ -884,7 +884,7 @@ dicom_add_element_copy (GSList *elements, * guint16 for @value_rep == %US or guint32 for other values of * @value_rep * - * Return value: the new head of @elements + * Returns: the new head of @elements */ static GSList * dicom_add_element_int (GSList *elements, @@ -945,7 +945,7 @@ dicom_elements_destroy (GSList *elements) * * Removes the specified DICOMELEMENT from @elements and Destroys it * - * Return value: the new head of @elements + * Returns: the new head of @elements **/ static GSList * dicom_destroy_element (GSList *elements, @@ -971,7 +971,7 @@ dicom_destroy_element (GSList *elements, * * Determines the equality of @a and @b as strcmp * - * Return value: an integer indicating the equality of @a and @b. + * Returns: an integer indicating the equality of @a and @b. **/ static gint dicom_elements_compare (gconstpointer a, @@ -1011,7 +1011,7 @@ dicom_elements_compare (gconstpointer a, * * Retrieves the specified DICOMELEMENT from @head, if available. * - * Return value: a DICOMELEMENT matching the specified group,element, + * Returns: a DICOMELEMENT matching the specified group,element, * or NULL if the specified element was not found. **/ static DICOMELEMENT * @@ -1031,7 +1031,7 @@ dicom_element_find_by_num (GSList *head, * * Reads all DICOMELEMENTs from the specified image's parasites. * - * Return value: a GSList of all known dicom elements + * Returns: a GSList of all known dicom elements **/ static GSList * dicom_get_elements_list (gint32 image_ID) @@ -1150,7 +1150,7 @@ dicom_get_elements_list (gint32 image_ID) * * Removes certain DICOMELEMENTs from the elements list which are specific to the output of this plugin. * - * Return value: the new head of @elements + * Returns: the new head of @elements **/ static GSList * dicom_remove_gimp_specified_elements (GSList *elements, @@ -1212,7 +1212,7 @@ dicom_remove_gimp_specified_elements (GSList *elements, * Defaults DICOMELEMENTs to the values set by previous version of * this plugin, but only if they do not already exist. * - * Return value: the new head of @elements + * Returns: the new head of @elements **/ static GSList * dicom_ensure_required_elements_present (GSList *elements, @@ -1512,7 +1512,7 @@ dicom_print_tags(gpointer data, * * Writes all Dicom tags in @elements to the file @DICOM * - * Return value: the new head of @elements + * Returns: the new head of @elements **/ static GSList * dicom_add_tags (FILE *DICOM, diff --git a/plug-ins/file-jpeg/jpeg-quality.c b/plug-ins/file-jpeg/jpeg-quality.c index 52bd2c77f0..13b557a633 100644 --- a/plug-ins/file-jpeg/jpeg-quality.c +++ b/plug-ins/file-jpeg/jpeg-quality.c @@ -83,7 +83,7 @@ static gint std_chrominance_sum[101] = * @cinfo contains the quantization tables read from the DQT markers * in the file. * - * Return Value: the JPEG quality setting in the range 1..100, -1..-100 or 0. + * Returns: the JPEG quality setting in the range 1..100, -1..-100 or 0. */ gint jpeg_detect_quality (struct jpeg_decompress_struct *cinfo) diff --git a/plug-ins/file-jpeg/jpeg-settings.c b/plug-ins/file-jpeg/jpeg-settings.c index df6ace2b09..af33e846e9 100644 --- a/plug-ins/file-jpeg/jpeg-settings.c +++ b/plug-ins/file-jpeg/jpeg-settings.c @@ -71,7 +71,7 @@ * @cinfo contains the quantization tables and the sampling factors * for each component. * - * Return Value: TRUE if a parasite has been attached to @image_ID. + * Returns: TRUE if a parasite has been attached to @image_ID. */ gboolean jpeg_detect_original_settings (struct jpeg_decompress_struct *cinfo, @@ -161,7 +161,7 @@ jpeg_detect_original_settings (struct jpeg_decompress_struct *cinfo, * zero, then these tables can be retrieved from the parasite by * calling jpeg_restore_original_tables(). * - * Return Value: TRUE if a valid parasite was attached to the image + * Returns: TRUE if a valid parasite was attached to the image */ gboolean jpeg_restore_original_settings (gint32 image_ID, @@ -264,7 +264,7 @@ jpeg_restore_original_settings (gint32 image_ID, * no parasite exists or if it cannot be used, this function returns * NULL. * - * Return Value: an array of quantization tables, or NULL. + * Returns: an array of quantization tables, or NULL. */ guint ** jpeg_restore_original_tables (gint32 image_ID, diff --git a/plug-ins/print/print-preview.c b/plug-ins/print/print-preview.c index ad5b8b3ab3..47c0e2bca9 100644 --- a/plug-ins/print/print-preview.c +++ b/plug-ins/print/print-preview.c @@ -545,7 +545,7 @@ print_preview_draw (GtkWidget *widget, * * Creates a new #PrintPreview widget. * - * Return value: the new #PrintPreview widget. + * Returns: the new #PrintPreview widget. **/ GtkWidget * print_preview_new (GtkPageSetup *page,