system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-10-15 12:34:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

libnm: document to allow omitting argument to get-options functions

Browse source 
These functions return static information, and don't require
a @setting argument. The list of options is interesting even
when having now setting instance at hand.

Document this to promise the user that passing %NULL is allowed.

It was allowed since when those functions were added.
This commit is contained in:
Thomas Haller 2017-03-27 17:07:28 +02:00
parent a482fbe1b6
commit 1601d2caf6
2 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
libnm-core/nm-setting-bond.c
View file

@ -395,10 +395,12 @@ nm_setting_bond_remove_option (NMSettingBond *setting,
/**
* nm_setting_bond_get_valid_options:
* @setting: the #NMSettingBond
* @setting: (allow none): the #NMSettingBond
*
* Returns a list of valid bond options.
*
* The @setting argument is unused and may be passed as %NULL.
*
* Returns: (transfer none): a %NULL-terminated array of strings of valid bond options.
**/
const char **

4
libnm-core/nm-setting-wired.c
View file

@ -565,10 +565,12 @@ nm_setting_wired_remove_s390_option (NMSettingWired *setting,
/**
* nm_setting_wired_get_valid_s390_options:
* @setting: the #NMSettingWired
* @setting: (allow none): the #NMSettingWired
*
* Returns a list of valid s390 options.
*
* The @setting argument is unused and %NULL may be passed instead.
*
* Returns: (transfer none): a %NULL-terminated array of strings of valid s390 options.
**/
const char **