diff options
Diffstat (limited to 'docs/libnm-util/tmpl/nm-setting.sgml')
| -rw-r--r-- | docs/libnm-util/tmpl/nm-setting.sgml | 276 |
1 files changed, 276 insertions, 0 deletions
diff --git a/docs/libnm-util/tmpl/nm-setting.sgml b/docs/libnm-util/tmpl/nm-setting.sgml new file mode 100644 index 00000000..832a29c6 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting.sgml @@ -0,0 +1,276 @@ +<!-- ##### SECTION Title ##### --> +NMSetting + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### 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: + +<!-- ##### MACRO NM_TYPE_SETTING_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO NM_SETTING_PARAM_SERIALIZE ##### --> +<para> + +</para> + + + +<!-- ##### 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> + + + +<!-- ##### STRUCT NMSetting ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting:name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingClass ##### --> +<para> + +</para> + +@parent: +@verify: +@need_secrets: +@update_one_secret: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> +<para> + +</para> + +@setting: +@key: +@value: +@flags: +@user_data: + + +<!-- ##### FUNCTION nm_setting_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_to_hash ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_new_from_hash ##### --> +<para> + +</para> + +@setting_type: +@hash: +@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: +@all_settings: +@error: +@Returns: + + +<!-- ##### 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: + +<!-- ##### 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: + +<!-- ##### 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_clear_secrets ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_need_secrets ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_update_secrets ##### --> +<para> + +</para> + +@setting: +@secrets: +@error: +@Returns: + + |