Merge pull request #319 from LedgerHQ/fix-typos

Small fixes in MuSig2 code documentation

Author: bigspider

src/musig/musig.h

@@ -67,7 +67,7 @@ static inline int compare_plain_pk(const void *a, const void *b) {
  *   Pointer to a list of pubkeys.
  * @param[in]  n_keys
  *   Number of pubkeys.
- * @param[out]  musig_keyagg_context_t
+ * @param[out]  ctx
  *   Pointer to receive the musig KeyAgg Context.
  *
  * @return 0 on success, a negative number in case of error.
@@ -102,7 +102,7 @@ int musig_nonce_gen(const uint8_t *rand,
 /**
  * Generates the aggregate nonce (nonce_agg in the reference implementation).
  *
- * @param[in]  rand
+ * @param[in]  pubnonces
  *   A list of musig_pubnonce_t, the pubnonces of all the participants.
  * @param[in]  n_keys
  *   Number of pubkeys.
@@ -120,6 +120,8 @@ int musig_nonce_agg(const musig_pubnonce_t pubnonces[], size_t n_keys, musig_pub
  *
  * @param[in]  secnonce
  *   The secret nonce.
+ * @param[in]  sk
+ *   The secret key.
  * @param[in]  session_ctx
  *   The session context.
  * @param[out] psig

src/musig/musig_sessions.h

@@ -32,6 +32,15 @@ typedef struct musig_signing_state_s {
 /**
  * Given a musig psbt session, computes the synthetic randomness for a given
  * (input_index, placeholder_index) pair.
+ *
+ * @param[in]  psbt_session
+ *   Pointer to the musig psbt session.
+ * @param[in]  input_index
+ *   The index of the input.
+ * @param[in]  placeholder_index
+ *   The index of the key placeholder.
+ * @param[out] out
+ *   Pointer to receive the synthetic randomness.
  */
 void compute_rand_i_j(const musig_psbt_session_t *psbt_session,
                       int input_index,
@@ -45,7 +54,7 @@ void compute_rand_i_j(const musig_psbt_session_t *psbt_session,
  * musigsession_round2_initialize are called in the code.
  *
  * This allows the calling code to not make any assumption about how
- * the inialization of the musig signing state is done.
+ * the initialization of the musig signing state is done.
  *
  * @param[in]  musig_signing_state
  *   Pointer to the musig signing state.