diff options
Diffstat (limited to 'docs/libnm/tmpl/nm-setting.sgml')
| -rw-r--r-- | docs/libnm/tmpl/nm-setting.sgml | 252 |
1 files changed, 252 insertions, 0 deletions
diff --git a/docs/libnm/tmpl/nm-setting.sgml b/docs/libnm/tmpl/nm-setting.sgml new file mode 100644 index 00000000..aec0ef91 --- /dev/null +++ b/docs/libnm/tmpl/nm-setting.sgml @@ -0,0 +1,252 @@ +<!-- ##### SECTION Title ##### --> +NMSetting + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO NM_SETTING_PARAM_REQUIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_SECRET ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_FUZZY_IGNORE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### ENUM NMSettingSecretFlags ##### --> +<para> + +</para> + +@NM_SETTING_SECRET_FLAG_NONE: +@NM_SETTING_SECRET_FLAG_AGENT_OWNED: +@NM_SETTING_SECRET_FLAG_NOT_SAVED: +@NM_SETTING_SECRET_FLAG_NOT_REQUIRED: + +<!-- ##### ENUM NMSettingCompareFlags ##### --> +<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: +@NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT: +@NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT: +@NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP: + +<!-- ##### STRUCT NMSetting ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting:name ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION NMSettingClearSecretsWithFlagsFn ##### --> +<para> + +</para> + +@setting: +@secret: +@flags: +@user_data: +@Returns: + + +<!-- ##### STRUCT NMSettingClass ##### --> +<para> + +</para> + +@parent: +@verify: +@need_secrets: +@update_one_secret: +@get_secret_flags: +@set_secret_flags: +@clear_secrets_with_flags: +@compare_property: + +<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> +<para> + +</para> + +@setting: +@key: +@value: +@flags: +@user_data: + + +<!-- ##### FUNCTION nm_setting_lookup_type ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION nm_setting_duplicate ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_name ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_verify ##### --> +<para> + +</para> + +@setting: +@connection: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_compare ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@Returns: + + +<!-- ##### ENUM NMSettingDiffResult ##### --> +<para> + +</para> + +@NM_SETTING_DIFF_RESULT_UNKNOWN: +@NM_SETTING_DIFF_RESULT_IN_A: +@NM_SETTING_DIFF_RESULT_IN_B: +@NM_SETTING_DIFF_RESULT_IN_A_DEFAULT: +@NM_SETTING_DIFF_RESULT_IN_B_DEFAULT: + +<!-- ##### FUNCTION nm_setting_diff ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@invert_results: +@results: +@Returns: + + +<!-- ##### FUNCTION nm_setting_enumerate_values ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_to_string ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_secret_flags ##### --> +<para> + +</para> + +@setting: +@secret_name: +@out_flags: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_set_secret_flags ##### --> +<para> + +</para> + +@setting: +@secret_name: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_dbus_property_type ##### --> +<para> + +</para> + +@setting: +@property_name: +@Returns: + + |