diff options
author | Max Horn | 2003-11-06 22:57:33 +0000 |
---|---|---|
committer | Max Horn | 2003-11-06 22:57:33 +0000 |
commit | 0f54b65caca3a69c147ee165b19b3668f8258cfb (patch) | |
tree | edf3f48bc85cee2aea835ae42d93afb7d138da5f /backends/fs/fs.h | |
parent | 92824087945d8a4c64492f64f081fa98876a38ca (diff) | |
download | scummvm-rg350-0f54b65caca3a69c147ee165b19b3668f8258cfb.tar.gz scummvm-rg350-0f54b65caca3a69c147ee165b19b3668f8258cfb.tar.bz2 scummvm-rg350-0f54b65caca3a69c147ee165b19b3668f8258cfb.zip |
cleanup
svn-id: r11167
Diffstat (limited to 'backends/fs/fs.h')
-rw-r--r-- | backends/fs/fs.h | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/backends/fs/fs.h b/backends/fs/fs.h index e3f0c809de..f9dbd80679 100644 --- a/backends/fs/fs.h +++ b/backends/fs/fs.h @@ -60,8 +60,8 @@ class FSList; -/* - * A single file system node. +/** + * File system node. */ class FilesystemNode { protected: @@ -69,7 +69,7 @@ protected: public: - /* + /** * Flag to tell listDir() which kind of files to list. */ typedef enum { @@ -78,9 +78,9 @@ public: kListAll = 3 } ListMode; - /* - * The starting point for any file system browsing. Returns a special node - * representing the FS root. + /** + * Returns a special node representing the FS root. The starting point for + * any file system browsing. * On Unix, this will be simply the node for / (the root directory). * On Windows, it will be a special node which "contains" all drives (C:, D:, E:). */ @@ -96,44 +96,45 @@ public: virtual ~FilesystemNode() {} - /* - * The display name, used by e.g. the GUI to present the file in the file browser. + /** + * Return display name, used by e.g. the GUI to present the file in the file browser. + * @return the display name */ virtual String displayName() const = 0; - /* + /** * Is this node valid (i.e. refering to an actual FS object)? */ virtual bool isValid() const = 0; - /* + /** * Is this node a directory or not? */ virtual bool isDirectory() const = 0; - /* + /** * A path representation suitable for use with fopen() */ virtual String path() const = 0; - /* + /** * List the content of this directory node. * If this node is not a directory, throw an exception or call error(). */ virtual FSList *listDir(ListMode mode = kListDirectoriesOnly) const = 0; - /* + /** * The parent node of this directory. * The parent of the root is the root itself */ virtual FilesystemNode *parent() const = 0; - /* + /** * Return a clone of this node allocated with new(). */ virtual FilesystemNode *clone() const = 0; - /* + /** * Compare the name of this node to the name of another. */ virtual bool operator< (const FilesystemNode& node) const @@ -143,8 +144,8 @@ public: }; -/* - * A sorted list of multiple file system nodes. E.g. the contents of a given directory. +/** + * Sorted list of multiple file system nodes. E.g. the contents of a given directory. */ class FSList : Common::List<FilesystemNode *> { public: |