Skip to content

Commit 5960a03

Browse files
committed
Fixing documentation strings for BLAKE2.
1 parent b6ce904 commit 5960a03

1 file changed

Lines changed: 39 additions & 36 deletions

File tree

crypto/blake2-hacl-generated.c

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -444,15 +444,16 @@ void Hacl_Blake2b_32_blake2b_finish(uint32_t nn, uint8_t *output,
444444
}
445445

446446
/**
447-
Write the BLAKE2b digest of message `d` using key `k` into `output`.
448-
449-
@param nn Length of the to-be-generated digest with 1 <= `nn` <= 64.
450-
@param output Pointer to `nn` bytes of memory where the digest is written to.
451-
@param ll Length of the input message.
452-
@param d Pointer to `ll` bytes of memory where the input message is read from.
453-
@param kk Length of the key. Can be 0.
454-
@param k Pointer to `kk` bytes of memory where the key is read from.
455-
*/
447+
* Hacl_Blake2b_32_blake2b() - Write the BLAKE2b digest of message `d` using
448+
* key `k` into `output`.
449+
* @nn: Length of the to-be-generated digest with 1 <= `nn` <= 64.
450+
* @output: Pointer to `nn` bytes of memory where the digest is written to.
451+
* @ll: Length of the input message.
452+
* @d: Pointer to `ll` bytes of memory where the input message is
453+
* read from.
454+
* @kk: Length of the key. Can be 0.
455+
* @k: Pointer to `kk` bytes of memory where the key is read from.
456+
*/
456457
void Hacl_Blake2b_32_blake2b(uint32_t nn, uint8_t *output, uint32_t ll,
457458
uint8_t *d, uint32_t kk, uint8_t *k)
458459
{
@@ -886,15 +887,17 @@ void Hacl_Blake2s_32_blake2s_finish(uint32_t nn, uint8_t *output,
886887
}
887888

888889
/**
889-
Write the BLAKE2s digest of message `d` using key `k` into `output`.
890-
891-
@param nn Length of to-be-generated digest with 1 <= `nn` <= 32.
892-
@param output Pointer to `nn` bytes of memory where the digest is written to.
893-
@param ll Length of the input message.
894-
@param d Pointer to `ll` bytes of memory where the input message is read from.
895-
@param kk Length of the key. Can be 0.
896-
@param k Pointer to `kk` bytes of memory where the key is read from.
897-
*/
890+
* Hacl_Blake2s_32_blake2s() - Write the BLAKE2s digest of message `d` using
891+
* key `k` into `output`.
892+
*
893+
* @nn: Length of to-be-generated digest with 1 <= `nn` <= 32.
894+
* @output: Pointer to `nn` bytes of memory where the digest is written to.
895+
* @ll: Length of the input message.
896+
* @d: Pointer to `ll` bytes of memory where the input message is read
897+
* from.
898+
* @kk: Length of the key. Can be 0.
899+
* @k: Pointer to `kk` bytes of memory where the key is read from.
900+
*/
898901
void Hacl_Blake2s_32_blake2s(uint32_t nn, uint8_t *output, uint32_t ll,
899902
uint8_t *d, uint32_t kk, uint8_t *k)
900903
{
@@ -907,9 +910,9 @@ void Hacl_Blake2s_32_blake2s(uint32_t nn, uint8_t *output, uint32_t ll,
907910
Lib_Memzero0_memzero(b, (uint32_t)16U, uint32_t);
908911
}
909912

910-
/**
911-
(Re-)initialization function when there is no key
912-
*/
913+
/*
914+
* (Re-)initialization function when there is no key
915+
*/
913916
void Hacl_Streaming_Blake2_blake2s_32_no_key_init(
914917
struct Hacl_Streaming_Blake2_blake2s_32_state_s *s1)
915918
{
@@ -928,9 +931,9 @@ void Hacl_Streaming_Blake2_blake2s_32_no_key_init(
928931
s1[0U] = tmp;
929932
}
930933

931-
/**
932-
Update function when there is no key; 0 = success, 1 = max length exceeded
933-
*/
934+
/*
935+
* Update function when there is no key; 0 = success, 1 = max length exceeded
936+
*/
934937
Hacl_Streaming_Types_error_code Hacl_Streaming_Blake2_blake2s_32_no_key_update(
935938
struct Hacl_Streaming_Blake2_blake2s_32_state_s *p, uint8_t *data,
936939
uint32_t len)
@@ -1085,9 +1088,9 @@ Hacl_Streaming_Types_error_code Hacl_Streaming_Blake2_blake2s_32_no_key_update(
10851088
return Hacl_Streaming_Types_Success;
10861089
}
10871090

1088-
/**
1089-
Finish function when there is no key
1090-
*/
1091+
/*
1092+
* Finish function when there is no key
1093+
*/
10911094
void Hacl_Streaming_Blake2_blake2s_32_no_key_finish(
10921095
struct Hacl_Streaming_Blake2_blake2s_32_state_s *p, uint8_t *dst)
10931096
{
@@ -1134,9 +1137,9 @@ void Hacl_Streaming_Blake2_blake2s_32_no_key_finish(
11341137
Hacl_Blake2s_32_blake2s_finish((uint32_t)32U, dst, tmp_block_state.snd);
11351138
}
11361139

1137-
/**
1138-
(Re)-initialization function when there is no key
1139-
*/
1140+
/*
1141+
* (Re)-initialization function when there is no key
1142+
*/
11401143
void Hacl_Streaming_Blake2_blake2b_32_no_key_init(
11411144
struct Hacl_Streaming_Blake2_blake2b_32_state_s *s1)
11421145
{
@@ -1155,9 +1158,9 @@ void Hacl_Streaming_Blake2_blake2b_32_no_key_init(
11551158
s1[0U] = tmp;
11561159
}
11571160

1158-
/**
1159-
Update function when there is no key; 0 = success, 1 = max length exceeded
1160-
*/
1161+
/*
1162+
* Update function when there is no key; 0 = success, 1 = max length exceeded
1163+
*/
11611164
Hacl_Streaming_Types_error_code Hacl_Streaming_Blake2_blake2b_32_no_key_update(
11621165
struct Hacl_Streaming_Blake2_blake2b_32_state_s *p, uint8_t *data,
11631166
uint32_t len)
@@ -1319,9 +1322,9 @@ Hacl_Streaming_Types_error_code Hacl_Streaming_Blake2_blake2b_32_no_key_update(
13191322
return Hacl_Streaming_Types_Success;
13201323
}
13211324

1322-
/**
1323-
Finish function when there is no key
1324-
*/
1325+
/*
1326+
* Finish function when there is no key
1327+
*/
13251328
void Hacl_Streaming_Blake2_blake2b_32_no_key_finish(
13261329
struct Hacl_Streaming_Blake2_blake2b_32_state_s *p, uint8_t *dst)
13271330
{

0 commit comments

Comments
 (0)