git-svn-id: https://www.grenoble.prabi.fr/svn/LECASofts/ecoPCR/branches/refactoring@44 60f365c0-8329-0410-b2a4-ec073aeeaa1d

src/libecoPCR/ecoIOUtils.c

@@ -16,20 +16,19 @@ int32_t is_big_endian()
 
 
 
-
-
-
 int32_t swap_int32_t(int32_t i)
 {
 	return SWAPINT32(i);
 }
 
 
-
-
-
-
-
+/**
+ * Read part of the file
+ * @param	*f	the database
+ * @param	recordSize the size to be read
+ * 
+ * @return	buffer
+ */
 void *read_ecorecord(FILE *f,int32_t *recordSize)
 {
 	static void *buffer    =NULL;
@@ -79,10 +78,14 @@ void *read_ecorecord(FILE *f,int32_t *recordSize)
 
 
 
-
-
-
-
+/**
+ * Open the database and check it's readable
+ * @param 	filename 		name of the database (.sdx, .rdx, .tbx)
+ * @param 	sequencecount	buffer - pointer to variable storing the number of occurence    
+ * @param 	abort_on_open_error		 	boolean to define the behaviour in case of error 
+ * 										while opening the database
+ * @return 	FILE type
+ **/
 FILE *open_ecorecorddb(const char *filename,
                        int32_t    *sequencecount,
                        int32_t    abort_on_open_error)