Use "Returns:" to annotate return values

To be able to annotate return values through GObject-introspection, you
need to make sure it is tagged with `Returns:` and not something else.
This commit is contained in:
Niels De Graef 2019-08-03 00:10:14 +02:00 committed by Jehan
parent 746a72b956
commit 1dda60154c
150 changed files with 458 additions and 458 deletions

View File

@ -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 *

View File

@ -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 *

View File

@ -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,

View File

@ -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)

View File

@ -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)

View File

@ -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,

View File

@ -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 *

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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,

View File

@ -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,

View File

@ -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)

View File

@ -281,7 +281,7 @@ gimp_image_item_list_transform (GimpImage *image,
* This function returns a #GList of #GimpItem<!-- -->s for which the
* @type and @set criterions match.
*
* Return value: The list of items.
* Returns: The list of items.
**/
GList *
gimp_image_item_list_get_list (GimpImage *image,

View File

@ -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

View File

@ -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,

View File

@ -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)

View File

@ -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,

View File

@ -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)

View File

@ -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.
**/

View File

@ -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)

View File

@ -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,

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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,

View File

@ -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

View File

@ -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)

View File

@ -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,

View File

@ -217,7 +217,7 @@ gimp_canvas_focus (GtkWidget *widget,
* look and work like their #GdkDrawable counterparts. #GimpCanvas
* gracefully handles attempts to draw on the unrealized widget.
*
* Return value: a new #GimpCanvas widget
* Returns: a new #GimpCanvas widget
**/
GtkWidget *
gimp_canvas_new (GimpDisplayConfig *config)

View File

@ -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)

View File

@ -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,

View File

@ -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

View File

@ -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)

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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)

View File

@ -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
**/

View File

@ -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)

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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)

View File

@ -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,

View File

@ -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)

View File

@ -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,

View File

@ -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,

View File

@ -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,

View File

@ -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 *

View File

@ -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)

View File

@ -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)

View File

@ -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,

View File

@ -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 *

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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,

View File

@ -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)

View File

@ -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)

View File

@ -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

View File

@ -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 '/**'.

View File

@ -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)

View File

@ -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
*/

View File

@ -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

View File

@ -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
**/

View File

@ -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
**/

View File

@ -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
*/

View File

@ -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
**/

View File

@ -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.

View File

@ -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
**/

View File

@ -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

View File

@ -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

View File

@ -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
**/

View File

@ -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
**/

View File

@ -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.
*

View File

@ -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

View File

@ -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

View File

@ -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
*/

View File

@ -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

View File

@ -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
*/

View File

@ -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
**/

View File

@ -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

View File

@ -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
*/

View File

@ -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
**/

View File

@ -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
**/

View File

@ -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

View File

@ -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.
*

View File

@ -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

View File

@ -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

View File

@ -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
**/

View File

@ -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

View File

@ -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.
*

View File

@ -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
**/

View File

@ -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
**/

View File

@ -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

View File

@ -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
**/

Some files were not shown because too many files have changed in this diff Show More