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 e5bb3dd..09c2b57 100644 (file)
--- a/src/sn_comparator.h
+++ b/src/sn_comparator.h
@@ -1,6 +1,10 @@
 /**
- * collectd - src/sn_comparator.h
- * Copyright (C) 2008  Florian octo Forster
+ * \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
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -16,7 +20,8 @@
  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  *
  * Authors:
- *   Florian octo Forster <octo at verplant.org>
+ *   Florian octo Forster <ff at octo.it>
+ * \endverbatim
  **/
 
 #ifndef SN_COMPARATOR_H
@@ -37,6 +42,7 @@ typedef struct sn_comparator_s sn_comparator_t;
 sn_comparator_t *sn_comparator_create (int min, int max);
 void sn_comparator_destroy (sn_comparator_t *c);
 void sn_comparator_invert (sn_comparator_t *c);
+void sn_comparator_shift (sn_comparator_t *c, int sw, int inputs_num);
 void sn_comparator_swap (sn_comparator_t *c, int con0, int con1);
 
 int sn_comparator_compare (const void *, const void *);