Skip to content

Commit 75a2366

Browse files
fix some docs in msddrvce/fatdrvce
Signed-off-by: mateoconlechuga <matthewwaltzis@gmail.com>
1 parent 40ea17c commit 75a2366

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

src/fatdrvce/fatdrvce.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,6 @@ uint24_t fat_Read(fat_file_t *file, uint24_t count, void *buffer);
249249
* @param file File handle returned from fat_Open.
250250
* @param count Number of blocks to write to file.
251251
* @param buffer Data to write to FAT file.
252-
* @return FAT_SUCCESS on success, otherwise error.
253252
* @return Returns number of blocks written, should equal \p count if success.
254253
*/
255254
uint24_t fat_Write(fat_file_t *file, uint24_t count, const void *buffer);

src/msddrvce/msddrvce.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ msd_error_t msd_WriteAsync(msd_transfer_t *xfer);
118118
* @param msd Initialized MSD structure.
119119
* @param lba Logical Block Address (LBA) of starting block to read.
120120
* @param count Number of blocks to read.
121-
* @param buffer Buffer to read into. Must be at least block size * count bytes.
121+
* @param buffer Buffer to read into. Must be at least \p MSD_BLOCK_SIZE * \p count bytes.
122122
* @return Number of blocks read, on success should equal \p count.
123123
*/
124124
uint24_t msd_Read(msd_t *msd, uint32_t lba, uint24_t count, void *buffer);
@@ -127,8 +127,8 @@ uint24_t msd_Read(msd_t *msd, uint32_t lba, uint24_t count, void *buffer);
127127
* Synchronous block write.
128128
* @param msd Iniailized MSD structure.
129129
* @param lba Logical Block Address (LBA) of starting block to read.
130-
* @param count Number of blocks to read.
131-
* @param buffer Buffer to read into. Must be at least block size * count bytes.
130+
* @param count Number of blocks to write.
131+
* @param buffer Buffer to write. Must be at least \p MSD_BLOCK_SIZE * \p count bytes.
132132
* @return Number of blocks written, on success should equal \p count.
133133
*/
134134
uint24_t msd_Write(msd_t *msd, uint32_t lba, uint24_t count, const void *buffer);

0 commit comments

Comments
 (0)