aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/find.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2013-11-10 15:13:24 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2013-11-10 15:13:24 -0500
commit016a8056f01221faa5ccee3581e488bd98650401 (patch)
treec28b7ca024cd236347f948b004a7a376728fec71 /modules/textadept/find.lua
parent4c01bce7d482d1f509f89e5b8304564007947a24 (diff)
downloadtextadept-016a8056f01221faa5ccee3581e488bd98650401.tar.gz
textadept-016a8056f01221faa5ccee3581e488bd98650401.zip
Updated LuaDoc.
Diffstat (limited to 'modules/textadept/find.lua')
-rw-r--r--modules/textadept/find.lua26
1 files changed, 13 insertions, 13 deletions
diff --git a/modules/textadept/find.lua b/modules/textadept/find.lua
index f367d5fa..ed8950f0 100644
--- a/modules/textadept/find.lua
+++ b/modules/textadept/find.lua
@@ -52,9 +52,9 @@ local M = ui.find
-- The text of the "In files" label.
-- This is primarily used for localization.
-- @field _G.events.FIND_WRAPPED (string)
--- Emitted when a search for text wraps, either from bottom to top when
--- searching for a next occurrence, or from top to bottom when searching for a
--- previous occurrence.
+-- Emitted when a text search wraps, either from bottom to top when searching
+-- for a next occurrence, or from top to bottom when searching for a previous
+-- occurrence.
-- This is useful for implementing a more visual or audible notice when a
-- search wraps in addition to the statusbar message.
module('ui.find')]]
@@ -78,15 +78,15 @@ events.FIND_WRAPPED = 'find_wrapped'
local preferred_view
---
--- The table of Lua patterns matching files and folders to exclude when finding
--- in files.
+-- The table of Lua patterns matching files and directories to exclude when
+-- finding in files.
-- The filter 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.
+-- `folders` sub-table that contains patterns matching directories to exclude,
+-- and an optional `extensions` sub-table that contains raw file extensions to
+-- exclude. Any patterns starting with '!' exclude files and directories that do
+-- not match the pattern that follows.
-- The default value is `lfs.FILTER`, a filter for common binary file extensions
--- and version control folders.
+-- and version control directories.
-- @see find_in_files
-- @class table
-- @name FILTER
@@ -207,8 +207,8 @@ function M.find_incremental(text, next, anchor)
end
---
--- Searches directory *dir* or user-specified directory for files that match
--- search text and options and prints the results to a files found buffer.
+-- Searches directory *dir* or the user-specified directory for files that match
+-- search text and options and prints the results to a "Files Found" buffer.
-- Use the `find_text`, `match_case`, `whole_word`, and `lua` fields to set the
-- search text and option flags, respectively. Use `FILTER` to set the search
-- filter.
@@ -327,7 +327,7 @@ events.connect(events.REPLACE_ALL, replace_all)
local function is_ff_buf(buf) return buf._type == _L['[Files Found Buffer]'] end
---
-- Jumps to the source of the find in files search result on line number *line*
--- in the files found buffer, or if `nil`, the next or previous search result
+-- in the "Files Found" buffer, or if `nil`, the next or previous search result
-- depending on boolean *next*.
-- @param line The line number in the files found buffer that contains the
-- search result to go to.