Skip to content

Commit da7bc1b

Browse files
committed
include: in doc, remove article in front of "pointer"
1 parent aa3dd52 commit da7bc1b

6 files changed

+22
-22
lines changed

contrib/lax_der_parsing.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ extern "C" {
6767
*
6868
* Returns: 1 when the signature could be parsed, 0 otherwise.
6969
* Args: ctx: a secp256k1 context object
70-
* Out: sig: a pointer to a signature object
71-
* In: input: a pointer to the signature to be parsed
70+
* Out: sig: pointer to a signature object
71+
* In: input: pointer to the signature to be parsed
7272
* inputlen: the length of the array pointed to be input
7373
*
7474
* This function will accept any valid DER encoded signature, even if the

include/secp256k1.h

+13-13
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ SECP256K1_API void secp256k1_context_destroy(
351351
* the data pointer argument set to NULL.
352352
*
353353
* Args: ctx: pointer to a context object.
354-
* In: fun: a pointer to a function to call when an illegal argument is
354+
* In: fun: pointer to a function to call when an illegal argument is
355355
* passed to the API, taking a message and an opaque pointer.
356356
* (NULL restores the default handler.)
357357
* data: the opaque pointer to pass to fun above, must be NULL for the default handler.
@@ -378,7 +378,7 @@ SECP256K1_API void secp256k1_context_set_illegal_callback(
378378
* crashing.
379379
*
380380
* Args: ctx: pointer to a context object.
381-
* In: fun: a pointer to a function to call when an internal error occurs,
381+
* In: fun: pointer to a function to call when an internal error occurs,
382382
* taking a message and an opaque pointer (NULL restores the
383383
* default handler, see secp256k1_context_set_illegal_callback
384384
* for details).
@@ -407,7 +407,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT secp256k1_scratch_space *secp256k1_sc
407407
/** Destroy a secp256k1 scratch space.
408408
*
409409
* The pointer may not be used afterwards.
410-
* Args: ctx: a pointer to a context object.
410+
* Args: ctx: pointer to a context object.
411411
* scratch: space to destroy
412412
*/
413413
SECP256K1_API void secp256k1_scratch_space_destroy(
@@ -440,13 +440,13 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ec_pubkey_parse(
440440
*
441441
* Returns: 1 always.
442442
* Args: ctx: pointer to a context object.
443-
* Out: output: a pointer to a 65-byte (if compressed==0) or 33-byte (if
443+
* Out: output: pointer to a 65-byte (if compressed==0) or 33-byte (if
444444
* compressed==1) byte array to place the serialized key
445445
* in.
446-
* In/Out: outputlen: a pointer to an integer which is initially set to the
446+
* In/Out: outputlen: pointer to an integer which is initially set to the
447447
* size of output, and is overwritten with the written
448448
* size.
449-
* In: pubkey: a pointer to a secp256k1_pubkey containing an
449+
* In: pubkey: pointer to a secp256k1_pubkey containing an
450450
* initialized public key.
451451
* flags: SECP256K1_EC_COMPRESSED if serialization should be in
452452
* compressed format, otherwise SECP256K1_EC_UNCOMPRESSED.
@@ -499,8 +499,8 @@ SECP256K1_API int secp256k1_ecdsa_signature_parse_compact(
499499
*
500500
* Returns: 1 when the signature could be parsed, 0 otherwise.
501501
* Args: ctx: pointer to a context object
502-
* Out: sig: a pointer to a signature object
503-
* In: input: a pointer to the signature to be parsed
502+
* Out: sig: pointer to a signature object
503+
* In: input: pointer to the signature to be parsed
504504
* inputlen: the length of the array pointed to be input
505505
*
506506
* This function will accept any valid DER encoded signature, even if the
@@ -521,12 +521,12 @@ SECP256K1_API int secp256k1_ecdsa_signature_parse_der(
521521
*
522522
* Returns: 1 if enough space was available to serialize, 0 otherwise
523523
* Args: ctx: pointer to a context object
524-
* Out: output: a pointer to an array to store the DER serialization
525-
* In/Out: outputlen: a pointer to a length integer. Initially, this integer
524+
* Out: output: pointer to an array to store the DER serialization
525+
* In/Out: outputlen: pointer to a length integer. Initially, this integer
526526
* should be set to the length of output. After the call
527527
* it will be set to the length of the serialization (even
528528
* if 0 was returned).
529-
* In: sig: a pointer to an initialized signature object
529+
* In: sig: pointer to an initialized signature object
530530
*/
531531
SECP256K1_API int secp256k1_ecdsa_signature_serialize_der(
532532
const secp256k1_context *ctx,
@@ -586,11 +586,11 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdsa_verify(
586586
*
587587
* Returns: 1 if sigin was not normalized, 0 if it already was.
588588
* Args: ctx: pointer to a context object
589-
* Out: sigout: a pointer to a signature to fill with the normalized form,
589+
* Out: sigout: pointer to a signature to fill with the normalized form,
590590
* or copy if the input was already normalized. (can be NULL if
591591
* you're only interested in whether the input was already
592592
* normalized).
593-
* In: sigin: a pointer to a signature to check/normalize (can be identical to sigout)
593+
* In: sigin: pointer to a signature to check/normalize (can be identical to sigout)
594594
*
595595
* With ECDSA a third-party can forge a second distinct signature of the same
596596
* message, given a single initial signature, but without knowing the key. This

include/secp256k1_ecdh.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ SECP256K1_API const secp256k1_ecdh_hash_function secp256k1_ecdh_hash_function_de
3939
* 0: scalar was invalid (zero or overflow) or hashfp returned 0
4040
* Args: ctx: pointer to a context object.
4141
* Out: output: pointer to an array to be filled by hashfp.
42-
* In: pubkey: a pointer to a secp256k1_pubkey containing an initialized public key.
42+
* In: pubkey: pointer to a secp256k1_pubkey containing an initialized public key.
4343
* seckey: a 32-byte scalar with which to multiply the point.
4444
* hashfp: pointer to a hash function. If NULL,
4545
* secp256k1_ecdh_hash_function_sha256 is used

include/secp256k1_ellswift.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ SECP256K1_API const secp256k1_ellswift_xdh_hash_function secp256k1_ellswift_xdh_
8787
* Returns: 1 always.
8888
* Args: ctx: pointer to a context object
8989
* Out: ell64: pointer to a 64-byte array to be filled
90-
* In: pubkey: a pointer to a secp256k1_pubkey containing an
90+
* In: pubkey: pointer to a secp256k1_pubkey containing an
9191
* initialized public key
9292
* rnd32: pointer to 32 bytes of randomness
9393
*
@@ -169,7 +169,7 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ellswift_create(
169169
* (will not be NULL)
170170
* ell_b64: pointer to the 64-byte encoded public key of party B
171171
* (will not be NULL)
172-
* seckey32: a pointer to our 32-byte secret key
172+
* seckey32: pointer to our 32-byte secret key
173173
* party: boolean indicating which party we are: zero if we are
174174
* party A, non-zero if we are party B. seckey32 must be
175175
* the private key corresponding to that party's ell_?64.

include/secp256k1_extrakeys.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_xonly_pubkey_parse(
5555
* Returns: 1 always.
5656
*
5757
* Args: ctx: pointer to a context object.
58-
* Out: output32: a pointer to a 32-byte array to place the serialized key in.
59-
* In: pubkey: a pointer to a secp256k1_xonly_pubkey containing an initialized public key.
58+
* Out: output32: pointer to a 32-byte array to place the serialized key in.
59+
* In: pubkey: pointer to a secp256k1_xonly_pubkey containing an initialized public key.
6060
*/
6161
SECP256K1_API int secp256k1_xonly_pubkey_serialize(
6262
const secp256k1_context *ctx,

include/secp256k1_preallocated.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ SECP256K1_API size_t secp256k1_context_preallocated_size(
5353
* from it) should not be used during the lifetime of the context object.
5454
*
5555
* Returns: pointer to newly created context object.
56-
* In: prealloc: a pointer to a rewritable contiguous block of memory of
56+
* In: prealloc: pointer to a rewritable contiguous block of memory of
5757
* size at least secp256k1_context_preallocated_size(flags)
5858
* bytes, as detailed above.
5959
* flags: which parts of the context to initialize.
@@ -93,7 +93,7 @@ SECP256K1_API size_t secp256k1_context_preallocated_clone_size(
9393
*
9494
* Returns: pointer to a newly created context object.
9595
* Args: ctx: pointer to a context to copy (not secp256k1_context_static).
96-
* In: prealloc: a pointer to a rewritable contiguous block of memory of
96+
* In: prealloc: pointer to a rewritable contiguous block of memory of
9797
* size at least secp256k1_context_preallocated_size(flags)
9898
* bytes, as detailed above.
9999
*/

0 commit comments

Comments
 (0)