aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/lfs_ext.lua
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2013-10-09 00:23:46 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2013-10-09 00:23:46 -0400
commit098be412f70bb6722c6751b70f939f08f70e196d (patch)
tree15e8a7961b38d85cb3c1966ad929b21fbf7cccfd /core/lfs_ext.lua
parentc9094906de1a7a306c8fdc27a2dc13c65ac40cf8 (diff)
More LuaDoc updates.
Diffstat (limited to 'core/lfs_ext.lua')
-rw-r--r--core/lfs_ext.lua10
1 files changed, 5 insertions, 5 deletions
diff --git a/core/lfs_ext.lua b/core/lfs_ext.lua
index 6e4f0ccf..633aee50 100644
--- a/core/lfs_ext.lua
+++ b/core/lfs_ext.lua
@@ -44,11 +44,11 @@ end
-- function *f* on each file found.
-- Files *f* is called on do not match any pattern in string or table *filter*,
-- and, unless *exclude_FILTER* is `true`, `FILTER` as well. A filter table
--- contains Lua patterns that match filenames to exclude, with patterns matching
--- folders to exclude listed in a `folders` sub-table. Patterns starting with
--- '!' exclude files and folders that do not match the pattern that follows. Use
--- a table of raw file extensions assigned to an `extensions` key for fast
--- filtering by extension.
+-- contains Lua patterns that match filenames to exclude, an optional `folders`
+-- sub-table that contains patterns matching folders to exclude, and an optional
+-- `extensions` sub-table that contains raw file extensions to exclude. Any
+-- patterns starting with '!' exclude files and folders that do not match the
+-- pattern that follows.
-- @param dir The directory path to iterate over.
-- @param f Function to call with each full file path found. If *f* returns
-- `false` explicitly, iteration ceases.