mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-04-02 07:20:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request from AndrzejKurek/doxygen-closure-fixes

Browse Source 
doxygen: add missing asterisk to group closures
This commit is contained in:
Gilles Peskine 2022-01-24 21:40:39 +01:00 committed by GitHub
commit a5c1bf0b8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 33 additions and 36 deletions

8
include/mbedtls/asn1.h

@ -58,7 +58,7 @@
/** Buffer too small when writing ASN.1 data structure. */ /** Buffer too small when writing ASN.1 data structure. */
#define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C #define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
/* \} name */ /** \} name ASN1 Error codes */
/** /**
* \name DER constants * \name DER constants
@ -118,8 +118,7 @@
#define MBEDTLS_ASN1_TAG_PC_MASK 0x20 #define MBEDTLS_ASN1_TAG_PC_MASK 0x20
#define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F #define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
/* \} name */ /** \} name DER constants */
/* \} addtogroup asn1_module */
/** Returns the size of the binary string, without the trailing \\0 */ /** Returns the size of the binary string, without the trailing \\0 */
#define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1) #define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
@ -626,6 +625,9 @@ void mbedtls_asn1_free_named_data( mbedtls_asn1_named_data *entry );
*/ */
void mbedtls_asn1_free_named_data_list( mbedtls_asn1_named_data **head ); void mbedtls_asn1_free_named_data_list( mbedtls_asn1_named_data **head );
/** \} name Functions to parse ASN.1 data structures */
/** \} addtogroup asn1_module */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif

2
include/mbedtls/ctr_drbg.h

@ -135,7 +135,7 @@
/**< The maximum size of seed or reseed buffer in bytes. */ /**< The maximum size of seed or reseed buffer in bytes. */
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#define MBEDTLS_CTR_DRBG_PR_OFF 0 #define MBEDTLS_CTR_DRBG_PR_OFF 0
/**< Prediction resistance is disabled. */ /**< Prediction resistance is disabled. */

2
include/mbedtls/ecp.h

@ -299,7 +299,7 @@ mbedtls_ecp_group;
#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up. */ #define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up. */
#endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */ #endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#else /* MBEDTLS_ECP_ALT */ #else /* MBEDTLS_ECP_ALT */
#include "ecp_alt.h" #include "ecp_alt.h"

2
include/mbedtls/entropy.h

@ -69,7 +69,7 @@
#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */ #define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR) #if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
#define MBEDTLS_ENTROPY_BLOCK_SIZE 64 /**< Block size of entropy accumulator (SHA-512) */ #define MBEDTLS_ENTROPY_BLOCK_SIZE 64 /**< Block size of entropy accumulator (SHA-512) */

2
include/mbedtls/hkdf.h

@ -35,7 +35,7 @@
*/ */
/** Bad input parameters to function. */ /** Bad input parameters to function. */
#define MBEDTLS_ERR_HKDF_BAD_INPUT_DATA -0x5F80 #define MBEDTLS_ERR_HKDF_BAD_INPUT_DATA -0x5F80
/* \} name */ /** \} name */
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {

2
include/mbedtls/hmac_drbg.h

@ -71,7 +71,7 @@
#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */ #define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#define MBEDTLS_HMAC_DRBG_PR_OFF 0 /**< No prediction resistance */ #define MBEDTLS_HMAC_DRBG_PR_OFF 0 /**< No prediction resistance */
#define MBEDTLS_HMAC_DRBG_PR_ON 1 /**< Prediction resistance enabled */ #define MBEDTLS_HMAC_DRBG_PR_ON 1 /**< Prediction resistance enabled */

8
include/mbedtls/mbedtls_config.h

@ -256,7 +256,7 @@
*/ */
//#define MBEDTLS_DEPRECATED_REMOVED //#define MBEDTLS_DEPRECATED_REMOVED
/* \} name SECTION: System support */ /** \} name SECTION: System support */
/** /**
* \name SECTION: mbed TLS feature support * \name SECTION: mbed TLS feature support
@ -1829,7 +1829,7 @@
* Comment this macro to disallow using RSASSA-PSS in certificates. * Comment this macro to disallow using RSASSA-PSS in certificates.
*/ */
#define MBEDTLS_X509_RSASSA_PSS_SUPPORT #define MBEDTLS_X509_RSASSA_PSS_SUPPORT
/* \} name SECTION: mbed TLS feature support */ /** \} name SECTION: mbed TLS feature support */
/** /**
* \name SECTION: mbed TLS modules * \name SECTION: mbed TLS modules
@ -3021,7 +3021,7 @@
*/ */
#define MBEDTLS_X509_CSR_WRITE_C #define MBEDTLS_X509_CSR_WRITE_C
/* \} name SECTION: mbed TLS modules */ /** \} name SECTION: mbed TLS modules */
/** /**
* \name SECTION: Module configuration options * \name SECTION: Module configuration options
@ -3319,4 +3319,4 @@
*/ */
//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED //#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
/* \} name SECTION: Customisation configuration options */ /** \} name SECTION: Customisation configuration options */

2
include/mbedtls/memory_buffer_alloc.h

@ -38,7 +38,7 @@
#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */ #define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#define MBEDTLS_MEMORY_VERIFY_NONE 0 #define MBEDTLS_MEMORY_VERIFY_NONE 0
#define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0) #define MBEDTLS_MEMORY_VERIFY_ALLOC (1 << 0)

2
include/mbedtls/pem.h

@ -51,7 +51,7 @@
#define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400 #define MBEDTLS_ERR_PEM_FEATURE_UNAVAILABLE -0x1400
/** Bad input parameters to function. */ /** Bad input parameters to function. */
#define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480 #define MBEDTLS_ERR_PEM_BAD_INPUT_DATA -0x1480
/* \} name */ /** \} name PEM Error codes */
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {

2
include/mbedtls/platform.h

@ -119,7 +119,7 @@ extern "C" {
#endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */ #endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
/* /*
* The function pointers for calloc and free. * The function pointers for calloc and free.

8
include/mbedtls/platform_time.h

@ -28,14 +28,6 @@
extern "C" { extern "C" {
#endif #endif
/**
* \name SECTION: Module settings
*
* The configuration options you can set for this module are in this section.
* Either change them in mbedtls_config.h or define them on the compiler command line.
* \{
*/
/* /*
* The time_t datatype * The time_t datatype
*/ */

2
include/mbedtls/ssl.h

@ -380,7 +380,7 @@
#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16 #define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
/* /*
* Length of the verify data for secure renegotiation * Length of the verify data for secure renegotiation

2
include/mbedtls/ssl_cache.h

@ -47,7 +47,7 @@
#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /*!< Maximum entries in cache */ #define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /*!< Maximum entries in cache */
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {

2
include/mbedtls/ssl_cookie.h

@ -42,7 +42,7 @@
#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */ #define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */
#endif #endif
/* \} name SECTION: Module settings */ /** \} name SECTION: Module settings */
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {

9
include/mbedtls/x509.h

@ -93,7 +93,7 @@
#define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980
/** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */ /** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */
#define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000 #define MBEDTLS_ERR_X509_FATAL_ERROR -0x3000
/* \} name */ /** \} name X509 Error codes */
/** /**
* \name X509 Verify codes * \name X509 Verify codes
@ -121,8 +121,8 @@
#define MBEDTLS_X509_BADCRL_BAD_PK 0x040000 /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */ #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000 /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */
#define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */ #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */
/* \} name */ /** \} name X509 Verify codes */
/* \} addtogroup x509_module */ /** \} addtogroup x509_module */
/* /*
* X.509 v3 Subject Alternative Name types. * X.509 v3 Subject Alternative Name types.
@ -252,7 +252,6 @@ typedef struct mbedtls_x509_time
mbedtls_x509_time; mbedtls_x509_time;
/** \} name Structures for parsing X.509 certificates, CRLs and CSRs */ /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */
/** \} addtogroup x509_module */
/** /**
* \brief Store the certificate DN in printable form into buf; * \brief Store the certificate DN in printable form into buf;
@ -308,6 +307,8 @@ int mbedtls_x509_time_is_past( const mbedtls_x509_time *to );
*/ */
int mbedtls_x509_time_is_future( const mbedtls_x509_time *from ); int mbedtls_x509_time_is_future( const mbedtls_x509_time *from );
/** \} addtogroup x509_module */
/* /*
* Internal module functions. You probably do not want to use these unless you * Internal module functions. You probably do not want to use these unless you
* know you do. * know you do.

4
include/mbedtls/x509_crl.h

@ -176,8 +176,8 @@ void mbedtls_x509_crl_init( mbedtls_x509_crl *crl );
*/ */
void mbedtls_x509_crl_free( mbedtls_x509_crl *crl ); void mbedtls_x509_crl_free( mbedtls_x509_crl *crl );
/* \} name */ /** \} name Structures and functions for parsing CRLs */
/* \} addtogroup x509_module */ /** \} addtogroup x509_module */
#ifdef __cplusplus #ifdef __cplusplus
} }

5
include/mbedtls/x509_crt.h

@ -955,8 +955,7 @@ void mbedtls_x509_crt_restart_free( mbedtls_x509_crt_restart_ctx *ctx );
#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */ #endif /* MBEDTLS_ECDSA_C && MBEDTLS_ECP_RESTARTABLE */
#endif /* MBEDTLS_X509_CRT_PARSE_C */ #endif /* MBEDTLS_X509_CRT_PARSE_C */
/* \} name */ /** \} name Structures and functions for parsing and writing X.509 certificates */
/* \} addtogroup x509_module */
#if defined(MBEDTLS_X509_CRT_WRITE_C) #if defined(MBEDTLS_X509_CRT_WRITE_C)
/** /**
@ -1186,6 +1185,8 @@ int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf,
#endif /* MBEDTLS_PEM_WRITE_C */ #endif /* MBEDTLS_PEM_WRITE_C */
#endif /* MBEDTLS_X509_CRT_WRITE_C */ #endif /* MBEDTLS_X509_CRT_WRITE_C */
/** \} addtogroup x509_module */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif

5
include/mbedtls/x509_csr.h

@ -154,8 +154,7 @@ void mbedtls_x509_csr_init( mbedtls_x509_csr *csr );
void mbedtls_x509_csr_free( mbedtls_x509_csr *csr ); void mbedtls_x509_csr_free( mbedtls_x509_csr *csr );
#endif /* MBEDTLS_X509_CSR_PARSE_C */ #endif /* MBEDTLS_X509_CSR_PARSE_C */
/* \} name */ /** \} name Structures and functions for X.509 Certificate Signing Requests (CSR) */
/* \} addtogroup x509_module */
#if defined(MBEDTLS_X509_CSR_WRITE_C) #if defined(MBEDTLS_X509_CSR_WRITE_C)
/** /**
@ -297,6 +296,8 @@ int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, s
#endif /* MBEDTLS_PEM_WRITE_C */ #endif /* MBEDTLS_PEM_WRITE_C */
#endif /* MBEDTLS_X509_CSR_WRITE_C */ #endif /* MBEDTLS_X509_CSR_WRITE_C */
/** \} addtogroup x509_module */
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif