Skip to content

Commit 149c41c

Browse files
committed
docs: complete interface description for secp256k1_schnorrsig_sign_custom
For the sake of completeness, add the missing descriptions for the return value and parameters (`ctx`, `sig64`, `keypair`), in the same wording/style as for the function `secp256k1_schnorrsig_sign32`.
1 parent f30c748 commit 149c41c

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

include/secp256k1_schnorrsig.h

+6-2
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,13 @@ SECP256K1_API int secp256k1_schnorrsig_sign(
144144
* Creates the same signatures as schnorrsig_sign if msglen is 32 and the
145145
* extraparams.ndata is the same as aux_rand32.
146146
*
147+
* Returns 1 on success, 0 on failure.
148+
* Args: ctx: pointer to a context object (not secp256k1_context_static).
149+
* Out: sig64: pointer to a 64-byte array to store the serialized signature.
147150
* In: msg: the message being signed. Can only be NULL if msglen is 0.
148-
* msglen: length of the message
149-
* extraparams: pointer to a extraparams object (can be NULL)
151+
* msglen: length of the message.
152+
* keypair: pointer to an initialized keypair.
153+
* extraparams: pointer to an extraparams object (can be NULL).
150154
*/
151155
SECP256K1_API int secp256k1_schnorrsig_sign_custom(
152156
const secp256k1_context *ctx,

0 commit comments

Comments
 (0)