From 5d08da46a2780c39d52834911b17ff1390052858 Mon Sep 17 00:00:00 2001 From: Celine Mercier Date: Fri, 22 Apr 2016 17:55:53 +0200 Subject: [PATCH] Updated the documentation in obidmscolumn.h --- src/obidmscolumn.h | 46 ++++++++++++++++++++++++---------------------- 1 file changed, 24 insertions(+), 22 deletions(-) diff --git a/src/obidmscolumn.h b/src/obidmscolumn.h index 614211f..ebc996c 100644 --- a/src/obidmscolumn.h +++ b/src/obidmscolumn.h @@ -34,14 +34,9 @@ */ #define MAXIMUM_LINE_COUNT (1000000000) /**< The maximum line count for the data of a column. //TODO */ -#define FORMATTED_TIME_LENGTH (1024) /**< The length allocated for the character string containing a formatted date. - */ #define COMMENTS_MAX_LENGTH (2048) /**< The maximum length for comments. */ -typedef int32_t obiversion_t; /**< Used to store the column version number - */ - /** * @brief OBIDMS column header structure. @@ -329,27 +324,34 @@ int obi_close_header(OBIDMS_column_header_p header); index_t obi_column_get_element_index_from_name(OBIDMS_column_p column, const char* element_name); -// TODO doc +/** + * @brief Prepares a column to set a value. + * + * @param column A pointer on an OBIDMS column. + * @param line_nb The number of the line at which the value will be set. + * + * @retval 0 if the operation was successfully completed. + * @retval -1 if an error occurred. + * + * @since April 2016 + * @author Celine Mercier (celine.mercier@metabarcoding.org) + */ int obi_column_prepare_to_set_value(OBIDMS_column_p column, index_t line_nb); -// TODO doc +/** + * @brief Prepares a column to recover a value. + * + * @param column A pointer on an OBIDMS column. + * @param line_nb The number of the line at which the value will be recovered. + * + * @retval 0 if the operation was successfully completed. + * @retval -1 if an error occurred. + * + * @since April 2016 + * @author Celine Mercier (celine.mercier@metabarcoding.org) + */ int obi_column_prepare_to_get_value(OBIDMS_column_p column, index_t line_nb); -/** TODO put in utils.c - * @brief Formats a date in a way that is easy to read. - * - * @warning The pointer returned must be freed by the caller. - * - * @param date A date. - * - * @returns The date formatted in a way that is easy to read. - * - * @since October 2015 - * @author Celine Mercier (celine.mercier@metabarcoding.org) - */ -char* obi_column_format_date(time_t date); - - #endif /* OBIDMSCOLUMN_H_ */