aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/snapopen.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-02-10 13:55:34 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2012-02-10 13:55:34 -0500
commitb3d0b5defde02020ad41225b4b11e82c4ea90af9 (patch)
treea3f3fbfd41b21757630c1e59cbf9d9ed801fa983 /modules/textadept/snapopen.lua
parentfbcb4f5c1dcfa2ffa45fb82a3bad2e543ee071e9 (diff)
downloadtextadept-b3d0b5defde02020ad41225b4b11e82c4ea90af9.tar.gz
textadept-b3d0b5defde02020ad41225b4b11e82c4ea90af9.zip
Update LuaDoc with new formatting.
Diffstat (limited to 'modules/textadept/snapopen.lua')
-rw-r--r--modules/textadept/snapopen.lua14
1 files changed, 7 insertions, 7 deletions
diff --git a/modules/textadept/snapopen.lua b/modules/textadept/snapopen.lua
index ddbb489f..3b9d6622 100644
--- a/modules/textadept/snapopen.lua
+++ b/modules/textadept/snapopen.lua
@@ -10,10 +10,10 @@ module('_M.textadept.snapopen')]]
-- Markdown:
-- ## Settings
--
--- * `DEFAULT_DEPTH` [number]: Maximum directory depth to search. The default
--- value is `4`.
--- * `MAX` [number]: Maximum number of files to list. The default value is
--- `1000`.
+-- * `DEFAULT_DEPTH` [number]
+-- Maximum directory depth to search. The default value is `4`.
+-- * `MAX` [number]
+-- Maximum number of files to list. The default value is `1000`.
--
-- ## Examples
--
@@ -111,12 +111,12 @@ end
-- excluded by adding filters to a table assigned to a `folders` key in the
-- filter table. All strings should be UTF-8 encoded.
-- @param exclude_PATHS Flag indicating whether or not to exclude `PATHS` in the
--- search. Defaults to `false`.
+-- search. The default value is `false`.
-- @param exclude_FILTER Flag indicating whether or not to exclude `FILTER` from
-- `filter` in the search. If false, adds `FILTER` to the given `filter`.
--- Defaults to `false`.
+-- The default value is `false`.
-- @param depth Number of directories to recurse into for finding files.
--- Defaults to `DEFAULT_DEPTH`.
+-- The default value is `DEFAULT_DEPTH`.
-- @usage _M.textadept.snapopen.open()
-- @usage _M.textadept.snapopen.open(buffer.filename:match('^.+/'), nil, true)
-- @usage _M.textadept.snapopen.open(nil, '!%.lua$')