doc: correct API docs for ECDSA signing out-params (s/array/signature object/)
What the developer wrote
Authored by Sebastian Falbesoner
doc: correct API docs for ECDSA signing out-params (s/array/signature object/)
What changed, and why it matters
This commit only fixes wording in the API documentation comments. It changes the description of a function output parameter from 'pointer to an array' to 'pointer to a signature object' in two header files. No actual code behavior changed, so there is no security impact.
No action required. This is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies only Doxygen-style documentation comments in include/secp256k1.h and include/secp256k1_recovery.h for the ECDSA signing functions. The parameter type in the actual C API was already a secp256k1_ecdsa_signature pointer (a structured object), not an array. This is a documentation accuracy correction with no functional or binary changes.
Changed components
include/secp256k1.hinclude/secp256k1_recovery.hInspect captured patch +2 / −2
diff --git a/include/secp256k1.h b/include/secp256k1.h
index b7ec6a2..2f3383e 100644
--- a/include/secp256k1.h
+++ b/include/secp256k1.h
@@ -687,7 +687,7 @@ SECP256K1_API const secp256k1_nonce_function secp256k1_nonce_function_default;
* Returns: 1: signature created
* 0: the nonce generation function failed, or the secret key was invalid.
* Args: ctx: pointer to a context object (not secp256k1_context_static).
- * Out: sig: pointer to an array where the signature will be placed.
+ * Out: sig: pointer to a signature object.
* In: msghash32: the 32-byte message hash being signed.
* seckey: pointer to a 32-byte secret key.
* noncefp: pointer to a nonce generation function. If NULL,
diff --git a/include/secp256k1_recovery.h b/include/secp256k1_recovery.h
index 2430f99..45f20ab 100644
--- a/include/secp256k1_recovery.h
+++ b/include/secp256k1_recovery.h
@@ -73,7 +73,7 @@ SECP256K1_API int secp256k1_ecdsa_recoverable_signature_serialize_compact(
* Returns: 1: signature created
* 0: the nonce generation function failed, or the secret key was invalid.
* Args: ctx: pointer to a context object (not secp256k1_context_static).
- * Out: sig: pointer to an array where the signature will be placed.
+ * Out: sig: pointer to a signature object.
* In: msghash32: the 32-byte message hash being signed.
* seckey: pointer to a 32-byte secret key.
* noncefp: pointer to a nonce generation function. If NULL,
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.