Partially add documentation and remove const when not needed

This commit is contained in:
Pradana AUMARS 2021-07-11 17:05:18 +02:00
parent fd78125832
commit 449a1bb36c
1 changed files with 52 additions and 15 deletions

View File

@ -118,7 +118,7 @@ easycsv_printcolumns(const easycsv*);
int int
easycsv_sortrow(easycsv*, easycsv_sortrow(easycsv*,
const char*, const char*,
const EASYCSV_SORT); EASYCSV_SORT);
/** /**
* Sort column * Sort column
@ -130,44 +130,81 @@ easycsv_sortrow(easycsv*,
int int
easycsv_sortcolumn(easycsv*, easycsv_sortcolumn(easycsv*,
const char*, const char*,
const EASYCSV_SORT); EASYCSV_SORT);
/*** Modifications, insert ***/ /*** Modifications, insert ***/
/**
* Insert row into CSV file
* @param[in] pointer to easycsv structure
* @param[in] cell value
* @param[in] row number
* @return easycsv error code
*/
int int
easycsv_insertrow(easycsv*, easycsv_insertrow(easycsv*,
const char*, const char*,
const int); int);
/* Insert string in a specific cell */ /**
* Insert string in a specific cell
* @param[in] pointer to easycsv structure
* @param[in] cell value
* @param[in] row number
* @param[in] column number
* @return easycsv error code
*/
int int
easycsv_insertvalue(easycsv*, easycsv_insertvalue(easycsv*,
const char*, const char*,
const unsigned int, unsigned int,
const unsigned int); unsigned int);
/* Insert string in a specific cell with specific mode */ /**
* Insert string in a specific cell with specific mode
* @param[in] pointer to easycsv structure
* @param[in] cell value
* @param[in] row number
* @param[in] column number
* @param[in] easycsv value mode
* @return easycsv error code
*/
int int
easycsv_insertvaluemode(easycsv*, easycsv_insertvaluemode(easycsv*,
const char*, const char*,
const unsigned int, unsigned int,
const unsigned int, unsigned int,
const EASYCSV_VALMODE); EASYCSV_VALMODE);
/* Insert string in a specific cell with named column in row 1 */ /**
* Insert string in a specific cell with named column in a given row
* @param[in] pointer to easycsv structure
* @param[in] cell value
* @param[in] row number
* @param[in] column value
* @return easycsv error code
*/
int int
easycsv_insertcolumnvalue(easycsv*, easycsv_insertcolumnvalue(easycsv*,
const char*, const char*,
const unsigned int, unsigned int,
const char*); const char*);
/* Insert string in a specific cell with named column in row 1 with specific mode */ /**
* Insert string in a specific cell with named column in a given row with specific mode
* @param[in] pointer to easycsv structure
* @param[in] cell value
* @param[in] row number
* @param[in] column value
* @param[in] easycsv value mode
* @return easycsv error code
*/
int int
easycsv_insertcolumnvaluemode(easycsv*, easycsv_insertcolumnvaluemode(easycsv*,
const char*, const char*,
const unsigned int, unsigned int,
const char*, const char*,
const EASYCSV_VALMODE); EASYCSV_VALMODE);
/* Modifications, push */ /* Modifications, push */