From 8f774ccb29e7d4317811dbc418d26c872c61010a Mon Sep 17 00:00:00 2001 From: Benign X <1341398182@qq.com> Date: Thu, 18 Jan 2024 17:57:16 +0800 Subject: [PATCH] doc(fs_template): fix doc params missing (#5376) --- examples/porting/lv_port_fs_template.c | 1 + src/libs/fsdrv/lv_fs_fatfs.c | 57 +++++++++++++------------- src/libs/fsdrv/lv_fs_memfs.c | 32 +++++++-------- src/libs/fsdrv/lv_fs_posix.c | 55 +++++++++++++------------ src/libs/fsdrv/lv_fs_stdio.c | 55 +++++++++++++------------ src/libs/fsdrv/lv_fs_win32.c | 55 +++++++++++++------------ 6 files changed, 130 insertions(+), 125 deletions(-) diff --git a/examples/porting/lv_port_fs_template.c b/examples/porting/lv_port_fs_template.c index f79ff49b7..a2d41e1d1 100644 --- a/examples/porting/lv_port_fs_template.c +++ b/examples/porting/lv_port_fs_template.c @@ -228,6 +228,7 @@ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) * @param drv pointer to a driver where this function belongs * @param rddir_p pointer to an initialized 'lv_fs_dir_t' variable * @param fn pointer to a buffer to store the filename + * @param fn_len length of the buffer to store the filename * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum */ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * rddir_p, char * fn, uint32_t fn_len) diff --git a/src/libs/fsdrv/lv_fs_fatfs.c b/src/libs/fsdrv/lv_fs_fatfs.c index 48a84d4be..44971733b 100644 --- a/src/libs/fsdrv/lv_fs_fatfs.c +++ b/src/libs/fsdrv/lv_fs_fatfs.c @@ -97,9 +97,9 @@ static void fs_init(void) /** * Open a file - * @param drv pointer to a driver where this function belongs - * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) - * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR + * @param drv pointer to a driver where this function belongs + * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) + * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR * @return pointer to FIL struct or NULL in case of fail */ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) @@ -126,8 +126,8 @@ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) /** * Close an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FIL variable. (opened with fs_open) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FIL variable. (opened with fs_open) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -141,11 +141,11 @@ static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p) /** * Read data from an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FIL variable. - * @param buf pointer to a memory block where to store the read data - * @param btr number of Bytes To Read - * @param br the real number of read bytes (Byte Read) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FIL variable. + * @param buf pointer to a memory block where to store the read data + * @param btr number of Bytes To Read + * @param br the real number of read bytes (Byte Read) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -159,11 +159,11 @@ static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_ /** * Write into a file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FIL variable - * @param buf pointer to a buffer with the bytes to write - * @param btw Bytes To Write - * @param bw the number of real written bytes (Bytes Written). NULL if unused. + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FIL variable + * @param buf pointer to a buffer with the bytes to write + * @param btw Bytes To Write + * @param bw the number of real written bytes (Bytes Written). NULL if unused. * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t btw, uint32_t * bw) @@ -176,10 +176,10 @@ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, /** * Set the read write pointer. Also expand the file size if necessary. - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FIL variable. (opened with fs_open ) - * @param pos the new position of read write pointer - * @param whence only LV_SEEK_SET is supported + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FIL variable. (opened with fs_open ) + * @param pos the new position of read write pointer + * @param whence only LV_SEEK_SET is supported * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -204,9 +204,9 @@ static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs /** * Give the position of the read write pointer - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FIL variable. - * @param pos_p pointer to to store the result + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FIL variable. + * @param pos_p pointer to to store the result * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -219,8 +219,8 @@ static lv_fs_res_t fs_tell(lv_fs_drv_t * drv, void * file_p, uint32_t * pos_p) /** * Initialize a 'DIR' variable for directory reading - * @param drv pointer to a driver where this function belongs - * @param path path to a directory + * @param drv pointer to a driver where this function belongs + * @param path path to a directory * @return pointer to an initialized 'DIR' variable */ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) @@ -240,9 +240,10 @@ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) /** * Read the next filename from a directory. * The name of the directories will begin with '/' - * @param drv pointer to a driver where this function belongs - * @param dir_p pointer to an initialized 'DIR' variable - * @param fn pointer to a buffer to store the filename + * @param drv pointer to a driver where this function belongs + * @param dir_p pointer to an initialized 'DIR' variable + * @param fn pointer to a buffer to store the filename + * @param fn_len length of the buffer to store the filename * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint32_t fn_len) @@ -268,7 +269,7 @@ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint3 /** * Close the directory reading - * @param drv pointer to a driver where this function belongs + * @param drv pointer to a driver where this function belongs * @param dir_p pointer to an initialized 'DIR' variable * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ diff --git a/src/libs/fsdrv/lv_fs_memfs.c b/src/libs/fsdrv/lv_fs_memfs.c index b8d2b68c7..746f62ea1 100644 --- a/src/libs/fsdrv/lv_fs_memfs.c +++ b/src/libs/fsdrv/lv_fs_memfs.c @@ -111,9 +111,9 @@ void lv_fs_memfs_init(void) /** * Open a file - * @param drv pointer to a driver where this function belongs - * @param path pointer to an extended path object containing the memory buffer address and size - * @param mode read: FS_MODE_RD (currently only reading from the buffer is supported) + * @param drv pointer to a driver where this function belongs + * @param path pointer to an extended path object containing the memory buffer address and size + * @param mode read: FS_MODE_RD (currently only reading from the buffer is supported) * @return pointer to FIL struct or NULL in case of fail */ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) @@ -125,8 +125,8 @@ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) /** * Close an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. (opened with fs_open) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. (opened with fs_open) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -139,11 +139,11 @@ static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p) /** * Read data from an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. - * @param buf pointer to a memory block where to store the read data - * @param btr number of Bytes To Read - * @param br the real number of read bytes (Byte Read) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. + * @param buf pointer to a memory block where to store the read data + * @param btr number of Bytes To Read + * @param br the real number of read bytes (Byte Read) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -159,9 +159,9 @@ static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_ /** * Set the read pointer. - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. (opened with fs_open ) - * @param pos the new position of read pointer + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. (opened with fs_open ) + * @param pos the new position of read pointer * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -193,9 +193,9 @@ static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs /** * Give the position of the read write pointer - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. - * @param pos_p pointer to to store the result + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. + * @param pos_p pointer to to store the result * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ diff --git a/src/libs/fsdrv/lv_fs_posix.c b/src/libs/fsdrv/lv_fs_posix.c index d391d74b2..b345ea969 100644 --- a/src/libs/fsdrv/lv_fs_posix.c +++ b/src/libs/fsdrv/lv_fs_posix.c @@ -96,9 +96,9 @@ void lv_fs_posix_init(void) /** * Open a file - * @param drv pointer to a driver where this function belongs - * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) - * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR + * @param drv pointer to a driver where this function belongs + * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) + * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR * @return a file handle or -1 in case of fail */ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) @@ -122,8 +122,8 @@ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) /** * Close an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p a file handle. (opened with fs_open) + * @param drv pointer to a driver where this function belongs + * @param file_p a file handle. (opened with fs_open) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -136,11 +136,11 @@ static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p) /** * Read data from an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p a file handle variable. - * @param buf pointer to a memory block where to store the read data - * @param btr number of Bytes To Read - * @param br the real number of read bytes (Byte Read) + * @param drv pointer to a driver where this function belongs + * @param file_p a file handle variable. + * @param buf pointer to a memory block where to store the read data + * @param btr number of Bytes To Read + * @param br the real number of read bytes (Byte Read) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -153,11 +153,11 @@ static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_ /** * Write into a file - * @param drv pointer to a driver where this function belongs - * @param file_p a file handle variable - * @param buf pointer to a buffer with the bytes to write - * @param btw Bytes To Write - * @param bw the number of real written bytes (Bytes Written). NULL if unused. + * @param drv pointer to a driver where this function belongs + * @param file_p a file handle variable + * @param buf pointer to a buffer with the bytes to write + * @param btw Bytes To Write + * @param bw the number of real written bytes (Bytes Written). NULL if unused. * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t btw, uint32_t * bw) @@ -169,9 +169,9 @@ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, /** * Set the read write pointer. Also expand the file size if necessary. - * @param drv pointer to a driver where this function belongs - * @param file_p a file handle variable. (opened with fs_open ) - * @param pos the new position of read write pointer + * @param drv pointer to a driver where this function belongs + * @param file_p a file handle variable. (opened with fs_open ) + * @param pos the new position of read write pointer * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -199,9 +199,9 @@ static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs /** * Give the position of the read write pointer - * @param drv pointer to a driver where this function belongs - * @param file_p a file handle variable. - * @param pos_p pointer to to store the result + * @param drv pointer to a driver where this function belongs + * @param file_p a file handle variable. + * @param pos_p pointer to to store the result * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -215,8 +215,8 @@ static lv_fs_res_t fs_tell(lv_fs_drv_t * drv, void * file_p, uint32_t * pos_p) /** * Initialize a 'fs_read_dir_t' variable for directory reading - * @param drv pointer to a driver where this function belongs - * @param path path to a directory + * @param drv pointer to a driver where this function belongs + * @param path path to a directory * @return pointer to an initialized 'DIR' or 'HANDLE' variable */ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) @@ -232,9 +232,10 @@ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) /** * Read the next filename from a directory. * The name of the directories will begin with '/' - * @param drv pointer to a driver where this function belongs - * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable - * @param fn pointer to a buffer to store the filename + * @param drv pointer to a driver where this function belongs + * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable + * @param fn pointer to a buffer to store the filename + * @param fn_len length of the buffer to store the filename * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint32_t fn_len) @@ -258,7 +259,7 @@ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint3 /** * Close the directory reading - * @param drv pointer to a driver where this function belongs + * @param drv pointer to a driver where this function belongs * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ diff --git a/src/libs/fsdrv/lv_fs_stdio.c b/src/libs/fsdrv/lv_fs_stdio.c index 6a93eb35c..fd5c2d183 100644 --- a/src/libs/fsdrv/lv_fs_stdio.c +++ b/src/libs/fsdrv/lv_fs_stdio.c @@ -97,9 +97,9 @@ void lv_fs_stdio_init(void) /** * Open a file - * @param drv pointer to a driver where this function belongs - * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) - * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR + * @param drv pointer to a driver where this function belongs + * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) + * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR * @return pointer to FIL struct or NULL in case of fail */ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) @@ -122,8 +122,8 @@ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) /** * Close an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. (opened with fs_open) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. (opened with fs_open) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -136,11 +136,11 @@ static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p) /** * Read data from an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. - * @param buf pointer to a memory block where to store the read data - * @param btr number of Bytes To Read - * @param br the real number of read bytes (Byte Read) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. + * @param buf pointer to a memory block where to store the read data + * @param btr number of Bytes To Read + * @param br the real number of read bytes (Byte Read) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -153,11 +153,11 @@ static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_ /** * Write into a file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable - * @param buf pointer to a buffer with the bytes to write - * @param btw Bytes To Write - * @param bw the number of real written bytes (Bytes Written). NULL if unused. + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable + * @param buf pointer to a buffer with the bytes to write + * @param btw Bytes To Write + * @param bw the number of real written bytes (Bytes Written). NULL if unused. * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t btw, uint32_t * bw) @@ -169,9 +169,9 @@ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, /** * Set the read write pointer. Also expand the file size if necessary. - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. (opened with fs_open ) - * @param pos the new position of read write pointer + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. (opened with fs_open ) + * @param pos the new position of read write pointer * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -199,9 +199,9 @@ static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs /** * Give the position of the read write pointer - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. - * @param pos_p pointer to to store the result + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. + * @param pos_p pointer to to store the result * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -214,8 +214,8 @@ static lv_fs_res_t fs_tell(lv_fs_drv_t * drv, void * file_p, uint32_t * pos_p) /** * Initialize a 'DIR' or 'HANDLE' variable for directory reading - * @param drv pointer to a driver where this function belongs - * @param path path to a directory + * @param drv pointer to a driver where this function belongs + * @param path path to a directory * @return pointer to an initialized 'DIR' or 'HANDLE' variable */ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) @@ -268,9 +268,10 @@ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) /** * Read the next filename form a directory. * The name of the directories will begin with '/' - * @param drv pointer to a driver where this function belongs - * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable - * @param fn pointer to a buffer to store the filename + * @param drv pointer to a driver where this function belongs + * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable + * @param fn pointer to a buffer to store the filename + * @param fn_len length of the buffer to store the filename * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint32_t fn_len) @@ -318,7 +319,7 @@ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint3 /** * Close the directory reading - * @param drv pointer to a driver where this function belongs + * @param drv pointer to a driver where this function belongs * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ diff --git a/src/libs/fsdrv/lv_fs_win32.c b/src/libs/fsdrv/lv_fs_win32.c index 42e27c7b4..4a8ac0a81 100644 --- a/src/libs/fsdrv/lv_fs_win32.c +++ b/src/libs/fsdrv/lv_fs_win32.c @@ -198,9 +198,9 @@ static lv_fs_res_t fs_error_from_win32(DWORD error) /** * Open a file - * @param drv pointer to a driver where this function belongs - * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) - * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR + * @param drv pointer to a driver where this function belongs + * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt) + * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR * @return pointer to FIL struct or NULL in case of fail */ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) @@ -234,8 +234,8 @@ static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode) /** * Close an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. (opened with fs_open) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. (opened with fs_open) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -249,11 +249,11 @@ static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p) /** * Read data from an opened file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. - * @param buf pointer to a memory block where to store the read data - * @param btr number of Bytes To Read - * @param br the real number of read bytes (Byte Read) + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. + * @param buf pointer to a memory block where to store the read data + * @param btr number of Bytes To Read + * @param br the real number of read bytes (Byte Read) * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -267,11 +267,11 @@ static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_ /** * Write into a file - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable - * @param buf pointer to a buffer with the bytes to write - * @param btw Bytes To Write - * @param bw the number of real written bytes (Bytes Written). NULL if unused. + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable + * @param buf pointer to a buffer with the bytes to write + * @param btw Bytes To Write + * @param bw the number of real written bytes (Bytes Written). NULL if unused. * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t btw, uint32_t * bw) @@ -284,9 +284,9 @@ static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, /** * Set the read write pointer. Also expand the file size if necessary. - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. (opened with fs_open ) - * @param pos the new position of read write pointer + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. (opened with fs_open ) + * @param pos the new position of read write pointer * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -314,9 +314,9 @@ static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs /** * Give the position of the read write pointer - * @param drv pointer to a driver where this function belongs - * @param file_p pointer to a FILE variable. - * @param pos_p pointer to to store the result + * @param drv pointer to a driver where this function belongs + * @param file_p pointer to a FILE variable. + * @param pos_p pointer to to store the result * @return LV_FS_RES_OK: no error, the file is read * any error from lv_fs_res_t enum */ @@ -353,8 +353,8 @@ static lv_fs_res_t fs_tell(lv_fs_drv_t * drv, void * file_p, uint32_t * pos_p) /** * Initialize a 'DIR' or 'HANDLE' variable for directory reading - * @param drv pointer to a driver where this function belongs - * @param path path to a directory + * @param drv pointer to a driver where this function belongs + * @param path path to a directory * @return pointer to an initialized 'DIR' or 'HANDLE' variable */ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) @@ -404,9 +404,10 @@ static void * fs_dir_open(lv_fs_drv_t * drv, const char * path) /** * Read the next filename from a directory. * The name of the directories will begin with '/' - * @param drv pointer to a driver where this function belongs - * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable - * @param fn pointer to a buffer to store the filename + * @param drv pointer to a driver where this function belongs + * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable + * @param fn pointer to a buffer to store the filename + * @param fn_len length of the buffer to store the filename * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint32_t fn_len) @@ -443,7 +444,7 @@ static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint3 /** * Close the directory reading - * @param drv pointer to a driver where this function belongs + * @param drv pointer to a driver where this function belongs * @param dir_p pointer to an initialized 'DIR' or 'HANDLE' variable * @return LV_FS_RES_OK or any error from lv_fs_res_t enum */