Doxygen documentation corrected and completed.
This commit is contained in:
@ -1,20 +1,26 @@
|
||||
/*
|
||||
* obierrno.h
|
||||
*
|
||||
* Created on: 23 mai 2015
|
||||
* Author: coissac
|
||||
/****************************************************************************
|
||||
* Header file for obi errnos *
|
||||
****************************************************************************/
|
||||
|
||||
/**
|
||||
* @file obierrno.h
|
||||
* @author Eric Coissac (eric.coissac@metabarcoding.org)
|
||||
* @date 23 May 2015
|
||||
* @brief Header file for obi errnos.
|
||||
*/
|
||||
|
||||
|
||||
#ifndef OBIERRNO_H_
|
||||
#define OBIERRNO_H_
|
||||
|
||||
|
||||
/**
|
||||
* @brief The declaration of the external variable `obi_errno`.
|
||||
*
|
||||
* `obi_errno` is an equivalent of `errno` for the system level error,
|
||||
* but for errors generated by the C layer of the OBITools framework.
|
||||
* but for errors generated by the C layer of the OBITools3 framework.
|
||||
*
|
||||
* @todo We have to look into defining this variable as thread specific.
|
||||
* @TODO We have to look into defining this variable as thread specific.
|
||||
*/
|
||||
extern int obi_errno;
|
||||
|
||||
@ -24,8 +30,8 @@ extern int obi_errno;
|
||||
* the specified `err` code
|
||||
*
|
||||
* This function is defined as a macro to reduce the risk
|
||||
* of increasing the problem generating the error by calling
|
||||
* a new function.
|
||||
* of increasing the problem by generating another error by calling
|
||||
* another function.
|
||||
*
|
||||
* @param err The error code as an integer value.
|
||||
*
|
||||
@ -41,6 +47,8 @@ extern int obi_errno;
|
||||
* Error codes set in errno following an error related
|
||||
* to the manipulation of an OBIDMS.
|
||||
*
|
||||
* @TODO
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
#define OBIDMS_EXIST_ERROR (1) /**< Trying to create an OBIDMS with a name
|
||||
|
Reference in New Issue
Block a user