Fix doc.
[bertos.git] / bertos / struct / kfile_mem.h
index a0d06ac3a69d903f0cc9729502f19a64e3f7096e..c723de2f4400d4b28bdfe2209630e2a4784ec60c 100644 (file)
 
 #include <kern/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 +77,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 */