From a17df5fb8bc593690598a59065684284a89c78c3 Mon Sep 17 00:00:00 2001 From: Jouni Malinen Date: Fri, 2 Jan 2009 22:28:04 +0200 Subject: [PATCH] Fixed number of doxygen warnings --- hostapd/ieee802_11.c | 1 + hostapd/pmksa_cache.c | 2 ++ hostapd/wpa.c | 1 + src/crypto/ms_funcs.c | 6 +++--- src/crypto/sha1.c | 2 +- src/eap_server/eap_methods.c | 2 +- src/eap_server/eap_sim_db.c | 7 +++++-- src/tls/bignum.c | 2 +- src/tls/tlsv1_client.c | 2 ++ src/utils/pcsc_funcs.c | 2 +- wpa_supplicant/ctrl_iface_dbus.c | 1 - wpa_supplicant/ctrl_iface_dbus_handlers.c | 4 ++-- wpa_supplicant/doc/code_structure.doxygen | 2 +- 13 files changed, 21 insertions(+), 13 deletions(-) diff --git a/hostapd/ieee802_11.c b/hostapd/ieee802_11.c index 62f4b066f..2109b23da 100644 --- a/hostapd/ieee802_11.c +++ b/hostapd/ieee802_11.c @@ -1399,6 +1399,7 @@ static void handle_action(struct hostapd_data *hapd, * @buf: management frame data (starting from IEEE 802.11 header) * @len: length of frame data in octets * @stype: management frame subtype from frame control field + * @fi: meta data about received frame (signal level, etc.) * * Process all incoming IEEE 802.11 management frames. This will be called for * each frame received from the kernel driver through wlan#ap interface. In diff --git a/hostapd/pmksa_cache.c b/hostapd/pmksa_cache.c index 77797943c..5f54a34c1 100644 --- a/hostapd/pmksa_cache.c +++ b/hostapd/pmksa_cache.c @@ -47,6 +47,7 @@ struct rsn_pmksa_cache { * @pmk_len: Length of pmk in bytes * @aa: Authenticator address * @spa: Supplicant address + * @pmkid: Buffer for PMKID * @use_sha256: Whether to use SHA256-based KDF * * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy @@ -404,6 +405,7 @@ struct rsn_pmksa_cache_entry * pmksa_cache_get(struct rsn_pmksa_cache *pmksa, /** * pmksa_cache_get_okc - Fetch a PMKSA cache entry using OKC * @pmksa: Pointer to PMKSA cache data from pmksa_cache_init() + * @aa: Authenticator address * @spa: Supplicant address * @pmkid: PMKID * Returns: Pointer to PMKSA cache entry or %NULL if no match was found diff --git a/hostapd/wpa.c b/hostapd/wpa.c index e995562b1..cf285b6fd 100644 --- a/hostapd/wpa.c +++ b/hostapd/wpa.c @@ -345,6 +345,7 @@ static struct wpa_group * wpa_group_init(struct wpa_authenticator *wpa_auth, * wpa_init - Initialize WPA authenticator * @addr: Authenticator address * @conf: Configuration for WPA authenticator + * @cb: Callback functions for WPA authenticator * Returns: Pointer to WPA authenticator data or %NULL on failure */ struct wpa_authenticator * wpa_init(const u8 *addr, diff --git a/src/crypto/ms_funcs.c b/src/crypto/ms_funcs.c index c5bc95d77..cb8e72da4 100644 --- a/src/crypto/ms_funcs.c +++ b/src/crypto/ms_funcs.c @@ -110,7 +110,7 @@ void challenge_response(const u8 *challenge, const u8 *password_hash, /** * generate_nt_response - GenerateNTResponse() - RFC 2759, Sect. 8.1 * @auth_challenge: 16-octet AuthenticatorChallenge (IN) - * @peer_hallenge: 16-octet PeerChallenge (IN) + * @peer_challenge: 16-octet PeerChallenge (IN) * @username: 0-to-256-char UserName (IN) * @username_len: Length of username * @password: 0-to-256-unicode-char Password (IN; ASCII) @@ -135,7 +135,7 @@ void generate_nt_response(const u8 *auth_challenge, const u8 *peer_challenge, /** * generate_nt_response_pwhash - GenerateNTResponse() - RFC 2759, Sect. 8.1 * @auth_challenge: 16-octet AuthenticatorChallenge (IN) - * @peer_hallenge: 16-octet PeerChallenge (IN) + * @peer_challenge: 16-octet PeerChallenge (IN) * @username: 0-to-256-char UserName (IN) * @username_len: Length of username * @password_hash: 16-octet PasswordHash (IN) @@ -429,7 +429,7 @@ void nt_password_hash_encrypted_with_block(const u8 *password_hash, * @new_password_len: Length of new_password * @old_password: 0-to-256-unicode-char OldPassword (IN; ASCII) * @old_password_len: Length of old_password - * @encrypted_password_ash: 16-octet EncryptedPasswordHash (OUT) + * @encrypted_password_hash: 16-octet EncryptedPasswordHash (OUT) */ void old_nt_password_hash_encrypted_with_new_nt_password_hash( const u8 *new_password, size_t new_password_len, diff --git a/src/crypto/sha1.c b/src/crypto/sha1.c index 0d7971950..ceec1a49a 100644 --- a/src/crypto/sha1.c +++ b/src/crypto/sha1.c @@ -345,7 +345,7 @@ static void pbkdf2_sha1_f(const char *passphrase, const char *ssid, * @passphrase: ASCII passphrase * @ssid: SSID * @ssid_len: SSID length in bytes - * @interations: Number of iterations to run + * @iterations: Number of iterations to run * @buf: Buffer for the generated key * @buflen: Length of the buffer in bytes * diff --git a/src/eap_server/eap_methods.c b/src/eap_server/eap_methods.c index 4175d8f9d..4092d675b 100644 --- a/src/eap_server/eap_methods.c +++ b/src/eap_server/eap_methods.c @@ -68,7 +68,7 @@ EapType eap_server_get_type(const char *name, int *vendor) * EAP_SERVER_METHOD_INTERFACE_VERSION) * @vendor: EAP Vendor-ID (EAP_VENDOR_*) (0 = IETF) * @method: EAP type number (EAP_TYPE_*) - * name: Name of the method (e.g., "TLS") + * @name: Name of the method (e.g., "TLS") * Returns: Allocated EAP method structure or %NULL on failure * * The returned structure should be freed with eap_server_method_free() when it diff --git a/src/eap_server/eap_sim_db.c b/src/eap_server/eap_sim_db.c index 8befbd880..ed0bd3cd1 100644 --- a/src/eap_server/eap_sim_db.c +++ b/src/eap_server/eap_sim_db.c @@ -996,6 +996,7 @@ eap_sim_db_add_reauth_data(struct eap_sim_db_data *data, const u8 *identity, * @reauth_id: reauth_id for this user. This needs to be an allocated buffer, * e.g., return value from eap_sim_db_get_next_reauth_id(). Caller must not * free it. + * @counter: AT_COUNTER value for fast re-authentication * @mk: 16-byte MK from the previous full authentication or %NULL * Returns: 0 on success, -1 on failure * @@ -1031,7 +1032,10 @@ int eap_sim_db_add_reauth(void *priv, const u8 *identity, * @reauth_id: reauth_id for this user. This needs to be an allocated buffer, * e.g., return value from eap_sim_db_get_next_reauth_id(). Caller must not * free it. - * @k_re: 32-byte K_re from the previous full authentication or %NULL + * @counter: AT_COUNTER value for fast re-authentication + * @k_encr: K_encr from the previous full authentication + * @k_aut: K_aut from the previous full authentication + * @k_re: 32-byte K_re from the previous full authentication * Returns: 0 on success, -1 on failure * * This function adds a new re-authentication entry for an EAP-AKA' user. @@ -1095,7 +1099,6 @@ const u8 * eap_sim_db_get_permanent(void *priv, const u8 *identity, * @identity: Identity of the user (may be permanent identity, pseudonym, or * reauth_id) * @identity_len: Length of identity - * @len: Buffer for length of the returned permanent identity * Returns: Pointer to the re-auth entry, or %NULL if not found */ struct eap_sim_reauth * diff --git a/src/tls/bignum.c b/src/tls/bignum.c index 6b718f97c..5c0fc62ed 100644 --- a/src/tls/bignum.c +++ b/src/tls/bignum.c @@ -97,7 +97,7 @@ int bignum_get_unsigned_bin(const struct bignum *n, u8 *buf, size_t *len) /** * bignum_set_unsigned_bin - Set bignum based on unsigned binary buffer - * @a: Bignum from bignum_init(); to be set to the given value + * @n: Bignum from bignum_init(); to be set to the given value * @buf: Buffer with unsigned binary value * @len: Length of buf in octets * Returns: 0 on success, -1 on failure diff --git a/src/tls/tlsv1_client.c b/src/tls/tlsv1_client.c index 97a195f35..302e3ee13 100644 --- a/src/tls/tlsv1_client.c +++ b/src/tls/tlsv1_client.c @@ -124,6 +124,8 @@ int tls_derive_keys(struct tlsv1_client *conn, * @in_data: Input data from TLS peer * @in_len: Input data length * @out_len: Length of the output buffer. + * @appl_data: Pointer to application data pointer, or %NULL if dropped + * @appl_data_len: Pointer to variable that is set to appl_data length * Returns: Pointer to output data, %NULL on failure */ u8 * tlsv1_client_handshake(struct tlsv1_client *conn, diff --git a/src/utils/pcsc_funcs.c b/src/utils/pcsc_funcs.c index cf8e3b009..bf9f04a71 100644 --- a/src/utils/pcsc_funcs.c +++ b/src/utils/pcsc_funcs.c @@ -611,7 +611,7 @@ failed: /** * scard_set_pin - Set PIN (CHV1/PIN1) code for accessing SIM/USIM commands * @scard: Pointer to private data from scard_init() - * pin: PIN code as an ASCII string (e.g., "1234") + * @pin: PIN code as an ASCII string (e.g., "1234") * Returns: 0 on success, -1 on failure */ int scard_set_pin(struct scard_data *scard, const char *pin) diff --git a/wpa_supplicant/ctrl_iface_dbus.c b/wpa_supplicant/ctrl_iface_dbus.c index 59763d6ca..7f2fba4ab 100644 --- a/wpa_supplicant/ctrl_iface_dbus.c +++ b/wpa_supplicant/ctrl_iface_dbus.c @@ -920,7 +920,6 @@ void wpa_supplicant_dbus_ctrl_iface_deinit(struct ctrl_iface_dbus_priv *iface) /** * wpas_dbus_register_new_iface - Register a new interface with dbus - * @global: Global %wpa_supplicant data * @wpa_s: %wpa_supplicant interface description structure to register * Returns: 0 on success, -1 on error * diff --git a/wpa_supplicant/ctrl_iface_dbus_handlers.c b/wpa_supplicant/ctrl_iface_dbus_handlers.c index 015eb5460..0cb558ee5 100644 --- a/wpa_supplicant/ctrl_iface_dbus_handlers.c +++ b/wpa_supplicant/ctrl_iface_dbus_handlers.c @@ -1287,7 +1287,7 @@ DBusMessage * wpas_dbus_iface_get_state(DBusMessage *message, /** * wpas_dbus_iface_set_blobs - Store named binary blobs (ie, for certificates) * @message: Pointer to incoming dbus message - * @global: %wpa_supplicant global data structure + * @wpa_s: %wpa_supplicant data structure * Returns: A dbus message containing a UINT32 indicating success (1) or * failure (0) * @@ -1370,7 +1370,7 @@ DBusMessage * wpas_dbus_iface_set_blobs(DBusMessage *message, /** * wpas_dbus_iface_remove_blob - Remove named binary blobs * @message: Pointer to incoming dbus message - * @global: %wpa_supplicant global data structure + * @wpa_s: %wpa_supplicant data structure * Returns: A dbus message containing a UINT32 indicating success (1) or * failure (0) * diff --git a/wpa_supplicant/doc/code_structure.doxygen b/wpa_supplicant/doc/code_structure.doxygen index fe3ad3c60..6398ff344 100644 --- a/wpa_supplicant/doc/code_structure.doxygen +++ b/wpa_supplicant/doc/code_structure.doxygen @@ -148,7 +148,7 @@ tls_gnutls.c TLS library wrapper for GnuTLS -\section crypto_func Cryptographic functions +\section tls_func TLS library asn1.c and asn1.h ASN.1 DER parsing