Add documentation

[c11tester.git] / datarace.h

diff --git a/datarace.h b/datarace.h
index ef1ef8ca4a256eeaede006d24c7c806fa5844103..33a5c26770df7deacc5ad4f14cacf9c7a3702880 100644 (file)
--- a/datarace.h
+++ b/datarace.h
@@ -1,3 +1,7 @@
+/** @file datarace.h
+ *  @brief Data race detection code.
+ */
+
 #ifndef DATARACE_H
 #include "config.h"
 #include <stdint.h>
@@ -19,7 +23,7 @@ void raceCheckRead(thread_id_t thread, void *location, ClockVector *currClock);
 
 
 
-/** Encoding idea:
+/** Basic encoding idea:
  *      (void *) Either:
  *      (1) points to a full record or
  *