adding header file for the OBIIntColumn structure

This commit is contained in:
Celine Mercier
2015-05-11 17:14:05 +02:00
parent 7c3c112eff
commit 7e74b40b0a

47
src/obiintcolumn.h Normal file
View File

@ -0,0 +1,47 @@
/****************************************************************************
* OBIIntColumn prototype file *
****************************************************************************/
/**
* @file obiintcolumn.h
* @author Celine Mercier
* @date 11 May 2015
* @brief Header file for the OBIIntColumn structure.
*/
#ifndef OBIINTCOLUMN_H_
#define OBIINTCOLUMN_H_
#include <stdio.h>
/**
* @brief enum for the OBIDataType.
*/
typedef enum OBIDataType {
OBI_VOID = 0, /**< data type not specified */
OBI_INT32, /**< type int32_t */
OBI_INT64, /**< type int64_t */
OBI_UINT32, /**< type uint32_t */
OBI_UNIT64, /**< type uint64_t */
OBI_STRING /**< type str */
} OBIDataType_t, *OBIDataType_p;
/**
* @brief Bried description of the function.
*
* Longer description of the function. This part may refer to the parameters
* of the function, like @p parameter.
* @param parameter Description of the first parameter of the function.
* @return Describe what the function returns.
* @see http://website/
* @note Something to note.
* @warning Warning.
*/
void test(int parameter);
#endif /* OBIINTCOLUMN_H_ */