X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fstruct%2Fkfile_mem.h;h=b25f3799a3cdfa1526fa640b306c2f8656e65aee;hb=15810459b8f5fb09b12cef6f8e4d4e64d167087b;hp=a0d06ac3a69d903f0cc9729502f19a64e3f7096e;hpb=4da38823ef72cc13d641c65380bb75136d2f209e;p=bertos.git diff --git a/bertos/struct/kfile_mem.h b/bertos/struct/kfile_mem.h index a0d06ac3..b25f3799 100644 --- 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 * * $WIZ$ module_name = "kfilemem" @@ -45,12 +44,15 @@ #ifndef STRUCT_KFILE_MEM #define STRUCT_KFILE_MEM -#include +#include +/** + * 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 */