From f28d344832e6eb6d693e6641108533e2852f7616 Mon Sep 17 00:00:00 2001 From: Hanno Becker Date: Thu, 8 Nov 2018 15:55:24 +0000 Subject: [PATCH] Expand documentation of mbedtls_cipher_list() --- include/mbedtls/cipher.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/include/mbedtls/cipher.h b/include/mbedtls/cipher.h index 47709a932..8dc55f922 100644 --- a/include/mbedtls/cipher.h +++ b/include/mbedtls/cipher.h @@ -324,11 +324,17 @@ typedef struct mbedtls_cipher_context_t } mbedtls_cipher_context_t; /** - * \brief This function retrieves the list of ciphers supported by the generic - * cipher module. + * \brief This function retrieves the list of ciphers supported + * by the generic cipher module. * - * \return A statically-allocated array of ciphers. The last entry - * is zero. + * For any cipher identifier in the returned list, you can + * obtain the corresponding generic cipher information structure + * via mbedtls_cipher_info_from_type(), which can then be used + * to prepare a cipher context via mbedtls_cipher_setup(). + * + * + * \return A statically-allocated array of cipher identifiers + * of type cipher_type_t. The last entry is zero. */ const int *mbedtls_cipher_list( void );