Do not assert on received data.
[bertos.git] / bertos / struct / kfile_mem.h
index 695e6648050a3ade51c6a840f173908fd7214c54..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;
 
 /**
@@ -70,10 +73,10 @@ INLINE KFileMem * KFILEMEM_CAST(KFile *fd)
 /**
  * Initialize KFileMem struct.
  *
- * \param kf Interface to initialize.
+ * \param km Interface to initialize.
  * \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 */