jeltz
/
hostap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Silenced number of Doxygen warnings

This commit is contained in:
Jouni Malinen 2009-01-04 15:07:54 +02:00
parent f565d71ac9
commit b39d1280a7
9 changed files with 33 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/crypto/ms_funcs.c
View File

@ -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=<hexdump of response>)
* 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=<hexdump of response>)
* 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,

2
src/drivers/driver.h
View File

@ -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

26
src/eap_peer/eap_config.h
View File

@ -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://<blob name>.
* this to blob://blob_name.
*
* On Windows, trusted CA certificates can be loaded from the system
* certificate store by setting this to cert_store://<name>, 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://<blob name>.
* 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://<blob name>.
* 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://<blob name>.
* 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://<blob name>.
* 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://<blob name>.
* 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://<blob name>.
* 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://<blob name>.
* 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=<num> 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=<Device Password> and
* uuid=<Device 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://<blob name>.
* this to blob://blob_name.
*/
char *pac_file;

2
src/utils/includes.h
View File

@ -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.
*/

6
src/utils/state_machine.h
View File

@ -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 <machine>_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: <prefix>_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: <prefix>_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

2
src/utils/wpa_debug.h
View File

@ -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 <seconds from 1970>.<microsoconds>
* This function prints a timestamp in seconds_from_1970.microsoconds
* format if debug output has been configured to include timestamps in debug
* messages.
*/

4
wpa_supplicant/config.h
View File

@ -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=<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: <categ>-<OUI>-<subcateg>
* 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

14
wpa_supplicant/config_winreg.c
View File

@ -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"

2
wpa_supplicant/main_winsvc.c
View File

@ -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.