Add documentation

[model-checker.git] / cyclegraph.h

diff --git a/cyclegraph.h b/cyclegraph.h
index 3ed4e4a2f6fe6bb008a3038b9c7208db0f9613b4..5cf709324a863d51e4ec45956093600460495232 100644 (file)
--- a/cyclegraph.h
+++ b/cyclegraph.h
@@ -1,3 +1,7 @@
+/** @file cyclegraph.h @brief Data structure to track ordering
+ *  constraints on modification order.  The idea is to see whether a
+ *  total order exists that satisfies the ordering constriants.*/
+
 #ifndef CYCLEGRAPH_H
 #define CYCLEGRAPH_H