From 900d67de874586a8761a2b7f2899e56bfec10859 Mon Sep 17 00:00:00 2001
From: Celine Mercier <celine.mercier@metabarcoding.org>
Date: Fri, 22 Apr 2016 15:43:39 +0200
Subject: [PATCH] Updated the documentation for columns with the type OBI_IDX

---
 src/obidmscolumn_idx.c |  2 --
 src/obidmscolumn_idx.h | 39 ++++++++++++++++++++++++++++++++++++++-
 2 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/src/obidmscolumn_idx.c b/src/obidmscolumn_idx.c
index 89f5505..ad8c046 100644
--- a/src/obidmscolumn_idx.c
+++ b/src/obidmscolumn_idx.c
@@ -15,8 +15,6 @@
 
 #include "obidmscolumn.h"
 #include "obitypes.h"
-#include "obierrno.h"
-#include "obidebug.h"
 
 
 #define DEBUG_LEVEL 0	// TODO has to be defined somewhere else (cython compil flag?)
diff --git a/src/obidmscolumn_idx.h b/src/obidmscolumn_idx.h
index 59f87f7..aaad05d 100644
--- a/src/obidmscolumn_idx.h
+++ b/src/obidmscolumn_idx.h
@@ -7,6 +7,9 @@
  * @author Celine Mercier
  * @date February 14th 2016
  * @brief Header file for the functions handling OBIColumns containing data with the OBIType OBI_IDX.
+ *
+ * Note: OBI_IDX columns contain indices referring to data stored elsewhere
+ *		 (for example lines in other columns) and contain only one element (index) per line.
  */
 
 
@@ -20,10 +23,44 @@
 #include "obidmscolumn.h"
 #include "obitypes.h"
 
-// TODO doc
 
+/**
+ * @brief Sets a value in an OBIDMS column containing data with the type OBI_IDX.
+ *
+ *	Note: OBI_IDX columns contain indices referring to data stored elsewhere
+ *		  (for example lines in other columns) and contain only one element (index) per line.
+ *
+ * @warning Pointers returned by obi_open_column() don't allow writing.
+ *
+ * @param column A pointer as returned by obi_create_column() or obi_clone_column().
+ * @param line_nb The number of the line where the value should be set.
+ * @param value The value that should be set.
+ *
+ * @returns An integer value indicating the success of the operation.
+ * @retval 0 on success.
+ * @retval -1 if an error occurred.
+ *
+ * @since February 2016
+ * @author Celine Mercier (celine.mercier@metabarcoding.org)
+ */
 int obi_column_set_index(OBIDMS_column_p column, index_t line_nb, index_t value);
 
+
+/**
+ * @brief Recovers a value in an OBIDMS column containing data with the type OBI_IDX.
+ *
+ *	Note: OBI_IDX columns contain indices referring to data stored elsewhere
+ *		  (for example lines in other columns) and contain only one element (index) per line.
+ *
+ * @param column A pointer as returned by obi_create_column() or obi_clone_column().
+ * @param line_nb The number of the line where the value should be recovered.
+ *
+ * @returns The recovered value.
+ * @retval OBIIdx_NA the NA value of the type if an error occurred and obi_errno is set.
+ *
+ * @since February 2016
+ * @author Celine Mercier (celine.mercier@metabarcoding.org)
+ */
 index_t obi_column_get_index(OBIDMS_column_p column, index_t line_nb);