[Scummvm-cvs-logs] SF.net SVN: scummvm: [22422] scummvm/trunk/backends/fs/abstract-fs.h
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Fri May 12 14:29:19 CEST 2006
Revision: 22422
Author: fingolfin
Date: 2006-05-12 14:11:37 -0700 (Fri, 12 May 2006)
ViewCVS: http://svn.sourceforge.net/scummvm/?rev=22422&view=rev
Log Message:
-----------
Updated some comments
Modified Paths:
--------------
scummvm/trunk/backends/fs/abstract-fs.h
Modified: scummvm/trunk/backends/fs/abstract-fs.h
===================================================================
--- scummvm/trunk/backends/fs/abstract-fs.h 2006-05-12 21:02:26 UTC (rev 22421)
+++ scummvm/trunk/backends/fs/abstract-fs.h 2006-05-12 21:11:37 UTC (rev 22422)
@@ -53,11 +53,15 @@
/**
* The child node with the given name. If no child with this name
- * exists, returns 0. Will never be called on a node which is not
- * a directory node.
+ * exists, returns 0. When called on a non-directory node, it should
+ * handle this gracefully by returning 0.
+ *
+ * @note Handling calls on non-dir nodes gracefully makes it possible to
+ * switch to a lazy type detection scheme in the future.
*/
virtual AbstractFilesystemNode *child(const String &name) const = 0;
+
/**
* Returns a special node representing the FS root. The starting point for
* any file system browsing.
@@ -70,7 +74,9 @@
* Construct a node based on a path; the path is in the same format as it
* would be for calls to fopen().
*
- * I.e. getNodeForPath(oldNode.path()) should create a new node identical to oldNode.
+ * Furthermore getNodeForPath(oldNode.path()) should create a new node
+ * identical to oldNode. Hence, we can use the "path" value for persistent
+ * storage e.g. in the config file.
*
* @TODO: This is of course a place where non-portable code easily will sneak
* in, because the format of the path used here is not well-defined.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list