Skip to content

Commit 89853a0

Browse files
committed
Make tweak function documentation more consistent.
Do this by adding a newline after the first sentence and aligning the rest.
1 parent 41fc785 commit 89853a0

File tree

1 file changed

+43
-38
lines changed

1 file changed

+43
-38
lines changed

include/secp256k1.h

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -616,17 +616,18 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_negate(
616616
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2);
617617

618618
/** Tweak a secret key by adding tweak to it.
619-
* Returns: 0 if the resulting secret key would be invalid (only when the tweak
620-
* is the negation of the secret key). 1 otherwise.
621-
* Args: ctx: pointer to a context object (cannot be NULL).
622-
* In/Out: seckey: pointer to a 32-byte secret key. The secret key should be
623-
* valid according to secp256k1_ec_seckey_verify. If this
624-
* function returns 0, seckey will be some unspecified
625-
* value. (cannot be NULL)
626-
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
627-
* keys (see secp256k1_ec_seckey_verify). For uniformly random
628-
* 32-byte arrays the chance of being out of range is
629-
* negligible (around 1 in 2^128). (cannot be NULL)
619+
*
620+
* Returns: 0 if the resulting secret key would be invalid (only when the tweak
621+
* is the negation of the secret key). 1 otherwise.
622+
* Args: ctx: pointer to a context object (cannot be NULL).
623+
* In/Out: seckey: pointer to a 32-byte secret key. The secret key should be
624+
* valid according to secp256k1_ec_seckey_verify. If this
625+
* function returns 0, seckey will be some unspecified
626+
* value. (cannot be NULL)
627+
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
628+
* keys (see secp256k1_ec_seckey_verify). For uniformly random
629+
* 32-byte arrays the chance of being out of range is
630+
* negligible (around 1 in 2^128). (cannot be NULL)
630631
*/
631632
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_seckey_tweak_add(
632633
const secp256k1_context* ctx,
@@ -643,16 +644,17 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_privkey_tweak_add(
643644
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3);
644645

645646
/** Tweak a public key by adding tweak times the generator to it.
646-
* Returns: 0 if the resulting public key would be invalid (only when the tweak
647-
* is the negation of the corresponding secret key). 1 otherwise.
648-
* Args: ctx: pointer to a context object initialized for validation
649-
* (cannot be NULL).
650-
* In/Out: pubkey: pointer to a public key object. If this function returns 0,
651-
* pubkey will be invalid. (cannot be NULL).
652-
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
653-
* keys (see secp256k1_ec_seckey_verify). For uniformly random
654-
* 32-byte arrays the chance of being out of range is
655-
* negligible (around 1 in 2^128). (cannot be NULL)
647+
*
648+
* Returns: 0 if the resulting public key would be invalid (only when the tweak
649+
* is the negation of the corresponding secret key). 1 otherwise.
650+
* Args: ctx: pointer to a context object initialized for validation
651+
* (cannot be NULL).
652+
* In/Out: pubkey: pointer to a public key object. If this function returns 0,
653+
* pubkey will be invalid. (cannot be NULL).
654+
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
655+
* keys (see secp256k1_ec_seckey_verify). For uniformly random
656+
* 32-byte arrays the chance of being out of range is
657+
* negligible (around 1 in 2^128). (cannot be NULL)
656658
*/
657659
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_tweak_add(
658660
const secp256k1_context* ctx,
@@ -661,14 +663,15 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_tweak_add(
661663
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3);
662664

663665
/** Tweak a secret key by multiplying it by a tweak.
664-
* Returns: 0 if the arguments are invalid.. 1 otherwise.
665-
* Args: ctx: pointer to a context object (cannot be NULL).
666-
* In/Out: seckey: pointer to a 32-byte secret key. If this function returns 0,
667-
* seckey will be some unspecified value. (cannot be NULL).
668-
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
669-
* keys (see secp256k1_ec_seckey_verify). For uniformly random
670-
* 32-byte arrays the chance of being out of range is
671-
* negligible (around 1 in 2^128). (cannot be NULL)
666+
*
667+
* Returns: 0 if the arguments are invalid.. 1 otherwise.
668+
* Args: ctx: pointer to a context object (cannot be NULL).
669+
* In/Out: seckey: pointer to a 32-byte secret key. If this function returns 0,
670+
* seckey will be some unspecified value. (cannot be NULL).
671+
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
672+
* keys (see secp256k1_ec_seckey_verify). For uniformly random
673+
* 32-byte arrays the chance of being out of range is
674+
* negligible (around 1 in 2^128). (cannot be NULL)
672675
*/
673676
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_seckey_tweak_mul(
674677
const secp256k1_context* ctx,
@@ -685,15 +688,16 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_privkey_tweak_mul(
685688
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3);
686689

687690
/** Tweak a public key by multiplying it by a tweak value.
688-
* Returns: 0 if the arguments are invalid. 1 otherwise.
689-
* Args: ctx: pointer to a context object initialized for validation
690-
* (cannot be NULL).
691-
* In/Out: pubkey: pointer to a public key object. If this function returns 0,
692-
* pubkey will be invalid. (cannot be NULL).
693-
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
694-
* keys (see secp256k1_ec_seckey_verify). For uniformly random
695-
* 32-byte arrays the chance of being out of range is
696-
* negligible (around 1 in 2^128). (cannot be NULL)
691+
*
692+
* Returns: 0 if the arguments are invalid. 1 otherwise.
693+
* Args: ctx: pointer to a context object initialized for validation
694+
* (cannot be NULL).
695+
* In/Out: pubkey: pointer to a public key object. If this function returns 0,
696+
* pubkey will be invalid. (cannot be NULL).
697+
* In: tweak: pointer to a 32-byte tweak. Must be in the same range as secret
698+
* keys (see secp256k1_ec_seckey_verify). For uniformly random
699+
* 32-byte arrays the chance of being out of range is
700+
* negligible (around 1 in 2^128). (cannot be NULL)
697701
*/
698702
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_tweak_mul(
699703
const secp256k1_context* ctx,
@@ -732,6 +736,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_context_randomize(
732736
) SECP256K1_ARG_NONNULL(1);
733737

734738
/** Add a number of public keys together.
739+
*
735740
* Returns: 1: the sum of the public keys is valid.
736741
* 0: the sum of the public keys is not valid.
737742
* Args: ctx: pointer to a context object

0 commit comments

Comments
 (0)