src/sn_{comparator,stage}.h: Add initial Doxygen stuff.

[sort-networks.git] / src / sn_comparator.h

diff --git a/src/sn_comparator.h b/src/sn_comparator.h
index b3510d5..09c2b57 100644 (file)
--- a/src/sn_comparator.h
+++ b/src/sn_comparator.h
@@ -1,4 +1,8 @@
 /**
+ * \file sn_comparator.h
+ * \brief The sn_comparator_t class and associated methods.
+ *
+ * \verbatim
  * libsortnetwork - src/sn_comparator.h
  * Copyright (C) 2008-2010  Florian octo Forster
  *
@@ -17,6 +21,7 @@
  *
  * Authors:
  *   Florian octo Forster <ff at octo.it>
+ * \endverbatim
  **/
 
 #ifndef SN_COMPARATOR_H