Changeset 581:2d38c2b64075

Timestamp:

06/04/08 08:00:43 (7 months ago)

Author:

Maxime Petazzoni <maxime.petazzoni@…>

Branch:

default

Message:

Add doxygen group description for the file system.

Files:

• nxos/base/fs.h (modified) (1 diff)

nxos/base/fs.h

@@ -22 +22 @@
 /*@{*/
 
-/** @defgroup fs Flash file system */
+/** @defgroup fs Flash file system
+ *
+ * A flash-friendly file system for the NXT on-board flash memory. This is a very simple
+ * file system implementation, allowing most of the basic features expected from a file
+ * system: open(), read(), write(), seek(), flush() and close(). Note that reading and
+ * writing use two different pointers. A seek() will move both of them.
+ *
+ * The file system also tries to minimize stress on the flash by progressively moving files
+ * needing more space towards the end of the flash medium. This relocation process happens
+ * automatically and may make one write operation rather costly (in terms of time).
+ *
+ * For more information, refer to the file system design document.
+ */
 /*@{*/