aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/session.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-09-12 11:24:11 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-09-12 11:24:11 -0400
commit9dc8ce16a1efc6482db6f1d5456d42958e79a06c (patch)
treee26ff636143fc74f92a6a3359a73e93194da6bc3 /modules/textadept/session.lua
parent4305f32ac153b7a45a1c001da2fcd412af905168 (diff)
downloadtextadept-9dc8ce16a1efc6482db6f1d5456d42958e79a06c.tar.gz
textadept-9dc8ce16a1efc6482db6f1d5456d42958e79a06c.zip
Documentation overhaul.
Rewrote most of the manual and Lua API to complement each other. Key bindings reference moved from Appendix to modules/textadept/keys.lua LuaDoc.
Diffstat (limited to 'modules/textadept/session.lua')
-rw-r--r--modules/textadept/session.lua14
1 files changed, 10 insertions, 4 deletions
diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua
index cee879c4..24554e35 100644
--- a/modules/textadept/session.lua
+++ b/modules/textadept/session.lua
@@ -4,17 +4,23 @@ local M = {}
--[[ This comment is for LuaDoc.
---
--- Session support for the textadept module.
+-- Session support for Textadept.
-- @field DEFAULT_SESSION (string)
-- The path to the default session file.
+-- The default value is `_USERHOME/session`, or `_USERHOME/session_term` if
+-- [`_G.NCURSES`][] is `true`.
+--
+-- [`_G.NCURSES`]: _G.html#NCURSES
-- @field SAVE_ON_QUIT (bool)
-- Save the session when quitting.
--- The default value is `true` and can be disabled by passing the command line
--- switch `-n` or `--nosession` to Textadept.
+-- The default value is `true`, but can be disabled by passing the command
+-- line switch `-n` or `--nosession` to Textadept.
-- @field MAX_RECENT_FILES (number)
--- The maximum number of files from the recent files list to save to the
+-- The maximum number of files from [`io.recent_files`][] to save to the
-- session.
-- The default value is `10`.
+--
+-- [`io.recent_files`]: io.html#recent_files
module('_M.textadept.session')]]
M.DEFAULT_SESSION = _USERHOME..(not NCURSES and '/session' or '/session_term')