mbed libraries for KL25Z
Diff: FileHandle.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 0:8024c367e29f
- Child:
- 9:663789d7729f
diff -r 73c5efe92a6c -r c14af7958ef5 FileHandle.h --- a/FileHandle.h Tue Oct 23 09:20:18 2012 +0000 +++ b/FileHandle.h Fri Nov 09 11:33:53 2012 +0000 @@ -16,81 +16,73 @@ namespace mbed { -/* Class FileHandle - * An OO equivalent of the internal FILEHANDLE variable - * and associated _sys_* functions +/** An OO equivalent of the internal FILEHANDLE variable + * and associated _sys_* functions. * * FileHandle is an abstract class, needing at least sys_write and - * sys_read to be implmented for a simple interactive device + * sys_read to be implmented for a simple interactive device. * * No one ever directly tals to/instanciates a FileHandle - it gets - * created by FileSystem, and wrapped up by stdio + * created by FileSystem, and wrapped up by stdio. */ class FileHandle { public: - - /* Function write - * Write the contents of a buffer to the file + /** Write the contents of a buffer to the file * - * Parameters - * buffer - the buffer to write from - * length - the number of characters to write + * @param buffer the buffer to write from + * @param length the number of characters to write * - * Returns + * @returns * The number of characters written (possibly 0) on success, -1 on error. */ virtual ssize_t write(const void* buffer, size_t length) = 0; - /* Function close - * Close the file + /** Close the file * - * Returns + * @returns * Zero on success, -1 on error. */ virtual int close() = 0; - /* Function read + /** Function read * Reads the contents of the file into a buffer * - * Parameters - * buffer - the buffer to read in to - * length - the number of characters to read + * @param buffer the buffer to read in to + * @param length the number of characters to read * - * Returns + * @returns * The number of characters read (zero at end of file) on success, -1 on error. */ virtual ssize_t read(void* buffer, size_t length) = 0; - /* Function isatty - * Check if the handle is for a interactive terminal device - * + /** Check if the handle is for a interactive terminal device. * If so, line buffered behaviour is used by default * - * Returns - * 1 if it is a terminal, 0 otherwise + * @returns + * 1 if it is a terminal, + * 0 otherwise */ - virtual int isatty() = 0 ; + virtual int isatty() = 0; - /* Function lseek - * Move the file position to a given offset from a given location. + /** Move the file position to a given offset from a given location. * - * Parameters - * offset - The offset from whence to move to - * whence - SEEK_SET for the start of the file, SEEK_CUR for the + * @param offset The offset from whence to move to + * @param whence SEEK_SET for the start of the file, SEEK_CUR for the * current file position, or SEEK_END for the end of the file. * - * Returns - * New file position on success, -1 on failure or unsupported + * @returns + * new file position on success, + * -1 on failure or unsupported */ virtual off_t lseek(off_t offset, int whence) = 0; - /* Function fsync - * Flush any buffers associated with the FileHandle, ensuring it + /** Flush any buffers associated with the FileHandle, ensuring it * is up to date on disk * - * Returns - * 0 on success or un-needed, -1 on error + * @returns + * 0 on success or un-needed, + * -1 on error */ virtual int fsync() = 0; @@ -104,6 +96,8 @@ lseek(pos, SEEK_SET); return res; } + + virtual ~FileHandle(); }; } // namespace mbed