diff options
Diffstat (limited to 'docs/libnm-util/tmpl')
26 files changed, 1997 insertions, 1987 deletions
diff --git a/docs/libnm-util/tmpl/nm-connection.sgml b/docs/libnm-util/tmpl/nm-connection.sgml index f6a97532..e8491ee1 100644 --- a/docs/libnm-util/tmpl/nm-connection.sgml +++ b/docs/libnm-util/tmpl/nm-connection.sgml @@ -22,99 +22,98 @@ NMConnection <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMConnection ##### --> +<!-- ##### ENUM NMConnectionError ##### --> <para> </para> +@NM_CONNECTION_ERROR_UNKNOWN: +@NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND: +@NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID: +@NM_CONNECTION_ERROR_SETTING_NOT_FOUND: -<!-- ##### SIGNAL NMConnection::secrets-cleared ##### --> +<!-- ##### MACRO NM_CONNECTION_ERROR ##### --> <para> </para> -@nmconnection: the object which received the signal. -<!-- ##### SIGNAL NMConnection::secrets-updated ##### --> + +<!-- ##### FUNCTION nm_connection_error_quark ##### --> <para> </para> -@nmconnection: the object which received the signal. -@arg1: +@void: +@Returns: -<!-- ##### ARG NMConnection:path ##### --> + +<!-- ##### MACRO NM_CONNECTION_PATH ##### --> <para> </para> -<!-- ##### STRUCT NMConnectionClass ##### --> + + +<!-- ##### STRUCT NMConnection ##### --> <para> </para> -@parent: -@secrets_updated: -<!-- ##### ENUM NMConnectionError ##### --> +<!-- ##### SIGNAL NMConnection::secrets-cleared ##### --> <para> </para> -@NM_CONNECTION_ERROR_UNKNOWN: -@NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND: -@NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID: -@NM_CONNECTION_ERROR_SETTING_NOT_FOUND: +@nmconnection: the object which received the signal. -<!-- ##### MACRO NM_CONNECTION_ERROR ##### --> +<!-- ##### SIGNAL NMConnection::secrets-updated ##### --> <para> </para> +@nmconnection: the object which received the signal. +@arg1: - -<!-- ##### MACRO NM_CONNECTION_PATH ##### --> +<!-- ##### ARG NMConnection:path ##### --> <para> </para> - - -<!-- ##### FUNCTION nm_connection_add_setting ##### --> +<!-- ##### STRUCT NMConnectionClass ##### --> <para> </para> -@connection: -@setting: - +@parent: +@secrets_updated: -<!-- ##### FUNCTION nm_connection_clear_secrets ##### --> +<!-- ##### FUNCTION nm_connection_new ##### --> <para> </para> -@connection: +@void: +@Returns: -<!-- ##### FUNCTION nm_connection_clear_secrets_with_flags ##### --> +<!-- ##### FUNCTION nm_connection_new_from_hash ##### --> <para> </para> -@connection: -@func: -@user_data: +@hash: +@error: +@Returns: -<!-- ##### FUNCTION nm_connection_compare ##### --> +<!-- ##### FUNCTION nm_connection_duplicate ##### --> <para> </para> -@a: -@b: -@flags: +@connection: @Returns: @@ -127,128 +126,138 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_diff ##### --> +<!-- ##### FUNCTION nm_connection_add_setting ##### --> <para> </para> -@a: -@b: -@flags: -@out_settings: -@Returns: +@connection: +@setting: -<!-- ##### FUNCTION nm_connection_dump ##### --> +<!-- ##### FUNCTION nm_connection_remove_setting ##### --> <para> </para> @connection: +@setting_type: -<!-- ##### FUNCTION nm_connection_duplicate ##### --> +<!-- ##### FUNCTION nm_connection_get_setting ##### --> <para> </para> @connection: +@setting_type: @Returns: -<!-- ##### FUNCTION nm_connection_error_quark ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_by_name ##### --> <para> </para> -@void: +@connection: +@name: @Returns: -<!-- ##### FUNCTION nm_connection_for_each_setting_value ##### --> +<!-- ##### FUNCTION nm_connection_replace_settings ##### --> <para> </para> @connection: -@func: -@user_data: +@new_settings: +@error: +@Returns: -<!-- ##### FUNCTION nm_connection_get_id ##### --> +<!-- ##### FUNCTION nm_connection_compare ##### --> <para> </para> -@connection: +@a: +@b: +@flags: @Returns: -<!-- ##### FUNCTION nm_connection_get_path ##### --> +<!-- ##### FUNCTION nm_connection_diff ##### --> <para> </para> -@connection: +@a: +@b: +@flags: +@out_settings: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting ##### --> +<!-- ##### FUNCTION nm_connection_verify ##### --> <para> </para> @connection: -@setting_type: +@error: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_802_1x ##### --> +<!-- ##### FUNCTION nm_connection_need_secrets ##### --> <para> </para> @connection: +@hints: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_adsl ##### --> +<!-- ##### FUNCTION nm_connection_clear_secrets ##### --> <para> </para> @connection: -@Returns: -<!-- ##### FUNCTION nm_connection_get_setting_bluetooth ##### --> +<!-- ##### FUNCTION nm_connection_clear_secrets_with_flags ##### --> <para> </para> @connection: -@Returns: +@func: +@user_data: -<!-- ##### FUNCTION nm_connection_get_setting_bond ##### --> +<!-- ##### FUNCTION nm_connection_update_secrets ##### --> <para> </para> @connection: +@setting_name: +@secrets: +@error: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_bridge ##### --> +<!-- ##### FUNCTION nm_connection_set_path ##### --> <para> </para> @connection: -@Returns: +@path: -<!-- ##### FUNCTION nm_connection_get_setting_bridge_port ##### --> +<!-- ##### FUNCTION nm_connection_get_path ##### --> <para> </para> @@ -257,71 +266,72 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_by_name ##### --> +<!-- ##### FUNCTION nm_connection_get_virtual_iface_name ##### --> <para> </para> @connection: -@name: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_cdma ##### --> +<!-- ##### FUNCTION nm_connection_is_type ##### --> <para> </para> @connection: +@type: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_connection ##### --> +<!-- ##### FUNCTION nm_connection_for_each_setting_value ##### --> <para> </para> @connection: -@Returns: +@func: +@user_data: -<!-- ##### FUNCTION nm_connection_get_setting_gsm ##### --> +<!-- ##### FUNCTION nm_connection_to_hash ##### --> <para> </para> @connection: +@flags: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_infiniband ##### --> +<!-- ##### FUNCTION nm_connection_dump ##### --> <para> </para> @connection: -@Returns: -<!-- ##### FUNCTION nm_connection_get_setting_ip4_config ##### --> +<!-- ##### FUNCTION nm_connection_lookup_setting_type ##### --> <para> </para> -@connection: +@name: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_ip6_config ##### --> +<!-- ##### FUNCTION nm_connection_lookup_setting_type_by_quark ##### --> <para> </para> -@connection: +@error_quark: @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_olpc_mesh ##### --> +<!-- ##### FUNCTION nm_connection_get_uuid ##### --> <para> </para> @@ -330,7 +340,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_ppp ##### --> +<!-- ##### FUNCTION nm_connection_get_id ##### --> <para> </para> @@ -339,7 +349,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_pppoe ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_802_1x ##### --> <para> </para> @@ -348,7 +358,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_serial ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_bluetooth ##### --> <para> </para> @@ -357,7 +367,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_vlan ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_bond ##### --> <para> </para> @@ -366,7 +376,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_vpn ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_bridge ##### --> <para> </para> @@ -375,7 +385,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_wimax ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_bridge_port ##### --> <para> </para> @@ -384,7 +394,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_wired ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_cdma ##### --> <para> </para> @@ -393,7 +403,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_wireless ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_connection ##### --> <para> </para> @@ -402,7 +412,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_setting_wireless_security ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_gsm ##### --> <para> </para> @@ -411,7 +421,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_uuid ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_infiniband ##### --> <para> </para> @@ -420,7 +430,7 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_get_virtual_iface_name ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_ip4_config ##### --> <para> </para> @@ -429,121 +439,111 @@ NMConnection @Returns: -<!-- ##### FUNCTION nm_connection_is_type ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_ip6_config ##### --> <para> </para> @connection: -@type: @Returns: -<!-- ##### FUNCTION nm_connection_lookup_setting_type ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_olpc_mesh ##### --> <para> </para> -@name: +@connection: @Returns: -<!-- ##### FUNCTION nm_connection_lookup_setting_type_by_quark ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_ppp ##### --> <para> </para> -@error_quark: +@connection: @Returns: -<!-- ##### FUNCTION nm_connection_need_secrets ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_pppoe ##### --> <para> </para> @connection: -@hints: @Returns: -<!-- ##### FUNCTION nm_connection_new ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_serial ##### --> <para> </para> -@void: +@connection: @Returns: -<!-- ##### FUNCTION nm_connection_new_from_hash ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_vpn ##### --> <para> </para> -@hash: -@error: +@connection: @Returns: -<!-- ##### FUNCTION nm_connection_remove_setting ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_wimax ##### --> <para> </para> @connection: -@setting_type: +@Returns: -<!-- ##### FUNCTION nm_connection_replace_settings ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_adsl ##### --> <para> </para> @connection: -@new_settings: -@error: @Returns: -<!-- ##### FUNCTION nm_connection_set_path ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_wired ##### --> <para> </para> @connection: -@path: +@Returns: -<!-- ##### FUNCTION nm_connection_to_hash ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_wireless ##### --> <para> </para> @connection: -@flags: @Returns: -<!-- ##### FUNCTION nm_connection_update_secrets ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_wireless_security ##### --> <para> </para> @connection: -@setting_name: -@secrets: -@error: @Returns: -<!-- ##### FUNCTION nm_connection_verify ##### --> +<!-- ##### FUNCTION nm_connection_get_setting_vlan ##### --> <para> </para> @connection: -@error: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-8021x.sgml b/docs/libnm-util/tmpl/nm-setting-8021x.sgml index f8ab2c77..881d2e94 100644 --- a/docs/libnm-util/tmpl/nm-setting-8021x.sgml +++ b/docs/libnm-util/tmpl/nm-setting-8021x.sgml @@ -22,509 +22,519 @@ NMSetting8021x <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSetting8021x ##### --> +<!-- ##### ENUM NMSetting8021xCKFormat ##### --> <para> </para> +@NM_SETTING_802_1X_CK_FORMAT_UNKNOWN: +@NM_SETTING_802_1X_CK_FORMAT_X509: +@NM_SETTING_802_1X_CK_FORMAT_RAW_KEY: +@NM_SETTING_802_1X_CK_FORMAT_PKCS12: -<!-- ##### ARG NMSetting8021x:altsubject-matches ##### --> +<!-- ##### ENUM NMSetting8021xCKScheme ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:anonymous-identity ##### --> +@NM_SETTING_802_1X_CK_SCHEME_UNKNOWN: +@NM_SETTING_802_1X_CK_SCHEME_BLOB: +@NM_SETTING_802_1X_CK_SCHEME_PATH: + +<!-- ##### MACRO NM_SETTING_802_1X_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:ca-cert ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:ca-path ##### --> +<!-- ##### ENUM NMSetting8021xError ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:client-cert ##### --> +@NM_SETTING_802_1X_ERROR_UNKNOWN: +@NM_SETTING_802_1X_ERROR_INVALID_PROPERTY: +@NM_SETTING_802_1X_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_802_1X_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:eap ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:identity ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:pac-file ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSetting8021x:password ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_EAP ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:password-flags ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:password-raw ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_IDENTITY ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:password-raw-flags ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase1-fast-provisioning ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_ANONYMOUS_IDENTITY ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:phase1-peaplabel ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase1-peapver ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PAC_FILE ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:phase2-altsubject-matches ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase2-auth ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_CA_CERT ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:phase2-autheap ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase2-ca-cert ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_CA_PATH ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:phase2-ca-path ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase2-client-cert ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_SUBJECT_MATCH ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:phase2-private-key ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase2-private-key-password ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_ALTSUBJECT_MATCHES ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:phase2-private-key-password-flags ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:phase2-subject-match ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_CLIENT_CERT ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:private-key ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:private-key-password ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_PEAPVER ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:private-key-password-flags ##### --> -<para> -</para> -<!-- ##### ARG NMSetting8021x:subject-match ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_PEAPLABEL ##### --> <para> </para> -<!-- ##### ARG NMSetting8021x:system-ca-certs ##### --> -<para> -</para> -<!-- ##### ENUM NMSetting8021xCKFormat ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING ##### --> <para> </para> -@NM_SETTING_802_1X_CK_FORMAT_UNKNOWN: -@NM_SETTING_802_1X_CK_FORMAT_X509: -@NM_SETTING_802_1X_CK_FORMAT_RAW_KEY: -@NM_SETTING_802_1X_CK_FORMAT_PKCS12: -<!-- ##### ENUM NMSetting8021xCKScheme ##### --> + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_AUTH ##### --> <para> </para> -@NM_SETTING_802_1X_CK_SCHEME_UNKNOWN: -@NM_SETTING_802_1X_CK_SCHEME_BLOB: -@NM_SETTING_802_1X_CK_SCHEME_PATH: -<!-- ##### STRUCT NMSetting8021xClass ##### --> + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_AUTHEAP ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSetting8021xError ##### --> + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_CERT ##### --> <para> </para> -@NM_SETTING_802_1X_ERROR_UNKNOWN: -@NM_SETTING_802_1X_ERROR_INVALID_PROPERTY: -@NM_SETTING_802_1X_ERROR_MISSING_PROPERTY: -<!-- ##### MACRO NM_SETTING_802_1X_ALTSUBJECT_MATCHES ##### --> + +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_PATH ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_ANONYMOUS_IDENTITY ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_CA_CERT ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_CA_PATH ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CLIENT_CERT ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_CLIENT_CERT ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_EAP ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_RAW ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_IDENTITY ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_RAW_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PAC_FILE ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_FLAGS ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_RAW ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PASSWORD_RAW_FLAGS ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_PEAPLABEL ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PIN ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE1_PEAPVER ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_PIN_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES ##### --> +<!-- ##### MACRO NM_SETTING_802_1X_SYSTEM_CA_CERTS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_AUTH ##### --> +<!-- ##### STRUCT NMSetting8021x ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_AUTHEAP ##### --> +<!-- ##### ARG NMSetting8021x:altsubject-matches ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:anonymous-identity ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_CERT ##### --> +<!-- ##### ARG NMSetting8021x:ca-cert ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:ca-path ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CA_PATH ##### --> +<!-- ##### ARG NMSetting8021x:client-cert ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:eap ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_CLIENT_CERT ##### --> +<!-- ##### ARG NMSetting8021x:identity ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:pac-file ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY ##### --> +<!-- ##### ARG NMSetting8021x:password ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:password-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD ##### --> +<!-- ##### ARG NMSetting8021x:password-raw ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:password-raw-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS ##### --> +<!-- ##### ARG NMSetting8021x:phase1-fast-provisioning ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:phase1-peaplabel ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH ##### --> +<!-- ##### ARG NMSetting8021x:phase1-peapver ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:phase2-altsubject-matches ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PIN ##### --> +<!-- ##### ARG NMSetting8021x:phase2-auth ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:phase2-autheap ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PIN_FLAGS ##### --> +<!-- ##### ARG NMSetting8021x:phase2-ca-cert ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:phase2-ca-path ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY ##### --> +<!-- ##### ARG NMSetting8021x:phase2-client-cert ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:phase2-private-key ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD ##### --> +<!-- ##### ARG NMSetting8021x:phase2-private-key-password ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:phase2-private-key-password-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS ##### --> +<!-- ##### ARG NMSetting8021x:phase2-subject-match ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:pin ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_SETTING_NAME ##### --> +<!-- ##### ARG NMSetting8021x:pin-flags ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:private-key ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_SUBJECT_MATCH ##### --> +<!-- ##### ARG NMSetting8021x:private-key-password ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:private-key-password-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_802_1X_SYSTEM_CA_CERTS ##### --> +<!-- ##### ARG NMSetting8021x:subject-match ##### --> <para> </para> +<!-- ##### ARG NMSetting8021x:system-ca-certs ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_802_1x_add_altsubject_match ##### --> +<!-- ##### STRUCT NMSetting8021xClass ##### --> <para> </para> -@setting: -@altsubject_match: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_802_1x_add_eap_method ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_new ##### --> <para> </para> -@setting: -@eap: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_add_phase2_altsubject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_num_eap_methods ##### --> <para> </para> @setting: -@phase2_altsubject_match: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_clear_altsubject_matches ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_eap_method ##### --> <para> </para> @setting: +@i: +@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_clear_eap_methods ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_add_eap_method ##### --> <para> </para> @setting: +@eap: +@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_clear_phase2_altsubject_matches ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_remove_eap_method ##### --> <para> </para> @setting: +@i: -<!-- ##### FUNCTION nm_setting_802_1x_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_clear_eap_methods ##### --> <para> </para> -@void: -@Returns: +@setting: -<!-- ##### FUNCTION nm_setting_802_1x_get_altsubject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_identity ##### --> <para> </para> @setting: -@i: @Returns: @@ -537,7 +547,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_blob ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_pac_file ##### --> <para> </para> @@ -546,7 +556,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_system_ca_certs ##### --> <para> </para> @@ -555,7 +565,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_scheme ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_path ##### --> <para> </para> @@ -564,7 +574,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_ca_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_path ##### --> <para> </para> @@ -573,7 +583,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_blob ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_scheme ##### --> <para> </para> @@ -582,7 +592,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_blob ##### --> <para> </para> @@ -591,7 +601,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_scheme ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_ca_cert_path ##### --> <para> </para> @@ -600,17 +610,20 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_eap_method ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_set_ca_cert ##### --> <para> </para> @setting: -@i: +@cert_path: +@scheme: +@out_format: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_identity ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_subject_match ##### --> <para> </para> @@ -628,43 +641,44 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_num_eap_methods ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_altsubject_match ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_num_phase2_altsubject_matches ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_add_altsubject_match ##### --> <para> </para> @setting: +@altsubject_match: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_pac_file ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_remove_altsubject_match ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_802_1x_get_password ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_clear_altsubject_matches ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_scheme ##### --> <para> </para> @@ -673,7 +687,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_password_raw ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_blob ##### --> <para> </para> @@ -682,7 +696,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_password_raw_flags ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_client_cert_path ##### --> <para> </para> @@ -691,16 +705,20 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_fast_provisioning ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_set_client_cert ##### --> <para> </para> @setting: +@cert_path: +@scheme: +@out_format: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_peaplabel ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_peapver ##### --> <para> </para> @@ -709,7 +727,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_peapver ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_peaplabel ##### --> <para> </para> @@ -718,13 +736,12 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_altsubject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase1_fast_provisioning ##### --> <para> </para> @setting: -@i: @Returns: @@ -746,7 +763,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_blob ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_scheme ##### --> <para> </para> @@ -755,7 +772,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_blob ##### --> <para> </para> @@ -764,7 +781,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_scheme ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_cert_path ##### --> <para> </para> @@ -773,16 +790,20 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_ca_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_ca_cert ##### --> <para> </para> @setting: +@cert_path: +@scheme: +@out_format: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_blob ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_subject_match ##### --> <para> </para> @@ -791,7 +812,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_num_phase2_altsubject_matches ##### --> <para> </para> @@ -800,43 +821,44 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_scheme ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_altsubject_match ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_blob ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_add_phase2_altsubject_match ##### --> <para> </para> @setting: +@phase2_altsubject_match: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_format ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_remove_phase2_altsubject_match ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_password ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_clear_phase2_altsubject_matches ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_scheme ##### --> <para> </para> @@ -845,7 +867,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_blob ##### --> <para> </para> @@ -854,7 +876,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_scheme ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_client_cert_path ##### --> <para> </para> @@ -863,16 +885,20 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_subject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_client_cert ##### --> <para> </para> @setting: +@cert_path: +@scheme: +@out_format: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_pin ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_password ##### --> <para> </para> @@ -881,7 +907,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_pin_flags ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_password_flags ##### --> <para> </para> @@ -890,7 +916,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_blob ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_password_raw ##### --> <para> </para> @@ -899,7 +925,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_format ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_password_raw_flags ##### --> <para> </para> @@ -908,7 +934,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_password ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_pin ##### --> <para> </para> @@ -917,7 +943,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_pin_flags ##### --> <para> </para> @@ -926,7 +952,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_path ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_scheme ##### --> <para> </para> @@ -935,7 +961,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_scheme ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_blob ##### --> <para> </para> @@ -944,7 +970,7 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_subject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_path ##### --> <para> </para> @@ -953,128 +979,112 @@ NMSetting8021x @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_get_system_ca_certs ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_set_private_key ##### --> <para> </para> @setting: +@key_path: +@password: +@scheme: +@out_format: +@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_new ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_password ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_remove_altsubject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_password_flags ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_remove_eap_method ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_private_key_format ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_remove_phase2_altsubject_match ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_scheme ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_802_1x_set_ca_cert ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_blob ##### --> <para> </para> @setting: -@cert_path: -@scheme: -@out_format: -@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_set_client_cert ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_path ##### --> <para> </para> @setting: -@cert_path: -@scheme: -@out_format: -@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_ca_cert ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_private_key ##### --> <para> </para> @setting: -@cert_path: +@key_path: +@password: @scheme: @out_format: @error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_client_cert ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_password ##### --> <para> </para> @setting: -@cert_path: -@scheme: -@out_format: -@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_set_phase2_private_key ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_password_flags ##### --> <para> </para> @setting: -@key_path: -@password: -@scheme: -@out_format: -@error: @Returns: -<!-- ##### FUNCTION nm_setting_802_1x_set_private_key ##### --> +<!-- ##### FUNCTION nm_setting_802_1x_get_phase2_private_key_format ##### --> <para> </para> @setting: -@key_path: -@password: -@scheme: -@out_format: -@error: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-adsl.sgml b/docs/libnm-util/tmpl/nm-setting-adsl.sgml index 0e209bc2..4b3716ef 100644 --- a/docs/libnm-util/tmpl/nm-setting-adsl.sgml +++ b/docs/libnm-util/tmpl/nm-setting-adsl.sgml @@ -22,110 +22,95 @@ NMSettingAdsl <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingAdsl ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingAdsl:encapsulation ##### --> -<para> -</para> - -<!-- ##### ARG NMSettingAdsl:password ##### --> +<!-- ##### ENUM NMSettingAdslError ##### --> <para> </para> -<!-- ##### ARG NMSettingAdsl:password-flags ##### --> -<para> - -</para> +@NM_SETTING_ADSL_ERROR_UNKNOWN: +@NM_SETTING_ADSL_ERROR_INVALID_PROPERTY: +@NM_SETTING_ADSL_ERROR_MISSING_PROPERTY: -<!-- ##### ARG NMSettingAdsl:protocol ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingAdsl:username ##### --> -<para> -</para> -<!-- ##### ARG NMSettingAdsl:vci ##### --> +<!-- ##### FUNCTION nm_setting_adsl_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingAdsl:vpi ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### STRUCT NMSettingAdslClass ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_USERNAME ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingAdslError ##### --> + +<!-- ##### MACRO NM_SETTING_ADSL_PASSWORD ##### --> <para> </para> -@NM_SETTING_ADSL_ERROR_UNKNOWN: -@NM_SETTING_ADSL_ERROR_INVALID_PROPERTY: -@NM_SETTING_ADSL_ERROR_MISSING_PROPERTY: -<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION ##### --> + +<!-- ##### MACRO NM_SETTING_ADSL_PASSWORD_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION_LLC ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION_VCMUX ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_VPI ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_PASSWORD ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_VCI ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_PASSWORD_FLAGS ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_PPPOA ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_PPPOE ##### --> <para> </para> @@ -139,67 +124,82 @@ NMSettingAdsl -<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_PPPOA ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION_VCMUX ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_PROTOCOL_PPPOE ##### --> +<!-- ##### MACRO NM_SETTING_ADSL_ENCAPSULATION_LLC ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_ADSL_SETTING_NAME ##### --> +<!-- ##### STRUCT NMSettingAdsl ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_ADSL_USERNAME ##### --> +<!-- ##### ARG NMSettingAdsl:encapsulation ##### --> <para> </para> +<!-- ##### ARG NMSettingAdsl:password ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_ADSL_VCI ##### --> +<!-- ##### ARG NMSettingAdsl:password-flags ##### --> <para> </para> +<!-- ##### ARG NMSettingAdsl:protocol ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_ADSL_VPI ##### --> +<!-- ##### ARG NMSettingAdsl:username ##### --> <para> </para> +<!-- ##### ARG NMSettingAdsl:vci ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_adsl_error_quark ##### --> +<!-- ##### ARG NMSettingAdsl:vpi ##### --> <para> </para> -@void: -@Returns: +<!-- ##### STRUCT NMSettingAdslClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_adsl_get_encapsulation ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_adsl_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_adsl_get_password ##### --> +<!-- ##### FUNCTION nm_setting_adsl_get_username ##### --> <para> </para> @@ -208,7 +208,7 @@ NMSettingAdsl @Returns: -<!-- ##### FUNCTION nm_setting_adsl_get_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_adsl_get_password ##### --> <para> </para> @@ -226,7 +226,7 @@ NMSettingAdsl @Returns: -<!-- ##### FUNCTION nm_setting_adsl_get_username ##### --> +<!-- ##### FUNCTION nm_setting_adsl_get_encapsulation ##### --> <para> </para> @@ -235,7 +235,7 @@ NMSettingAdsl @Returns: -<!-- ##### FUNCTION nm_setting_adsl_get_vci ##### --> +<!-- ##### FUNCTION nm_setting_adsl_get_vpi ##### --> <para> </para> @@ -244,7 +244,7 @@ NMSettingAdsl @Returns: -<!-- ##### FUNCTION nm_setting_adsl_get_vpi ##### --> +<!-- ##### FUNCTION nm_setting_adsl_get_vci ##### --> <para> </para> @@ -253,12 +253,12 @@ NMSettingAdsl @Returns: -<!-- ##### FUNCTION nm_setting_adsl_new ##### --> +<!-- ##### FUNCTION nm_setting_adsl_get_password_flags ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml b/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml index cc64b574..3a9c9773 100644 --- a/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bluetooth.sgml @@ -22,32 +22,12 @@ NMSettingBluetooth <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingBluetooth ##### --> -<para> - -</para> - - -<!-- ##### ARG NMSettingBluetooth:bdaddr ##### --> -<para> - -</para> - -<!-- ##### ARG NMSettingBluetooth:type ##### --> +<!-- ##### MACRO NM_SETTING_BLUETOOTH_SETTING_NAME ##### --> <para> </para> -<!-- ##### STRUCT NMSettingBluetoothClass ##### --> -<para> - -</para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: <!-- ##### ENUM NMSettingBluetoothError ##### --> <para> @@ -59,21 +39,23 @@ NMSettingBluetooth @NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY: @NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND: -<!-- ##### MACRO NM_SETTING_BLUETOOTH_BDADDR ##### --> +<!-- ##### MACRO NM_SETTING_BLUETOOTH_ERROR ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BLUETOOTH_ERROR ##### --> +<!-- ##### FUNCTION nm_setting_bluetooth_error_quark ##### --> <para> </para> +@void: +@Returns: -<!-- ##### MACRO NM_SETTING_BLUETOOTH_SETTING_NAME ##### --> +<!-- ##### MACRO NM_SETTING_BLUETOOTH_BDADDR ##### --> <para> </para> @@ -101,25 +83,43 @@ NMSettingBluetooth -<!-- ##### FUNCTION nm_setting_bluetooth_error_quark ##### --> +<!-- ##### STRUCT NMSettingBluetooth ##### --> <para> </para> -@void: -@Returns: +<!-- ##### ARG NMSettingBluetooth:bdaddr ##### --> +<para> + +</para> -<!-- ##### FUNCTION nm_setting_bluetooth_get_bdaddr ##### --> +<!-- ##### ARG NMSettingBluetooth:type ##### --> <para> </para> -@setting: +<!-- ##### STRUCT NMSettingBluetoothClass ##### --> +<para> + +</para> + +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_bluetooth_new ##### --> +<para> + +</para> + +@void: @Returns: -<!-- ##### FUNCTION nm_setting_bluetooth_get_connection_type ##### --> +<!-- ##### FUNCTION nm_setting_bluetooth_get_bdaddr ##### --> <para> </para> @@ -128,12 +128,12 @@ NMSettingBluetooth @Returns: -<!-- ##### FUNCTION nm_setting_bluetooth_new ##### --> +<!-- ##### FUNCTION nm_setting_bluetooth_get_connection_type ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-bond.sgml b/docs/libnm-util/tmpl/nm-setting-bond.sgml index caa8b37a..2500beed 100644 --- a/docs/libnm-util/tmpl/nm-setting-bond.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bond.sgml @@ -22,32 +22,12 @@ NMSettingBond <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingBond ##### --> -<para> - -</para> - - -<!-- ##### ARG NMSettingBond:interface-name ##### --> -<para> - -</para> - -<!-- ##### ARG NMSettingBond:options ##### --> +<!-- ##### MACRO NM_SETTING_BOND_SETTING_NAME ##### --> <para> </para> -<!-- ##### STRUCT NMSettingBondClass ##### --> -<para> -</para> - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: <!-- ##### ENUM NMSettingBondError ##### --> <para> @@ -67,6 +47,15 @@ NMSettingBond +<!-- ##### FUNCTION nm_setting_bond_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + <!-- ##### MACRO NM_SETTING_BOND_INTERFACE_NAME ##### --> <para> @@ -81,14 +70,14 @@ NMSettingBond -<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_INTERVAL ##### --> +<!-- ##### MACRO NM_SETTING_BOND_OPTION_MODE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_IP_TARGET ##### --> +<!-- ##### MACRO NM_SETTING_BOND_OPTION_MIIMON ##### --> <para> </para> @@ -102,46 +91,55 @@ NMSettingBond -<!-- ##### MACRO NM_SETTING_BOND_OPTION_MIIMON ##### --> +<!-- ##### MACRO NM_SETTING_BOND_OPTION_UPDELAY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BOND_OPTION_MODE ##### --> +<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_INTERVAL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BOND_OPTION_UPDELAY ##### --> +<!-- ##### MACRO NM_SETTING_BOND_OPTION_ARP_IP_TARGET ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BOND_SETTING_NAME ##### --> +<!-- ##### STRUCT NMSettingBond ##### --> <para> </para> +<!-- ##### ARG NMSettingBond:interface-name ##### --> +<para> -<!-- ##### FUNCTION nm_setting_bond_add_option ##### --> +</para> + +<!-- ##### ARG NMSettingBond:options ##### --> <para> </para> -@setting: -@name: -@value: -@Returns: +<!-- ##### STRUCT NMSettingBondClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_bond_error_quark ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_bond_new ##### --> <para> </para> @@ -190,35 +188,37 @@ NMSettingBond @Returns: -<!-- ##### FUNCTION nm_setting_bond_get_option_default ##### --> +<!-- ##### FUNCTION nm_setting_bond_add_option ##### --> <para> </para> @setting: @name: +@value: @Returns: -<!-- ##### FUNCTION nm_setting_bond_get_valid_options ##### --> +<!-- ##### FUNCTION nm_setting_bond_remove_option ##### --> <para> </para> @setting: +@name: @Returns: -<!-- ##### FUNCTION nm_setting_bond_new ##### --> +<!-- ##### FUNCTION nm_setting_bond_get_valid_options ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_bond_remove_option ##### --> +<!-- ##### FUNCTION nm_setting_bond_get_option_default ##### --> <para> </para> diff --git a/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml b/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml index 6e1b473b..692cb73d 100644 --- a/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bridge-port.sgml @@ -22,48 +22,46 @@ NMSettingBridgePort <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingBridgePort ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingBridgePort:hairpin-mode ##### --> + +<!-- ##### ENUM NMSettingBridgePortError ##### --> <para> </para> -<!-- ##### ARG NMSettingBridgePort:path-cost ##### --> +@NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN: +@NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY: +@NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingBridgePort:priority ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingBridgePortClass ##### --> +<!-- ##### FUNCTION nm_setting_bridge_port_error_quark ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: +@void: +@Returns: -<!-- ##### ENUM NMSettingBridgePortError ##### --> + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_PRIORITY ##### --> <para> </para> -@NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN: -@NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY: -@NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY: -<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_ERROR ##### --> + +<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_PATH_COST ##### --> <para> </para> @@ -77,46 +75,48 @@ NMSettingBridgePort -<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_PATH_COST ##### --> +<!-- ##### STRUCT NMSettingBridgePort ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_PRIORITY ##### --> +<!-- ##### ARG NMSettingBridgePort:hairpin-mode ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_BRIDGE_PORT_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingBridgePort:path-cost ##### --> <para> </para> +<!-- ##### ARG NMSettingBridgePort:priority ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_bridge_port_error_quark ##### --> +<!-- ##### STRUCT NMSettingBridgePortClass ##### --> <para> </para> -@void: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_bridge_port_get_hairpin_mode ##### --> +<!-- ##### FUNCTION nm_setting_bridge_port_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_bridge_port_get_path_cost ##### --> +<!-- ##### FUNCTION nm_setting_bridge_port_get_priority ##### --> <para> </para> @@ -125,7 +125,7 @@ NMSettingBridgePort @Returns: -<!-- ##### FUNCTION nm_setting_bridge_port_get_priority ##### --> +<!-- ##### FUNCTION nm_setting_bridge_port_get_path_cost ##### --> <para> </para> @@ -134,12 +134,12 @@ NMSettingBridgePort @Returns: -<!-- ##### FUNCTION nm_setting_bridge_port_new ##### --> +<!-- ##### FUNCTION nm_setting_bridge_port_get_hairpin_mode ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-bridge.sgml b/docs/libnm-util/tmpl/nm-setting-bridge.sgml index 7e2cb5a4..bf9593e5 100644 --- a/docs/libnm-util/tmpl/nm-setting-bridge.sgml +++ b/docs/libnm-util/tmpl/nm-setting-bridge.sgml @@ -22,149 +22,149 @@ NMSettingBridge <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingBridge ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingBridge:ageing-time ##### --> + +<!-- ##### ENUM NMSettingBridgeError ##### --> <para> </para> -<!-- ##### ARG NMSettingBridge:forward-delay ##### --> +@NM_SETTING_BRIDGE_ERROR_UNKNOWN: +@NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY: +@NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_BRIDGE_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingBridge:hello-time ##### --> -<para> -</para> -<!-- ##### ARG NMSettingBridge:interface-name ##### --> +<!-- ##### FUNCTION nm_setting_bridge_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingBridge:max-age ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingBridge:priority ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_INTERFACE_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingBridge:stp ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingBridgeClass ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_STP ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingBridgeError ##### --> + +<!-- ##### MACRO NM_SETTING_BRIDGE_PRIORITY ##### --> <para> </para> -@NM_SETTING_BRIDGE_ERROR_UNKNOWN: -@NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY: -@NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY: -<!-- ##### MACRO NM_SETTING_BRIDGE_AGEING_TIME ##### --> + +<!-- ##### MACRO NM_SETTING_BRIDGE_FORWARD_DELAY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BRIDGE_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_HELLO_TIME ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BRIDGE_FORWARD_DELAY ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_MAX_AGE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BRIDGE_HELLO_TIME ##### --> +<!-- ##### MACRO NM_SETTING_BRIDGE_AGEING_TIME ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_BRIDGE_INTERFACE_NAME ##### --> +<!-- ##### STRUCT NMSettingBridge ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_BRIDGE_MAX_AGE ##### --> +<!-- ##### ARG NMSettingBridge:ageing-time ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_BRIDGE_PRIORITY ##### --> +<!-- ##### ARG NMSettingBridge:forward-delay ##### --> <para> </para> +<!-- ##### ARG NMSettingBridge:hello-time ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_BRIDGE_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingBridge:interface-name ##### --> <para> </para> +<!-- ##### ARG NMSettingBridge:max-age ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_BRIDGE_STP ##### --> +<!-- ##### ARG NMSettingBridge:priority ##### --> <para> </para> +<!-- ##### ARG NMSettingBridge:stp ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_bridge_error_quark ##### --> +<!-- ##### STRUCT NMSettingBridgeClass ##### --> <para> </para> -@void: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_bridge_get_ageing_time ##### --> +<!-- ##### FUNCTION nm_setting_bridge_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_bridge_get_forward_delay ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_interface_name ##### --> <para> </para> @@ -173,7 +173,7 @@ NMSettingBridge @Returns: -<!-- ##### FUNCTION nm_setting_bridge_get_hello_time ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_stp ##### --> <para> </para> @@ -182,7 +182,7 @@ NMSettingBridge @Returns: -<!-- ##### FUNCTION nm_setting_bridge_get_interface_name ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_priority ##### --> <para> </para> @@ -191,7 +191,7 @@ NMSettingBridge @Returns: -<!-- ##### FUNCTION nm_setting_bridge_get_max_age ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_forward_delay ##### --> <para> </para> @@ -200,7 +200,7 @@ NMSettingBridge @Returns: -<!-- ##### FUNCTION nm_setting_bridge_get_priority ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_hello_time ##### --> <para> </para> @@ -209,7 +209,7 @@ NMSettingBridge @Returns: -<!-- ##### FUNCTION nm_setting_bridge_get_stp ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_max_age ##### --> <para> </para> @@ -218,12 +218,12 @@ NMSettingBridge @Returns: -<!-- ##### FUNCTION nm_setting_bridge_new ##### --> +<!-- ##### FUNCTION nm_setting_bridge_get_ageing_time ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-cdma.sgml b/docs/libnm-util/tmpl/nm-setting-cdma.sgml index 5d065170..4c90acb1 100644 --- a/docs/libnm-util/tmpl/nm-setting-cdma.sgml +++ b/docs/libnm-util/tmpl/nm-setting-cdma.sgml @@ -22,61 +22,47 @@ NMSettingCdma <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingCdma ##### --> +<!-- ##### MACRO NM_SETTING_CDMA_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingCdma:number ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingCdma:password ##### --> +<!-- ##### ENUM NMSettingCdmaError ##### --> <para> </para> -<!-- ##### ARG NMSettingCdma:password-flags ##### --> -<para> - -</para> +@NM_SETTING_CDMA_ERROR_UNKNOWN: +@NM_SETTING_CDMA_ERROR_INVALID_PROPERTY: +@NM_SETTING_CDMA_ERROR_MISSING_PROPERTY: +@NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING: -<!-- ##### ARG NMSettingCdma:username ##### --> +<!-- ##### MACRO NM_SETTING_CDMA_ERROR ##### --> <para> </para> -<!-- ##### STRUCT NMSettingCdmaClass ##### --> -<para> -</para> - -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingCdmaError ##### --> +<!-- ##### FUNCTION nm_setting_cdma_error_quark ##### --> <para> </para> -@NM_SETTING_CDMA_ERROR_UNKNOWN: -@NM_SETTING_CDMA_ERROR_INVALID_PROPERTY: -@NM_SETTING_CDMA_ERROR_MISSING_PROPERTY: -@NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING: +@void: +@Returns: -<!-- ##### MACRO NM_SETTING_CDMA_ERROR ##### --> + +<!-- ##### MACRO NM_SETTING_CDMA_NUMBER ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_CDMA_NUMBER ##### --> +<!-- ##### MACRO NM_SETTING_CDMA_USERNAME ##### --> <para> </para> @@ -97,39 +83,53 @@ NMSettingCdma -<!-- ##### MACRO NM_SETTING_CDMA_SETTING_NAME ##### --> +<!-- ##### STRUCT NMSettingCdma ##### --> <para> </para> +<!-- ##### ARG NMSettingCdma:number ##### --> +<para> + +</para> -<!-- ##### MACRO NM_SETTING_CDMA_USERNAME ##### --> +<!-- ##### ARG NMSettingCdma:password ##### --> <para> </para> +<!-- ##### ARG NMSettingCdma:password-flags ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_cdma_error_quark ##### --> +<!-- ##### ARG NMSettingCdma:username ##### --> <para> </para> -@void: -@Returns: +<!-- ##### STRUCT NMSettingCdmaClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_cdma_get_number ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_cdma_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_cdma_get_password ##### --> +<!-- ##### FUNCTION nm_setting_cdma_get_number ##### --> <para> </para> @@ -138,7 +138,7 @@ NMSettingCdma @Returns: -<!-- ##### FUNCTION nm_setting_cdma_get_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_cdma_get_username ##### --> <para> </para> @@ -147,7 +147,7 @@ NMSettingCdma @Returns: -<!-- ##### FUNCTION nm_setting_cdma_get_username ##### --> +<!-- ##### FUNCTION nm_setting_cdma_get_password ##### --> <para> </para> @@ -156,12 +156,12 @@ NMSettingCdma @Returns: -<!-- ##### FUNCTION nm_setting_cdma_new ##### --> +<!-- ##### FUNCTION nm_setting_cdma_get_password_flags ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-connection.sgml b/docs/libnm-util/tmpl/nm-setting-connection.sgml index 81d6801c..aa04897e 100644 --- a/docs/libnm-util/tmpl/nm-setting-connection.sgml +++ b/docs/libnm-util/tmpl/nm-setting-connection.sgml @@ -22,104 +22,90 @@ NMSettingConnection <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingConnection ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:autoconnect ##### --> + +<!-- ##### ENUM NMSettingConnectionError ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:id ##### --> +@NM_SETTING_CONNECTION_ERROR_UNKNOWN: +@NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY: +@NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY: +@NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND: +@NM_SETTING_CONNECTION_ERROR_IP_CONFIG_NOT_ALLOWED: + +<!-- ##### MACRO NM_SETTING_CONNECTION_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:master ##### --> -<para> -</para> -<!-- ##### ARG NMSettingConnection:permissions ##### --> +<!-- ##### FUNCTION nm_setting_connection_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:read-only ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingConnection:secondaries ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_ID ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:slave-type ##### --> -<para> -</para> -<!-- ##### ARG NMSettingConnection:timestamp ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_UUID ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:type ##### --> -<para> -</para> -<!-- ##### ARG NMSettingConnection:uuid ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_TYPE ##### --> <para> </para> -<!-- ##### ARG NMSettingConnection:zone ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingConnectionClass ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingConnectionError ##### --> + +<!-- ##### MACRO NM_SETTING_CONNECTION_TIMESTAMP ##### --> <para> </para> -@NM_SETTING_CONNECTION_ERROR_UNKNOWN: -@NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY: -@NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY: -@NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND: -@NM_SETTING_CONNECTION_ERROR_IP_CONFIG_NOT_ALLOWED: -<!-- ##### MACRO NM_SETTING_CONNECTION_AUTOCONNECT ##### --> + +<!-- ##### MACRO NM_SETTING_CONNECTION_READ_ONLY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_CONNECTION_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_PERMISSIONS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_CONNECTION_ID ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_ZONE ##### --> <para> </para> @@ -133,101 +119,111 @@ NMSettingConnection -<!-- ##### MACRO NM_SETTING_CONNECTION_PERMISSIONS ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_SLAVE_TYPE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_CONNECTION_READ_ONLY ##### --> +<!-- ##### MACRO NM_SETTING_CONNECTION_SECONDARIES ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_CONNECTION_SECONDARIES ##### --> +<!-- ##### STRUCT NMSettingConnection ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_CONNECTION_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingConnection:autoconnect ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_CONNECTION_SLAVE_TYPE ##### --> +<!-- ##### ARG NMSettingConnection:id ##### --> <para> </para> +<!-- ##### ARG NMSettingConnection:master ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_CONNECTION_TIMESTAMP ##### --> +<!-- ##### ARG NMSettingConnection:permissions ##### --> <para> </para> +<!-- ##### ARG NMSettingConnection:read-only ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_CONNECTION_TYPE ##### --> +<!-- ##### ARG NMSettingConnection:secondaries ##### --> <para> </para> +<!-- ##### ARG NMSettingConnection:slave-type ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_CONNECTION_UUID ##### --> +<!-- ##### ARG NMSettingConnection:timestamp ##### --> <para> </para> +<!-- ##### ARG NMSettingConnection:type ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_CONNECTION_ZONE ##### --> +<!-- ##### ARG NMSettingConnection:uuid ##### --> <para> </para> +<!-- ##### ARG NMSettingConnection:zone ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_connection_add_permission ##### --> +<!-- ##### STRUCT NMSettingConnectionClass ##### --> <para> </para> -@setting: -@ptype: -@pitem: -@detail: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_connection_add_secondary ##### --> +<!-- ##### FUNCTION nm_setting_connection_new ##### --> <para> </para> -@setting: -@sec_uuid: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_connection_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_id ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_autoconnect ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_uuid ##### --> <para> </para> @@ -245,7 +241,7 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_id ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_autoconnect ##### --> <para> </para> @@ -254,7 +250,7 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_master ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_timestamp ##### --> <para> </para> @@ -263,7 +259,7 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_num_permissions ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_read_only ##### --> <para> </para> @@ -272,7 +268,7 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_num_secondaries ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_num_permissions ##### --> <para> </para> @@ -294,7 +290,7 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_read_only ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_zone ##### --> <para> </para> @@ -303,35 +299,38 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_secondary ##### --> +<!-- ##### FUNCTION nm_setting_connection_permissions_user_allowed ##### --> <para> </para> @setting: -@idx: +@uname: @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_slave_type ##### --> +<!-- ##### FUNCTION nm_setting_connection_add_permission ##### --> <para> </para> @setting: +@ptype: +@pitem: +@detail: @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_timestamp ##### --> +<!-- ##### FUNCTION nm_setting_connection_remove_permission ##### --> <para> </para> @setting: -@Returns: +@idx: -<!-- ##### FUNCTION nm_setting_connection_get_uuid ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_master ##### --> <para> </para> @@ -340,51 +339,52 @@ NMSettingConnection @Returns: -<!-- ##### FUNCTION nm_setting_connection_get_zone ##### --> +<!-- ##### FUNCTION nm_setting_connection_is_slave_type ##### --> <para> </para> @setting: +@type: @Returns: -<!-- ##### FUNCTION nm_setting_connection_is_slave_type ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_slave_type ##### --> <para> </para> @setting: -@type: @Returns: -<!-- ##### FUNCTION nm_setting_connection_new ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_num_secondaries ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_connection_permissions_user_allowed ##### --> +<!-- ##### FUNCTION nm_setting_connection_get_secondary ##### --> <para> </para> @setting: -@uname: +@idx: @Returns: -<!-- ##### FUNCTION nm_setting_connection_remove_permission ##### --> +<!-- ##### FUNCTION nm_setting_connection_add_secondary ##### --> <para> </para> @setting: -@idx: +@sec_uuid: +@Returns: <!-- ##### FUNCTION nm_setting_connection_remove_secondary ##### --> diff --git a/docs/libnm-util/tmpl/nm-setting-gsm.sgml b/docs/libnm-util/tmpl/nm-setting-gsm.sgml index 0d29a11a..d73ab6df 100644 --- a/docs/libnm-util/tmpl/nm-setting-gsm.sgml +++ b/docs/libnm-util/tmpl/nm-setting-gsm.sgml @@ -22,121 +22,87 @@ NMSettingGsm <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingGsm ##### --> +<!-- ##### MACRO NM_SETTING_GSM_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:allowed-bands ##### --> + +<!-- ##### ENUM NMSettingGsmError ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:apn ##### --> +@NM_SETTING_GSM_ERROR_UNKNOWN: +@NM_SETTING_GSM_ERROR_INVALID_PROPERTY: +@NM_SETTING_GSM_ERROR_MISSING_PROPERTY: +@NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING: + +<!-- ##### MACRO NM_SETTING_GSM_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:home-only ##### --> -<para> -</para> -<!-- ##### ARG NMSettingGsm:network-id ##### --> +<!-- ##### FUNCTION nm_setting_gsm_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:network-type ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingGsm:number ##### --> +<!-- ##### MACRO NM_SETTING_GSM_NUMBER ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:password ##### --> -<para> -</para> -<!-- ##### ARG NMSettingGsm:password-flags ##### --> +<!-- ##### MACRO NM_SETTING_GSM_USERNAME ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:pin ##### --> -<para> -</para> -<!-- ##### ARG NMSettingGsm:pin-flags ##### --> +<!-- ##### MACRO NM_SETTING_GSM_PASSWORD ##### --> <para> </para> -<!-- ##### ARG NMSettingGsm:username ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingGsmClass ##### --> +<!-- ##### MACRO NM_SETTING_GSM_PASSWORD_FLAGS ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingGsmError ##### --> + +<!-- ##### MACRO NM_SETTING_GSM_APN ##### --> <para> </para> -@NM_SETTING_GSM_ERROR_UNKNOWN: -@NM_SETTING_GSM_ERROR_INVALID_PROPERTY: -@NM_SETTING_GSM_ERROR_MISSING_PROPERTY: -@NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING: -<!-- ##### ENUM NMSettingGsmNetworkBand ##### --> + +<!-- ##### MACRO NM_SETTING_GSM_NETWORK_ID ##### --> <para> </para> -@NM_SETTING_GSM_BAND_UNKNOWN: -@NM_SETTING_GSM_BAND_ANY: -@NM_SETTING_GSM_BAND_EGSM: -@NM_SETTING_GSM_BAND_DCS: -@NM_SETTING_GSM_BAND_PCS: -@NM_SETTING_GSM_BAND_G850: -@NM_SETTING_GSM_BAND_U2100: -@NM_SETTING_GSM_BAND_U1800: -@NM_SETTING_GSM_BAND_U17IV: -@NM_SETTING_GSM_BAND_U800: -@NM_SETTING_GSM_BAND_U850: -@NM_SETTING_GSM_BAND_U900: -@NM_SETTING_GSM_BAND_U17IX: -@NM_SETTING_GSM_BAND_U1900: -@NM_SETTING_GSM_BAND_U2600: -<!-- ##### ENUM NMSettingGsmNetworkType ##### --> + +<!-- ##### MACRO NM_SETTING_GSM_NETWORK_TYPE ##### --> <para> </para> -@NM_SETTING_GSM_NETWORK_TYPE_ANY: -@NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA: -@NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE: -@NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA: -@NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE: -@NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G: -@NM_SETTING_GSM_NETWORK_TYPE_4G: + <!-- ##### MACRO NM_SETTING_GSM_ALLOWED_BANDS ##### --> <para> @@ -145,14 +111,14 @@ NMSettingGsm -<!-- ##### MACRO NM_SETTING_GSM_APN ##### --> +<!-- ##### MACRO NM_SETTING_GSM_PIN ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_GSM_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_GSM_PIN_FLAGS ##### --> <para> </para> @@ -166,88 +132,122 @@ NMSettingGsm -<!-- ##### MACRO NM_SETTING_GSM_NETWORK_ID ##### --> +<!-- ##### ENUM NMSettingGsmNetworkType ##### --> <para> </para> +@NM_SETTING_GSM_NETWORK_TYPE_ANY: +@NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA: +@NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE: +@NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA: +@NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE: +@NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G: +@NM_SETTING_GSM_NETWORK_TYPE_4G: - -<!-- ##### MACRO NM_SETTING_GSM_NETWORK_TYPE ##### --> +<!-- ##### ENUM NMSettingGsmNetworkBand ##### --> <para> </para> +@NM_SETTING_GSM_BAND_UNKNOWN: +@NM_SETTING_GSM_BAND_ANY: +@NM_SETTING_GSM_BAND_EGSM: +@NM_SETTING_GSM_BAND_DCS: +@NM_SETTING_GSM_BAND_PCS: +@NM_SETTING_GSM_BAND_G850: +@NM_SETTING_GSM_BAND_U2100: +@NM_SETTING_GSM_BAND_U1800: +@NM_SETTING_GSM_BAND_U17IV: +@NM_SETTING_GSM_BAND_U800: +@NM_SETTING_GSM_BAND_U850: +@NM_SETTING_GSM_BAND_U900: +@NM_SETTING_GSM_BAND_U17IX: +@NM_SETTING_GSM_BAND_U1900: +@NM_SETTING_GSM_BAND_U2600: - -<!-- ##### MACRO NM_SETTING_GSM_NUMBER ##### --> +<!-- ##### STRUCT NMSettingGsm ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_GSM_PASSWORD ##### --> +<!-- ##### ARG NMSettingGsm:allowed-bands ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_GSM_PASSWORD_FLAGS ##### --> +<!-- ##### ARG NMSettingGsm:apn ##### --> <para> </para> +<!-- ##### ARG NMSettingGsm:home-only ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_GSM_PIN ##### --> +<!-- ##### ARG NMSettingGsm:network-id ##### --> <para> </para> +<!-- ##### ARG NMSettingGsm:network-type ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_GSM_PIN_FLAGS ##### --> +<!-- ##### ARG NMSettingGsm:number ##### --> <para> </para> +<!-- ##### ARG NMSettingGsm:password ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_GSM_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingGsm:password-flags ##### --> <para> </para> +<!-- ##### ARG NMSettingGsm:pin ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_GSM_USERNAME ##### --> +<!-- ##### ARG NMSettingGsm:pin-flags ##### --> <para> </para> +<!-- ##### ARG NMSettingGsm:username ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_gsm_error_quark ##### --> +<!-- ##### STRUCT NMSettingGsmClass ##### --> <para> </para> -@void: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_gsm_get_allowed_bands ##### --> +<!-- ##### FUNCTION nm_setting_gsm_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_apn ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_number ##### --> <para> </para> @@ -256,7 +256,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_home_only ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_username ##### --> <para> </para> @@ -265,7 +265,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_network_id ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_password ##### --> <para> </para> @@ -274,7 +274,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_network_type ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_apn ##### --> <para> </para> @@ -283,7 +283,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_number ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_network_id ##### --> <para> </para> @@ -292,7 +292,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_password ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_network_type ##### --> <para> </para> @@ -301,7 +301,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_allowed_bands ##### --> <para> </para> @@ -319,7 +319,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_pin_flags ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_home_only ##### --> <para> </para> @@ -328,7 +328,7 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_get_username ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_pin_flags ##### --> <para> </para> @@ -337,12 +337,12 @@ NMSettingGsm @Returns: -<!-- ##### FUNCTION nm_setting_gsm_new ##### --> +<!-- ##### FUNCTION nm_setting_gsm_get_password_flags ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-infiniband.sgml b/docs/libnm-util/tmpl/nm-setting-infiniband.sgml index 02a59881..39f397eb 100644 --- a/docs/libnm-util/tmpl/nm-setting-infiniband.sgml +++ b/docs/libnm-util/tmpl/nm-setting-infiniband.sgml @@ -22,83 +22,92 @@ NMSettingInfiniband <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingInfiniband ##### --> +<!-- ##### MACRO NM_SETTING_INFINIBAND_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingInfiniband:mac-address ##### --> + +<!-- ##### ENUM NMSettingInfinibandError ##### --> <para> </para> -<!-- ##### ARG NMSettingInfiniband:mtu ##### --> +@NM_SETTING_INFINIBAND_ERROR_UNKNOWN: +@NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY: +@NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_INFINIBAND_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingInfiniband:transport-mode ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingInfinibandClass ##### --> +<!-- ##### FUNCTION nm_setting_infiniband_error_quark ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: +@void: +@Returns: -<!-- ##### ENUM NMSettingInfinibandError ##### --> + +<!-- ##### MACRO NM_SETTING_INFINIBAND_MAC_ADDRESS ##### --> <para> </para> -@NM_SETTING_INFINIBAND_ERROR_UNKNOWN: -@NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY: -@NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY: -<!-- ##### MACRO NM_SETTING_INFINIBAND_ERROR ##### --> + +<!-- ##### MACRO NM_SETTING_INFINIBAND_MTU ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_INFINIBAND_MAC_ADDRESS ##### --> +<!-- ##### MACRO NM_SETTING_INFINIBAND_TRANSPORT_MODE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_INFINIBAND_MTU ##### --> +<!-- ##### STRUCT NMSettingInfiniband ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_INFINIBAND_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingInfiniband:mac-address ##### --> <para> </para> +<!-- ##### ARG NMSettingInfiniband:mtu ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_INFINIBAND_TRANSPORT_MODE ##### --> +<!-- ##### ARG NMSettingInfiniband:transport-mode ##### --> <para> </para> +<!-- ##### STRUCT NMSettingInfinibandClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_infiniband_error_quark ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_infiniband_new ##### --> <para> </para> @@ -134,12 +143,3 @@ NMSettingInfiniband @Returns: -<!-- ##### FUNCTION nm_setting_infiniband_new ##### --> -<para> - -</para> - -@void: -@Returns: - - diff --git a/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml b/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml index 4b915f2b..ea5b49c9 100644 --- a/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml +++ b/docs/libnm-util/tmpl/nm-setting-ip4-config.sgml @@ -22,106 +22,82 @@ NMSettingIP4Config <!-- ##### SECTION Image ##### --> -<!-- ##### TYPEDEF NMIP4Address ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_SETTING_NAME ##### --> <para> </para> -<!-- ##### TYPEDEF NMIP4Route ##### --> -<para> - -</para> - -<!-- ##### STRUCT NMSettingIP4Config ##### --> +<!-- ##### ENUM NMSettingIP4ConfigError ##### --> <para> </para> +@NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN: +@NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY: +@NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY: +@NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD: -<!-- ##### ARG NMSettingIP4Config:addresses ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingIP4Config:dhcp-client-id ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP4Config:dhcp-hostname ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingIP4Config:dhcp-send-hostname ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingIP4Config:dns ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD ##### --> <para> </para> -<!-- ##### ARG NMSettingIP4Config:dns-search ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP4Config:ignore-auto-dns ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DNS ##### --> <para> </para> -<!-- ##### ARG NMSettingIP4Config:ignore-auto-routes ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP4Config:may-fail ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DNS_SEARCH ##### --> <para> </para> -<!-- ##### ARG NMSettingIP4Config:method ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP4Config:never-default ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ADDRESSES ##### --> <para> </para> -<!-- ##### ARG NMSettingIP4Config:routes ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingIP4ConfigClass ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ROUTES ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingIP4ConfigError ##### --> + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES ##### --> <para> </para> -@NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN: -@NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY: -@NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY: -@NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ADDRESSES ##### --> + +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS ##### --> <para> </para> @@ -135,145 +111,156 @@ NMSettingIP4Config -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DNS ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_NEVER_DEFAULT ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_DNS_SEARCH ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_MAY_FAIL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_AUTO ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_MANUAL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_MAY_FAIL ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_SHARED ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD ##### --> +<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_DISABLED ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_AUTO ##### --> +<!-- ##### TYPEDEF NMIP4Address ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_DISABLED ##### --> +<!-- ##### FUNCTION nm_ip4_address_new ##### --> <para> </para> +@void: +@Returns: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL ##### --> +<!-- ##### FUNCTION nm_ip4_address_dup ##### --> <para> </para> +@source: +@Returns: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_MANUAL ##### --> +<!-- ##### FUNCTION nm_ip4_address_ref ##### --> <para> </para> +@address: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_METHOD_SHARED ##### --> +<!-- ##### FUNCTION nm_ip4_address_unref ##### --> <para> </para> +@address: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_NEVER_DEFAULT ##### --> +<!-- ##### FUNCTION nm_ip4_address_compare ##### --> <para> </para> +@address: +@other: +@Returns: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_ROUTES ##### --> +<!-- ##### FUNCTION nm_ip4_address_get_address ##### --> <para> </para> +@address: +@Returns: -<!-- ##### MACRO NM_SETTING_IP4_CONFIG_SETTING_NAME ##### --> +<!-- ##### FUNCTION nm_ip4_address_set_address ##### --> <para> </para> +@address: +@addr: -<!-- ##### FUNCTION nm_ip4_address_compare ##### --> +<!-- ##### FUNCTION nm_ip4_address_get_prefix ##### --> <para> </para> @address: -@other: @Returns: -<!-- ##### FUNCTION nm_ip4_address_dup ##### --> +<!-- ##### FUNCTION nm_ip4_address_set_prefix ##### --> <para> </para> -@source: -@Returns: +@address: +@prefix: -<!-- ##### FUNCTION nm_ip4_address_get_address ##### --> +<!-- ##### FUNCTION nm_ip4_address_get_gateway ##### --> <para> </para> @@ -282,25 +269,22 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_ip4_address_get_gateway ##### --> +<!-- ##### FUNCTION nm_ip4_address_set_gateway ##### --> <para> </para> @address: -@Returns: +@gateway: -<!-- ##### FUNCTION nm_ip4_address_get_prefix ##### --> +<!-- ##### TYPEDEF NMIP4Route ##### --> <para> </para> -@address: -@Returns: - -<!-- ##### FUNCTION nm_ip4_address_new ##### --> +<!-- ##### FUNCTION nm_ip4_route_new ##### --> <para> </para> @@ -309,78 +293,78 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_ip4_address_ref ##### --> +<!-- ##### FUNCTION nm_ip4_route_dup ##### --> <para> </para> -@address: +@source: +@Returns: -<!-- ##### FUNCTION nm_ip4_address_set_address ##### --> +<!-- ##### FUNCTION nm_ip4_route_ref ##### --> <para> </para> -@address: -@addr: +@route: -<!-- ##### FUNCTION nm_ip4_address_set_gateway ##### --> +<!-- ##### FUNCTION nm_ip4_route_unref ##### --> <para> </para> -@address: -@gateway: +@route: -<!-- ##### FUNCTION nm_ip4_address_set_prefix ##### --> +<!-- ##### FUNCTION nm_ip4_route_compare ##### --> <para> </para> -@address: -@prefix: +@route: +@other: +@Returns: -<!-- ##### FUNCTION nm_ip4_address_unref ##### --> +<!-- ##### FUNCTION nm_ip4_route_get_dest ##### --> <para> </para> -@address: +@route: +@Returns: -<!-- ##### FUNCTION nm_ip4_route_compare ##### --> +<!-- ##### FUNCTION nm_ip4_route_set_dest ##### --> <para> </para> @route: -@other: -@Returns: +@dest: -<!-- ##### FUNCTION nm_ip4_route_dup ##### --> +<!-- ##### FUNCTION nm_ip4_route_get_prefix ##### --> <para> </para> -@source: +@route: @Returns: -<!-- ##### FUNCTION nm_ip4_route_get_dest ##### --> +<!-- ##### FUNCTION nm_ip4_route_set_prefix ##### --> <para> </para> @route: -@Returns: +@prefix: -<!-- ##### FUNCTION nm_ip4_route_get_metric ##### --> +<!-- ##### FUNCTION nm_ip4_route_get_next_hop ##### --> <para> </para> @@ -389,16 +373,16 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_ip4_route_get_next_hop ##### --> +<!-- ##### FUNCTION nm_ip4_route_set_next_hop ##### --> <para> </para> @route: -@Returns: +@next_hop: -<!-- ##### FUNCTION nm_ip4_route_get_prefix ##### --> +<!-- ##### FUNCTION nm_ip4_route_get_metric ##### --> <para> </para> @@ -407,132 +391,149 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_ip4_route_new ##### --> +<!-- ##### FUNCTION nm_ip4_route_set_metric ##### --> <para> </para> -@void: -@Returns: +@route: +@metric: -<!-- ##### FUNCTION nm_ip4_route_ref ##### --> +<!-- ##### STRUCT NMSettingIP4Config ##### --> <para> </para> -@route: +<!-- ##### ARG NMSettingIP4Config:addresses ##### --> +<para> -<!-- ##### FUNCTION nm_ip4_route_set_dest ##### --> +</para> + +<!-- ##### ARG NMSettingIP4Config:dhcp-client-id ##### --> <para> </para> -@route: -@dest: +<!-- ##### ARG NMSettingIP4Config:dhcp-hostname ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip4_route_set_metric ##### --> +<!-- ##### ARG NMSettingIP4Config:dhcp-send-hostname ##### --> <para> </para> -@route: -@metric: +<!-- ##### ARG NMSettingIP4Config:dns ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip4_route_set_next_hop ##### --> +<!-- ##### ARG NMSettingIP4Config:dns-search ##### --> <para> </para> -@route: -@next_hop: +<!-- ##### ARG NMSettingIP4Config:ignore-auto-dns ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip4_route_set_prefix ##### --> +<!-- ##### ARG NMSettingIP4Config:ignore-auto-routes ##### --> <para> </para> -@route: -@prefix: +<!-- ##### ARG NMSettingIP4Config:may-fail ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip4_route_unref ##### --> +<!-- ##### ARG NMSettingIP4Config:method ##### --> <para> </para> -@route: +<!-- ##### ARG NMSettingIP4Config:never-default ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_ip4_config_add_address ##### --> +<!-- ##### ARG NMSettingIP4Config:routes ##### --> <para> </para> -@setting: -@address: -@Returns: +<!-- ##### STRUCT NMSettingIP4ConfigClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_ip4_config_add_dns ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_ip4_config_new ##### --> <para> </para> -@setting: -@dns: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_add_dns_search ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_method ##### --> <para> </para> @setting: -@dns_search: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_add_route ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_dns ##### --> <para> </para> @setting: -@route: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_clear_addresses ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_dns ##### --> <para> </para> @setting: +@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_clear_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_add_dns ##### --> <para> </para> @setting: +@dns: +@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_clear_dns_searches ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_remove_dns ##### --> <para> </para> @setting: +@i: -<!-- ##### FUNCTION nm_setting_ip4_config_clear_routes ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_clear_dns ##### --> <para> </para> @@ -540,16 +541,16 @@ NMSettingIP4Config @setting: -<!-- ##### FUNCTION nm_setting_ip4_config_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_dns_searches ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_address ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_dns_search ##### --> <para> </para> @@ -559,44 +560,43 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_client_id ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_add_dns_search ##### --> <para> </para> @setting: +@dns_search: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_hostname ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_remove_dns_search ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_send_hostname ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_clear_dns_searches ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_addresses ##### --> <para> </para> @setting: -@i: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_dns_search ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_address ##### --> <para> </para> @@ -606,34 +606,34 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_ignore_auto_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_add_address ##### --> <para> </para> @setting: +@address: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_ignore_auto_routes ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_remove_address ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_ip4_config_get_may_fail ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_clear_addresses ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_method ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_num_routes ##### --> <para> </para> @@ -642,43 +642,44 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_never_default ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_route ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_num_addresses ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_add_route ##### --> <para> </para> @setting: +@route: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_num_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_remove_route ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_ip4_config_get_num_dns_searches ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_clear_routes ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_num_routes ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_ignore_auto_routes ##### --> <para> </para> @@ -687,58 +688,57 @@ NMSettingIP4Config @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_get_route ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_ignore_auto_dns ##### --> <para> </para> @setting: -@i: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_new ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_client_id ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_remove_address ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_send_hostname ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_remove_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_dhcp_hostname ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_remove_dns_search ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_never_default ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip4_config_remove_route ##### --> +<!-- ##### FUNCTION nm_setting_ip4_config_get_may_fail ##### --> <para> </para> @setting: -@i: +@Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml b/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml index 3e5af03a..df2fbec4 100644 --- a/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml +++ b/docs/libnm-util/tmpl/nm-setting-ip6-config.sgml @@ -22,269 +22,252 @@ NMSettingIP6Config <!-- ##### SECTION Image ##### --> -<!-- ##### TYPEDEF NMIP6Address ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_SETTING_NAME ##### --> <para> </para> -<!-- ##### TYPEDEF NMIP6Route ##### --> -<para> - -</para> - -<!-- ##### STRUCT NMSettingIP6Config ##### --> +<!-- ##### ENUM NMSettingIP6ConfigError ##### --> <para> </para> +@NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN: +@NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY: +@NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY: +@NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD: -<!-- ##### ARG NMSettingIP6Config:addresses ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingIP6Config:dhcp-hostname ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP6Config:dns ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingIP6Config:dns-search ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingIP6Config:ignore-auto-dns ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD ##### --> <para> </para> -<!-- ##### ARG NMSettingIP6Config:ignore-auto-routes ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP6Config:ip6-privacy ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DNS ##### --> <para> </para> -<!-- ##### ARG NMSettingIP6Config:may-fail ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP6Config:method ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DNS_SEARCH ##### --> <para> </para> -<!-- ##### ARG NMSettingIP6Config:never-default ##### --> -<para> -</para> -<!-- ##### ARG NMSettingIP6Config:routes ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ADDRESSES ##### --> <para> </para> -<!-- ##### STRUCT NMSettingIP6ConfigClass ##### --> -<para> - -</para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingIP6ConfigError ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ROUTES ##### --> <para> </para> -@NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN: -@NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY: -@NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY: -@NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD: -<!-- ##### ENUM NMSettingIP6ConfigPrivacy ##### --> + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES ##### --> <para> </para> -@NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN: -@NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED: -@NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR: -@NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR: -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ADDRESSES ##### --> + +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_NEVER_DEFAULT ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DNS ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_MAY_FAIL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DNS_SEARCH ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IP6_PRIVACY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_IGNORE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_AUTO ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_IP6_PRIVACY ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_DHCP ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_MAY_FAIL ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_MANUAL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_AUTO ##### --> +<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_SHARED ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_DHCP ##### --> +<!-- ##### ENUM NMSettingIP6ConfigPrivacy ##### --> <para> </para> +@NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN: +@NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED: +@NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR: +@NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR: - -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_IGNORE ##### --> +<!-- ##### TYPEDEF NMIP6Address ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL ##### --> +<!-- ##### FUNCTION nm_ip6_address_new ##### --> <para> </para> +@void: +@Returns: -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_MANUAL ##### --> +<!-- ##### FUNCTION nm_ip6_address_dup ##### --> <para> </para> +@source: +@Returns: -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_METHOD_SHARED ##### --> +<!-- ##### FUNCTION nm_ip6_address_ref ##### --> <para> </para> +@address: -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_NEVER_DEFAULT ##### --> +<!-- ##### FUNCTION nm_ip6_address_unref ##### --> <para> </para> +@address: -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_ROUTES ##### --> +<!-- ##### FUNCTION nm_ip6_address_compare ##### --> <para> </para> +@address: +@other: +@Returns: -<!-- ##### MACRO NM_SETTING_IP6_CONFIG_SETTING_NAME ##### --> +<!-- ##### FUNCTION nm_ip6_address_get_address ##### --> <para> </para> +@address: +@Returns: -<!-- ##### FUNCTION nm_ip6_address_compare ##### --> +<!-- ##### FUNCTION nm_ip6_address_set_address ##### --> <para> </para> @address: -@other: -@Returns: +@addr: -<!-- ##### FUNCTION nm_ip6_address_dup ##### --> +<!-- ##### FUNCTION nm_ip6_address_get_prefix ##### --> <para> </para> -@source: +@address: @Returns: -<!-- ##### FUNCTION nm_ip6_address_get_address ##### --> +<!-- ##### FUNCTION nm_ip6_address_set_prefix ##### --> <para> </para> @address: -@Returns: +@prefix: <!-- ##### FUNCTION nm_ip6_address_get_gateway ##### --> @@ -296,87 +279,84 @@ NMSettingIP6Config @Returns: -<!-- ##### FUNCTION nm_ip6_address_get_prefix ##### --> +<!-- ##### FUNCTION nm_ip6_address_set_gateway ##### --> <para> </para> @address: -@Returns: +@gateway: -<!-- ##### FUNCTION nm_ip6_address_new ##### --> +<!-- ##### TYPEDEF NMIP6Route ##### --> <para> </para> -@void: -@Returns: - -<!-- ##### FUNCTION nm_ip6_address_ref ##### --> +<!-- ##### FUNCTION nm_ip6_route_new ##### --> <para> </para> -@address: +@void: +@Returns: -<!-- ##### FUNCTION nm_ip6_address_set_address ##### --> +<!-- ##### FUNCTION nm_ip6_route_dup ##### --> <para> </para> -@address: -@addr: +@source: +@Returns: -<!-- ##### FUNCTION nm_ip6_address_set_gateway ##### --> +<!-- ##### FUNCTION nm_ip6_route_ref ##### --> <para> </para> -@address: -@gateway: +@route: -<!-- ##### FUNCTION nm_ip6_address_set_prefix ##### --> +<!-- ##### FUNCTION nm_ip6_route_unref ##### --> <para> </para> -@address: -@prefix: +@route: -<!-- ##### FUNCTION nm_ip6_address_unref ##### --> +<!-- ##### FUNCTION nm_ip6_route_compare ##### --> <para> </para> -@address: +@route: +@other: +@Returns: -<!-- ##### FUNCTION nm_ip6_route_compare ##### --> +<!-- ##### FUNCTION nm_ip6_route_get_dest ##### --> <para> </para> @route: -@other: @Returns: -<!-- ##### FUNCTION nm_ip6_route_dup ##### --> +<!-- ##### FUNCTION nm_ip6_route_set_dest ##### --> <para> </para> -@source: -@Returns: +@route: +@dest: -<!-- ##### FUNCTION nm_ip6_route_get_dest ##### --> +<!-- ##### FUNCTION nm_ip6_route_get_prefix ##### --> <para> </para> @@ -385,13 +365,13 @@ NMSettingIP6Config @Returns: -<!-- ##### FUNCTION nm_ip6_route_get_metric ##### --> +<!-- ##### FUNCTION nm_ip6_route_set_prefix ##### --> <para> </para> @route: -@Returns: +@prefix: <!-- ##### FUNCTION nm_ip6_route_get_next_hop ##### --> @@ -403,141 +383,162 @@ NMSettingIP6Config @Returns: -<!-- ##### FUNCTION nm_ip6_route_get_prefix ##### --> +<!-- ##### FUNCTION nm_ip6_route_set_next_hop ##### --> <para> </para> @route: -@Returns: +@next_hop: -<!-- ##### FUNCTION nm_ip6_route_new ##### --> +<!-- ##### FUNCTION nm_ip6_route_get_metric ##### --> <para> </para> -@void: +@route: @Returns: -<!-- ##### FUNCTION nm_ip6_route_ref ##### --> +<!-- ##### FUNCTION nm_ip6_route_set_metric ##### --> <para> </para> @route: +@metric: -<!-- ##### FUNCTION nm_ip6_route_set_dest ##### --> +<!-- ##### STRUCT NMSettingIP6Config ##### --> <para> </para> -@route: -@dest: +<!-- ##### ARG NMSettingIP6Config:addresses ##### --> +<para> -<!-- ##### FUNCTION nm_ip6_route_set_metric ##### --> +</para> + +<!-- ##### ARG NMSettingIP6Config:dhcp-hostname ##### --> <para> </para> -@route: -@metric: +<!-- ##### ARG NMSettingIP6Config:dns ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip6_route_set_next_hop ##### --> +<!-- ##### ARG NMSettingIP6Config:dns-search ##### --> <para> </para> -@route: -@next_hop: +<!-- ##### ARG NMSettingIP6Config:ignore-auto-dns ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip6_route_set_prefix ##### --> +<!-- ##### ARG NMSettingIP6Config:ignore-auto-routes ##### --> <para> </para> -@route: -@prefix: +<!-- ##### ARG NMSettingIP6Config:ip6-privacy ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_ip6_route_unref ##### --> +<!-- ##### ARG NMSettingIP6Config:may-fail ##### --> <para> </para> -@route: +<!-- ##### ARG NMSettingIP6Config:method ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_ip6_config_add_address ##### --> +<!-- ##### ARG NMSettingIP6Config:never-default ##### --> <para> </para> -@setting: -@address: -@Returns: +<!-- ##### ARG NMSettingIP6Config:routes ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_ip6_config_add_dns ##### --> +<!-- ##### STRUCT NMSettingIP6ConfigClass ##### --> <para> </para> -@setting: -@dns: +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_ip6_config_new ##### --> +<para> + +</para> + +@void: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_add_dns_search ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_method ##### --> <para> </para> @setting: -@dns_search: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_add_route ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_dns ##### --> <para> </para> @setting: -@route: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_clear_addresses ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_dns ##### --> <para> </para> @setting: +@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_clear_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_add_dns ##### --> <para> </para> @setting: +@dns: +@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_clear_dns_searches ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_remove_dns ##### --> <para> </para> @setting: +@i: -<!-- ##### FUNCTION nm_setting_ip6_config_clear_routes ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_clear_dns ##### --> <para> </para> @@ -545,16 +546,16 @@ NMSettingIP6Config @setting: -<!-- ##### FUNCTION nm_setting_ip6_config_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_dns_searches ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_address ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_dns_search ##### --> <para> </para> @@ -564,36 +565,34 @@ NMSettingIP6Config @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_dhcp_hostname ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_add_dns_search ##### --> <para> </para> @setting: +@dns_search: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_remove_dns_search ##### --> <para> </para> @setting: @i: -@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_dns_search ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_clear_dns_searches ##### --> <para> </para> @setting: -@i: -@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_ignore_auto_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_addresses ##### --> <para> </para> @@ -602,43 +601,44 @@ NMSettingIP6Config @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_ignore_auto_routes ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_address ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_ip6_privacy ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_add_address ##### --> <para> </para> @setting: +@address: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_may_fail ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_remove_address ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_ip6_config_get_method ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_clear_addresses ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_never_default ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_num_routes ##### --> <para> </para> @@ -647,94 +647,94 @@ NMSettingIP6Config @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_num_addresses ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_route ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_num_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_add_route ##### --> <para> </para> @setting: +@route: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_num_dns_searches ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_remove_route ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_ip6_config_get_num_routes ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_clear_routes ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_get_route ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_ignore_auto_routes ##### --> <para> </para> @setting: -@i: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_new ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_ignore_auto_dns ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_remove_address ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_dhcp_hostname ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_remove_dns ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_never_default ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_remove_dns_search ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_may_fail ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_ip6_config_remove_route ##### --> +<!-- ##### FUNCTION nm_setting_ip6_config_get_ip6_privacy ##### --> <para> </para> @setting: -@i: +@Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml b/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml index 9a1e720e..6d525379 100644 --- a/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml +++ b/docs/libnm-util/tmpl/nm-setting-olpc-mesh.sgml @@ -22,46 +22,44 @@ NMSettingOlpcMesh <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingOlpcMesh ##### --> +<!-- ##### MACRO NM_SETTING_OLPC_MESH_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingOlpcMesh:channel ##### --> + +<!-- ##### ENUM NMSettingOlpcMeshError ##### --> <para> </para> -<!-- ##### ARG NMSettingOlpcMesh:dhcp-anycast-address ##### --> +@NM_SETTING_OLPC_MESH_ERROR_UNKNOWN: +@NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY: +@NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingOlpcMesh:ssid ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingOlpcMeshClass ##### --> +<!-- ##### FUNCTION nm_setting_olpc_mesh_error_quark ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: +@void: +@Returns: -<!-- ##### ENUM NMSettingOlpcMeshError ##### --> + +<!-- ##### MACRO NM_SETTING_OLPC_MESH_SSID ##### --> <para> </para> -@NM_SETTING_OLPC_MESH_ERROR_UNKNOWN: -@NM_SETTING_OLPC_MESH_ERROR_INVALID_PROPERTY: -@NM_SETTING_OLPC_MESH_ERROR_MISSING_PROPERTY: + <!-- ##### MACRO NM_SETTING_OLPC_MESH_CHANNEL ##### --> <para> @@ -77,46 +75,48 @@ NMSettingOlpcMesh -<!-- ##### MACRO NM_SETTING_OLPC_MESH_ERROR ##### --> +<!-- ##### STRUCT NMSettingOlpcMesh ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_OLPC_MESH_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingOlpcMesh:channel ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_OLPC_MESH_SSID ##### --> +<!-- ##### ARG NMSettingOlpcMesh:dhcp-anycast-address ##### --> <para> </para> +<!-- ##### ARG NMSettingOlpcMesh:ssid ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_olpc_mesh_error_quark ##### --> +<!-- ##### STRUCT NMSettingOlpcMeshClass ##### --> <para> </para> -@void: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_olpc_mesh_get_channel ##### --> +<!-- ##### FUNCTION nm_setting_olpc_mesh_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_olpc_mesh_get_dhcp_anycast_address ##### --> +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_ssid ##### --> <para> </para> @@ -125,7 +125,7 @@ NMSettingOlpcMesh @Returns: -<!-- ##### FUNCTION nm_setting_olpc_mesh_get_ssid ##### --> +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_channel ##### --> <para> </para> @@ -134,12 +134,12 @@ NMSettingOlpcMesh @Returns: -<!-- ##### FUNCTION nm_setting_olpc_mesh_new ##### --> +<!-- ##### FUNCTION nm_setting_olpc_mesh_get_dhcp_anycast_address ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-ppp.sgml b/docs/libnm-util/tmpl/nm-setting-ppp.sgml index 90815380..69cf509c 100644 --- a/docs/libnm-util/tmpl/nm-setting-ppp.sgml +++ b/docs/libnm-util/tmpl/nm-setting-ppp.sgml @@ -22,159 +22,131 @@ NMSettingPPP <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingPPP ##### --> +<!-- ##### MACRO NM_SETTING_PPP_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:baud ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingPPP:crtscts ##### --> +<!-- ##### ENUM NMSettingPPPError ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:lcp-echo-failure ##### --> +@NM_SETTING_PPP_ERROR_UNKNOWN: +@NM_SETTING_PPP_ERROR_INVALID_PROPERTY: +@NM_SETTING_PPP_ERROR_MISSING_PROPERTY: +@NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED: + +<!-- ##### MACRO NM_SETTING_PPP_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:lcp-echo-interval ##### --> -<para> -</para> -<!-- ##### ARG NMSettingPPP:mppe-stateful ##### --> +<!-- ##### FUNCTION nm_setting_ppp_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:mru ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingPPP:mtu ##### --> +<!-- ##### MACRO NM_SETTING_PPP_NOAUTH ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:no-vj-comp ##### --> -<para> -</para> -<!-- ##### ARG NMSettingPPP:noauth ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_EAP ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:nobsdcomp ##### --> -<para> -</para> -<!-- ##### ARG NMSettingPPP:nodeflate ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_PAP ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:refuse-chap ##### --> -<para> -</para> -<!-- ##### ARG NMSettingPPP:refuse-eap ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_CHAP ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:refuse-mschap ##### --> -<para> -</para> -<!-- ##### ARG NMSettingPPP:refuse-mschapv2 ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_MSCHAP ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:refuse-pap ##### --> -<para> -</para> -<!-- ##### ARG NMSettingPPP:require-mppe ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REFUSE_MSCHAPV2 ##### --> <para> </para> -<!-- ##### ARG NMSettingPPP:require-mppe-128 ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingPPPClass ##### --> +<!-- ##### MACRO NM_SETTING_PPP_NOBSDCOMP ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingPPPError ##### --> + +<!-- ##### MACRO NM_SETTING_PPP_NODEFLATE ##### --> <para> </para> -@NM_SETTING_PPP_ERROR_UNKNOWN: -@NM_SETTING_PPP_ERROR_INVALID_PROPERTY: -@NM_SETTING_PPP_ERROR_MISSING_PROPERTY: -@NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED: -<!-- ##### MACRO NM_SETTING_PPP_BAUD ##### --> + +<!-- ##### MACRO NM_SETTING_PPP_NO_VJ_COMP ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_CRTSCTS ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REQUIRE_MPPE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_PPP_REQUIRE_MPPE_128 ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_LCP_ECHO_FAILURE ##### --> +<!-- ##### MACRO NM_SETTING_PPP_MPPE_STATEFUL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_LCP_ECHO_INTERVAL ##### --> +<!-- ##### MACRO NM_SETTING_PPP_CRTSCTS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_MPPE_STATEFUL ##### --> +<!-- ##### MACRO NM_SETTING_PPP_BAUD ##### --> <para> </para> @@ -195,109 +167,137 @@ NMSettingPPP -<!-- ##### MACRO NM_SETTING_PPP_NOAUTH ##### --> +<!-- ##### MACRO NM_SETTING_PPP_LCP_ECHO_FAILURE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_NOBSDCOMP ##### --> +<!-- ##### MACRO NM_SETTING_PPP_LCP_ECHO_INTERVAL ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_PPP_NODEFLATE ##### --> +<!-- ##### STRUCT NMSettingPPP ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_PPP_NO_VJ_COMP ##### --> +<!-- ##### ARG NMSettingPPP:baud ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:crtscts ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REFUSE_CHAP ##### --> +<!-- ##### ARG NMSettingPPP:lcp-echo-failure ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:lcp-echo-interval ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REFUSE_EAP ##### --> +<!-- ##### ARG NMSettingPPP:mppe-stateful ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:mru ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REFUSE_MSCHAP ##### --> +<!-- ##### ARG NMSettingPPP:mtu ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:no-vj-comp ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REFUSE_MSCHAPV2 ##### --> +<!-- ##### ARG NMSettingPPP:noauth ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:nobsdcomp ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REFUSE_PAP ##### --> +<!-- ##### ARG NMSettingPPP:nodeflate ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:refuse-chap ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REQUIRE_MPPE ##### --> +<!-- ##### ARG NMSettingPPP:refuse-eap ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:refuse-mschap ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_REQUIRE_MPPE_128 ##### --> +<!-- ##### ARG NMSettingPPP:refuse-mschapv2 ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:refuse-pap ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPP_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingPPP:require-mppe ##### --> <para> </para> +<!-- ##### ARG NMSettingPPP:require-mppe-128 ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_ppp_error_quark ##### --> +<!-- ##### STRUCT NMSettingPPPClass ##### --> <para> </para> -@void: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_ppp_get_baud ##### --> +<!-- ##### FUNCTION nm_setting_ppp_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_crtscts ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_noauth ##### --> <para> </para> @@ -306,7 +306,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_lcp_echo_failure ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_eap ##### --> <para> </para> @@ -315,7 +315,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_lcp_echo_interval ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_pap ##### --> <para> </para> @@ -324,7 +324,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_mppe_stateful ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_chap ##### --> <para> </para> @@ -333,7 +333,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_mru ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_mschap ##### --> <para> </para> @@ -342,7 +342,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_mtu ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_refuse_mschapv2 ##### --> <para> </para> @@ -351,7 +351,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_no_vj_comp ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_nobsdcomp ##### --> <para> </para> @@ -360,7 +360,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_noauth ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_nodeflate ##### --> <para> </para> @@ -369,7 +369,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_nobsdcomp ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_no_vj_comp ##### --> <para> </para> @@ -378,7 +378,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_nodeflate ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_require_mppe ##### --> <para> </para> @@ -387,7 +387,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_refuse_chap ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_require_mppe_128 ##### --> <para> </para> @@ -396,7 +396,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_refuse_eap ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_mppe_stateful ##### --> <para> </para> @@ -405,7 +405,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_refuse_mschap ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_crtscts ##### --> <para> </para> @@ -414,7 +414,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_refuse_mschapv2 ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_baud ##### --> <para> </para> @@ -423,7 +423,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_refuse_pap ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_mru ##### --> <para> </para> @@ -432,7 +432,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_require_mppe ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_mtu ##### --> <para> </para> @@ -441,7 +441,7 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_get_require_mppe_128 ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_lcp_echo_failure ##### --> <para> </para> @@ -450,12 +450,12 @@ NMSettingPPP @Returns: -<!-- ##### FUNCTION nm_setting_ppp_new ##### --> +<!-- ##### FUNCTION nm_setting_ppp_get_lcp_echo_interval ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-pppoe.sgml b/docs/libnm-util/tmpl/nm-setting-pppoe.sgml index 3c022169..1ab1ae55 100644 --- a/docs/libnm-util/tmpl/nm-setting-pppoe.sgml +++ b/docs/libnm-util/tmpl/nm-setting-pppoe.sgml @@ -22,54 +22,47 @@ NMSettingPPPOE <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingPPPOE ##### --> +<!-- ##### MACRO NM_SETTING_PPPOE_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingPPPOE:password ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingPPPOE:password-flags ##### --> +<!-- ##### ENUM NMSettingPPPOEError ##### --> <para> </para> -<!-- ##### ARG NMSettingPPPOE:service ##### --> +@NM_SETTING_PPPOE_ERROR_UNKNOWN: +@NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY: +@NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY: +@NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING: + +<!-- ##### MACRO NM_SETTING_PPPOE_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingPPPOE:username ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingPPPOEClass ##### --> +<!-- ##### FUNCTION nm_setting_pppoe_error_quark ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: +@void: +@Returns: -<!-- ##### ENUM NMSettingPPPOEError ##### --> + +<!-- ##### MACRO NM_SETTING_PPPOE_SERVICE ##### --> <para> </para> -@NM_SETTING_PPPOE_ERROR_UNKNOWN: -@NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY: -@NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY: -@NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING: -<!-- ##### MACRO NM_SETTING_PPPOE_ERROR ##### --> + +<!-- ##### MACRO NM_SETTING_PPPOE_USERNAME ##### --> <para> </para> @@ -90,46 +83,53 @@ NMSettingPPPOE -<!-- ##### MACRO NM_SETTING_PPPOE_SERVICE ##### --> +<!-- ##### STRUCT NMSettingPPPOE ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_PPPOE_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingPPPOE:password ##### --> <para> </para> +<!-- ##### ARG NMSettingPPPOE:password-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_PPPOE_USERNAME ##### --> +<!-- ##### ARG NMSettingPPPOE:service ##### --> <para> </para> +<!-- ##### ARG NMSettingPPPOE:username ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_pppoe_error_quark ##### --> +<!-- ##### STRUCT NMSettingPPPOEClass ##### --> <para> </para> -@void: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_pppoe_get_password ##### --> +<!-- ##### FUNCTION nm_setting_pppoe_new ##### --> <para> </para> -@setting: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_pppoe_get_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_pppoe_get_service ##### --> <para> </para> @@ -138,7 +138,7 @@ NMSettingPPPOE @Returns: -<!-- ##### FUNCTION nm_setting_pppoe_get_service ##### --> +<!-- ##### FUNCTION nm_setting_pppoe_get_username ##### --> <para> </para> @@ -147,7 +147,7 @@ NMSettingPPPOE @Returns: -<!-- ##### FUNCTION nm_setting_pppoe_get_username ##### --> +<!-- ##### FUNCTION nm_setting_pppoe_get_password ##### --> <para> </para> @@ -156,12 +156,12 @@ NMSettingPPPOE @Returns: -<!-- ##### FUNCTION nm_setting_pppoe_new ##### --> +<!-- ##### FUNCTION nm_setting_pppoe_get_password_flags ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-private.sgml b/docs/libnm-util/tmpl/nm-setting-private.sgml index 8c990ffc..75ebe7a9 100644 --- a/docs/libnm-util/tmpl/nm-setting-private.sgml +++ b/docs/libnm-util/tmpl/nm-setting-private.sgml @@ -22,18 +22,18 @@ nm-setting-private <!-- ##### SECTION Image ##### --> -<!-- ##### MACRO NM_SETTING_REGISTER_TYPE ##### --> +<!-- ##### MACRO NM_SETTING_SECRET_FLAGS_ALL ##### --> <para> </para> -@x: -<!-- ##### MACRO NM_SETTING_SECRET_FLAGS_ALL ##### --> +<!-- ##### MACRO NM_SETTING_REGISTER_TYPE ##### --> <para> </para> +@x: diff --git a/docs/libnm-util/tmpl/nm-setting-serial.sgml b/docs/libnm-util/tmpl/nm-setting-serial.sgml index f0313441..b79ec0a9 100644 --- a/docs/libnm-util/tmpl/nm-setting-serial.sgml +++ b/docs/libnm-util/tmpl/nm-setting-serial.sgml @@ -22,108 +22,117 @@ NMSettingSerial <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingSerial ##### --> +<!-- ##### MACRO NM_SETTING_SERIAL_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingSerial:baud ##### --> + +<!-- ##### ENUM NMSettingSerialError ##### --> <para> </para> -<!-- ##### ARG NMSettingSerial:bits ##### --> +@NM_SETTING_SERIAL_ERROR_UNKNOWN: +@NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY: +@NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY: +@NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING: + +<!-- ##### MACRO NM_SETTING_SERIAL_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingSerial:parity ##### --> -<para> -</para> -<!-- ##### ARG NMSettingSerial:send-delay ##### --> +<!-- ##### FUNCTION nm_setting_serial_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingSerial:stopbits ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### STRUCT NMSettingSerialClass ##### --> +<!-- ##### MACRO NM_SETTING_SERIAL_BAUD ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingSerialError ##### --> + +<!-- ##### MACRO NM_SETTING_SERIAL_BITS ##### --> <para> </para> -@NM_SETTING_SERIAL_ERROR_UNKNOWN: -@NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY: -@NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY: -@NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING: -<!-- ##### MACRO NM_SETTING_SERIAL_BAUD ##### --> + +<!-- ##### MACRO NM_SETTING_SERIAL_PARITY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_SERIAL_BITS ##### --> +<!-- ##### MACRO NM_SETTING_SERIAL_STOPBITS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_SERIAL_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_SERIAL_SEND_DELAY ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_SERIAL_PARITY ##### --> +<!-- ##### STRUCT NMSettingSerial ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_SERIAL_SEND_DELAY ##### --> +<!-- ##### ARG NMSettingSerial:baud ##### --> <para> </para> +<!-- ##### ARG NMSettingSerial:bits ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_SERIAL_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingSerial:parity ##### --> <para> </para> +<!-- ##### ARG NMSettingSerial:send-delay ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_SERIAL_STOPBITS ##### --> +<!-- ##### ARG NMSettingSerial:stopbits ##### --> <para> </para> +<!-- ##### STRUCT NMSettingSerialClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_serial_error_quark ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_serial_new ##### --> <para> </para> @@ -159,15 +168,6 @@ NMSettingSerial @Returns: -<!-- ##### FUNCTION nm_setting_serial_get_send_delay ##### --> -<para> - -</para> - -@setting: -@Returns: - - <!-- ##### FUNCTION nm_setting_serial_get_stopbits ##### --> <para> @@ -177,12 +177,12 @@ NMSettingSerial @Returns: -<!-- ##### FUNCTION nm_setting_serial_new ##### --> +<!-- ##### FUNCTION nm_setting_serial_get_send_delay ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-vlan.sgml b/docs/libnm-util/tmpl/nm-setting-vlan.sgml index f7d67364..47b44bd6 100644 --- a/docs/libnm-util/tmpl/nm-setting-vlan.sgml +++ b/docs/libnm-util/tmpl/nm-setting-vlan.sgml @@ -22,178 +22,173 @@ NMSettingVlan <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingVlan ##### --> +<!-- ##### MACRO NM_SETTING_VLAN_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingVlan:egress-priority-map ##### --> -<para> -</para> - -<!-- ##### ARG NMSettingVlan:flags ##### --> +<!-- ##### ENUM NMSettingVlanError ##### --> <para> </para> -<!-- ##### ARG NMSettingVlan:id ##### --> +@NM_SETTING_VLAN_ERROR_UNKNOWN: +@NM_SETTING_VLAN_ERROR_INVALID_PROPERTY: +@NM_SETTING_VLAN_ERROR_MISSING_PROPERTY: +@NM_SETTING_VLAN_ERROR_INVALID_PARENT: + +<!-- ##### MACRO NM_SETTING_VLAN_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingVlan:ingress-priority-map ##### --> -<para> -</para> -<!-- ##### ARG NMSettingVlan:interface-name ##### --> +<!-- ##### FUNCTION nm_setting_vlan_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingVlan:parent ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### STRUCT NMSettingVlanClass ##### --> +<!-- ##### MACRO NM_SETTING_VLAN_INTERFACE_NAME ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingVlanError ##### --> + +<!-- ##### MACRO NM_SETTING_VLAN_PARENT ##### --> <para> </para> -@NM_SETTING_VLAN_ERROR_UNKNOWN: -@NM_SETTING_VLAN_ERROR_INVALID_PROPERTY: -@NM_SETTING_VLAN_ERROR_MISSING_PROPERTY: -@NM_SETTING_VLAN_ERROR_INVALID_PARENT: -<!-- ##### ENUM NMVlanFlags ##### --> + +<!-- ##### MACRO NM_SETTING_VLAN_ID ##### --> <para> </para> -@NM_VLAN_FLAG_REORDER_HEADERS: -@NM_VLAN_FLAG_GVRP: -@NM_VLAN_FLAG_LOOSE_BINDING: -<!-- ##### ENUM NMVlanPriorityMap ##### --> + +<!-- ##### MACRO NM_SETTING_VLAN_FLAGS ##### --> <para> </para> -@NM_VLAN_INGRESS_MAP: -@NM_VLAN_EGRESS_MAP: -<!-- ##### MACRO NM_SETTING_VLAN_EGRESS_PRIORITY_MAP ##### --> + +<!-- ##### MACRO NM_SETTING_VLAN_INGRESS_PRIORITY_MAP ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_VLAN_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_VLAN_EGRESS_PRIORITY_MAP ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_VLAN_FLAGS ##### --> +<!-- ##### STRUCT NMSettingVlan ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_VLAN_ID ##### --> +<!-- ##### ARG NMSettingVlan:egress-priority-map ##### --> <para> </para> +<!-- ##### ARG NMSettingVlan:flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_VLAN_INGRESS_PRIORITY_MAP ##### --> +<!-- ##### ARG NMSettingVlan:id ##### --> <para> </para> +<!-- ##### ARG NMSettingVlan:ingress-priority-map ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_VLAN_INTERFACE_NAME ##### --> +<!-- ##### ARG NMSettingVlan:interface-name ##### --> <para> </para> +<!-- ##### ARG NMSettingVlan:parent ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_VLAN_PARENT ##### --> +<!-- ##### STRUCT NMSettingVlanClass ##### --> <para> </para> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: - -<!-- ##### MACRO NM_SETTING_VLAN_SETTING_NAME ##### --> +<!-- ##### ENUM NMVlanPriorityMap ##### --> <para> </para> +@NM_VLAN_INGRESS_MAP: +@NM_VLAN_EGRESS_MAP: - -<!-- ##### FUNCTION nm_setting_vlan_add_priority ##### --> +<!-- ##### ENUM NMVlanFlags ##### --> <para> </para> -@setting: -@map: -@from: -@to: -@Returns: - +@NM_VLAN_FLAG_REORDER_HEADERS: +@NM_VLAN_FLAG_GVRP: +@NM_VLAN_FLAG_LOOSE_BINDING: -<!-- ##### FUNCTION nm_setting_vlan_add_priority_str ##### --> +<!-- ##### FUNCTION nm_setting_vlan_new ##### --> <para> </para> -@setting: -@map: -@str: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_vlan_clear_priorities ##### --> +<!-- ##### FUNCTION nm_setting_vlan_get_interface_name ##### --> <para> </para> @setting: -@map: +@Returns: -<!-- ##### FUNCTION nm_setting_vlan_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_vlan_get_parent ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_vlan_get_flags ##### --> +<!-- ##### FUNCTION nm_setting_vlan_get_id ##### --> <para> </para> @@ -202,7 +197,7 @@ NMSettingVlan @Returns: -<!-- ##### FUNCTION nm_setting_vlan_get_id ##### --> +<!-- ##### FUNCTION nm_setting_vlan_get_flags ##### --> <para> </para> @@ -211,35 +206,42 @@ NMSettingVlan @Returns: -<!-- ##### FUNCTION nm_setting_vlan_get_interface_name ##### --> +<!-- ##### FUNCTION nm_setting_vlan_get_num_priorities ##### --> <para> </para> @setting: +@map: @Returns: -<!-- ##### FUNCTION nm_setting_vlan_get_num_priorities ##### --> +<!-- ##### FUNCTION nm_setting_vlan_get_priority ##### --> <para> </para> @setting: @map: +@idx: +@out_from: +@out_to: @Returns: -<!-- ##### FUNCTION nm_setting_vlan_get_parent ##### --> +<!-- ##### FUNCTION nm_setting_vlan_add_priority ##### --> <para> </para> @setting: +@map: +@from: +@to: @Returns: -<!-- ##### FUNCTION nm_setting_vlan_get_priority ##### --> +<!-- ##### FUNCTION nm_setting_vlan_remove_priority ##### --> <para> </para> @@ -247,27 +249,25 @@ NMSettingVlan @setting: @map: @idx: -@out_from: -@out_to: -@Returns: -<!-- ##### FUNCTION nm_setting_vlan_new ##### --> +<!-- ##### FUNCTION nm_setting_vlan_clear_priorities ##### --> <para> </para> -@void: -@Returns: +@setting: +@map: -<!-- ##### FUNCTION nm_setting_vlan_remove_priority ##### --> +<!-- ##### FUNCTION nm_setting_vlan_add_priority_str ##### --> <para> </para> @setting: @map: -@idx: +@str: +@Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-vpn.sgml b/docs/libnm-util/tmpl/nm-setting-vpn.sgml index 567776c1..4b323f35 100644 --- a/docs/libnm-util/tmpl/nm-setting-vpn.sgml +++ b/docs/libnm-util/tmpl/nm-setting-vpn.sgml @@ -22,60 +22,50 @@ NMSettingVPN <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingVPN ##### --> +<!-- ##### MACRO NM_SETTING_VPN_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingVPN:data ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingVPN:secrets ##### --> +<!-- ##### ENUM NMSettingVpnError ##### --> <para> </para> -<!-- ##### ARG NMSettingVPN:service-type ##### --> +@NM_SETTING_VPN_ERROR_UNKNOWN: +@NM_SETTING_VPN_ERROR_INVALID_PROPERTY: +@NM_SETTING_VPN_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_VPN_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingVPN:user-name ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingVPNClass ##### --> +<!-- ##### FUNCTION nm_setting_vpn_error_quark ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: +@void: +@Returns: -<!-- ##### ENUM NMSettingVpnError ##### --> + +<!-- ##### MACRO NM_SETTING_VPN_SERVICE_TYPE ##### --> <para> </para> -@NM_SETTING_VPN_ERROR_UNKNOWN: -@NM_SETTING_VPN_ERROR_INVALID_PROPERTY: -@NM_SETTING_VPN_ERROR_MISSING_PROPERTY: -<!-- ##### USER_FUNCTION NMVPNIterFunc ##### --> + +<!-- ##### MACRO NM_SETTING_VPN_USER_NAME ##### --> <para> </para> -@key: -@value: -@user_data: <!-- ##### MACRO NM_SETTING_VPN_DATA ##### --> @@ -85,129 +75,136 @@ NMSettingVPN -<!-- ##### MACRO NM_SETTING_VPN_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_VPN_SECRETS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_VPN_SECRETS ##### --> +<!-- ##### STRUCT NMSettingVPN ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_VPN_SERVICE_TYPE ##### --> +<!-- ##### ARG NMSettingVPN:data ##### --> <para> </para> +<!-- ##### ARG NMSettingVPN:secrets ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_VPN_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingVPN:service-type ##### --> <para> </para> +<!-- ##### ARG NMSettingVPN:user-name ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_VPN_USER_NAME ##### --> +<!-- ##### STRUCT NMSettingVPNClass ##### --> <para> </para> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: - -<!-- ##### FUNCTION nm_setting_vpn_add_data_item ##### --> +<!-- ##### USER_FUNCTION NMVPNIterFunc ##### --> <para> </para> -@setting: @key: -@item: +@value: +@user_data: -<!-- ##### FUNCTION nm_setting_vpn_add_secret ##### --> +<!-- ##### FUNCTION nm_setting_vpn_new ##### --> <para> </para> -@setting: -@key: -@secret: +@void: +@Returns: -<!-- ##### FUNCTION nm_setting_vpn_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_vpn_get_service_type ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_vpn_foreach_data_item ##### --> +<!-- ##### FUNCTION nm_setting_vpn_get_user_name ##### --> <para> </para> @setting: -@func: -@user_data: +@Returns: -<!-- ##### FUNCTION nm_setting_vpn_foreach_secret ##### --> +<!-- ##### FUNCTION nm_setting_vpn_get_num_data_items ##### --> <para> </para> @setting: -@func: -@user_data: +@Returns: -<!-- ##### FUNCTION nm_setting_vpn_get_data_item ##### --> +<!-- ##### FUNCTION nm_setting_vpn_add_data_item ##### --> <para> </para> @setting: @key: -@Returns: +@item: -<!-- ##### FUNCTION nm_setting_vpn_get_num_data_items ##### --> +<!-- ##### FUNCTION nm_setting_vpn_get_data_item ##### --> <para> </para> @setting: +@key: @Returns: -<!-- ##### FUNCTION nm_setting_vpn_get_num_secrets ##### --> +<!-- ##### FUNCTION nm_setting_vpn_remove_data_item ##### --> <para> </para> @setting: -@Returns: +@key: -<!-- ##### FUNCTION nm_setting_vpn_get_secret ##### --> +<!-- ##### FUNCTION nm_setting_vpn_foreach_data_item ##### --> <para> </para> @setting: -@key: -@Returns: +@func: +@user_data: -<!-- ##### FUNCTION nm_setting_vpn_get_service_type ##### --> +<!-- ##### FUNCTION nm_setting_vpn_get_num_secrets ##### --> <para> </para> @@ -216,25 +213,27 @@ NMSettingVPN @Returns: -<!-- ##### FUNCTION nm_setting_vpn_get_user_name ##### --> +<!-- ##### FUNCTION nm_setting_vpn_add_secret ##### --> <para> </para> @setting: -@Returns: +@key: +@secret: -<!-- ##### FUNCTION nm_setting_vpn_new ##### --> +<!-- ##### FUNCTION nm_setting_vpn_get_secret ##### --> <para> </para> -@void: +@setting: +@key: @Returns: -<!-- ##### FUNCTION nm_setting_vpn_remove_data_item ##### --> +<!-- ##### FUNCTION nm_setting_vpn_remove_secret ##### --> <para> </para> @@ -243,12 +242,13 @@ NMSettingVPN @key: -<!-- ##### FUNCTION nm_setting_vpn_remove_secret ##### --> +<!-- ##### FUNCTION nm_setting_vpn_foreach_secret ##### --> <para> </para> @setting: -@key: +@func: +@user_data: diff --git a/docs/libnm-util/tmpl/nm-setting-wimax.sgml b/docs/libnm-util/tmpl/nm-setting-wimax.sgml index 0b96fa9f..151e723e 100644 --- a/docs/libnm-util/tmpl/nm-setting-wimax.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wimax.sgml @@ -22,39 +22,39 @@ NMSettingWimax <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingWimax ##### --> +<!-- ##### MACRO NM_SETTING_WIMAX_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingWimax:mac-address ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingWimax:network-name ##### --> +<!-- ##### ENUM NMSettingWimaxError ##### --> <para> </para> -<!-- ##### STRUCT NMSettingWimaxClass ##### --> +@NM_SETTING_WIMAX_ERROR_UNKNOWN: +@NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY: + +<!-- ##### MACRO NM_SETTING_WIMAX_ERROR ##### --> <para> </para> -@parent: -<!-- ##### ENUM NMSettingWimaxError ##### --> + +<!-- ##### FUNCTION nm_setting_wimax_error_quark ##### --> <para> </para> -@NM_SETTING_WIMAX_ERROR_UNKNOWN: -@NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY: -@NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY: +@void: +@Returns: -<!-- ##### MACRO NM_SETTING_WIMAX_ERROR ##### --> + +<!-- ##### MACRO NM_SETTING_WIMAX_NETWORK_NAME ##### --> <para> </para> @@ -68,35 +68,35 @@ NMSettingWimax -<!-- ##### MACRO NM_SETTING_WIMAX_NETWORK_NAME ##### --> +<!-- ##### STRUCT NMSettingWimax ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_WIMAX_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingWimax:mac-address ##### --> <para> </para> +<!-- ##### ARG NMSettingWimax:network-name ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_wimax_error_quark ##### --> +<!-- ##### STRUCT NMSettingWimaxClass ##### --> <para> </para> -@void: -@Returns: - +@parent: -<!-- ##### FUNCTION nm_setting_wimax_get_mac_address ##### --> +<!-- ##### FUNCTION nm_setting_wimax_new ##### --> <para> </para> -@setting: +@void: @Returns: @@ -109,12 +109,12 @@ NMSettingWimax @Returns: -<!-- ##### FUNCTION nm_setting_wimax_new ##### --> +<!-- ##### FUNCTION nm_setting_wimax_get_mac_address ##### --> <para> </para> -@void: +@setting: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-wired.sgml b/docs/libnm-util/tmpl/nm-setting-wired.sgml index 09fb963a..893a9c06 100644 --- a/docs/libnm-util/tmpl/nm-setting-wired.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wired.sgml @@ -22,88 +22,67 @@ NMSettingWired <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingWired ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingWired:auto-negotiate ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingWired:cloned-mac-address ##### --> +<!-- ##### ENUM NMSettingWiredError ##### --> <para> </para> -<!-- ##### ARG NMSettingWired:duplex ##### --> -<para> - -</para> +@NM_SETTING_WIRED_ERROR_UNKNOWN: +@NM_SETTING_WIRED_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIRED_ERROR_MISSING_PROPERTY: -<!-- ##### ARG NMSettingWired:mac-address ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingWired:mac-address-blacklist ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWired:mtu ##### --> +<!-- ##### FUNCTION nm_setting_wired_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingWired:port ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingWired:s390-nettype ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_PORT ##### --> <para> </para> -<!-- ##### ARG NMSettingWired:s390-options ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWired:s390-subchannels ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_SPEED ##### --> <para> </para> -<!-- ##### ARG NMSettingWired:speed ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingWiredClass ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_DUPLEX ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingWiredError ##### --> + +<!-- ##### MACRO NM_SETTING_WIRED_AUTO_NEGOTIATE ##### --> <para> </para> -@NM_SETTING_WIRED_ERROR_UNKNOWN: -@NM_SETTING_WIRED_ERROR_INVALID_PROPERTY: -@NM_SETTING_WIRED_ERROR_MISSING_PROPERTY: -<!-- ##### MACRO NM_SETTING_WIRED_AUTO_NEGOTIATE ##### --> + +<!-- ##### MACRO NM_SETTING_WIRED_MAC_ADDRESS ##### --> <para> </para> @@ -117,95 +96,114 @@ NMSettingWired -<!-- ##### MACRO NM_SETTING_WIRED_DUPLEX ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRED_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_MTU ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRED_MAC_ADDRESS ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_S390_SUBCHANNELS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_S390_NETTYPE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRED_MTU ##### --> +<!-- ##### MACRO NM_SETTING_WIRED_S390_OPTIONS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRED_PORT ##### --> +<!-- ##### STRUCT NMSettingWired ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_WIRED_S390_NETTYPE ##### --> +<!-- ##### ARG NMSettingWired:auto-negotiate ##### --> <para> </para> +<!-- ##### ARG NMSettingWired:cloned-mac-address ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRED_S390_OPTIONS ##### --> +<!-- ##### ARG NMSettingWired:duplex ##### --> <para> </para> +<!-- ##### ARG NMSettingWired:mac-address ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRED_S390_SUBCHANNELS ##### --> +<!-- ##### ARG NMSettingWired:mac-address-blacklist ##### --> <para> </para> +<!-- ##### ARG NMSettingWired:mtu ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRED_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingWired:port ##### --> <para> </para> +<!-- ##### ARG NMSettingWired:s390-nettype ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRED_SPEED ##### --> +<!-- ##### ARG NMSettingWired:s390-options ##### --> <para> </para> +<!-- ##### ARG NMSettingWired:s390-subchannels ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_wired_add_s390_option ##### --> +<!-- ##### ARG NMSettingWired:speed ##### --> <para> </para> -@setting: -@key: -@item: -@Returns: +<!-- ##### STRUCT NMSettingWiredClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_wired_error_quark ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_wired_new ##### --> <para> </para> @@ -214,7 +212,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_auto_negotiate ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_port ##### --> <para> </para> @@ -223,7 +221,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_cloned_mac_address ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_speed ##### --> <para> </para> @@ -241,7 +239,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_mac_address ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_auto_negotiate ##### --> <para> </para> @@ -250,7 +248,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_mac_address_blacklist ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_mac_address ##### --> <para> </para> @@ -259,7 +257,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_mtu ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_cloned_mac_address ##### --> <para> </para> @@ -268,7 +266,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_num_s390_options ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_mac_address_blacklist ##### --> <para> </para> @@ -277,7 +275,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_port ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_mtu ##### --> <para> </para> @@ -286,7 +284,7 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_s390_nettype ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_s390_subchannels ##### --> <para> </para> @@ -295,52 +293,54 @@ NMSettingWired @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_s390_option ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_s390_nettype ##### --> <para> </para> @setting: -@idx: -@out_key: -@out_value: @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_s390_option_by_key ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_num_s390_options ##### --> <para> </para> @setting: -@key: @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_s390_subchannels ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_s390_option ##### --> <para> </para> @setting: +@idx: +@out_key: +@out_value: @Returns: -<!-- ##### FUNCTION nm_setting_wired_get_speed ##### --> +<!-- ##### FUNCTION nm_setting_wired_get_s390_option_by_key ##### --> <para> </para> @setting: +@key: @Returns: -<!-- ##### FUNCTION nm_setting_wired_new ##### --> +<!-- ##### FUNCTION nm_setting_wired_add_s390_option ##### --> <para> </para> -@void: +@setting: +@key: +@item: @Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml b/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml index 01b16ce9..7c8b7dc8 100644 --- a/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wireless-security.sgml @@ -22,380 +22,381 @@ NMSettingWirelessSecurity <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingWirelessSecurity ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:auth-alg ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingWirelessSecurity:group ##### --> +<!-- ##### ENUM NMSettingWirelessSecurityError ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:key-mgmt ##### --> +@NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN: +@NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY: +@NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING: +@NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X: +@NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME: +@NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP: + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:leap-password ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWirelessSecurity:leap-password-flags ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:leap-username ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingWirelessSecurity:pairwise ##### --> +<!-- ##### ENUM NMWepKeyType ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:proto ##### --> +@NM_WEP_KEY_TYPE_UNKNOWN: +@NM_WEP_KEY_TYPE_KEY: +@NM_WEP_KEY_TYPE_PASSPHRASE: +@NM_WEP_KEY_TYPE_LAST: + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_KEY_MGMT ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:psk ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWirelessSecurity:psk-flags ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-key-flags ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-key-type ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_AUTH_ALG ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-key0 ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-key1 ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PROTO ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-key2 ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-key3 ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PAIRWISE ##### --> <para> </para> -<!-- ##### ARG NMSettingWirelessSecurity:wep-tx-keyidx ##### --> -<para> -</para> -<!-- ##### STRUCT NMSettingWirelessSecurityClass ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_GROUP ##### --> <para> </para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingWirelessSecurityError ##### --> + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME ##### --> <para> </para> -@NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN: -@NM_SETTING_WIRELESS_SECURITY_ERROR_INVALID_PROPERTY: -@NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_PROPERTY: -@NM_SETTING_WIRELESS_SECURITY_ERROR_MISSING_802_1X_SETTING: -@NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_802_1X: -@NM_SETTING_WIRELESS_SECURITY_ERROR_LEAP_REQUIRES_USERNAME: -@NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP: -<!-- ##### ENUM NMWepKeyType ##### --> + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 ##### --> <para> </para> -@NM_WEP_KEY_TYPE_UNKNOWN: -@NM_WEP_KEY_TYPE_KEY: -@NM_WEP_KEY_TYPE_PASSPHRASE: -@NM_WEP_KEY_TYPE_LAST: -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_AUTH_ALG ##### --> + +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_GROUP ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_KEY_MGMT ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PAIRWISE ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PROTO ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK ##### --> +<!-- ##### STRUCT NMSettingWirelessSecurity ##### --> <para> </para> - -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:auth-alg ##### --> <para> </para> - - -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:group ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:key-mgmt ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:leap-password ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:leap-password-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:leap-username ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:pairwise ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:proto ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:psk ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:psk-flags ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:wep-key-flags ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:wep-key-type ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:wep-key0 ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:wep-key1 ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:wep-key2 ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX ##### --> +<!-- ##### ARG NMSettingWirelessSecurity:wep-key3 ##### --> <para> </para> +<!-- ##### ARG NMSettingWirelessSecurity:wep-tx-keyidx ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_wireless_security_add_group ##### --> +<!-- ##### STRUCT NMSettingWirelessSecurityClass ##### --> <para> </para> -@setting: -@group: -@Returns: - +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: -<!-- ##### FUNCTION nm_setting_wireless_security_add_pairwise ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_new ##### --> <para> </para> -@setting: -@pairwise: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_add_proto ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_key_mgmt ##### --> <para> </para> @setting: -@proto: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_clear_groups ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_num_protos ##### --> <para> </para> @setting: +@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_clear_pairwise ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_proto ##### --> <para> </para> @setting: +@i: +@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_clear_protos ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_add_proto ##### --> <para> </para> @setting: +@proto: +@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_remove_proto ##### --> <para> </para> -@void: -@Returns: +@setting: +@i: -<!-- ##### FUNCTION nm_setting_wireless_security_get_auth_alg ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_clear_protos ##### --> <para> </para> @setting: -@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_group ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_num_pairwise ##### --> <para> </para> @setting: -@i: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_key_mgmt ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_pairwise ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_password ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_add_pairwise ##### --> <para> </para> @setting: +@pairwise: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_password_flags ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_remove_pairwise ##### --> <para> </para> @setting: -@Returns: +@i: -<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_username ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_clear_pairwise ##### --> <para> </para> @setting: -@Returns: <!-- ##### FUNCTION nm_setting_wireless_security_get_num_groups ##### --> @@ -407,42 +408,41 @@ NMSettingWirelessSecurity @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_num_pairwise ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_group ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_num_protos ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_add_group ##### --> <para> </para> @setting: +@group: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_pairwise ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_remove_group ##### --> <para> </para> @setting: @i: -@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_proto ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_clear_groups ##### --> <para> </para> @setting: -@i: -@Returns: <!-- ##### FUNCTION nm_setting_wireless_security_get_psk ##### --> @@ -463,17 +463,16 @@ NMSettingWirelessSecurity @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_username ##### --> <para> </para> @setting: -@idx: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key_flags ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_password ##### --> <para> </para> @@ -482,7 +481,7 @@ NMSettingWirelessSecurity @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key_type ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_leap_password_flags ##### --> <para> </para> @@ -491,58 +490,59 @@ NMSettingWirelessSecurity @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_tx_keyidx ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key ##### --> <para> </para> @setting: +@idx: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_new ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_set_wep_key ##### --> <para> </para> -@void: -@Returns: +@setting: +@idx: +@key: -<!-- ##### FUNCTION nm_setting_wireless_security_remove_group ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_tx_keyidx ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_remove_pairwise ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_auth_alg ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_remove_proto ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key_flags ##### --> <para> </para> @setting: -@i: +@Returns: -<!-- ##### FUNCTION nm_setting_wireless_security_set_wep_key ##### --> +<!-- ##### FUNCTION nm_setting_wireless_security_get_wep_key_type ##### --> <para> </para> @setting: -@idx: -@key: +@Returns: diff --git a/docs/libnm-util/tmpl/nm-setting-wireless.sgml b/docs/libnm-util/tmpl/nm-setting-wireless.sgml index a74c82ef..e390bb09 100644 --- a/docs/libnm-util/tmpl/nm-setting-wireless.sgml +++ b/docs/libnm-util/tmpl/nm-setting-wireless.sgml @@ -22,119 +22,90 @@ NMSettingWireless <!-- ##### SECTION Image ##### --> -<!-- ##### STRUCT NMSettingWireless ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SETTING_NAME ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:band ##### --> -<para> - -</para> -<!-- ##### ARG NMSettingWireless:bssid ##### --> +<!-- ##### ENUM NMSettingWirelessError ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:channel ##### --> -<para> - -</para> +@NM_SETTING_WIRELESS_ERROR_UNKNOWN: +@NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY: +@NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY: +@NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING: +@NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND: -<!-- ##### ARG NMSettingWireless:cloned-mac-address ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_ERROR ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:hidden ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWireless:mac-address ##### --> +<!-- ##### FUNCTION nm_setting_wireless_error_quark ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:mac-address-blacklist ##### --> -<para> +@void: +@Returns: -</para> -<!-- ##### ARG NMSettingWireless:mode ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SSID ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:mtu ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWireless:rate ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_MODE ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:security ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWireless:seen-bssids ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_BAND ##### --> <para> </para> -<!-- ##### ARG NMSettingWireless:ssid ##### --> -<para> -</para> -<!-- ##### ARG NMSettingWireless:tx-power ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_CHANNEL ##### --> <para> </para> -<!-- ##### STRUCT NMSettingWirelessClass ##### --> -<para> - -</para> -@parent: -@_reserved1: -@_reserved2: -@_reserved3: -@_reserved4: -<!-- ##### ENUM NMSettingWirelessError ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_BSSID ##### --> <para> </para> -@NM_SETTING_WIRELESS_ERROR_UNKNOWN: -@NM_SETTING_WIRELESS_ERROR_INVALID_PROPERTY: -@NM_SETTING_WIRELESS_ERROR_MISSING_PROPERTY: -@NM_SETTING_WIRELESS_ERROR_MISSING_SECURITY_SETTING: -@NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND: -<!-- ##### MACRO NM_SETTING_WIRELESS_BAND ##### --> + +<!-- ##### MACRO NM_SETTING_WIRELESS_RATE ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_BSSID ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_TX_POWER ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_CHANNEL ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_MAC_ADDRESS ##### --> <para> </para> @@ -148,35 +119,35 @@ NMSettingWireless -<!-- ##### MACRO NM_SETTING_WIRELESS_ERROR ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_HIDDEN ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_MTU ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_MAC_ADDRESS ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SEEN_BSSIDS ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_SEC ##### --> <para> </para> -<!-- ##### MACRO NM_SETTING_WIRELESS_MODE ##### --> +<!-- ##### MACRO NM_SETTING_WIRELESS_HIDDEN ##### --> <para> </para> @@ -204,89 +175,112 @@ NMSettingWireless -<!-- ##### MACRO NM_SETTING_WIRELESS_MTU ##### --> +<!-- ##### STRUCT NMSettingWireless ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:band ##### --> +<para> + +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_RATE ##### --> +<!-- ##### ARG NMSettingWireless:bssid ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:channel ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SEC ##### --> +<!-- ##### ARG NMSettingWireless:cloned-mac-address ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:hidden ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SEEN_BSSIDS ##### --> +<!-- ##### ARG NMSettingWireless:mac-address ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:mac-address-blacklist ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SETTING_NAME ##### --> +<!-- ##### ARG NMSettingWireless:mode ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:mtu ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_SSID ##### --> +<!-- ##### ARG NMSettingWireless:rate ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:security ##### --> +<para> +</para> -<!-- ##### MACRO NM_SETTING_WIRELESS_TX_POWER ##### --> +<!-- ##### ARG NMSettingWireless:seen-bssids ##### --> <para> </para> +<!-- ##### ARG NMSettingWireless:ssid ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_wireless_add_seen_bssid ##### --> +<!-- ##### ARG NMSettingWireless:tx-power ##### --> <para> </para> -@setting: -@bssid: -@Returns: +<!-- ##### STRUCT NMSettingWirelessClass ##### --> +<para> +</para> -<!-- ##### FUNCTION nm_setting_wireless_ap_security_compatible ##### --> +@parent: +@_reserved1: +@_reserved2: +@_reserved3: +@_reserved4: + +<!-- ##### FUNCTION nm_setting_wireless_new ##### --> <para> </para> -@s_wireless: -@s_wireless_sec: -@ap_flags: -@ap_wpa: -@ap_rsn: -@ap_mode: +@void: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_error_quark ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_ssid ##### --> <para> </para> -@void: +@setting: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_band ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_mode ##### --> <para> </para> @@ -295,7 +289,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_bssid ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_band ##### --> <para> </para> @@ -313,7 +307,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_cloned_mac_address ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_bssid ##### --> <para> </para> @@ -322,7 +316,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_hidden ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_rate ##### --> <para> </para> @@ -331,7 +325,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_mac_address ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_tx_power ##### --> <para> </para> @@ -340,7 +334,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_mac_address_blacklist ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_mac_address ##### --> <para> </para> @@ -349,7 +343,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_mode ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_cloned_mac_address ##### --> <para> </para> @@ -358,7 +352,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_mtu ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_mac_address_blacklist ##### --> <para> </para> @@ -367,7 +361,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_num_seen_bssids ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_mtu ##### --> <para> </para> @@ -376,7 +370,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_rate ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_security ##### --> <para> </para> @@ -385,7 +379,7 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_security ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_hidden ##### --> <para> </para> @@ -394,17 +388,17 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_seen_bssid ##### --> +<!-- ##### FUNCTION nm_setting_wireless_add_seen_bssid ##### --> <para> </para> @setting: -@i: +@bssid: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_ssid ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_num_seen_bssids ##### --> <para> </para> @@ -413,21 +407,27 @@ NMSettingWireless @Returns: -<!-- ##### FUNCTION nm_setting_wireless_get_tx_power ##### --> +<!-- ##### FUNCTION nm_setting_wireless_get_seen_bssid ##### --> <para> </para> @setting: +@i: @Returns: -<!-- ##### FUNCTION nm_setting_wireless_new ##### --> +<!-- ##### FUNCTION nm_setting_wireless_ap_security_compatible ##### --> <para> </para> -@void: +@s_wireless: +@s_wireless_sec: +@ap_flags: +@ap_wpa: +@ap_rsn: +@ap_mode: @Returns: 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: diff --git a/docs/libnm-util/tmpl/nm-utils.sgml b/docs/libnm-util/tmpl/nm-utils.sgml index acb59fe9..f4ae27dd 100644 --- a/docs/libnm-util/tmpl/nm-utils.sgml +++ b/docs/libnm-util/tmpl/nm-utils.sgml @@ -22,44 +22,31 @@ nm-utils <!-- ##### SECTION Image ##### --> -<!-- ##### ENUM NMUtilsSecurityType ##### --> -<para> - -</para> - -@NMU_SEC_INVALID: -@NMU_SEC_NONE: -@NMU_SEC_STATIC_WEP: -@NMU_SEC_LEAP: -@NMU_SEC_DYNAMIC_WEP: -@NMU_SEC_WPA_PSK: -@NMU_SEC_WPA_ENTERPRISE: -@NMU_SEC_WPA2_PSK: -@NMU_SEC_WPA2_ENTERPRISE: - -<!-- ##### MACRO NM_UTILS_HWADDR_LEN_MAX ##### --> +<!-- ##### FUNCTION nm_utils_init ##### --> <para> </para> +@error: +@Returns: -<!-- ##### FUNCTION nm_utils_ap_mode_security_valid ##### --> +<!-- ##### FUNCTION nm_utils_deinit ##### --> <para> </para> -@type: -@wifi_caps: -@Returns: +@void: -<!-- ##### FUNCTION nm_utils_deinit ##### --> +<!-- ##### FUNCTION nm_utils_is_empty_ssid ##### --> <para> </para> -@void: +@ssid: +@len: +@Returns: <!-- ##### FUNCTION nm_utils_escape_ssid ##### --> @@ -72,88 +59,100 @@ nm-utils @Returns: -<!-- ##### FUNCTION nm_utils_file_is_pkcs12 ##### --> +<!-- ##### FUNCTION nm_utils_same_ssid ##### --> <para> </para> -@filename: +@ssid1: +@ssid2: +@ignore_trailing_null: @Returns: -<!-- ##### FUNCTION nm_utils_gvalue_hash_dup ##### --> +<!-- ##### FUNCTION nm_utils_ssid_to_utf8 ##### --> <para> </para> -@hash: +@ssid: @Returns: -<!-- ##### FUNCTION nm_utils_hwaddr_atoba ##### --> +<!-- ##### FUNCTION nm_utils_gvalue_hash_dup ##### --> <para> </para> -@asc: -@type: +@hash: @Returns: -<!-- ##### FUNCTION nm_utils_hwaddr_aton ##### --> +<!-- ##### FUNCTION nm_utils_slist_free ##### --> <para> </para> -@asc: -@type: -@buffer: -@Returns: +@list: +@elem_destroy_fn: -<!-- ##### FUNCTION nm_utils_hwaddr_len ##### --> +<!-- ##### ENUM NMUtilsSecurityType ##### --> <para> </para> -@type: -@Returns: - +@NMU_SEC_INVALID: +@NMU_SEC_NONE: +@NMU_SEC_STATIC_WEP: +@NMU_SEC_LEAP: +@NMU_SEC_DYNAMIC_WEP: +@NMU_SEC_WPA_PSK: +@NMU_SEC_WPA_ENTERPRISE: +@NMU_SEC_WPA2_PSK: +@NMU_SEC_WPA2_ENTERPRISE: -<!-- ##### FUNCTION nm_utils_hwaddr_ntoa ##### --> +<!-- ##### FUNCTION nm_utils_security_valid ##### --> <para> </para> -@addr: @type: +@wifi_caps: +@have_ap: +@adhoc: +@ap_flags: +@ap_wpa: +@ap_rsn: @Returns: -<!-- ##### FUNCTION nm_utils_hwaddr_type ##### --> +<!-- ##### FUNCTION nm_utils_ap_mode_security_valid ##### --> <para> </para> -@len: +@type: +@wifi_caps: @Returns: -<!-- ##### FUNCTION nm_utils_iface_valid_name ##### --> +<!-- ##### FUNCTION nm_utils_wep_key_valid ##### --> <para> </para> -@name: +@key: +@wep_type: @Returns: -<!-- ##### FUNCTION nm_utils_init ##### --> +<!-- ##### FUNCTION nm_utils_wpa_psk_valid ##### --> <para> </para> -@error: +@psk: @Returns: @@ -175,49 +174,49 @@ nm-utils @value: -<!-- ##### FUNCTION nm_utils_ip4_get_default_prefix ##### --> +<!-- ##### FUNCTION nm_utils_ip4_routes_from_gvalue ##### --> <para> </para> -@ip: +@value: @Returns: -<!-- ##### FUNCTION nm_utils_ip4_netmask_to_prefix ##### --> +<!-- ##### FUNCTION nm_utils_ip4_routes_to_gvalue ##### --> <para> </para> -@netmask: -@Returns: +@list: +@value: -<!-- ##### FUNCTION nm_utils_ip4_prefix_to_netmask ##### --> +<!-- ##### FUNCTION nm_utils_ip4_netmask_to_prefix ##### --> <para> </para> -@prefix: +@netmask: @Returns: -<!-- ##### FUNCTION nm_utils_ip4_routes_from_gvalue ##### --> +<!-- ##### FUNCTION nm_utils_ip4_prefix_to_netmask ##### --> <para> </para> -@value: +@prefix: @Returns: -<!-- ##### FUNCTION nm_utils_ip4_routes_to_gvalue ##### --> +<!-- ##### FUNCTION nm_utils_ip4_get_default_prefix ##### --> <para> </para> -@list: -@value: +@ip: +@Returns: <!-- ##### FUNCTION nm_utils_ip6_addresses_from_gvalue ##### --> @@ -238,7 +237,7 @@ nm-utils @value: -<!-- ##### FUNCTION nm_utils_ip6_dns_from_gvalue ##### --> +<!-- ##### FUNCTION nm_utils_ip6_routes_from_gvalue ##### --> <para> </para> @@ -247,7 +246,7 @@ nm-utils @Returns: -<!-- ##### FUNCTION nm_utils_ip6_dns_to_gvalue ##### --> +<!-- ##### FUNCTION nm_utils_ip6_routes_to_gvalue ##### --> <para> </para> @@ -256,7 +255,7 @@ nm-utils @value: -<!-- ##### FUNCTION nm_utils_ip6_routes_from_gvalue ##### --> +<!-- ##### FUNCTION nm_utils_ip6_dns_from_gvalue ##### --> <para> </para> @@ -265,7 +264,7 @@ nm-utils @Returns: -<!-- ##### FUNCTION nm_utils_ip6_routes_to_gvalue ##### --> +<!-- ##### FUNCTION nm_utils_ip6_dns_to_gvalue ##### --> <para> </para> @@ -274,22 +273,21 @@ nm-utils @value: -<!-- ##### FUNCTION nm_utils_is_empty_ssid ##### --> +<!-- ##### FUNCTION nm_utils_uuid_generate ##### --> <para> </para> -@ssid: -@len: +@void: @Returns: -<!-- ##### FUNCTION nm_utils_is_uuid ##### --> +<!-- ##### FUNCTION nm_utils_uuid_generate_from_string ##### --> <para> </para> -@str: +@s: @Returns: @@ -305,124 +303,126 @@ nm-utils @Returns: -<!-- ##### FUNCTION nm_utils_same_ssid ##### --> +<!-- ##### FUNCTION nm_utils_file_is_pkcs12 ##### --> <para> </para> -@ssid1: -@ssid2: -@ignore_trailing_null: +@filename: @Returns: -<!-- ##### FUNCTION nm_utils_security_valid ##### --> +<!-- ##### FUNCTION nm_utils_wifi_freq_to_channel ##### --> <para> </para> -@type: -@wifi_caps: -@have_ap: -@adhoc: -@ap_flags: -@ap_wpa: -@ap_rsn: +@freq: @Returns: -<!-- ##### FUNCTION nm_utils_slist_free ##### --> +<!-- ##### FUNCTION nm_utils_wifi_channel_to_freq ##### --> <para> </para> -@list: -@elem_destroy_fn: +@channel: +@band: +@Returns: -<!-- ##### FUNCTION nm_utils_ssid_to_utf8 ##### --> +<!-- ##### FUNCTION nm_utils_wifi_find_next_channel ##### --> <para> </para> -@ssid: +@channel: +@direction: +@band: @Returns: -<!-- ##### FUNCTION nm_utils_uuid_generate ##### --> +<!-- ##### FUNCTION nm_utils_wifi_is_channel_valid ##### --> <para> </para> -@void: +@channel: +@band: @Returns: -<!-- ##### FUNCTION nm_utils_uuid_generate_from_string ##### --> +<!-- ##### MACRO NM_UTILS_HWADDR_LEN_MAX ##### --> <para> </para> -@s: + + +<!-- ##### FUNCTION nm_utils_hwaddr_len ##### --> +<para> + +</para> + +@type: @Returns: -<!-- ##### FUNCTION nm_utils_wep_key_valid ##### --> +<!-- ##### FUNCTION nm_utils_hwaddr_type ##### --> <para> </para> -@key: -@wep_type: +@len: @Returns: -<!-- ##### FUNCTION nm_utils_wifi_channel_to_freq ##### --> +<!-- ##### FUNCTION nm_utils_hwaddr_ntoa ##### --> <para> </para> -@channel: -@band: +@addr: +@type: @Returns: -<!-- ##### FUNCTION nm_utils_wifi_find_next_channel ##### --> +<!-- ##### FUNCTION nm_utils_hwaddr_atoba ##### --> <para> </para> -@channel: -@direction: -@band: +@asc: +@type: @Returns: -<!-- ##### FUNCTION nm_utils_wifi_freq_to_channel ##### --> +<!-- ##### FUNCTION nm_utils_hwaddr_aton ##### --> <para> </para> -@freq: +@asc: +@type: +@buffer: @Returns: -<!-- ##### FUNCTION nm_utils_wifi_is_channel_valid ##### --> +<!-- ##### FUNCTION nm_utils_iface_valid_name ##### --> <para> </para> -@channel: -@band: +@name: @Returns: -<!-- ##### FUNCTION nm_utils_wpa_psk_valid ##### --> +<!-- ##### FUNCTION nm_utils_is_uuid ##### --> <para> </para> -@psk: +@str: @Returns: |