Skip to content

Commit 7289b51

Browse files
docs: Use doxygen style if and only if comment is user-facing
and improve phrasing slightly.
1 parent e7d0185 commit 7289b51

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

include/secp256k1.h

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ extern "C" {
77

88
#include <stddef.h>
99

10-
/* Unless explicitly stated all pointer arguments must not be NULL.
10+
/** Unless explicitly stated all pointer arguments must not be NULL.
1111
*
1212
* The following rules specify the order of arguments in API calls:
1313
*
@@ -134,7 +134,7 @@ typedef int (*secp256k1_nonce_function)(
134134
# define SECP256K1_INLINE inline
135135
# endif
136136

137-
/** When this header is used at build-time the SECP256K1_BUILD define needs to be set
137+
/* When this header is used at build-time the SECP256K1_BUILD define needs to be set
138138
* to correctly setup export attributes and nullness checks. This is normally done
139139
* by secp256k1.c but to guard against this header being included before secp256k1.c
140140
* has had a chance to set the define (e.g. via test harnesses that just includes
@@ -163,9 +163,9 @@ typedef int (*secp256k1_nonce_function)(
163163
# endif
164164
#endif
165165

166-
/**Warning attributes
167-
* NONNULL is not used if SECP256K1_BUILD is set to avoid the compiler optimizing out
168-
* some paranoid null checks. */
166+
/* Warning attributes
167+
* NONNULL is not used if SECP256K1_BUILD is set to avoid the compiler optimizing out
168+
* some paranoid null checks. */
169169
# if defined(__GNUC__) && SECP256K1_GNUC_PREREQ(3, 4)
170170
# define SECP256K1_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
171171
# else
@@ -177,7 +177,7 @@ typedef int (*secp256k1_nonce_function)(
177177
# define SECP256K1_ARG_NONNULL(_x)
178178
# endif
179179

180-
/** Attribute for marking functions, types, and variables as deprecated */
180+
/* Attribute for marking functions, types, and variables as deprecated */
181181
#if !defined(SECP256K1_BUILD) && defined(__has_attribute)
182182
# if __has_attribute(__deprecated__)
183183
# define SECP256K1_DEPRECATED(_msg) __attribute__ ((__deprecated__(_msg)))
@@ -188,11 +188,11 @@ typedef int (*secp256k1_nonce_function)(
188188
# define SECP256K1_DEPRECATED(_msg)
189189
#endif
190190

191-
/** All flags' lower 8 bits indicate what they're for. Do not use directly. */
191+
/* All flags' lower 8 bits indicate what they're for. Do not use directly. */
192192
#define SECP256K1_FLAGS_TYPE_MASK ((1 << 8) - 1)
193193
#define SECP256K1_FLAGS_TYPE_CONTEXT (1 << 0)
194194
#define SECP256K1_FLAGS_TYPE_COMPRESSION (1 << 1)
195-
/** The higher bits contain the actual data. Do not use directly. */
195+
/* The higher bits contain the actual data. Do not use directly. */
196196
#define SECP256K1_FLAGS_BIT_CONTEXT_VERIFY (1 << 8)
197197
#define SECP256K1_FLAGS_BIT_CONTEXT_SIGN (1 << 9)
198198
#define SECP256K1_FLAGS_BIT_CONTEXT_DECLASSIFY (1 << 10)

0 commit comments

Comments
 (0)