Comment updates (#25)

This commit is contained in:
Sebastian 2016-10-17 09:51:52 -04:00 committed by Douglas Stebila
parent 14b5f66420
commit c6a9fae2ac

View File

@ -76,20 +76,20 @@ typedef struct OQS_KEX {
*
* @param k Key exchange structure
* @param alice_priv Alice's private key
* @param alice_msg Alice's public key
* @param alice_msg_len Alice's public key length
* @param alice_msg Alice's message (public key + optional additional data)
* @param alice_msg_len Alice's message length
* @return 1 on success, or 0 on failure
*/
int (*alice_0)(OQS_KEX *k, void **alive_priv, uint8_t **alice_msg, size_t *alice_msg_len);
/**
* Pointer to a function for public, private and shared key generation by Bob.
* Pointer to a function for shared key generation by Bob.
*
* @param k Key exchange structure
* @param alice_msg Alice's public key
* @param alice_msg_len Alice's public key length
* @param bob_msg Bob's public key
* @param bob_msg_len Bob's public key length
* @param alice_msg Alice's message (public key + optional additional data)
* @param alice_msg_len Alice's message length
* @param bob_msg Bob's message (public key / encryption of shared key + optional additional data)
* @param bob_msg_len Bob's message length
* @param key Shared key
* @param key_len Shared key length
* @return 1 on success, or 0 on failure
@ -101,8 +101,8 @@ typedef struct OQS_KEX {
*
* @param k Key exchange structure
* @param alice_priv Alice's private key
* @param bob_msg Bob's public key
* @param bob_msg_len Bob's public key length
* @param bob_msg Bob's message (public key / encryption of shared key + optional additional data)
* @param bob_msg_len Bob's message length
* @param key Shared key
* @param key_len Shared key length
* @return 1 on success, or 0 on failure