diff options
| author | Michael Biebl <biebl@debian.org> | 2011-11-12 01:36:14 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2011-11-12 01:36:14 +0100 |
| commit | b436a68a20ff3114ded32a7a3d70cdd4954039f9 (patch) | |
| tree | 3e7d6971c35b47b6e67604f54d434d909be0f228 /docs/libnm-util/tmpl/nm-setting.sgml | |
| parent | 485d149fe80915d94ed49ea6c2c0552cf7a3e79a (diff) | |
Imported Upstream version 0.9.2.0 upstream/0.9.2.0
Diffstat (limited to 'docs/libnm-util/tmpl/nm-setting.sgml')
| -rw-r--r-- | docs/libnm-util/tmpl/nm-setting.sgml | 323 |
1 files changed, 323 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..912a47c6 --- /dev/null +++ b/docs/libnm-util/tmpl/nm-setting.sgml @@ -0,0 +1,323 @@ +<!-- ##### SECTION Title ##### --> +NMSetting + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT NMSetting ##### --> +<para> + +</para> + + +<!-- ##### ARG NMSetting:name ##### --> +<para> + +</para> + +<!-- ##### STRUCT NMSettingClass ##### --> +<para> + +</para> + +@parent: +@verify: +@need_secrets: +@update_one_secret: +@get_secret_flags: +@set_secret_flags: +@compare_property: +@clear_secrets_with_flags: +@_reserved1: +@_reserved2: + +<!-- ##### USER_FUNCTION NMSettingClearSecretsWithFlagsFn ##### --> +<para> + +</para> + +@setting: +@secret: +@flags: +@user_data: +@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: +@NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS: +@NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS: + +<!-- ##### ENUM NMSettingDiffResult ##### --> +<para> + +</para> + +@NM_SETTING_DIFF_RESULT_UNKNOWN: +@NM_SETTING_DIFF_RESULT_IN_A: +@NM_SETTING_DIFF_RESULT_IN_B: + +<!-- ##### 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: + +<!-- ##### ENUM NMSettingHashFlags ##### --> +<para> + +</para> + +@NM_SETTING_HASH_FLAG_ALL: +@NM_SETTING_HASH_FLAG_NO_SECRETS: +@NM_SETTING_HASH_FLAG_ONLY_SECRETS: + +<!-- ##### 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: + +<!-- ##### USER_FUNCTION NMSettingValueIterFn ##### --> +<para> + +</para> + +@setting: +@key: +@value: +@flags: +@user_data: + + +<!-- ##### MACRO NM_SETTING_NAME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_FUZZY_IGNORE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_REQUIRED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_SECRET ##### --> +<para> + +</para> + + + +<!-- ##### MACRO NM_SETTING_PARAM_SERIALIZE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION nm_setting_clear_secrets ##### --> +<para> + +</para> + +@setting: + + +<!-- ##### FUNCTION nm_setting_clear_secrets_with_flags ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_compare ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@Returns: + + +<!-- ##### FUNCTION nm_setting_diff ##### --> +<para> + +</para> + +@a: +@b: +@flags: +@invert_results: +@results: +@Returns: + + +<!-- ##### FUNCTION nm_setting_duplicate ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_enumerate_values ##### --> +<para> + +</para> + +@setting: +@func: +@user_data: + + +<!-- ##### FUNCTION nm_setting_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_name ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_get_secret_flags ##### --> +<para> + +</para> + +@setting: +@secret_name: +@out_flags: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_need_secrets ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_new_from_hash ##### --> +<para> + +</para> + +@setting_type: +@hash: +@Returns: + + +<!-- ##### FUNCTION nm_setting_set_secret_flags ##### --> +<para> + +</para> + +@setting: +@secret_name: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_to_hash ##### --> +<para> + +</para> + +@setting: +@flags: +@Returns: + + +<!-- ##### FUNCTION nm_setting_to_string ##### --> +<para> + +</para> + +@setting: +@Returns: + + +<!-- ##### FUNCTION nm_setting_update_secrets ##### --> +<para> + +</para> + +@setting: +@secrets: +@error: +@Returns: + + +<!-- ##### FUNCTION nm_setting_verify ##### --> +<para> + +</para> + +@setting: +@all_settings: +@error: +@Returns: + + |