yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-29 20:24:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fix

Browse Source 
Add '\c' tags before functions and fields
This commit is contained in:
Andrzej Kurek 2018-02-21 05:13:28 -05:00
parent b6e81bc3d7
commit 57b3ccb4fa
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/mbedtls/pk_info.h
View File

@ -219,27 +219,27 @@ struct mbedtls_pk_info_t
* *
* If \c pub is an ECC key and \c pub is a transparent ECC key that can * If \c pub is an ECC key and \c pub is a transparent ECC key that can
* be used for ECDSA (i.e. \c pub has the type #MBEDTLS_PK_ECKEY or * be used for ECDSA (i.e. \c pub has the type #MBEDTLS_PK_ECKEY or
* #MBEDTLS_PK_ECDSA), then check_pair_func must return 0 if the public * #MBEDTLS_PK_ECDSA), then \c check_pair_func must return 0 if the public
* key is mathematically equivalent to the public part of prv, and * key is mathematically equivalent to the public part of \c prv, and
* #MBEDTLS_ERR_ECP_BAD_INPUT_DATA otherwise. * #MBEDTLS_ERR_ECP_BAD_INPUT_DATA otherwise.
* *
* If \c pub is a transparent key (key of type #MBEDTLS_PK_RSA, * If \c pub is a transparent key (key of type #MBEDTLS_PK_RSA,
* #MBEDTLS_PK_RSASSA_PSS, #MBEDTLS_PK_ECKEY or #MBEDTLS_PK_ECDSA) whose * #MBEDTLS_PK_RSASSA_PSS, #MBEDTLS_PK_ECKEY or #MBEDTLS_PK_ECDSA) whose
* type does not match the semantic type of \c prv (RSA, ECC or other), * type does not match the semantic type of \c prv (RSA, ECC or other),
* then check_pair_func must return #MBEDTLS_ERR_PK_TYPE_MISMATCH. * then \c check_pair_func must return #MBEDTLS_ERR_PK_TYPE_MISMATCH.
* *
* If \c pub and \c prv are opaque keys from the same engines (i.e. ''), * If \c pub and \c prv are opaque keys from the same engines (i.e. ''),
* then check_pair_func must return 0, #MBEDTLS_ERR_PK_TYPE_MISMATCH, or * then \c check_pair_func must return 0, #MBEDTLS_ERR_PK_TYPE_MISMATCH, or
* #MBEDTLS_ERR_RSA_KEY_CHECK_FAILED or #MBEDTLS_ERR_ECP_BAD_INPUT_DATA * #MBEDTLS_ERR_RSA_KEY_CHECK_FAILED or #MBEDTLS_ERR_ECP_BAD_INPUT_DATA
* as in the case of transparent keys. * as in the case of transparent keys.
* *
* If \c pub is an opaque key which is not from the same engine as \c prv, * If \c pub is an opaque key which is not from the same engine as \c prv,
* then check_pair_func may either return a semantically correct status as * then \c check_pair_func may either return a semantically correct status
* in the case of transparent keys, or it may return * as in the case of transparent keys, or it may return
* #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE. * #MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE.
* *
* Alternatively, check_pair_func may return another PK, RSA or ECP error * Alternatively, \c check_pair_func may return another PK, RSA or ECP
* code if applicable. */ * error code if applicable. */
int (*check_pair_func)( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv ); int (*check_pair_func)( const mbedtls_pk_context *pub, const mbedtls_pk_context *prv );
/** Allocate a new context /** Allocate a new context