From b39d1280a7c9338171916fb7be1cdeddb8af1062 Mon Sep 17 00:00:00 2001 From: Jouni Malinen Date: Sun, 4 Jan 2009 15:07:54 +0200 Subject: [PATCH] Silenced number of Doxygen warnings --- src/crypto/ms_funcs.c | 4 ++-- src/drivers/driver.h | 2 +- src/eap_peer/eap_config.h | 26 +++++++++++++------------- src/utils/includes.h | 2 +- src/utils/state_machine.h | 6 +++--- src/utils/wpa_debug.h | 2 +- wpa_supplicant/config.h | 4 ++-- wpa_supplicant/config_winreg.c | 14 +++++++++----- wpa_supplicant/main_winsvc.c | 2 +- 9 files changed, 33 insertions(+), 29 deletions(-) diff --git a/src/crypto/ms_funcs.c b/src/crypto/ms_funcs.c index cb8e72da4..c14af64af 100644 --- a/src/crypto/ms_funcs.c +++ b/src/crypto/ms_funcs.c @@ -164,7 +164,7 @@ void generate_nt_response_pwhash(const u8 *auth_challenge, * @username: 0-to-256-char UserName (IN) * @username_len: Length of username * @response: 20-octet AuthenticatorResponse (OUT) (note: this value is usually - * encoded as a 42-octet ASCII string (S=) + * encoded as a 42-octet ASCII string (S=hexdump_of_response) */ void generate_authenticator_response_pwhash( const u8 *password_hash, @@ -219,7 +219,7 @@ void generate_authenticator_response_pwhash( * @username: 0-to-256-char UserName (IN) * @username_len: Length of username * @response: 20-octet AuthenticatorResponse (OUT) (note: this value is usually - * encoded as a 42-octet ASCII string (S=) + * encoded as a 42-octet ASCII string (S=hexdump_of_response) */ void generate_authenticator_response(const u8 *password, size_t password_len, const u8 *peer_challenge, diff --git a/src/drivers/driver.h b/src/drivers/driver.h index ef51e9a2d..9bce6c6e8 100644 --- a/src/drivers/driver.h +++ b/src/drivers/driver.h @@ -941,7 +941,7 @@ struct wpa_driver_ops { struct wpa_scan_results * (*get_scan_results2)(void *priv); /** - * * set_probe_req_ie - Set information element(s) for Probe Request + * set_probe_req_ie - Set information element(s) for Probe Request * @priv: private driver interface data * @ies: Information elements to append or %NULL to remove extra IEs * @ies_len: Length of the IE buffer in octets diff --git a/src/eap_peer/eap_config.h b/src/eap_peer/eap_config.h index 6e4919cff..94245c3d0 100644 --- a/src/eap_peer/eap_config.h +++ b/src/eap_peer/eap_config.h @@ -83,10 +83,10 @@ struct eap_peer_config { * wpa_supplicant is run in the background. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. * * On Windows, trusted CA certificates can be loaded from the system - * certificate store by setting this to cert_store://, e.g., + * certificate store by setting this to cert_store://name, e.g., * ca_cert="cert_store://CA" or ca_cert="cert_store://ROOT". * Note that when running wpa_supplicant as an application, the user * certificate store (My user account) is used, whereas computer store @@ -115,7 +115,7 @@ struct eap_peer_config { * wpa_supplicant is run in the background. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *client_cert; @@ -142,7 +142,7 @@ struct eap_peer_config { * (Computer account) is used when running wpasvc as a service. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *private_key; @@ -167,7 +167,7 @@ struct eap_peer_config { * wpa_supplicant is run in the background. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *dh_file; @@ -215,7 +215,7 @@ struct eap_peer_config { * EAP-TTLS/PEAP/FAST tunnel) authentication. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *ca_cert2; @@ -242,7 +242,7 @@ struct eap_peer_config { * wpa_supplicant is run in the background. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *client_cert2; @@ -255,7 +255,7 @@ struct eap_peer_config { * wpa_supplicant is run in the background. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *private_key2; @@ -276,7 +276,7 @@ struct eap_peer_config { * wpa_supplicant is run in the background. * * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ u8 *dh_file2; @@ -344,7 +344,7 @@ struct eap_peer_config { * 2 = allow authenticated provisioning, * 3 = allow both unauthenticated and authenticated provisioning * - * fast_max_pac_list_len= option can be used to set the maximum + * fast_max_pac_list_len=num option can be used to set the maximum * number of PAC entries to store in a PAC list (default: 10). * * fast_pac_format=binary option can be used to select binary format @@ -357,8 +357,8 @@ struct eap_peer_config { * 1 = use cryptobinding if server supports it * 2 = require cryptobinding * - * EAP-WSC (WPS) uses following options: pin= and - * uuid= + * EAP-WSC (WPS) uses following options: pin=Device_Password and + * uuid=Device_UUID */ char *phase1; @@ -578,7 +578,7 @@ struct eap_peer_config { * to the file should be used since working directory may change when * wpa_supplicant is run in the background. * Alternatively, a named configuration blob can be used by setting - * this to blob://. + * this to blob://blob_name. */ char *pac_file; diff --git a/src/utils/includes.h b/src/utils/includes.h index 0a9bcc6d6..63b5c23d8 100644 --- a/src/utils/includes.h +++ b/src/utils/includes.h @@ -12,7 +12,7 @@ * See README and COPYING for more details. * * This header file is included into all C files so that commonly used header - * files can be selected with OS specific #ifdefs in one place instead of + * files can be selected with OS specific ifdef blocks in one place instead of * having to have OS/C library specific selection in many files. */ diff --git a/src/utils/state_machine.h b/src/utils/state_machine.h index 62766bf40..31f667217 100644 --- a/src/utils/state_machine.h +++ b/src/utils/state_machine.h @@ -14,7 +14,7 @@ * This file includes a set of pre-processor macros that can be used to * implement a state machine. In addition to including this header file, each * file implementing a state machine must define STATE_MACHINE_DATA to be the - * data structure including state variables (enum _state, + * data structure including state variables (enum machine_state, * Boolean changed), and STATE_MACHINE_DEBUG_PREFIX to be a string that is used * as a prefix for all debug messages. If SM_ENTRY_MA macro is used to define * a group of state machines with shared data structure, STATE_MACHINE_ADDR @@ -61,7 +61,7 @@ sm->machine ## _state = machine ## _ ## state; * SM_ENTRY_M - State machine function entry point for state machine group * @machine: State machine name * @_state: State machine state - * @data: State variable prefix (full variable: _state) + * @data: State variable prefix (full variable: prefix_state) * * This macro is like SM_ENTRY, but for state machine groups that use a shared * data structure for more than one state machine. Both machine and prefix @@ -80,7 +80,7 @@ sm->data ## _ ## state = machine ## _ ## _state; * SM_ENTRY_MA - State machine function entry point for state machine group * @machine: State machine name * @_state: State machine state - * @data: State variable prefix (full variable: _state) + * @data: State variable prefix (full variable: prefix_state) * * This macro is like SM_ENTRY_M, but a MAC address is included in debug * output. STATE_MACHINE_ADDR has to be defined to point to the MAC address to diff --git a/src/utils/wpa_debug.h b/src/utils/wpa_debug.h index 7f50e3f72..2d23f0649 100644 --- a/src/utils/wpa_debug.h +++ b/src/utils/wpa_debug.h @@ -43,7 +43,7 @@ void wpa_debug_close_file(void); /** * wpa_debug_printf_timestamp - Print timestamp for debug output * - * This function prints a timestamp in . + * This function prints a timestamp in seconds_from_1970.microsoconds * format if debug output has been configured to include timestamps in debug * messages. */ diff --git a/wpa_supplicant/config.h b/wpa_supplicant/config.h index 9cb006644..0cea4dc99 100644 --- a/wpa_supplicant/config.h +++ b/wpa_supplicant/config.h @@ -154,7 +154,7 @@ struct wpa_config { * ctrl_interface_group - Control interface group (DEPRECATED) * * This variable is only used for backwards compatibility. Group for - * UNIX domain sockets should now be specified using GROUP= in + * UNIX domain sockets should now be specified using GROUP=group in * ctrl_interface variable. */ char *ctrl_interface_group; @@ -286,7 +286,7 @@ struct wpa_config { /** * device_type - Primary Device Type (WPS) - * Used format: -- + * Used format: categ-OUI-subcateg * categ = Category as an integer value * OUI = OUI and type octet as a 4-octet hex-encoded value; * 0050F204 for default WPS OUI diff --git a/wpa_supplicant/config_winreg.c b/wpa_supplicant/config_winreg.c index e16630d33..01996429a 100644 --- a/wpa_supplicant/config_winreg.c +++ b/wpa_supplicant/config_winreg.c @@ -11,12 +11,13 @@ * * See README and COPYING for more details. * - * This file implements a configuration backend for Windows registry.. All the + * This file implements a configuration backend for Windows registry. All the * configuration information is stored in the registry and the format for * network configuration fields is same as described in the sample * configuration file, wpa_supplicant.conf. * - * Configuration data is in HKEY_LOCAL_MACHINE\SOFTWARE\wpa_supplicant\configs + * Configuration data is in + * \a HKEY_LOCAL_MACHINE\\SOFTWARE\\%wpa_supplicant\\configs * key. Each configuration profile has its own key under this. In terms of text * files, each profile would map to a separate text file with possibly multiple * networks. Under each profile, there is a networks key that lists all @@ -24,9 +25,12 @@ * network block in the configuration file. In addition, blobs subkey has * possible blobs as values. * - * HKEY_LOCAL_MACHINE\SOFTWARE\wpa_supplicant\configs\test\networks\0000 - * ssid="example" - * key_mgmt=WPA-PSK + * Example network configuration block: + * \verbatim +HKEY_LOCAL_MACHINE\SOFTWARE\wpa_supplicant\configs\test\networks\0000 + ssid="example" + key_mgmt=WPA-PSK +\endverbatim */ #include "includes.h" diff --git a/wpa_supplicant/main_winsvc.c b/wpa_supplicant/main_winsvc.c index 4b072fcdf..4a46ed5f1 100644 --- a/wpa_supplicant/main_winsvc.c +++ b/wpa_supplicant/main_winsvc.c @@ -12,7 +12,7 @@ * See README and COPYING for more details. * * The root of wpa_supplicant configuration in registry is - * HKEY_LOCAL_MACHINE\SOFTWARE\wpa_supplicant. This level includes global + * HKEY_LOCAL_MACHINE\\SOFTWARE\\%wpa_supplicant. This level includes global * parameters and a 'interfaces' subkey with all the interface configuration * (adapter to confname mapping). Each such mapping is a subkey that has * 'adapter' and 'config' values.