SCHED_ENQUEUE(): Enhance documentation

[bertos.git] / bertos / kern / kfile.h

diff --git a/bertos/kern/kfile.h b/bertos/kern/kfile.h
index 0e375cf3f4fcb8d2967b3cb509fa5e03e4e25bd3..bcc88e7218751bd2b4862eb3329b980915e767d4 100644 (file)
--- a/bertos/kern/kfile.h
+++ b/bertos/kern/kfile.h
@@ -27,7 +27,7 @@
  * the GNU General Public License.
  *
  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 1999, 2000, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
+ * Copyright 1999, 2000, 2001, 2003 Bernie Innocenti <bernie@codewiz.org>
  *
  * -->
  *
@@ -43,20 +43,20 @@
  * you have to declare your context structure:
  *
  * \code
- * typedef struct KFileSerial
+ * typedef struct SerialKFile
  * {
  *             KFile fd;
  *             Serial *ser;
- * } KFileSerial;
+ * } Serial;
  * \endcode
  *
- * You should also supply a macro for casting KFile to KFileSerial:
+ * You should also supply a macro for casting KFile to SerialKFile:
  *
  * \code
- * INLINE KFileSerial * KFILESERIAL(KFile *fd)
+ * INLINE Serial * SERIAL_CAST(KFile *fd)
  * {
  *             ASSERT(fd->_type == KFT_SERIAL);
- *             return (KFileSerial *)fd;
+ *             return (Serial *)fd;
  * }
  * \endcode
  *
@@ -67,12 +67,12 @@
  * \code
  * static int ser_kfile_close(struct KFile *fd)
  * {
- *             KFileSerial *fds = KFILESERIAL(fd);
+ *             SerialKFile *fds = SerialKFile(fd);
  *             ser_close(fds->ser);
  *             return 0;
  * }
  * \endcode
- * KFILESERIAL macro helps to ensure that obj passed is really a Serial.
+ * SerialKFile macro helps to ensure that obj passed is really a Serial.
  *
  * KFile interface do not supply the open function: this is deliberate,
  * because in embedded systems each device has its own init parameters.
@@ -81,7 +81,7 @@
  *
  * \version $Id$
  *
- * \author Bernardo Innocenti <bernie@develer.com>
+ * \author Bernie Innocenti <bernie@codewiz.org>
  * \author Francesco Sacchi <batt@develer.com>
  * \author Daniele Basile <asterix@develer.com>
  */