Commit b5bbf8ed authored by Marco Trevisan's avatar Marco Trevisan Committed by Thomas Haller

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

!94
(cherry picked from commit 73005fcf)
parent 7da44cf8
Pipeline #22751 canceled with stage
......@@ -1868,7 +1868,7 @@ nm_connection_clear_secrets (NMConnection *connection)
/**
* nm_connection_clear_secrets_with_flags:
* @connection: the #NMConnection
* @func: (scope call): (allow-none): function to be called to determine whether a
* @func: (scope call) (allow-none): function to be called to determine whether a
* specific secret should be cleared or not. If %NULL, all secrets are cleared.
* @user_data: caller-supplied data passed to @func
*
......@@ -2080,7 +2080,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.
*
......
......@@ -200,7 +200,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
......
......@@ -1125,7 +1125,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.
*
......
......@@ -204,7 +204,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.
*
......@@ -381,7 +381,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.
*
......
......@@ -278,7 +278,7 @@ nm_wireguard_peer_get_public_key (const NMWireGuardPeer *self)
/**
* nm_wireguard_peer_set_public_key:
* @self: the unsealed #NMWireGuardPeer instance
* @public_key: (allow-none): (transfer none): the new public
* @public_key: (allow-none) (transfer none): the new public
* key or %NULL to clear the public key.
*
* Reset the public key. Note that if the public key is valid, it
......@@ -344,7 +344,7 @@ nm_wireguard_peer_get_preshared_key (const NMWireGuardPeer *self)
/**
* nm_wireguard_peer_set_preshared_key:
* @self: the unsealed #NMWireGuardPeer instance
* @preshared_key: (allow-none): (transfer none): the new preshared
* @preshared_key: (allow-none) (transfer none): the new preshared
* key or %NULL to clear the preshared key.
*
* Reset the preshared key. Note that if the preshared key is valid, it
......@@ -1149,7 +1149,7 @@ nm_setting_wireguard_get_peer (NMSettingWireGuard *self,
* @self: the #NMSettingWireGuard instance
* @public_key: the public key for looking up the
* peer.
* @out_idx: (out): (allow-none): optional output argument
* @out_idx: (out) (allow-none): optional output argument
* for the index of the found peer. If no index is found,
* this is set to the nm_setting_wireguard_get_peers_len().
*
......
......@@ -2449,7 +2449,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
......
......@@ -3497,7 +3497,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.
......
......@@ -146,7 +146,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.
......
......@@ -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.
......
......@@ -1366,7 +1366,7 @@ nm_client_add_and_activate_connection2 (NMClient *client,
* @client: an #NMClient
* @result: the result passed to the #GAsyncReadyCallback
* @error: location for a #GError, or %NULL
* @out_result: (allow-none): (transfer full): the output result
* @out_result: (allow-none) (transfer full): the output result
* of type "a{sv}" returned by D-Bus' AddAndActivate2 call. Currently no
* output is implemented yet.
*
......
......@@ -2132,7 +2132,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
......@@ -2266,7 +2266,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
*
......
......@@ -2260,7 +2260,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
......
......@@ -1924,7 +1924,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
......
......@@ -2916,7 +2916,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
......@@ -4241,7 +4241,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.
......
......@@ -2519,10 +2519,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.
......
......@@ -373,7 +373,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
......
......@@ -799,7 +799,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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment