X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fstruct%2Fkfile_mem.h;h=b25f3799a3cdfa1526fa640b306c2f8656e65aee;hb=adde3a44787554723d12e61e5c69fca10a514c59;hp=695e6648050a3ade51c6a840f173908fd7214c54;hpb=e4b96c973d54ffbd7950253295c6686a9db08b0a;p=bertos.git diff --git a/bertos/struct/kfile_mem.h b/bertos/struct/kfile_mem.h index 695e6648..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; /** @@ -70,10 +72,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 */