Fixed number of doxygen warnings

This commit is contained in:
Jouni Malinen 2009-01-02 22:28:04 +02:00
parent a4149765a2
commit a17df5fb8b
13 changed files with 21 additions and 13 deletions

View File

@ -1399,6 +1399,7 @@ static void handle_action(struct hostapd_data *hapd,
* @buf: management frame data (starting from IEEE 802.11 header) * @buf: management frame data (starting from IEEE 802.11 header)
* @len: length of frame data in octets * @len: length of frame data in octets
* @stype: management frame subtype from frame control field * @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 * 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 * each frame received from the kernel driver through wlan#ap interface. In

View File

@ -47,6 +47,7 @@ struct rsn_pmksa_cache {
* @pmk_len: Length of pmk in bytes * @pmk_len: Length of pmk in bytes
* @aa: Authenticator address * @aa: Authenticator address
* @spa: Supplicant address * @spa: Supplicant address
* @pmkid: Buffer for PMKID
* @use_sha256: Whether to use SHA256-based KDF * @use_sha256: Whether to use SHA256-based KDF
* *
* IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy * 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_cache_get_okc - Fetch a PMKSA cache entry using OKC
* @pmksa: Pointer to PMKSA cache data from pmksa_cache_init() * @pmksa: Pointer to PMKSA cache data from pmksa_cache_init()
* @aa: Authenticator address
* @spa: Supplicant address * @spa: Supplicant address
* @pmkid: PMKID * @pmkid: PMKID
* Returns: Pointer to PMKSA cache entry or %NULL if no match was found * Returns: Pointer to PMKSA cache entry or %NULL if no match was found

View File

@ -345,6 +345,7 @@ static struct wpa_group * wpa_group_init(struct wpa_authenticator *wpa_auth,
* wpa_init - Initialize WPA authenticator * wpa_init - Initialize WPA authenticator
* @addr: Authenticator address * @addr: Authenticator address
* @conf: Configuration for WPA authenticator * @conf: Configuration for WPA authenticator
* @cb: Callback functions for WPA authenticator
* Returns: Pointer to WPA authenticator data or %NULL on failure * Returns: Pointer to WPA authenticator data or %NULL on failure
*/ */
struct wpa_authenticator * wpa_init(const u8 *addr, struct wpa_authenticator * wpa_init(const u8 *addr,

View File

@ -110,7 +110,7 @@ void challenge_response(const u8 *challenge, const u8 *password_hash,
/** /**
* generate_nt_response - GenerateNTResponse() - RFC 2759, Sect. 8.1 * generate_nt_response - GenerateNTResponse() - RFC 2759, Sect. 8.1
* @auth_challenge: 16-octet AuthenticatorChallenge (IN) * @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: 0-to-256-char UserName (IN)
* @username_len: Length of username * @username_len: Length of username
* @password: 0-to-256-unicode-char Password (IN; ASCII) * @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 * generate_nt_response_pwhash - GenerateNTResponse() - RFC 2759, Sect. 8.1
* @auth_challenge: 16-octet AuthenticatorChallenge (IN) * @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: 0-to-256-char UserName (IN)
* @username_len: Length of username * @username_len: Length of username
* @password_hash: 16-octet PasswordHash (IN) * @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 * @new_password_len: Length of new_password
* @old_password: 0-to-256-unicode-char OldPassword (IN; ASCII) * @old_password: 0-to-256-unicode-char OldPassword (IN; ASCII)
* @old_password_len: Length of old_password * @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( void old_nt_password_hash_encrypted_with_new_nt_password_hash(
const u8 *new_password, size_t new_password_len, const u8 *new_password, size_t new_password_len,

View File

@ -345,7 +345,7 @@ static void pbkdf2_sha1_f(const char *passphrase, const char *ssid,
* @passphrase: ASCII passphrase * @passphrase: ASCII passphrase
* @ssid: SSID * @ssid: SSID
* @ssid_len: SSID length in bytes * @ssid_len: SSID length in bytes
* @interations: Number of iterations to run * @iterations: Number of iterations to run
* @buf: Buffer for the generated key * @buf: Buffer for the generated key
* @buflen: Length of the buffer in bytes * @buflen: Length of the buffer in bytes
* *

View File

@ -68,7 +68,7 @@ EapType eap_server_get_type(const char *name, int *vendor)
* EAP_SERVER_METHOD_INTERFACE_VERSION) * EAP_SERVER_METHOD_INTERFACE_VERSION)
* @vendor: EAP Vendor-ID (EAP_VENDOR_*) (0 = IETF) * @vendor: EAP Vendor-ID (EAP_VENDOR_*) (0 = IETF)
* @method: EAP type number (EAP_TYPE_*) * @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 * Returns: Allocated EAP method structure or %NULL on failure
* *
* The returned structure should be freed with eap_server_method_free() when it * The returned structure should be freed with eap_server_method_free() when it

View File

@ -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, * @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 * e.g., return value from eap_sim_db_get_next_reauth_id(). Caller must not
* free it. * free it.
* @counter: AT_COUNTER value for fast re-authentication
* @mk: 16-byte MK from the previous full authentication or %NULL * @mk: 16-byte MK from the previous full authentication or %NULL
* Returns: 0 on success, -1 on failure * 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, * @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 * e.g., return value from eap_sim_db_get_next_reauth_id(). Caller must not
* free it. * 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 * Returns: 0 on success, -1 on failure
* *
* This function adds a new re-authentication entry for an EAP-AKA' user. * 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 * @identity: Identity of the user (may be permanent identity, pseudonym, or
* reauth_id) * reauth_id)
* @identity_len: Length of identity * @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 * Returns: Pointer to the re-auth entry, or %NULL if not found
*/ */
struct eap_sim_reauth * struct eap_sim_reauth *

View File

@ -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 * 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 * @buf: Buffer with unsigned binary value
* @len: Length of buf in octets * @len: Length of buf in octets
* Returns: 0 on success, -1 on failure * Returns: 0 on success, -1 on failure

View File

@ -124,6 +124,8 @@ int tls_derive_keys(struct tlsv1_client *conn,
* @in_data: Input data from TLS peer * @in_data: Input data from TLS peer
* @in_len: Input data length * @in_len: Input data length
* @out_len: Length of the output buffer. * @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 * Returns: Pointer to output data, %NULL on failure
*/ */
u8 * tlsv1_client_handshake(struct tlsv1_client *conn, u8 * tlsv1_client_handshake(struct tlsv1_client *conn,

View File

@ -611,7 +611,7 @@ failed:
/** /**
* scard_set_pin - Set PIN (CHV1/PIN1) code for accessing SIM/USIM commands * scard_set_pin - Set PIN (CHV1/PIN1) code for accessing SIM/USIM commands
* @scard: Pointer to private data from scard_init() * @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 * Returns: 0 on success, -1 on failure
*/ */
int scard_set_pin(struct scard_data *scard, const char *pin) int scard_set_pin(struct scard_data *scard, const char *pin)

View File

@ -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 * 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 * @wpa_s: %wpa_supplicant interface description structure to register
* Returns: 0 on success, -1 on error * Returns: 0 on success, -1 on error
* *

View File

@ -1287,7 +1287,7 @@ DBusMessage * wpas_dbus_iface_get_state(DBusMessage *message,
/** /**
* wpas_dbus_iface_set_blobs - Store named binary blobs (ie, for certificates) * wpas_dbus_iface_set_blobs - Store named binary blobs (ie, for certificates)
* @message: Pointer to incoming dbus message * @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 * Returns: A dbus message containing a UINT32 indicating success (1) or
* failure (0) * failure (0)
* *
@ -1370,7 +1370,7 @@ DBusMessage * wpas_dbus_iface_set_blobs(DBusMessage *message,
/** /**
* wpas_dbus_iface_remove_blob - Remove named binary blobs * wpas_dbus_iface_remove_blob - Remove named binary blobs
* @message: Pointer to incoming dbus message * @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 * Returns: A dbus message containing a UINT32 indicating success (1) or
* failure (0) * failure (0)
* *

View File

@ -148,7 +148,7 @@ tls_gnutls.c
TLS library wrapper for GnuTLS TLS library wrapper for GnuTLS
\section crypto_func Cryptographic functions \section tls_func TLS library
asn1.c and asn1.h asn1.c and asn1.h
ASN.1 DER parsing ASN.1 DER parsing