Add tag for wizard.

[bertos.git] / bertos / io / kfile_block.h

diff --git a/bertos/io/kfile_block.h b/bertos/io/kfile_block.h
index 9694ea94c5c97cf4b1b527f66427acca65156068..e84e92d780791dfbc284ca23c30ba13768ee272f 100644 (file)
--- a/bertos/io/kfile_block.h
+++ b/bertos/io/kfile_block.h
@@ -32,6 +32,15 @@
  *
  * \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.
+ *
+ * \author Francesco Sacchi <batt@develer.com>
+ * \author Daniele Basile <asterix@develer.com>
+ *
+ * $WIZ$ module_name = "kfile_block"
+ * $WIZ$ module_depends = "kfile", "kblock"
  */
 
 #ifndef IO_KFILE_BLOCK_H
@@ -41,12 +50,25 @@
 #include <io/kblock.h>
 #include <io/kfile.h>
 
+/**
+ * KFileBlock context.
+ */
 typedef struct KFileBlock
 {
-       KFile fd;
-       KBlock *b;
+       KFile fd;    ///< KFile context
+       KBlock *blk; ///< KBlock device
 } KFileBlock;
 
-void kfileblock_init(KFileBlock *fb, KBlock *b);
+/**
+ * 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 blk block device to be accessed with a KFile interface.
+ */
+void kfileblock_init(KFileBlock *fb, KBlock *blk);
 
 #endif /* IO_KFILE_KBLOCK_H */