Skip to content

Commit f28d344

Browse files
author
Hanno Becker
committed
Expand documentation of mbedtls_cipher_list()
1 parent 18597cd commit f28d344

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

include/mbedtls/cipher.h

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -324,11 +324,17 @@ typedef struct mbedtls_cipher_context_t
324324
} mbedtls_cipher_context_t;
325325

326326
/**
327-
* \brief This function retrieves the list of ciphers supported by the generic
328-
* cipher module.
327+
* \brief This function retrieves the list of ciphers supported
328+
* by the generic cipher module.
329329
*
330-
* \return A statically-allocated array of ciphers. The last entry
331-
* is zero.
330+
* For any cipher identifier in the returned list, you can
331+
* obtain the corresponding generic cipher information structure
332+
* via mbedtls_cipher_info_from_type(), which can then be used
333+
* to prepare a cipher context via mbedtls_cipher_setup().
334+
*
335+
*
336+
* \return A statically-allocated array of cipher identifiers
337+
* of type cipher_type_t. The last entry is zero.
332338
*/
333339
const int *mbedtls_cipher_list( void );
334340

0 commit comments

Comments
 (0)