diff options
Diffstat (limited to 'docs/libnm-util/tmpl/nm-utils.sgml')
| -rw-r--r-- | docs/libnm-util/tmpl/nm-utils.sgml | 210 |
1 files changed, 105 insertions, 105 deletions
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: |