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

fixed bugs and typos in the obidms and obidmscolumn source and header

Browse Source 
files
This commit is contained in:
Celine Mercier
2015-06-17 16:51:16 +02:00
parent 9f9c20aa4a
commit ed662077b3
4 changed files with 342 additions and 316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/obidms.h
View File

@ -15,31 +15,31 @@
#include <string.h>
#include <stdio.h>
#include <obierrno.h>
#include "obierrno.h"
#define OBIDMS_MAX_NAME (2048) /**< The maximum length of an OBIDMS name
*/
/** @brief A structure decribing an OBIDMS instance
/** @brief A structure describing an OBIDMS instance
*
* A pointer to this structure is returned on creation
* and opening of an OBITools Data Management System (DMS)
*/
typedef struct OBIDMS {
char dirname[OBIDMS_MAX_NAME+1]; /**< The name of the directory
* containing the DMS
*/
DIR *directory; /**< A directory entry usable to
* refer and scan the database directory
*/
char directory_name[OBIDMS_MAX_NAME+1]; /**< The name of the directory
* containing the DMS
*/
DIR* directory; /**< A directory entry usable to
* refer and scan the database directory
*/
} OBIDMS_t, *OBIDMS_p;
/*@
* @brief Checks if an OBIDMS exists
*
* @param name a pointer to a C string containing the name of the database.
* @param dms_name a pointer to a C string containing the name of the database.
* The actual directory name used to store the DMS will be
* `<name>.obidms`.
*
@ -52,7 +52,7 @@ typedef struct OBIDMS {
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
int obi_dms_exists(const char* name);
int obi_dms_exists(const char* dms_name);
/**
@ -62,7 +62,7 @@ int obi_dms_exists(const char* name);
* if a directory with this name does not already exist
* before creating the new database.
*
* @param name a pointer to a C string containing the name of the database.
* @param dms_name a pointer to a C string containing the name of the database.
* The actual directory name used to store the DMS will be
* `<name>.obidms`
*
@ -78,13 +78,13 @@ int obi_dms_exists(const char* name);
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
OBIDMS_p obi_create_dms(const char *name);
OBIDMS_p obi_create_dms(const char *dms_name);
/**
* @brief Opens an existing OBITools Data Management instance (OBIDMS).
*
* @param name a pointer to a C string containing the name of the database.
* @param dms_name a pointer to a C string containing the name of the database.
* The actual directory name used to store the DMS will be
* `<name>.obidms`
*
@ -100,7 +100,7 @@ OBIDMS_p obi_create_dms(const char *name);
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
OBIDMS_p obi_open_dms(const char *name);
OBIDMS_p obi_open_dms(const char *dms_name);
/**
@ -109,7 +109,7 @@ OBIDMS_p obi_open_dms(const char *name);
* If the database already exists, this function opens it, otherwise it
* creates a new database.
*
* @param name a pointer to a C string containing the name of the database.
* @param dms_name a pointer to a C string containing the name of the database.
* The actual directory name used to store the DMS is
* `<name>.obidms`
*
@ -124,7 +124,7 @@ OBIDMS_p obi_open_dms(const char *name);
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
OBIDMS_p obi_dms(const char *name);
OBIDMS_p obi_dms(const char *dms_name);
/**