Updated the documentation for utils functions

src/utils.h

@@ -19,14 +19,38 @@
 #include "obidms.h"
 
 
+#define FORMATTED_TIME_LENGTH (1024)    /**< The length allocated for the character string containing a formatted date.
+ 	 	 	 	 	 	 	 	 	     */
 #define ONE_IF_ZERO(x) (((x)==0)?1:(x))	/**< If x is equal to 0, x takes the value 1.
                                 	   	 */
 
 
-/*
- * TODO
+/**
+ * @brief Counts the number of files and directories in a directory.
+ *
+ * @param dir_path The absolute path of the directory.
+ *
+ * @returns The number of files and directories in the directory.
+ *
+ * @since April 2016
+ * @author Celine Mercier (celine.mercier@metabarcoding.org)
  */
-int count_dir(char *dir);
+int count_dir(char* dir_path);
+
+
+/**
+ * @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_format_date(time_t date);
 
 
 #endif /* UTILS_H_ */