nm: Fix syntax on introspection annotations

Various annotations were added using multiple colons, while only one has
to be added or g-ir-introspect will consider them part of the description

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/merge_requests/94
(cherry picked from commit 73005fcf5b)
(cherry picked from commit b5bbf8edc2)
This commit is contained in:
Marco Trevisan (Treviño) 2019-03-06 20:04:50 +01:00 committed by Thomas Haller
parent 52f7e2d6d6
commit 3e24e328a6
15 changed files with 19 additions and 19 deletions

View file

@ -1939,7 +1939,7 @@ _for_each_sort (NMSetting **p_a, NMSetting **p_b, void *unused)
/**
* nm_connection_get_settings:
* @connection: the #NMConnection instance
* @out_length: (allow-none): (out): the length of the returned array
* @out_length: (allow-none) (out): the length of the returned array
*
* Retrieves the settings in @connection.
*

View file

@ -202,7 +202,7 @@ G_DEFINE_TYPE (NMSetting8021x, nm_setting_802_1x, NM_TYPE_SETTING)
* nm_setting_802_1x_check_cert_scheme:
* @pdata: (allow-none): the data pointer
* @length: the length of the data
* @error: (allow-none): (out): validation reason
* @error: (allow-none) (out): validation reason
*
* Determines and verifies the blob type.
* When setting certificate properties of NMSetting8021x

View file

@ -1123,7 +1123,7 @@ _nm_ip_route_get_attributes_direct (NMIPRoute *route)
* @route: the #NMIPRoute
* @sorted: whether to sort the names. Otherwise, their order is
* undefined and unstable.
* @out_length: (allow-none): (out): the number of elements
* @out_length: (allow-none) (out): the number of elements
*
* Gets an array of attribute names defined on @route.
*

View file

@ -218,7 +218,7 @@ nm_setting_vpn_get_data_item (NMSettingVpn *setting, const char *key)
/**
* nm_setting_vpn_get_data_keys:
* @setting: the #NMSettingVpn
* @out_length: (allow-none): (out): the length of the returned array
* @out_length: (allow-none) (out): the length of the returned array
*
* Retrieves every data key inside @setting, as an array.
*
@ -395,7 +395,7 @@ nm_setting_vpn_get_secret (NMSettingVpn *setting, const char *key)
/**
* nm_setting_vpn_get_secret_keys:
* @setting: the #NMSettingVpn
* @out_length: (allow-none): (out): the length of the returned array
* @out_length: (allow-none) (out): the length of the returned array
*
* Retrieves every secret key inside @setting, as an array.
*

View file

@ -2185,7 +2185,7 @@ out_zero:
/**
* nm_setting_gendata_get_all_names:
* @setting: the #NMSetting
* @out_len: (allow-none): (out):
* @out_len: (allow-none) (out):
*
* Gives the number of generic data elements and optionally returns all their
* key names and values. This API is low level access and unless you know what you

View file

@ -3243,7 +3243,7 @@ _nm_utils_check_module_file (const char *name,
* @predicate: (scope call): if given, pass the file name to this function
* for additional checks. This check is performed after the check for
* @file_test_flags. You cannot omit both @file_test_flags and @predicate.
* @user_data: (closure): (allow-none): user data for @predicate function.
* @user_data: (closure) (allow-none): user data for @predicate function.
* @error: (allow-none): on failure, set a "not found" error %G_IO_ERROR %G_IO_ERROR_NOT_FOUND.
*
* Searches for a @progname file in a list of search @paths.

View file

@ -148,7 +148,7 @@ nm_vpn_plugin_info_check_file_full (const char *filename,
* other users.
* @check_file: pass a callback to do your own validation.
* @user_data: user data for @check_file.
* @error: (allow-none): (out): the error reason if the check fails.
* @error: (allow-none) (out): the error reason if the check fails.
*
* Check whether the file exists and is a valid name file (in keyfile format).
* Additionally, also check for file permissions.

View file

@ -1736,7 +1736,7 @@ nm_utils_file_is_pkcs12 (const char *filename)
* @predicate: (scope call): if given, pass the file name to this function
* for additional checks. This check is performed after the check for
* @file_test_flags. You cannot omit both @file_test_flags and @predicate.
* @user_data: (closure): (allow-none): user data for @predicate function.
* @user_data: (closure) (allow-none): user data for @predicate function.
* @error: (allow-none): on failure, set a "not found" error %G_IO_ERROR %G_IO_ERROR_NOT_FOUND.
*
* Searches for a @progname file in a list of search @paths.

View file

@ -2059,7 +2059,7 @@ nm_device_reapply_finish (NMDevice *device,
* nm_device_get_applied_connection:
* @device: a #NMDevice
* @flags: the flags argument. Currently this value must always be zero.
* @version_id: (out): (allow-none): returns the current version id of
* @version_id: (out) (allow-none): returns the current version id of
* the applied connection
* @cancellable: a #GCancellable, or %NULL
* @error: location for a #GError, or %NULL
@ -2193,7 +2193,7 @@ nm_device_get_applied_connection_async (NMDevice *device,
* nm_device_get_applied_connection_finish:
* @device: a #NMDevice
* @result: the result passed to the #GAsyncReadyCallback
* @version_id: (out): (allow-none): the current version id of the applied
* @version_id: (out) (allow-none): the current version id of the applied
* connection.
* @error: location for a #GError, or %NULL
*

View file

@ -2258,7 +2258,7 @@ _add_route (NMIP4Config *self,
* nm_ip4_config_add_route:
* @self: the #NMIP4Config
* @new: the new route to add to @self
* @out_obj_new: (allow-none): (out): the added route object. Must be unrefed
* @out_obj_new: (allow-none) (out): the added route object. Must be unrefed
* by caller.
*
* Adds the new route to @self. If a route with the same basic properties

View file

@ -1922,7 +1922,7 @@ _add_route (NMIP6Config *self,
* nm_ip6_config_add_route:
* @self: the #NMIP6Config
* @new: the new route to add to @self
* @out_obj_new: (allow-none): (out): the added route object. Must be unrefed
* @out_obj_new: (allow-none) (out): the added route object. Must be unrefed
* by caller.
*
* Adds the new route to @self. If a route with the same basic properties

View file

@ -2859,7 +2859,7 @@ nm_platform_link_veth_get_properties (NMPlatform *self, int ifindex, int *out_pe
* nm_platform_link_tun_get_properties:
* @self: the #NMPlatform instance
* @ifindex: the ifindex to look up
* @out_properties: (out): (allow-none): return the read properties
* @out_properties: (out) (allow-none): return the read properties
*
* Only recent versions of kernel export tun properties via netlink.
* So, if that's the case, then we have the NMPlatformLnkTun instance
@ -4172,7 +4172,7 @@ nm_platform_ip_route_get_prune_list (NMPlatform *self,
* at the end of the operation. Note that if @routes contains
* the same route, then it will not be deleted. @routes overrules
* @routes_prune list.
* @out_temporary_not_available: (allow-none): (out): routes that could
* @out_temporary_not_available: (allow-none) (out): routes that could
* currently not be synced. The caller shall keep them and try later again.
*
* Returns: %TRUE on success.

View file

@ -2331,10 +2331,10 @@ nmp_cache_remove_netlink (NMPCache *cache,
* afterwards. Hence, during a dump, every update should move the object to the
* end of the list, to obtain the correct order. That means, to use NM_DEDUP_MULTI_IDX_MODE_APPEND_FORCE,
* instead of NM_DEDUP_MULTI_IDX_MODE_APPEND.
* @out_obj_old: (allow-none): (out): return the object with same ID as @obj_hand_over,
* @out_obj_old: (allow-none) (out): return the object with same ID as @obj_hand_over,
* that was in the cache before update. If an object is returned, the caller must
* unref it afterwards.
* @out_obj_new: (allow-none): (out): return the object from the cache after update.
* @out_obj_new: (allow-none) (out): return the object from the cache after update.
* The caller must unref this object.
*
* Returns: how the cache changed.

View file

@ -369,7 +369,7 @@ _clear_connections_cached_list (NMSettingsPrivate *priv)
/**
* nm_settings_get_connections:
* @self: the #NMSettings
* @out_len: (out): (allow-none): returns the number of returned
* @out_len: (out) (allow-none): returns the number of returned
* connections.
*
* Returns: (transfer-none): a list of NMSettingsConnections. The list is

View file

@ -801,7 +801,7 @@ enum {
* @options_route: (in-out): when line is from the OPTIONS setting, this is a pre-created
* route object that is completed with the settings from options. Otherwise,
* it shall point to %NULL and a new route is created and returned.
* @out_route: (out): (transfer-full): (allow-none): the parsed %NMIPRoute instance.
* @out_route: (out) (transfer-full) (allow-none): the parsed %NMIPRoute instance.
* In case a @options_route is passed in, it returns the input route that was modified
* in-place. But the caller must unref the returned route in either case.
* @error: the failure description.