diff options
author | mascarenhas <mascarenhas> | 2009-06-03 20:53:55 +0000 |
---|---|---|
committer | mascarenhas <mascarenhas> | 2009-06-03 20:53:55 +0000 |
commit | 327acf788fd2a28436bcc8f4848a3a2819fa1ca8 (patch) | |
tree | 6a0b8639fd0849f30a22e9d633782be7c68667b4 /doc | |
parent | 375d009d89eae607b2b95615f42134e4cdd8a2f6 (diff) | |
download | luafilesystem-327acf788fd2a28436bcc8f4848a3a2819fa1ca8.tar.gz luafilesystem-327acf788fd2a28436bcc8f4848a3a2819fa1ca8.tar.bz2 luafilesystem-327acf788fd2a28436bcc8f4848a3a2819fa1ca8.zip |
updated docs for lfs.dir
Diffstat (limited to 'doc')
-rw-r--r-- | doc/us/manual.html | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/us/manual.html b/doc/us/manual.html index ee80703..1409c40 100644 --- a/doc/us/manual.html +++ b/doc/us/manual.html | |||
@@ -186,11 +186,12 @@ LuaFileSystem offers the following functions: | |||
186 | <dd>Returns a string with the current working directory or <code>nil</code> | 186 | <dd>Returns a string with the current working directory or <code>nil</code> |
187 | plus an error string.</dd> | 187 | plus an error string.</dd> |
188 | 188 | ||
189 | <dt><a name="dir"></a><strong><code>lfs.dir (path)</code></strong></dt> | 189 | <dt><a name="dir"></a><strong><code>iter, dir_obj = lfs.dir (path)</code></strong></dt> |
190 | <dd> | 190 | <dd> |
191 | Lua iterator over the entries of a given directory. | 191 | Lua iterator over the entries of a given directory. |
192 | Each time the iterator is called it returns a directory entry's name as a string, or | 192 | Each time the iterator is called with <code>dir_obj</code> it returns a directory entry's name as a string, or |
193 | <code>nil</code> if there are no more entries. | 193 | <code>nil</code> if there are no more entries. You can also iterate by calling <code>dir_obj:next()</code>, and |
194 | explicitly close the directory before the iteration finished with <code>dir_obj:close()</code>. | ||
194 | Raises an error if <code>path</code> is not a directory. | 195 | Raises an error if <code>path</code> is not a directory. |
195 | </dd> | 196 | </dd> |
196 | 197 | ||
@@ -261,7 +262,7 @@ LuaFileSystem offers the following functions: | |||
261 | 262 | ||
262 | <div id="about"> | 263 | <div id="about"> |
263 | <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p> | 264 | <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p> |
264 | <p><small>$Id: manual.html,v 1.44 2009/04/24 22:24:06 mascarenhas Exp $</small></p> | 265 | <p><small>$Id: manual.html,v 1.45 2009/06/03 20:53:55 mascarenhas Exp $</small></p> |
265 | </div> <!-- id="about" --> | 266 | </div> <!-- id="about" --> |
266 | 267 | ||
267 | </div> <!-- id="container" --> | 268 | </div> <!-- id="container" --> |