Document *everything*

1 files changed, 20 insertions, 5 deletions

diff --git a/src/crypto/mac/macs.c.in b/src/crypto/mac/macs.c.in
index 0db26d9..5f9a353 100644
--- a/src/crypto/mac/macs.c.in
+++ b/src/crypto/mac/macs.c.in
@@ -23,6 +23,12 @@
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+/**
+   \file
+
+   Generated lists of MACs and their implementations
+*/
+
 
 #include <src/crypto.h>
 #include <src/fastd.h>
@@ -30,29 +36,35 @@
 
 @MAC_DEFINITIONS@
 
+/** A MAC implementation */
 typedef struct fastd_mac_impl {
-	const char *name;
-	const fastd_mac_t *impl;
+	const char *name;			/**< The name of the MAC implementation */
+	const fastd_mac_t *impl;		/**< The MAC implementation */
 } fastd_mac_impl_t;
 
+/** A MAC */
 typedef struct mac_entry {
-	const char *name;
-	const fastd_mac_info_t *info;
-	const fastd_mac_impl_t *impls;
+	const char *name;			/**< The name of the MAC */
+	const fastd_mac_info_t *info;		/**< The associated MAC information */
+	const fastd_mac_impl_t *impls;		/**< NULL-terminated array of MAC implementations */
 } mac_entry_t;
 
 @MAC_IMPLS@
 
+/** The list of supported MACs */
 static const mac_entry_t macs[] = { @MAC_LIST@
 };
 
+/** The list of chosen MAC implementations */
 static const fastd_mac_t *mac_conf[array_size(macs)] = {};
 
 
+/** Checks if a MAC implementation is available on the runtime platform */
 static inline bool mac_available(const fastd_mac_t *mac) {
 	return (!mac->available) || mac->available();
 }
 
+/** Initializes the list of MAC implementations */
 void fastd_mac_init(void) {
 	size_t i, j;
 	for (i = 0; i < array_size(macs); i++) {
@@ -65,6 +77,7 @@ void fastd_mac_init(void) {
 	}
 }
 
+/** Configures a MAC to use a specific implementation */
 bool fastd_mac_config(const char *name, const char *impl) {
 	size_t i;
 	for (i = 0; i < array_size(macs); i++) {
@@ -87,6 +100,7 @@ bool fastd_mac_config(const char *name, const char *impl) {
 	return false;
 }
 
+/** 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) {
 	size_t i, j;
 	for (i = 0; i < array_size(macs); i++) {
@@ -102,6 +116,7 @@ const fastd_mac_info_t* fastd_mac_info_get_by_name(const char *name) {
 	return NULL;
 }
 
+/** Returns the chosen MAC implementation for a given cipher */
 const fastd_mac_t* fastd_mac_get(const fastd_mac_info_t *info) {
 	size_t i;
 	for (i = 0; i < array_size(macs); i++) {