Refactor KFileSerial to SerialKFile. Tested and working.

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

diff --git a/bertos/kern/kfile.h b/bertos/kern/kfile.h
index 0fbfcd3bda4d13f43d768f8d62fe17c2e79ef2cd..1f352699610af7282d2e530e7399fb8b054c5593 100644 (file)
--- a/bertos/kern/kfile.h
+++ b/bertos/kern/kfile.h
@@ -43,20 +43,20 @@
  * you have to declare your context structure:
  *
  * \code
- * typedef struct KFileSerial
+ * typedef struct SerialKFile
  * {
  *             KFile fd;
  *             Serial *ser;
- * } KFileSerial;
+ * } SerialKFile;
  * \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 SerialKFile * SERIALKFILE(KFile *fd)
  * {
  *             ASSERT(fd->_type == KFT_SERIAL);
- *             return (KFileSerial *)fd;
+ *             return (SerialKFile *)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.