From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Mon, 17 May 2010 07:53:27 +0000 (+0200)
Subject: src/sn_{comparator,stage}.h: Add initial Doxygen stuff.
X-Git-Tag: v1.0.0~44
X-Git-Url: https://git.octo.it/?p=sort-networks.git;a=commitdiff_plain;h=b3c14c5bb0f490e0b488e3b9e9cf2eeff645d7a3

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

diff --git a/src/sn_comparator.h b/src/sn_comparator.h
index b3510d5..09c2b57 100644
--- 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
diff --git a/src/sn_stage.h b/src/sn_stage.h
index 6bd3364..192887a 100644
--- a/src/sn_stage.h
+++ b/src/sn_stage.h
@@ -1,4 +1,8 @@
 /**
+ * \file sn_stage.h
+ * \brief The sn_stage_t class and associated methods.
+ *
+ * \verbatim
  * libsortnetwork - src/sn_stage.h
  * Copyright (C) 2008-2010  Florian octo Forster
  *
@@ -17,6 +21,7 @@
  *
  * Authors:
  *   Florian octo Forster <ff at octo.it>
+ * \endverbatim
  **/
 
 #ifndef SN_STAGE_H
@@ -45,6 +50,14 @@ enum sn_network_cut_dir_e
 #define SN_STAGE_COMP_GET(s,n) ((s)->comparators + (n))
 
 sn_stage_t *sn_stage_create (int depth);
+
+/**
+ * Clones an existing stage.
+ *
+ * \param s Stage to clone.
+ * \return Copied stage or NULL on error. The returned stage must be freed
+ *   using sn_stage_destroy().
+ */
 sn_stage_t *sn_stage_clone (const sn_stage_t *s);
 void sn_stage_destroy (sn_stage_t *s);