mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-02-26 18:10:37 +01:00
doc: reorder gtkdoc annotations for consistancy
This commit is contained in:
parent
334b299d5c
commit
1725e3a3e8
6 changed files with 12 additions and 12 deletions
|
|
@ -4465,8 +4465,8 @@ nm_client_connectivity_check_get_uri(NMClient *client)
|
|||
/**
|
||||
* nm_client_get_logging:
|
||||
* @client: a #NMClient
|
||||
* @level: (nullable) (out) (optional): return location for logging level string
|
||||
* @domains: (nullable) (out) (optional): return location for log domains string. The string is
|
||||
* @level: (out) (optional) (nullable): return location for logging level string
|
||||
* @domains: (out) (optional) (nullable): return location for log domains string. The string is
|
||||
* a list of domains separated by ","
|
||||
* @error: return location for a #GError, or %NULL
|
||||
*
|
||||
|
|
@ -5402,7 +5402,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: (optional) (nullable) (transfer full) (out): the output result
|
||||
* @out_result: (out) (optional) (nullable) (transfer full): the output result
|
||||
* of type "a{sv}" returned by D-Bus' AddAndActivate2 call. Currently, no
|
||||
* output is implemented yet.
|
||||
*
|
||||
|
|
@ -5875,7 +5875,7 @@ nm_client_add_connection2(NMClient *client,
|
|||
* nm_client_add_connection2_finish:
|
||||
* @client: the #NMClient
|
||||
* @result: the #GAsyncResult
|
||||
* @out_result: (optional) (nullable) (transfer full) (out): the output
|
||||
* @out_result: (out) (optional) (nullable) (transfer full): the output
|
||||
* #GVariant from AddConnection2().
|
||||
* If you care about the output result, then the "ignore_out_result"
|
||||
* parameter of nm_client_add_connection2() must not be set to %TRUE.
|
||||
|
|
|
|||
|
|
@ -507,10 +507,10 @@ nm_setting_wired_get_num_s390_options(NMSettingWired *setting)
|
|||
* @setting: the #NMSettingWired
|
||||
* @idx: index of the desired option, from 0 to
|
||||
* nm_setting_wired_get_num_s390_options() - 1
|
||||
* @out_key: (optional) (nullable) (out) (transfer none): on return, the key
|
||||
* @out_key: (out) (optional) (nullable) (transfer none): on return, the key
|
||||
* name of the s390 specific option; this value is owned by the setting and
|
||||
* should not be modified
|
||||
* @out_value: (optional) (nullable) (out) (transfer none): on return, the value
|
||||
* @out_value: (out) (optional) (nullable) (transfer none): on return, the value
|
||||
* of the key of the s390 specific option; this value is owned by the setting
|
||||
* and should not be modified
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3937,7 +3937,7 @@ nm_setting_option_get(NMSetting *setting, const char *opt_name)
|
|||
* nm_setting_option_get_boolean:
|
||||
* @setting: the #NMSetting
|
||||
* @opt_name: the option to get
|
||||
* @out_value: (nullable) (out): the optional output value.
|
||||
* @out_value: (out) (nullable): the optional output value.
|
||||
* If the option is unset, %FALSE will be returned.
|
||||
*
|
||||
* Returns: %TRUE if @opt_name is set to a boolean variant.
|
||||
|
|
@ -3962,7 +3962,7 @@ nm_setting_option_get_boolean(NMSetting *setting, const char *opt_name, gboolean
|
|||
* nm_setting_option_get_uint32:
|
||||
* @setting: the #NMSetting
|
||||
* @opt_name: the option to get
|
||||
* @out_value: (nullable) (out): the optional output value.
|
||||
* @out_value: (out) (nullable): the optional output value.
|
||||
* If the option is unset, 0 will be returned.
|
||||
*
|
||||
* Returns: %TRUE if @opt_name is set to a uint32 variant.
|
||||
|
|
|
|||
|
|
@ -5333,7 +5333,7 @@ NM_UTILS_FLAGS2STR_DEFINE(nm_bluetooth_capability_to_string,
|
|||
* @base64_key: the (possibly invalid) base64 encode key.
|
||||
* @required_key_len: the expected (binary) length of the key after
|
||||
* decoding. If the length does not match, the validation fails.
|
||||
* @out_key: (optional): (out): an optional output buffer for the binary
|
||||
* @out_key: (out) (optional): an optional output buffer for the binary
|
||||
* key. If given, it will be filled with exactly @required_key_len
|
||||
* bytes.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -444,7 +444,7 @@ nm_utils_file_set_contents(const char *filename,
|
|||
/**
|
||||
* nm_utils_file_stat:
|
||||
* @filename: the filename to stat.
|
||||
* @out_st: (nullable) (out): if given, this will be passed to stat().
|
||||
* @out_st: (out) (nullable): if given, this will be passed to stat().
|
||||
*
|
||||
* Just wraps stat() and gives the errno number as function result instead
|
||||
* of setting the errno (though, errno is also set). It's only for convenience
|
||||
|
|
|
|||
|
|
@ -1764,10 +1764,10 @@ nm_utils_escaped_tokens_escape_full(const char *str,
|
|||
* nm_utils_escaped_tokens_options_split:
|
||||
* @str: the src string. This string will be modified in-place.
|
||||
* The output values will point into @str.
|
||||
* @out_key: (nullable) (out): the returned output key. This will always be set
|
||||
* @out_key: (out) (nullable): the returned output key. This will always be set
|
||||
* to @str itself. @str will be modified to contain only the unescaped,
|
||||
* truncated key name.
|
||||
* @out_val: (nullable) (out): returns the parsed (and unescaped) value or
|
||||
* @out_val: (out) (nullable): returns the parsed (and unescaped) value or
|
||||
* %NULL, if @str contains no '=' delimiter.
|
||||
*
|
||||
* Honors backslash escaping to parse @str as "key=value" pairs. Optionally, if no '='
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue