Diff: FATFileSystem.h

Revision:

3:e960e2b81a3c

Parent:

1:46ce1e16c870

Child:

4:3ff2606d5713

diff -r b6669c987c8e -r e960e2b81a3c FATFileSystem.h
--- a/FATFileSystem.h	Thu Nov 29 10:56:08 2012 +0000
+++ b/FATFileSystem.h	Mon Mar 17 14:09:00 2014 +0000
@@ -29,6 +29,9 @@
 
 using namespace mbed;
 
+/**
+  * FATFileSystem based on ChaN's Fat Filesystem library v0.8 
+  */
 class FATFileSystem : public FileSystemLike {
 public:
 
@@ -38,11 +41,30 @@
     static FATFileSystem * _ffs[_VOLUMES];   // FATFileSystem objects, as parallel to FatFs drives array
     FATFS _fs;                               // Work area (file system object) for logical drive
     int _fsid;
-
+    
+    /**
+      * Opens a file on the filesystem
+      */
     virtual FileHandle *open(const char* name, int flags);
+    
+    /**
+     * Removes a file path
+     */
     virtual int remove(const char *filename);
+
+    /**
+     * Formats a logical drive, FDISK artitioning rule, 512 bytes per cluster
+     */
     virtual int format();
+
+    /**
+      * Opens a directory on the filesystem
+      */
     virtual DirHandle *opendir(const char *name);
+    
+    /**
+     * Creates a directory path
+     */
     virtual int mkdir(const char *name, mode_t mode);
 
     virtual int disk_initialize() { return 0; }