From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sun, 14 Jun 2015 13:02:11 +0000 (+0200)
Subject: mm.c: Add documentation of mood comparator macros.
X-Git-Tag: v0.5.5~13
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=d16908705950b9e28a1692b4f721f8ae83bf2846

mm.c: Add documentation of mood comparator macros.

This makes doxygen a bit happier, and it's good to document the
preprocessor magic anyway.
---

diff --git a/mm.c b/mm.c
index 902e41f0..d6f3573c 100644
--- a/mm.c
+++ b/mm.c
@@ -17,6 +17,7 @@
 #include "afs.h"
 #include "mm.h"
 
+/** The comparators for numeric mood methods (year, bitrate, ...). */
 #define MOOD_COMPARATORS \
 	MC(LESS, <) \
 	MC(LESS_OR_EQUAL, <=) \
@@ -27,10 +28,14 @@
 	MC(GREATER, >) \
 	MC(GREATER_OR_EQUAL, >=) \
 
+/** Prefix mood comparator name with "_MC", example: MC_LESS. */
 #define MC(a, b) MC_ ## a,
+/** Each mood comparator is identified by an integer of this type. */
 enum mood_comparator_id {MOOD_COMPARATORS NUM_MOOD_COMPARATORS};
 #undef MC
+/** Stringfied mood comparator, example: "<". */
 #define MC(a, b) # b,
+/** Array of mood comparators represented as C strings ("<", "<=", ...). */
 static const char *mood_comparators[] = {MOOD_COMPARATORS};
 #undef MC