From f36baed085b87d7a393a1cd2d1864d5834c61e27 Mon Sep 17 00:00:00 2001
From: Ed Schouten <ed@80386.nl>
Date: Mon, 13 Oct 2008 15:54:07 +0200
Subject: [PATCH] Document some definitions that don't have Doxygen tags yet.

---
 herrie/src/md5.c       | 16 ++++++++++++++++
 herrie/src/scrobbler.c |  3 +++
 2 files changed, 19 insertions(+)

diff --git a/herrie/src/md5.c b/herrie/src/md5.c
index 2646396..1ebb2fc 100644
--- a/herrie/src/md5.c
+++ b/herrie/src/md5.c
@@ -64,10 +64,26 @@ md5_decode(uint32_t buf[16])
 #endif /* G_BYTE_ORDER != G_LITTLE_ENDIAN */
 }
 
+/**
+ * @brief First of the four MD5 calculation steps.
+ */
 #define md5_f(x, y, z)	(z ^ (x & (y ^ z)))
+/**
+ * @brief Second of the four MD5 calculation steps.
+ */
 #define md5_g(x, y, z)	(y ^ (z & (x ^ y)))
+/**
+ * @brief Third of the four MD5 calculation steps.
+ */
 #define md5_h(x, y, z)	(x ^ y ^ z)
+/**
+ * @brief Fourth of the four MD5 calculation steps.
+ */
 #define md5_i(x, y, z)	(y ^ (x | ~z))
+/**
+ * @brief Perform a single MD5 calculation step, including the rotation
+ *        and addition steps.
+ */
 #define md5_step(f, w, x, y, z, d, s) do {	\
 	w += f(x, y, z) + d;			\
 	w = (w << s) | (w >> (32 - s));		\
diff --git a/herrie/src/scrobbler.c b/herrie/src/scrobbler.c
index 0c9419e..46e7abb 100644
--- a/herrie/src/scrobbler.c
+++ b/herrie/src/scrobbler.c
@@ -132,6 +132,9 @@ scrobbler_queue_insert_tail(struct scrobbler_entry *se)
 	scrobbler_queue_last = se;
 }
 
+/**
+ * @brief Iterate through all entries in the Scrobbler queue.
+ */
 #define SCROBBLER_QUEUE_FOREACH(se) \
 	for (se = scrobbler_queue_first; se != NULL; se = se->next)
 
-- 
2.11.4.GIT