docs: use "Returns:" consistently

Instead of "Return value:".
This commit is contained in:
William Jon McCann
2014-02-19 19:35:23 -05:00
parent 9cb53851be
commit 20f4d1820b
93 changed files with 600 additions and 600 deletions

View File

@@ -323,7 +323,7 @@ g_find_program_in_path (const gchar *program)
* the program is found, the return value contains the full name
* including the type suffix.
*
* Return value: a newly-allocated string with the absolute path, or %NULL
* Returns: a newly-allocated string with the absolute path, or %NULL
**/
#ifdef G_OS_WIN32
static gchar *
@@ -1075,7 +1075,7 @@ static gchar *g_application_name = NULL;
* g_get_prgname() (which may be %NULL if g_set_prgname() has also not
* been called).
*
* Return value: human-readable application name. may return %NULL
* Returns: human-readable application name. may return %NULL
*
* Since: 2.2
**/
@@ -1144,7 +1144,7 @@ g_set_application_name (const gchar *application_name)
* CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
* what g_get_user_config_dir() returns.
*
* Return value: a string owned by GLib that must not be modified
* Returns: a string owned by GLib that must not be modified
* or freed.
* Since: 2.6
**/
@@ -1230,7 +1230,7 @@ g_init_user_config_dir (void)
* CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
* what g_get_user_data_dir() returns.
*
* Return value: a string owned by GLib that must not be modified
* Returns: a string owned by GLib that must not be modified
* or freed.
* Since: 2.6
**/
@@ -1262,7 +1262,7 @@ g_get_user_config_dir (void)
* C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
* See documentation for CSIDL_INTERNET_CACHE.
*
* Return value: a string owned by GLib that must not be modified
* Returns: a string owned by GLib that must not be modified
* or freed.
* Since: 2.6
**/
@@ -1704,7 +1704,7 @@ g_reload_user_special_dirs_cache (void)
* of the special directory without requiring the session to restart; GLib
* will not reflect any change once the special directories are loaded.
*
* Return value: the path to the specified special directory, or %NULL
* Returns: the path to the specified special directory, or %NULL
* if the logical id was not found. The returned string is owned by
* GLib and should not be modified or freed.
*
@@ -1921,7 +1921,7 @@ g_win32_get_system_data_dirs_for_module (void (*address_of_function)(void))
* Note that on Windows the returned list can vary depending on where
* this function is called.
*
* Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
* Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
* not be modified or freed.
* Since: 2.6
**/
@@ -1973,7 +1973,7 @@ g_get_system_data_dirs (void)
* of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
* This information will not roam and is available to anyone using the computer.
*
* Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
* Returns: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib that must
* not be modified or freed.
* Since: 2.6
**/