aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/snapopen.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-03-16 16:53:53 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-03-16 16:53:53 -0400
commitbdccda5d155578f6564bd7b13f1d1affd48b0671 (patch)
tree2f62fe3c2ce5c9d8cb7fe3125fd74360faedf248 /modules/textadept/snapopen.lua
parentc80a277bc7d220465ad46848b4dc805698e30895 (diff)
downloadtextadept-bdccda5d155578f6564bd7b13f1d1affd48b0671.tar.gz
textadept-bdccda5d155578f6564bd7b13f1d1affd48b0671.zip
Moved "Markdown:" comments into module LuaDoc comments.
Diffstat (limited to 'modules/textadept/snapopen.lua')
-rw-r--r--modules/textadept/snapopen.lua20
1 files changed, 9 insertions, 11 deletions
diff --git a/modules/textadept/snapopen.lua b/modules/textadept/snapopen.lua
index 6f8d4772..3ccfe376 100644
--- a/modules/textadept/snapopen.lua
+++ b/modules/textadept/snapopen.lua
@@ -5,15 +5,6 @@ local M = {}
--[[ This comment is for LuaDoc.
---
-- Snapopen for the textadept module.
-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`.
--
-- ## Examples
--
@@ -29,8 +20,15 @@ module('_M.textadept.snapopen')]]
-- snapopen(nil, '!%.lua$')
--
-- -- Ignore the project's 'images' folder and HTML pages.
--- snapopen('/path/to/project',
--- { folders = { 'images' }, extensions = { 'html' } }, true)
+-- snapopen('/path/to/project', {
+-- folders = { 'images' },
+-- extensions = { 'html' }
+-- }, true)
+-- @field DEFAULT_DEPTH (number)
+-- Maximum directory depth to search. The default value is `4`.
+-- @field MAX (number)
+-- Maximum number of files to list. The default value is `1000`.
+module('_M.textadept.snapopen')]]
---
-- Table of default UTF-8 paths to search.