From 2b1c24c738e96986e79867c3b188afa6c7e9a677 Mon Sep 17 00:00:00 2001 From: bernie Date: Sun, 17 Aug 2008 18:31:25 +0000 Subject: [PATCH] kfile: doc cleanup git-svn-id: https://src.develer.com/svnoss/bertos/trunk@1655 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/kern/kfile.c | 4 +--- bertos/kern/kfile.h | 8 +++++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/bertos/kern/kfile.c b/bertos/kern/kfile.c index 3d664e53..6750aba3 100644 --- a/bertos/kern/kfile.c +++ b/bertos/kern/kfile.c @@ -27,19 +27,17 @@ * the GNU General Public License. * * Copyright 2007 Develer S.r.l. (http://www.develer.com/) - * * --> * * \brief Virtual KFile I/O interface. + * * This module implements some generic I/O interfaces for kfile. * * \version $Id$ * \author Francesco Sacchi * \author Daniele Basile - * */ - #include "kfile.h" #include "cfg/cfg_kfile.h" diff --git a/bertos/kern/kfile.h b/bertos/kern/kfile.h index 609c8d63..4f1d8fc8 100644 --- a/bertos/kern/kfile.h +++ b/bertos/kern/kfile.h @@ -178,7 +178,9 @@ typedef void (*ClearErrFunc_t) (struct KFile *fd); /** * Context data for callback functions which operate on * pseudo files. - * \note If you change interface, remember to add corresponding access function. + * + * \note Remember to add the corresponding accessor functions + * when extending this interface. */ typedef struct KFile { @@ -190,11 +192,11 @@ typedef struct KFile FlushFunc_t flush; ErrorFunc_t error; ClearErrFunc_t clearerr; - DB(id_t _type); ///< Used to keep trace, at runtime, of obj type. + DB(id_t _type); ///< Used to keep track, at runtime, of the class type. /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */ kfile_off_t seek_pos; - kfile_size_t size; + kfile_size_t size; // FIXME: should be kfile_off_t } KFile; /** -- 2.25.1