From c69570713ef75ee3e5a41a5edf7dd3c58d794f4d Mon Sep 17 00:00:00 2001 From: "7u83@mail.ru" <7u83@mail.ru@noemail.net> Date: Mon, 4 May 2015 05:28:21 +0000 Subject: [PATCH] Comments stuff. FossilOrigin-Name: 7d81fc88819b4286912472223025e9afaccba0cd70b038aacecbfbb5806a366f --- src/capwap/file.c | 20 ++++++++++++++++++++ src/capwap/file.h | 6 ++++++ 2 files changed, 26 insertions(+) diff --git a/src/capwap/file.c b/src/capwap/file.c index 4eabb4e8..5cb1cd5d 100644 --- a/src/capwap/file.c +++ b/src/capwap/file.c @@ -2,6 +2,26 @@ #include #include +/** + * @file + */ + +/** + * Load a file from disk to memory + * @param filename name of file to load + * @param size variable which receives the size of the file in bytes + * @return a pointer to the memory where the file was loaded in \n + * The memory must be freed using free. + * + * Eexample: + * \code + #include "capwap/file.h" + size_t bytes; + char * data = cw_load_file("file.txt",&bytes); + if (data) + free (data); + \endcode + */ char *cw_load_file(const char *filename,size_t *size) { FILE * infile = fopen(filename,"rb"); diff --git a/src/capwap/file.h b/src/capwap/file.h index f835181e..58afa1cc 100644 --- a/src/capwap/file.h +++ b/src/capwap/file.h @@ -1,9 +1,15 @@ #ifndef __CW_FILE_H #define __CW_FILE_H +/** + *@defgroup FileFunctions File Functions + *@{ + */ + char *cw_load_file(const char *filename,size_t *size); int cw_save_file(const char *filename, char *data,int len); +/**@}*/ #endif