summaryrefslogtreecommitdiffstats
path: root/src/crypto.h
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2015-01-11 13:46:38 +0100
committerMatthias Schiffer <mschiffer@universe-factory.net>2015-01-11 13:46:38 +0100
commitf4aa0157048c945bc8d54e87946909dd496c85cb (patch)
treef4671cd70bb3406bc4fad1446b89a7e2e47a1813 /src/crypto.h
parent306667786ecabacf91b37c7e97a757561e951fe0 (diff)
downloadfastd-f4aa0157048c945bc8d54e87946909dd496c85cb.tar
fastd-f4aa0157048c945bc8d54e87946909dd496c85cb.zip
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.
Diffstat (limited to 'src/crypto.h')
-rw-r--r--src/crypto.h15
1 files changed, 15 insertions, 0 deletions
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);