frost/secp256k1-zkp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Use doxygen style if and only if comment is user-facing

Browse Source 
and improve phrasing slightly.
This commit is contained in:
Tim Ruffing 2022-11-23 17:26:41 +01:00
parent e7d0185c90
commit 7289b51d31
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/secp256k1.h
View File

@ -7,7 +7,7 @@ extern "C" {
#include <stddef.h> #include <stddef.h>
/* Unless explicitly stated all pointer arguments must not be NULL. /** Unless explicitly stated all pointer arguments must not be NULL.
* *
* The following rules specify the order of arguments in API calls: * The following rules specify the order of arguments in API calls:
* *
@ -134,7 +134,7 @@ typedef int (*secp256k1_nonce_function)(
# define SECP256K1_INLINE inline # define SECP256K1_INLINE inline
# endif # endif
/** When this header is used at build-time the SECP256K1_BUILD define needs to be set /* When this header is used at build-time the SECP256K1_BUILD define needs to be set
* to correctly setup export attributes and nullness checks. This is normally done * to correctly setup export attributes and nullness checks. This is normally done
* by secp256k1.c but to guard against this header being included before secp256k1.c * by secp256k1.c but to guard against this header being included before secp256k1.c
* has had a chance to set the define (e.g. via test harnesses that just includes * 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)(
# endif # endif
#endif #endif
/**Warning attributes /* Warning attributes
* NONNULL is not used if SECP256K1_BUILD is set to avoid the compiler optimizing out * NONNULL is not used if SECP256K1_BUILD is set to avoid the compiler optimizing out
* some paranoid null checks. */ * some paranoid null checks. */
# if defined(__GNUC__) && SECP256K1_GNUC_PREREQ(3, 4) # if defined(__GNUC__) && SECP256K1_GNUC_PREREQ(3, 4)
# define SECP256K1_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__)) # define SECP256K1_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
# else # else
@ -177,7 +177,7 @@ typedef int (*secp256k1_nonce_function)(
# define SECP256K1_ARG_NONNULL(_x) # define SECP256K1_ARG_NONNULL(_x)
# endif # endif
/** Attribute for marking functions, types, and variables as deprecated */ /* Attribute for marking functions, types, and variables as deprecated */
#if !defined(SECP256K1_BUILD) && defined(__has_attribute) #if !defined(SECP256K1_BUILD) && defined(__has_attribute)
# if __has_attribute(__deprecated__) # if __has_attribute(__deprecated__)
# define SECP256K1_DEPRECATED(_msg) __attribute__ ((__deprecated__(_msg))) # define SECP256K1_DEPRECATED(_msg) __attribute__ ((__deprecated__(_msg)))
@ -188,11 +188,11 @@ typedef int (*secp256k1_nonce_function)(
# define SECP256K1_DEPRECATED(_msg) # define SECP256K1_DEPRECATED(_msg)
#endif #endif
/** All flags' lower 8 bits indicate what they're for. Do not use directly. */ /* All flags' lower 8 bits indicate what they're for. Do not use directly. */
#define SECP256K1_FLAGS_TYPE_MASK ((1 << 8) - 1) #define SECP256K1_FLAGS_TYPE_MASK ((1 << 8) - 1)
#define SECP256K1_FLAGS_TYPE_CONTEXT (1 << 0) #define SECP256K1_FLAGS_TYPE_CONTEXT (1 << 0)
#define SECP256K1_FLAGS_TYPE_COMPRESSION (1 << 1) #define SECP256K1_FLAGS_TYPE_COMPRESSION (1 << 1)
/** The higher bits contain the actual data. Do not use directly. */ /* The higher bits contain the actual data. Do not use directly. */
#define SECP256K1_FLAGS_BIT_CONTEXT_VERIFY (1 << 8) #define SECP256K1_FLAGS_BIT_CONTEXT_VERIFY (1 << 8)
#define SECP256K1_FLAGS_BIT_CONTEXT_SIGN (1 << 9) #define SECP256K1_FLAGS_BIT_CONTEXT_SIGN (1 << 9)
#define SECP256K1_FLAGS_BIT_CONTEXT_DECLASSIFY (1 << 10) #define SECP256K1_FLAGS_BIT_CONTEXT_DECLASSIFY (1 << 10)