diff options
Diffstat (limited to 'docs/libnm-util/tmpl/nm-setting.sgml')
| -rw-r--r-- | docs/libnm-util/tmpl/nm-setting.sgml | 214 |
1 files changed, 107 insertions, 107 deletions
diff --git a/docs/libnm-util/tmpl/nm-setting.sgml b/docs/libnm-util/tmpl/nm-setting.sgml index 2067408a..d5df34e5 100644 --- a/docs/libnm-util/tmpl/nm-setting.sgml +++ b/docs/libnm-util/tmpl/nm-setting.sgml @@ -22,84 +22,66 @@ NMSetting <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSetting ##### --> +<!-- ##### ENUM NMSettingError ##### --> <para> </para> +@NM_SETTING_ERROR_UNKNOWN: +@NM_SETTING_ERROR_PROPERTY_NOT_FOUND: +@NM_SETTING_ERROR_PROPERTY_NOT_SECRET: +@NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH: -<!-- ##### ARG NMSetting:name ##### --> +<!-- ##### MACRO NM_SETTING_ERROR ##### --> <para> </para> -<!-- ##### STRUCT NMSettingClass ##### --> + + +<!-- ##### FUNCTION nm_setting_error_quark ##### --> <para> </para> -@parent: -@verify: -@need_secrets: -@update_one_secret: -@get_secret_flags: -@set_secret_flags: -@compare_property: -@clear_secrets_with_flags: -@get_virtual_iface_name: -@_reserved1: +@void: +@Returns: -<!-- ##### USER_FUNCTION NMSettingClearSecretsWithFlagsFn ##### --> + +<!-- ##### MACRO NM_SETTING_PARAM_SERIALIZE ##### --> <para> </para> -@setting: -@secret: -@flags: -@user_data: -@Returns: -<!-- ##### ENUM NMSettingCompareFlags ##### --> +<!-- ##### MACRO NM_SETTING_PARAM_REQUIRED ##### --> <para> </para> -@NM_SETTING_COMPARE_FLAG_EXACT: -@NM_SETTING_COMPARE_FLAG_FUZZY: -@NM_SETTING_COMPARE_FLAG_IGNORE_ID: -@NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS: -@NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS: -@NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS: -<!-- ##### ENUM NMSettingDiffResult ##### --> + +<!-- ##### MACRO NM_SETTING_PARAM_SECRET ##### --> <para> </para> -@NM_SETTING_DIFF_RESULT_UNKNOWN: -@NM_SETTING_DIFF_RESULT_IN_A: -@NM_SETTING_DIFF_RESULT_IN_B: -<!-- ##### ENUM NMSettingError ##### --> + +<!-- ##### MACRO NM_SETTING_PARAM_FUZZY_IGNORE ##### --> <para> </para> -@NM_SETTING_ERROR_UNKNOWN: -@NM_SETTING_ERROR_PROPERTY_NOT_FOUND: -@NM_SETTING_ERROR_PROPERTY_NOT_SECRET: -@NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH: -<!-- ##### ENUM NMSettingHashFlags ##### --> + +<!-- ##### MACRO NM_SETTING_NAME ##### --> <para> </para> -@NM_SETTING_HASH_FLAG_ALL: -@NM_SETTING_HASH_FLAG_NO_SECRETS: -@NM_SETTING_HASH_FLAG_ONLY_SECRETS: + <!-- ##### ENUM NMSettingSecretFlags ##### --> <para> @@ -111,152 +93,171 @@ NMSetting @NM_SETTING_SECRET_FLAG_NOT_SAVED: @NM_SETTING_SECRET_FLAG_NOT_REQUIRED: -<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> +<!-- ##### ENUM NMSettingCompareFlags ##### --> <para> </para> -@setting: -@key: -@value: -@flags: -@user_data: - +@NM_SETTING_COMPARE_FLAG_EXACT: +@NM_SETTING_COMPARE_FLAG_FUZZY: +@NM_SETTING_COMPARE_FLAG_IGNORE_ID: +@NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS: +@NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS: +@NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS: -<!-- ##### MACRO NM_SETTING_ERROR ##### --> +<!-- ##### STRUCT NMSetting ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_NAME ##### --> +<!-- ##### ARG NMSetting:name ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_PARAM_FUZZY_IGNORE ##### --> +<!-- ##### USER_FUNCTION NMSettingClearSecretsWithFlagsFn ##### --> <para> </para> +@setting: +@secret: +@flags: +@user_data: +@Returns: -<!-- ##### MACRO NM_SETTING_PARAM_REQUIRED ##### --> +<!-- ##### STRUCT NMSettingClass ##### --> <para> </para> +@parent: +@verify: +@need_secrets: +@update_one_secret: +@get_secret_flags: +@set_secret_flags: +@compare_property: +@clear_secrets_with_flags: +@get_virtual_iface_name: +@_reserved1: - -<!-- ##### MACRO NM_SETTING_PARAM_SECRET ##### --> +<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> <para> </para> +@setting: +@key: +@value: +@flags: +@user_data: -<!-- ##### MACRO NM_SETTING_PARAM_SERIALIZE ##### --> +<!-- ##### ENUM NMSettingHashFlags ##### --> <para> </para> +@NM_SETTING_HASH_FLAG_ALL: +@NM_SETTING_HASH_FLAG_NO_SECRETS: +@NM_SETTING_HASH_FLAG_ONLY_SECRETS: - -<!-- ##### FUNCTION nm_setting_clear_secrets ##### --> +<!-- ##### FUNCTION nm_setting_to_hash ##### --> <para> </para> @setting: +@flags: +@Returns: -<!-- ##### FUNCTION nm_setting_clear_secrets_with_flags ##### --> +<!-- ##### FUNCTION nm_setting_new_from_hash ##### --> <para> </para> -@setting: -@func: -@user_data: +@setting_type: +@hash: +@Returns: -<!-- ##### FUNCTION nm_setting_compare ##### --> +<!-- ##### FUNCTION nm_setting_duplicate ##### --> <para> </para> -@a: -@b: -@flags: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_diff ##### --> +<!-- ##### FUNCTION nm_setting_get_name ##### --> <para> </para> -@a: -@b: -@flags: -@invert_results: -@results: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_duplicate ##### --> +<!-- ##### FUNCTION nm_setting_verify ##### --> <para> </para> @setting: +@all_settings: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_enumerate_values ##### --> +<!-- ##### FUNCTION nm_setting_compare ##### --> <para> </para> -@setting: -@func: -@user_data: +@a: +@b: +@flags: +@Returns: -<!-- ##### FUNCTION nm_setting_error_quark ##### --> +<!-- ##### ENUM NMSettingDiffResult ##### --> <para> </para> -@void: -@Returns: - +@NM_SETTING_DIFF_RESULT_UNKNOWN: +@NM_SETTING_DIFF_RESULT_IN_A: +@NM_SETTING_DIFF_RESULT_IN_B: -<!-- ##### FUNCTION nm_setting_get_name ##### --> +<!-- ##### FUNCTION nm_setting_diff ##### --> <para> </para> -@setting: +@a: +@b: +@flags: +@invert_results: +@results: @Returns: -<!-- ##### FUNCTION nm_setting_get_secret_flags ##### --> +<!-- ##### FUNCTION nm_setting_enumerate_values ##### --> <para> </para> @setting: -@secret_name: -@out_flags: -@error: -@Returns: +@func: +@user_data: -<!-- ##### FUNCTION nm_setting_get_virtual_iface_name ##### --> +<!-- ##### FUNCTION nm_setting_to_string ##### --> <para> </para> @@ -265,75 +266,74 @@ NMSetting @Returns: -<!-- ##### FUNCTION nm_setting_need_secrets ##### --> +<!-- ##### FUNCTION nm_setting_clear_secrets ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_new_from_hash ##### --> +<!-- ##### FUNCTION nm_setting_clear_secrets_with_flags ##### --> <para> </para> -@setting_type: -@hash: -@Returns: +@setting: +@func: +@user_data: -<!-- ##### FUNCTION nm_setting_set_secret_flags ##### --> +<!-- ##### FUNCTION nm_setting_need_secrets ##### --> <para> </para> @setting: -@secret_name: -@flags: -@error: @Returns: -<!-- ##### FUNCTION nm_setting_to_hash ##### --> +<!-- ##### FUNCTION nm_setting_update_secrets ##### --> <para> </para> @setting: -@flags: +@secrets: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_to_string ##### --> +<!-- ##### FUNCTION nm_setting_get_secret_flags ##### --> <para> </para> @setting: +@secret_name: +@out_flags: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_update_secrets ##### --> +<!-- ##### FUNCTION nm_setting_set_secret_flags ##### --> <para> </para> @setting: -@secrets: +@secret_name: +@flags: @error: @Returns: -<!-- ##### FUNCTION nm_setting_verify ##### --> +<!-- ##### FUNCTION nm_setting_get_virtual_iface_name ##### --> <para> </para> @setting: -@all_settings: -@error: @Returns: |