obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Doxygen documentation corrected and completed.

Browse Source
This commit is contained in:
Celine Mercier
2015-09-30 12:03:46 +02:00
parent 45af8396b8
commit 4b7f2d268b
25 changed files with 670 additions and 689 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/obidmscolumndir.c
View File

@@ -4,7 +4,7 @@
/**
* @file obidmscolumndir.c
* @author Celine Mercier
* @author Celine Mercier (celine.mercier@metabarcoding.org)
* @date 18 June 2015
* @brief Functions for OBIDMS column directories.
*/
@@ -25,7 +25,7 @@
#include "obidebug.h"
#define DEBUG_LEVEL 0
#define DEBUG_LEVEL 0 // TODO has to be defined somewhere else (cython compil flag?)
/**************************************************************************
@@ -43,15 +43,10 @@
*
* @warning The returned pointer has to be freed by the caller.
*
* @param column_name the name of the OBIDMS column
* @param column_name The name of the OBIDMS column.
*
* @return a pointer to the OBIDMS column directory name
* @retvalue <column_directory_name> if everything is ok
* @retvalue NULL if an error occurs
*
* ###Error values
* - OBIDMS_MEMORY_ERROR : something wrong occurred during memory allocation.
* - OBIDMS_LONG_NAME_ERROR : the database name exceeds the limit.
* @returns A pointer to the OBIDMS column directory name.
* @retval NULL if an error occurred.
*
* @since June 2015
* @author Celine Mercier (celine.mercier@metabarcoding.org)
@@ -78,10 +73,10 @@ static char* build_column_directory_name(const char* column_name)
}
// Test if the database name is not too long
if (strlen(column_directory_name) >= OBIDMS_COLUMN_DIR_MAX_NAME)
if (strlen(column_directory_name) >= OBIDMS_COLUMN_MAX_NAME)
{
obi_set_errno(OBICOLDIR_LONG_NAME_ERROR);
obidebug(1, "\nError building a column directory name");
obidebug(1, "\nError due to column name too long");
free(column_directory_name);
return NULL;
}