Diff: FileSystemLike.h

Revision:

43:e2ed12d17f06

Parent:

27:7110ebee3484

Child:

44:24d45a770a51

--- a/FileSystemLike.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/FileSystemLike.h	Fri Oct 26 17:40:46 2012 +0100
@@ -22,8 +22,7 @@
 
 namespace mbed {
 
-/* Class FileSystemLike
- *  A filesystem-like object is one that can be used to open files
+/** A filesystem-like object is one that can be used to open files
  *  though it by fopen("/name/filename", mode)
  *
  *  Implementations must define at least open (the default definitions
@@ -33,61 +32,61 @@
 
  public:
 
-    /* Constructor FileSystemLike
+    /** FileSystemLike constructor
      *
-     * Variables
-     *  name - The name to use for the filesystem.
+     *  @param name The name to use for the filesystem.
      */
     FileSystemLike(const char *name) : Base(name) {}
 
-    /* Function open
+    /** Opens a file from the filesystem
      *
-     * Variables
-     *  filename - The name of the file to open.
-     *  flags - One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
+     *  @param filename The name of the file to open.
+     *  @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
      *    zero or more of O_CREAT, O_TRUNC, or O_APPEND.
-     *  returns - A pointer to a FileHandle object representing the
-     *   file on success, or NULL on failure.
+     *
+     *  @returns
+     *    A pointer to a FileHandle object representing the
+     *    file on success, or NULL on failure.
      */
     virtual FileHandle *open(const char *filename, int flags) = 0;
 
-    /* Function remove
-     *  Remove a file from the filesystem.
+    /** Remove a file from the filesystem.
      *
-     * Variables
-     *  filename - the name of the file to remove.
-     *  returns - 0 on success, -1 on failure.
+     *  @param filename the name of the file to remove.
+     *  @param returns 0 on success, -1 on failure.
      */
     virtual int remove(const char *filename) { return -1; };
 
-    /* Function rename
-     *  Rename a file in the filesystem.
+    /** Rename a file in the filesystem.
      *
-     * Variables
-     *  oldname - the name of the file to rename.
-     *  newname - the name to rename it to.
-     *  returns - 0 on success, -1 on failure.
+     *  @param oldname the name of the file to rename.
+     *  @param newname the name to rename it to.
+     *
+     *  @returns
+     *    0 on success,
+     *   -1 on failure.
      */
     virtual int rename(const char *oldname, const char *newname) { return -1; };
 
-    /* Function opendir
-     *  Opens a directory in the filesystem and returns a DirHandle
-     *   representing the directory stream.
+    /** Opens a directory in the filesystem and returns a DirHandle
+     *  representing the directory stream.
      *
-     * Variables
-     *  name - The name of the directory to open.
-     *  returns - A DirHandle representing the directory stream, or
-     *   NULL on failure.
+     *  @param name The name of the directory to open.
+     *
+     *  @returns
+     *    A DirHandle representing the directory stream, or
+     *    NULL on failure.
      */
     virtual DirHandle *opendir(const char *name) { return NULL; };
 
-    /* Function mkdir
-     *  Creates a directory in the filesystem.
+    /** Creates a directory in the filesystem.
      *
-     * Variables
-     *  name - The name of the directory to create.
-     *  mode - The permissions to create the directory with.
-     *  returns - 0 on success, -1 on failure.
+     *  @param name The name of the directory to create.
+     *  @param mode The permissions to create the directory with.
+     * 
+     *  @returns
+     *    0 on success,
+     *   -1 on failure.
      */
     virtual int mkdir(const char *name, mode_t mode) { return -1; }