eUgEntOptIc44/gimp
1
1
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-10-06 01:12:40 +02:00
Code Issues Releases Activity

Use "Returns:" to annotate return values

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

12
libgimpmodule/gimpmodule.c
View File

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

8
libgimpmodule/gimpmoduledb.c
View File

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