Drop last uses of @returns:
authorRyan Lortie <desrt@desrt.ca>
Mon, 21 Nov 2011 17:02:02 +0000 (12:02 -0500)
committerRyan Lortie <desrt@desrt.ca>
Mon, 21 Nov 2011 17:02:02 +0000 (12:02 -0500)
gio/gapplication.c
gio/gkeyfilesettingsbackend.c
gio/gsettings.c
gio/gsettings.h
gio/gsettingsbackend.c

index e2603c0..0f98da6 100644 (file)
@@ -674,7 +674,6 @@ get_platform_data (GApplication *application)
 /**
  * g_application_id_is_valid:
  * @application_id: a potential application identifier
- * @returns: %TRUE if @application_id is valid
  *
  * Checks if @application_id is a valid application identifier.
  *
@@ -690,6 +689,8 @@ get_platform_data (GApplication *application)
  *   <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
  *   <listitem>Application identifiers must not exceed 255 characters.</listitem>
  * </itemizedlist>
+ *
+ * Returns: %TRUE if @application_id is valid
  **/
 gboolean
 g_application_id_is_valid (const gchar *application_id)
@@ -740,13 +741,14 @@ g_application_id_is_valid (const gchar *application_id)
  * g_application_new:
  * @application_id: the application id
  * @flags: the application flags
- * @returns: a new #GApplication instance
  *
  * Creates a new #GApplication instance.
  *
  * This function calls g_type_init() for you.
  *
  * The application id must be valid.  See g_application_id_is_valid().
+ *
+ * Returns: a new #GApplication instance
  **/
 GApplication *
 g_application_new (const gchar       *application_id,
@@ -766,10 +768,11 @@ g_application_new (const gchar       *application_id,
 /**
  * g_application_get_application_id:
  * @application: a #GApplication
- * @returns: the identifier for @application, owned by @application
  *
  * Gets the unique identifier for @application.
  *
+ * Returns: the identifier for @application, owned by @application
+ *
  * Since: 2.28
  **/
 const gchar *
@@ -815,12 +818,13 @@ g_application_set_application_id (GApplication *application,
 /**
  * g_application_get_flags:
  * @application: a #GApplication
- * @returns: the flags for @application
  *
  * Gets the flags for @application.
  *
  * See #GApplicationFlags.
  *
+ * Returns: the flags for @application
+ *
  * Since: 2.28
  **/
 GApplicationFlags
@@ -915,13 +919,14 @@ g_application_set_inactivity_timeout (GApplication *application,
 /**
  * g_application_get_is_registered:
  * @application: a #GApplication
- * @returns: %TRUE if @application is registered
  *
  * Checks if @application is registered.
  *
  * An application is registered if g_application_register() has been
  * successfully called.
  *
+ * Returns: %TRUE if @application is registered
+ *
  * Since: 2.28
  **/
 gboolean
@@ -935,7 +940,6 @@ g_application_get_is_registered (GApplication *application)
 /**
  * g_application_get_is_remote:
  * @application: a #GApplication
- * @returns: %TRUE if @application is remote
  *
  * Checks if @application is remote.
  *
@@ -948,6 +952,8 @@ g_application_get_is_registered (GApplication *application)
  * g_application_register() has been called.  See
  * g_application_get_is_registered().
  *
+ * Returns: %TRUE if @application is remote
+ *
  * Since: 2.28
  **/
 gboolean
@@ -965,7 +971,6 @@ g_application_get_is_remote (GApplication *application)
  * @application: a #GApplication
  * @cancellable: a #GCancellable, or %NULL
  * @error: a pointer to a NULL #GError, or %NULL
- * @returns: %TRUE if registration succeeded
  *
  * Attempts registration of the application.
  *
@@ -994,6 +999,8 @@ g_application_get_is_remote (GApplication *application)
  * instance is or is not the primary instance of the application.  See
  * g_application_get_is_remote() for that.
  *
+ * Returns: %TRUE if registration succeeded
+ *
  * Since: 2.28
  **/
 gboolean
@@ -1172,7 +1179,6 @@ g_application_open (GApplication  *application,
  * @application: a #GApplication
  * @argc: the argc from main() (or 0 if @argv is %NULL)
  * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
- * @returns: the exit status
  *
  * Runs the application.
  *
@@ -1241,6 +1247,8 @@ g_application_open (GApplication  *application,
  * use count of zero is delayed for a while (ie: the instance stays
  * around to provide its <emphasis>service</emphasis> to others).
  *
+ * Returns: the exit status
+ *
  * Since: 2.28
  **/
 int
index 05bb10d..6601eba 100644 (file)
@@ -571,7 +571,6 @@ dir_changed (GFileMonitor       *monitor,
  * @root_path: the path under which all settings keys appear
  * @root_group: (allow-none): the group name corresponding to
  *              @root_path, or %NULL
- * @returns: (transfer full): a keyfile-backed #GSettingsBackend
  *
  * Creates a keyfile-backed #GSettingsBackend.
  *
@@ -617,6 +616,8 @@ dir_changed (GFileMonitor       *monitor,
  * syntax of the key file format.  For example, if you have '[' or ']'
  * characters in your path names or '=' in your key names you may be in
  * trouble.
+ *
+ * Returns: (transfer full): a keyfile-backed #GSettingsBackend
  **/
 GSettingsBackend *
 g_keyfile_settings_backend_new (const gchar *filename,
index 38e114c..5898fdd 100644 (file)
@@ -630,8 +630,6 @@ g_settings_class_init (GSettingsClass *class)
    * @keys: (array length=n_keys) (element-type GQuark) (allow-none):
    *        an array of #GQuark<!-- -->s for the changed keys, or %NULL
    * @n_keys: the length of the @keys array, or 0
-   * @returns: %TRUE to stop other handlers from being invoked for the
-   *           event. FALSE to propagate the event further.
    *
    * The "change-event" signal is emitted once per change event that
    * affects this settings object.  You should connect to this signal
@@ -648,6 +646,9 @@ g_settings_class_init (GSettingsClass *class)
    * The default handler for this signal invokes the "changed" signal
    * for each affected key.  If any other connected handler returns
    * %TRUE then this default functionality will be suppressed.
+   *
+   * Returns: %TRUE to stop other handlers from being invoked for the
+   *          event. FALSE to propagate the event further.
    */
   g_settings_signals[SIGNAL_CHANGE_EVENT] =
     g_signal_new ("change-event", G_TYPE_SETTINGS,
@@ -681,8 +682,6 @@ g_settings_class_init (GSettingsClass *class)
    * GSettings::writable-change-event:
    * @settings: the object on which the signal was emitted
    * @key: the quark of the key, or 0
-   * @returns: %TRUE to stop other handlers from being invoked for the
-   *           event. FALSE to propagate the event further.
    *
    * The "writable-change-event" signal is emitted once per writability
    * change event that affects this settings object.  You should connect
@@ -702,6 +701,9 @@ g_settings_class_init (GSettingsClass *class)
    * example, a new mandatory setting is introduced).  If any other
    * connected handler returns %TRUE then this default functionality
    * will be suppressed.
+   *
+   * Returns: %TRUE to stop other handlers from being invoked for the
+   *          event. FALSE to propagate the event further.
    */
   g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
     g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
@@ -825,7 +827,6 @@ g_settings_class_init (GSettingsClass *class)
 /**
  * g_settings_new:
  * @schema_id: the id of the schema
- * @returns: a new #GSettings object
  *
  * Creates a new #GSettings object with the schema specified by
  * @schema_id.
@@ -835,6 +836,8 @@ g_settings_class_init (GSettingsClass *class)
  * call to g_settings_new().  The new #GSettings will hold a reference
  * on the context.  See g_main_context_push_thread_default().
  *
+ * Returns: a new #GSettings object
+ *
  * Since: 2.26
  */
 GSettings *
@@ -851,7 +854,6 @@ g_settings_new (const gchar *schema_id)
  * g_settings_new_with_path:
  * @schema_id: the id of the schema
  * @path: the path to use
- * @returns: a new #GSettings object
  *
  * Creates a new #GSettings object with the relocatable schema specified
  * by @schema_id and a given path.
@@ -863,6 +865,8 @@ g_settings_new (const gchar *schema_id)
  * It is a programmer error to call this function for a schema that
  * has an explicitly specified path.
  *
+ * Returns: a new #GSettings object
+ *
  * Since: 2.26
  */
 GSettings *
@@ -882,7 +886,6 @@ g_settings_new_with_path (const gchar *schema_id,
  * g_settings_new_with_backend:
  * @schema_id: the id of the schema
  * @backend: the #GSettingsBackend to use
- * @returns: a new #GSettings object
  *
  * Creates a new #GSettings object with the schema specified by
  * @schema_id and a given #GSettingsBackend.
@@ -893,6 +896,8 @@ g_settings_new_with_path (const gchar *schema_id,
  * the system to get a settings object that modifies the system default
  * settings instead of the settings for this user.
  *
+ * Returns: a new #GSettings object
+ *
  * Since: 2.26
  */
 GSettings *
@@ -913,7 +918,6 @@ g_settings_new_with_backend (const gchar      *schema_id,
  * @schema_id: the id of the schema
  * @backend: the #GSettingsBackend to use
  * @path: the path to use
- * @returns: a new #GSettings object
  *
  * Creates a new #GSettings object with the schema specified by
  * @schema_id and a given #GSettingsBackend and path.
@@ -921,6 +925,8 @@ g_settings_new_with_backend (const gchar      *schema_id,
  * This is a mix of g_settings_new_with_backend() and
  * g_settings_new_with_path().
  *
+ * Returns: a new #GSettings object
+ *
  * Since: 2.26
  */
 GSettings *
@@ -944,7 +950,6 @@ g_settings_new_with_backend_and_path (const gchar      *schema_id,
  * @schema: a #GSettingsSchema
  * @backend: (allow-none): a #GSettingsBackend
  * @path: (allow-none): the path to use
- * @returns: a new #GSettings object
  *
  * Creates a new #GSettings object with a given schema, backend and
  * path.
@@ -970,6 +975,8 @@ g_settings_new_with_backend_and_path (const gchar      *schema_id,
  * @path is non-%NULL and not equal to the path that the schema does
  * have.
  *
+ * Returns: a new #GSettings object
+ *
  * Since: 2.32
  */
 GSettings *
@@ -1028,13 +1035,14 @@ g_settings_read_from_backend (GSettings          *settings,
  * g_settings_get_value:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: a new #GVariant
  *
  * Gets the value that is stored in @settings for @key.
  *
  * It is a programmer error to give a @key that isn't contained in the
  * schema for @settings.
  *
+ * Returns: a new #GVariant
+ *
  * Since: 2.26
  */
 GVariant *
@@ -1065,7 +1073,6 @@ g_settings_get_value (GSettings   *settings,
  * g_settings_get_enum:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: the enum value
  *
  * Gets the value that is stored in @settings for @key and converts it
  * to the enum value that it represents.
@@ -1080,6 +1087,8 @@ g_settings_get_value (GSettings   *settings,
  * value for the enumerated type then this function will return the
  * default value.
  *
+ * Returns: the enum value
+ *
  * Since: 2.26
  **/
 gint
@@ -1123,7 +1132,6 @@ g_settings_get_enum (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: a key, within @settings
  * @value: an enumerated value
- * @returns: %TRUE, if the set succeeds
  *
  * Looks up the enumerated type nick for @value and writes it to @key,
  * within @settings.
@@ -1135,6 +1143,8 @@ g_settings_get_enum (GSettings   *settings,
  * After performing the write, accessing @key directly with
  * g_settings_get_string() will return the 'nick' associated with
  * @value.
+ *
+ * Returns: %TRUE, if the set succeeds
  **/
 gboolean
 g_settings_set_enum (GSettings   *settings,
@@ -1176,7 +1186,6 @@ g_settings_set_enum (GSettings   *settings,
  * g_settings_get_flags:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: the flags value
  *
  * Gets the value that is stored in @settings for @key and converts it
  * to the flags value that it represents.
@@ -1191,6 +1200,8 @@ g_settings_set_enum (GSettings   *settings,
  * value for the flags type then this function will return the default
  * value.
  *
+ * Returns: the flags value
+ *
  * Since: 2.26
  **/
 guint
@@ -1234,7 +1245,6 @@ g_settings_get_flags (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: a key, within @settings
  * @value: a flags value
- * @returns: %TRUE, if the set succeeds
  *
  * Looks up the flags type nicks for the bits specified by @value, puts
  * them in an array of strings and writes the array to @key, within
@@ -1247,6 +1257,8 @@ g_settings_get_flags (GSettings   *settings,
  * After performing the write, accessing @key directly with
  * g_settings_get_strv() will return an array of 'nicks'; one for each
  * bit in @value.
+ *
+ * Returns: %TRUE, if the set succeeds
  **/
 gboolean
 g_settings_set_flags (GSettings   *settings,
@@ -1289,8 +1301,6 @@ g_settings_set_flags (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: a #GVariant of the correct type
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1300,6 +1310,9 @@ g_settings_set_flags (GSettings   *settings,
  *
  * If @value is floating then this function consumes the reference.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  **/
 gboolean
@@ -1382,8 +1395,6 @@ g_settings_get (GSettings   *settings,
  * @key: the name of the key to set
  * @format: a #GVariant format string
  * @...: arguments as per @format
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1394,6 +1405,9 @@ g_settings_get (GSettings   *settings,
  * schema for @settings or for the #GVariantType of @format to mismatch
  * the type given in the schema.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -1419,7 +1433,6 @@ g_settings_set (GSettings   *settings,
  * @mapping: (scope call): the function to map the value in the
  *           settings database to the value used by the application
  * @user_data: user data for @mapping
- * @returns: (transfer full): the result, which may be %NULL
  *
  * Gets the value that is stored at @key in @settings, subject to
  * application-level validation/mapping.
@@ -1429,7 +1442,7 @@ g_settings_set (GSettings   *settings,
  * @mapping function performs that processing.  If the function
  * indicates that the processing was unsuccessful (due to a parse error,
  * for example) then the mapping is tried again with another value.
-
+ *
  * This allows a robust 'fall back to defaults' behaviour to be
  * implemented somewhat automatically.
  *
@@ -1448,6 +1461,8 @@ g_settings_set (GSettings   *settings,
  * to each invocation of @mapping.  The final value of that #gpointer is
  * what is returned by this function.  %NULL is valid; it is returned
  * just as any other value would be.
+ *
+ * Returns: (transfer full): the result, which may be %NULL
  **/
 gpointer
 g_settings_get_mapped (GSettings           *settings,
@@ -1499,7 +1514,6 @@ g_settings_get_mapped (GSettings           *settings,
  * g_settings_get_string:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: a newly-allocated string
  *
  * Gets the value that is stored at @key in @settings.
  *
@@ -1508,6 +1522,8 @@ g_settings_get_mapped (GSettings           *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a string type in the schema for @settings.
  *
+ * Returns: a newly-allocated string
+ *
  * Since: 2.26
  */
 gchar *
@@ -1529,8 +1545,6 @@ g_settings_get_string (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: the value to set it to
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1539,6 +1553,9 @@ g_settings_get_string (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a string type in the schema for @settings.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -1553,7 +1570,6 @@ g_settings_set_string (GSettings   *settings,
  * g_settings_get_int:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: an integer
  *
  * Gets the value that is stored at @key in @settings.
  *
@@ -1562,6 +1578,8 @@ g_settings_set_string (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a int32 type in the schema for @settings.
  *
+ * Returns: an integer
+ *
  * Since: 2.26
  */
 gint
@@ -1583,8 +1601,6 @@ g_settings_get_int (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: the value to set it to
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1593,6 +1609,9 @@ g_settings_get_int (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a int32 type in the schema for @settings.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -1607,7 +1626,6 @@ g_settings_set_int (GSettings   *settings,
  * g_settings_get_uint:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: an unsigned integer
  *
  * Gets the value that is stored at @key in @settings.
  *
@@ -1617,6 +1635,8 @@ g_settings_set_int (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a uint32 type in the schema for @settings.
  *
+ * Returns: an unsigned integer
+ *
  * Since: 2.30
  */
 guint
@@ -1638,8 +1658,6 @@ g_settings_get_uint (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: the value to set it to
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1649,6 +1667,9 @@ g_settings_get_uint (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a uint32 type in the schema for @settings.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.30
  */
 gboolean
@@ -1663,7 +1684,6 @@ g_settings_set_uint (GSettings   *settings,
  * g_settings_get_double:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: a double
  *
  * Gets the value that is stored at @key in @settings.
  *
@@ -1672,6 +1692,8 @@ g_settings_set_uint (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a 'double' type in the schema for @settings.
  *
+ * Returns: a double
+ *
  * Since: 2.26
  */
 gdouble
@@ -1693,8 +1715,6 @@ g_settings_get_double (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: the value to set it to
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1703,6 +1723,9 @@ g_settings_get_double (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a 'double' type in the schema for @settings.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -1717,7 +1740,6 @@ g_settings_set_double (GSettings   *settings,
  * g_settings_get_boolean:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: a boolean
  *
  * Gets the value that is stored at @key in @settings.
  *
@@ -1726,6 +1748,8 @@ g_settings_set_double (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a boolean type in the schema for @settings.
  *
+ * Returns: a boolean
+ *
  * Since: 2.26
  */
 gboolean
@@ -1747,8 +1771,6 @@ g_settings_get_boolean (GSettings  *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: the value to set it to
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1757,6 +1779,9 @@ g_settings_get_boolean (GSettings  *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having a boolean type in the schema for @settings.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -1771,15 +1796,16 @@ g_settings_set_boolean (GSettings  *settings,
  * g_settings_get_strv:
  * @settings: a #GSettings object
  * @key: the key to get the value for
- * @returns: (array zero-terminated=1) (transfer full): a
- * newly-allocated, %NULL-terminated array of strings, the value that
- * is stored at @key in @settings.
  *
  * A convenience variant of g_settings_get() for string arrays.
  *
  * It is a programmer error to give a @key that isn't specified as
  * having an array of strings type in the schema for @settings.
  *
+ * Returns: (array zero-terminated=1) (transfer full): a
+ * newly-allocated, %NULL-terminated array of strings, the value that
+ * is stored at @key in @settings.
+ *
  * Since: 2.26
  */
 gchar **
@@ -1801,8 +1827,6 @@ g_settings_get_strv (GSettings   *settings,
  * @settings: a #GSettings object
  * @key: the name of the key to set
  * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
- * @returns: %TRUE if setting the key succeeded,
- *     %FALSE if the key was not writable
  *
  * Sets @key in @settings to @value.
  *
@@ -1812,6 +1836,9 @@ g_settings_get_strv (GSettings   *settings,
  * It is a programmer error to give a @key that isn't specified as
  * having an array of strings type in the schema for @settings.
  *
+ * Returns: %TRUE if setting the key succeeded,
+ *     %FALSE if the key was not writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -1910,11 +1937,12 @@ g_settings_revert (GSettings *settings)
 /**
  * g_settings_get_has_unapplied:
  * @settings: a #GSettings object
- * @returns: %TRUE if @settings has unapplied changes
  *
  * Returns whether the #GSettings object has any unapplied
  * changes.  This can only be the case if it is in 'delayed-apply' mode.
  *
+ * Returns: %TRUE if @settings has unapplied changes
+ *
  * Since: 2.26
  */
 gboolean
@@ -1975,10 +2003,11 @@ g_settings_sync (void)
  * g_settings_is_writable:
  * @settings: a #GSettings object
  * @name: the name of a key
- * @returns: %TRUE if the key @name is writable
  *
  * Finds out if a key can be written or not
  *
+ * Returns: %TRUE if the key @name is writable
+ *
  * Since: 2.26
  */
 gboolean
@@ -2001,7 +2030,6 @@ g_settings_is_writable (GSettings   *settings,
  * g_settings_get_child:
  * @settings: a #GSettings object
  * @name: the name of the 'child' schema
- * @returns: (transfer full): a 'child' settings object
  *
  * Creates a 'child' settings object which has a base path of
  * <replaceable>base-path</replaceable>/@name, where
@@ -2010,6 +2038,8 @@ g_settings_is_writable (GSettings   *settings,
  * The schema for the child settings object must have been declared
  * in the schema of @settings using a <tag class="starttag">child</tag> element.
  *
+ * Returns: (transfer full): a 'child' settings object
+ *
  * Since: 2.26
  */
 GSettings *
@@ -2044,7 +2074,6 @@ g_settings_get_child (GSettings   *settings,
 /**
  * g_settings_list_keys:
  * @settings: a #GSettings object
- * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
  *
  * Introspects the list of keys on @settings.
  *
@@ -2054,6 +2083,8 @@ g_settings_get_child (GSettings   *settings,
  *
  * You should free the return value with g_strfreev() when you are done
  * with it.
+ *
+ * Returns: (transfer full) (element-type utf8): a list of the keys on @settings
  */
 gchar **
 g_settings_list_keys (GSettings *settings)
@@ -2080,7 +2111,6 @@ g_settings_list_keys (GSettings *settings)
 /**
  * g_settings_list_children:
  * @settings: a #GSettings object
- * @returns: (transfer full) (element-type utf8): a list of the children on @settings
  *
  * Gets the list of children on @settings.
  *
@@ -2101,6 +2131,8 @@ g_settings_list_keys (GSettings *settings)
  *
  * You should free the return value with g_strfreev() when you are done
  * with it.
+ *
+ * Returns: (transfer full) (element-type utf8): a list of the children on @settings
  */
 gchar **
 g_settings_list_children (GSettings *settings)
@@ -2134,7 +2166,6 @@ g_settings_list_children (GSettings *settings)
  * g_settings_get_range:
  * @settings: a #GSettings
  * @key: the key to query the range of
- * @returns: a #GVariant describing the range
  *
  * Queries the range of a key.
  *
@@ -2179,6 +2210,8 @@ g_settings_list_children (GSettings *settings)
  * You should free the returned value with g_variant_unref() when it is
  * no longer needed.
  *
+ * Returns: a #GVariant describing the range
+ *
  * Since: 2.28
  **/
 GVariant *
@@ -2217,7 +2250,6 @@ g_settings_get_range (GSettings   *settings,
  * @settings: a #GSettings
  * @key: the key to check
  * @value: the value to check
- * @returns: %TRUE if @value is valid for @key
  *
  * Checks if the given @value is of the correct type and within the
  * permitted range for @key.
@@ -2229,6 +2261,8 @@ g_settings_get_range (GSettings   *settings,
  * It is a programmer error to give a @key that isn't contained in the
  * schema for @settings.
  *
+ * Returns: %TRUE if @value is valid for @key
+ *
  * Since: 2.28
  **/
 gboolean
index 0c26db5..80b9990 100644 (file)
@@ -166,11 +166,12 @@ void                    g_settings_sync                                 (void);
  * @value: a #GValue containing the property value to map
  * @expected_type: the #GVariantType to create
  * @user_data: user data that was specified when the binding was created
- * @returns: a new #GVariant holding the data from @value,
- *     or %NULL in case of an error
  *
  * The type for the function that is used to convert an object property
  * value to a #GVariant for storing it in #GSettings.
+ *
+ * Returns: a new #GVariant holding the data from @value,
+ *     or %NULL in case of an error
  */
 typedef GVariant *    (*GSettingsBindSetMapping)                        (const GValue       *value,
                                                                          const GVariantType *expected_type,
@@ -181,11 +182,12 @@ typedef GVariant *    (*GSettingsBindSetMapping)                        (const G
  * @value: return location for the property value
  * @variant: the #GVariant
  * @user_data: user data that was specified when the binding was created
- * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
  *
  * The type for the function that is used to convert from #GSettings to
  * an object property. The @value is already initialized to hold values
  * of the appropriate type.
+ *
+ * Returns: %TRUE if the conversion succeeded, %FALSE in case of an error
  */
 typedef gboolean      (*GSettingsBindGetMapping)                        (GValue             *value,
                                                                          GVariant           *variant,
@@ -197,7 +199,6 @@ typedef gboolean      (*GSettingsBindGetMapping)                        (GValue
  * @result: (out): the result of the mapping
  * @user_data: (closure): the user data that was passed to
  * g_settings_get_mapped()
- * @returns: %TRUE if the conversion succeeded, %FALSE in case of an error
  *
  * The type of the function that is used to convert from a value stored
  * in a #GSettings to a value that is useful to the application.
@@ -209,6 +210,8 @@ typedef gboolean      (*GSettingsBindGetMapping)                        (GValue
  * If @value is %NULL then it means that the mapping function is being
  * given a "last chance" to successfully return a valid value.  %TRUE
  * must be returned in this case.
+ *
+ * Returns: %TRUE if the conversion succeeded, %FALSE in case of an error
  **/
 typedef gboolean      (*GSettingsGetMapping)                            (GVariant           *value,
                                                                          gpointer           *result,
index a170241..6ea88d2 100644 (file)
@@ -706,7 +706,6 @@ g_settings_backend_changed_tree (GSettingsBackend *backend,
  * @key: the key to read
  * @expected_type: a #GVariantType
  * @default_value: if the default value should be returned
- * @returns: the value that was read, or %NULL
  *
  * Reads a key. This call will never block.
  *
@@ -720,6 +719,8 @@ g_settings_backend_changed_tree (GSettingsBackend *backend,
  * If @default_value is %TRUE then this gets the default value from the
  * backend (ie: the one that the backend would contain if
  * g_settings_reset() were called).
+ *
+ * Returns: the value that was read, or %NULL
  */
 GVariant *
 g_settings_backend_read (GSettingsBackend   *backend,
@@ -747,7 +748,6 @@ g_settings_backend_read (GSettingsBackend   *backend,
  * @key: the name of the key
  * @value: a #GVariant value to write to this key
  * @origin_tag: the origin tag
- * @returns: %TRUE if the write succeeded, %FALSE if the key was not writable
  *
  * Writes exactly one key.
  *
@@ -760,6 +760,8 @@ g_settings_backend_read (GSettingsBackend   *backend,
  * to emit a second "changed" signal (either during this call, or later)
  * to indicate that the affected keys have suddenly "changed back" to their
  * old values.
+ *
+ * Returns: %TRUE if the write succeeded, %FALSE if the key was not writable
  */
 gboolean
 g_settings_backend_write (GSettingsBackend *backend,
@@ -826,7 +828,6 @@ g_settings_backend_reset (GSettingsBackend *backend,
  * g_settings_backend_get_writable:
  * @backend: a #GSettingsBackend implementation
  * @key: the name of a key
- * @returns: %TRUE if the key is writable
  *
  * Finds out if a key is available for writing to.  This is the
  * interface through which 'lockdown' is implemented.  Locked down
@@ -834,6 +835,8 @@ g_settings_backend_reset (GSettingsBackend *backend,
  *
  * You should not write to locked-down keys, but if you do, the
  * implementation will deal with it.
+ *
+ * Returns: %TRUE if the key is writable
  */
 gboolean
 g_settings_backend_get_writable (GSettingsBackend *backend,
@@ -922,11 +925,12 @@ g_settings_backend_variant_unref0 (gpointer data)
 
 /*< private >
  * g_settings_backend_create_tree:
- * @returns: a new #GTree
  *
  * This is a convenience function for creating a tree that is compatible
  * with g_settings_backend_write().  It merely calls g_tree_new_full()
  * with strcmp(), g_free() and g_variant_unref().
+ *
+ * Returns: a new #GTree
  */
 GTree *
 g_settings_backend_create_tree (void)
@@ -953,7 +957,6 @@ g_settings_backend_verify (gpointer impl)
 
 /**
  * g_settings_backend_get_default:
- * @returns: (transfer full): the default #GSettingsBackend
  *
  * Returns the default #GSettingsBackend. It is possible to override
  * the default by setting the <envar>GSETTINGS_BACKEND</envar>
@@ -961,6 +964,8 @@ g_settings_backend_verify (gpointer impl)
  *
  * The user gets a reference to the backend.
  *
+ * Returns: (transfer full): the default #GSettingsBackend
+ *
  * Since: 2.28
  */
 GSettingsBackend *
@@ -978,13 +983,14 @@ g_settings_backend_get_default (void)
  * g_settings_backend_get_permission:
  * @backend: a #GSettingsBackend
  * @path: a path
- * @returns: a non-%NULL #GPermission. Free with g_object_unref()
  *
  * Gets the permission object associated with writing to keys below
  * @path on @backend.
  *
  * If this is not implemented in the backend, then a %TRUE
  * #GSimplePermission is returned.
+ *
+ * Returns: a non-%NULL #GPermission. Free with g_object_unref()
  */
 GPermission *
 g_settings_backend_get_permission (GSettingsBackend *backend,