From f4aa0157048c945bc8d54e87946909dd496c85cb Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Sun, 11 Jan 2015 13:46:38 +0100 Subject: doc: move comments from generated source files to headers Unfortunately, Doxygen stopped interpreting the .c.in files as C source files a while ago. Move the comments to the header files to avoid the Doxygen warnings. --- src/crypto.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'src/crypto.h') diff --git a/src/crypto.h b/src/crypto.h index c55e931..5571bf9 100644 --- a/src/crypto.h +++ b/src/crypto.h @@ -77,16 +77,31 @@ struct fastd_mac { }; +/** Initializes the list of cipher implementations */ void fastd_cipher_init(void); + +/** Configures a cipher to use a specific implementation */ bool fastd_cipher_config(const char *name, const char *impl); + +/** Returns information about the cipher with the specified name if there is an implementation available */ const fastd_cipher_info_t * fastd_cipher_info_get_by_name(const char *name); + +/** Returns the chosen cipher implementation for a given cipher */ const fastd_cipher_t * fastd_cipher_get(const fastd_cipher_info_t *info); + +/** Initializes the list of MAC implementations */ void fastd_mac_init(void); + +/** Configures a MAC to use a specific implementation */ bool fastd_mac_config(const char *name, const char *impl); + +/** Returns information about the MAC with the specified name if there is an implementation available */ const fastd_mac_info_t * fastd_mac_info_get_by_name(const char *name); + +/** Returns the chosen MAC implementation for a given cipher */ const fastd_mac_t * fastd_mac_get(const fastd_mac_info_t *info); -- cgit v1.2.3