Specify that easycsv_read_value returns heap-allocated string pointer

Signed-off-by: Pradana AUMARS <paumars@courrier.dev>
2 years ago · bb1e4aef4f
parent 769322ec6b
commit bb1e4aef4f
1 changed files with 2 additions and 1 deletions
--- a/include/easycsv.h
+++ b/include/easycsv.h
@ -139,10 +139,11 @@ easycsv_find_num_value(const easycsv*,

 /** 
 * Read string in a specific cell 
+ * String is heap-allocated, it must be destroyed (free'd) manually
 * @param[in] constant pointer to easycsv structure 
 * @param[in] row number
 * @param[in] column number
- * @return string value of cell, NULL if empty cell
+ * @return string value of cell, NULL if error
 */
 char*
 easycsv_read_value(const easycsv*,