Clean up code. Add comments. Init module with callback to register all

[bertos.git] / bertos / struct / kfile_mem.h

diff --git a/bertos/struct/kfile_mem.h b/bertos/struct/kfile_mem.h
index a0d06ac3a69d903f0cc9729502f19a64e3f7096e..b25f3799a3cdfa1526fa640b306c2f8656e65aee 100644 (file)
--- a/bertos/struct/kfile_mem.h
+++ b/bertos/struct/kfile_mem.h
@@ -35,7 +35,6 @@
  * Convenient way to access a memory region using the KFile interface.
  *
  *
- * \version $Id: cfg_adc.h 2348 2009-02-16 13:43:44Z duplo $
  * \author Francesco Sacchi <batt@develer.com>
  *
  * $WIZ$ module_name = "kfilemem"
@@ -45,12 +44,15 @@
 #ifndef STRUCT_KFILE_MEM
 #define STRUCT_KFILE_MEM
 
-#include <kern/kfile.h>
+#include <io/kfile.h>
 
+/**
+ * Context for KFile over memory buffer.
+ */
 typedef struct KFileMem
 {
-               KFile fd;
-               void *mem;
+       KFile fd;  ///< KFile base class
+       void *mem; ///< Pointer to the memory buffer used.
 } KFileMem;
 
 /**
@@ -74,6 +76,6 @@ INLINE KFileMem * KFILEMEM_CAST(KFile *fd)
  * \param mem Pointer to the memory buffer to operate on.
  * \param len Size of the buffer
  */
-void kfilemem_init(KFileMem *kf, void *mem, size_t len);
+void kfilemem_init(KFileMem *km, void *mem, size_t len);
 
 #endif /* STRUCT_KFILE_MEM */