From eed845c2bc3e3132f5bb625dd07e80484c4c06ea Mon Sep 17 00:00:00 2001 From: batt Date: Mon, 2 Aug 2010 13:12:56 +0000 Subject: [PATCH] Add documentation; remove ASSERT on partial write.bertos/io/kfile_block.c git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4120 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/io/kfile_block.h | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/bertos/io/kfile_block.h b/bertos/io/kfile_block.h index 9694ea94..f7b9f9bc 100644 --- a/bertos/io/kfile_block.h +++ b/bertos/io/kfile_block.h @@ -32,6 +32,9 @@ * * \brief KFile interface over a KBlock. * + * With this module, you can access a KBlock device + * with the handy KFile interface. + * In order to achieve this, the block device must support partial block write. */ #ifndef IO_KFILE_BLOCK_H @@ -41,12 +44,25 @@ #include #include +/** + * KFileBlock context. + */ typedef struct KFileBlock { - KFile fd; - KBlock *b; + KFile fd; ///< KFile context + KBlock *b; ///< KBlock device } KFileBlock; +/** + * Init a KFile over KBlock. + * After this you can access your KBlock device with a handy KFile interface. + * + * \note The block device must support partial block write in order support + * random write access. + * + * \param fb KFileBlock context. + * \param b block device to be accessed with a KFile interface. + */ void kfileblock_init(KFileBlock *fb, KBlock *b); #endif /* IO_KFILE_KBLOCK_H */ -- 2.25.1