aboutsummaryrefslogtreecommitdiff
path: root/core/init.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-03-07 09:28:43 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2012-03-07 09:28:43 -0500
commit96c85498c019e381d0aeed2e33e626563563ea8c (patch)
treea44a3ff017cc7c5de3e4845434324c7798689d24 /core/init.lua
parent6c5bda943d87c629e3fbeaa9178d5fdcb96134c5 (diff)
downloadtextadept-96c85498c019e381d0aeed2e33e626563563ea8c.tar.gz
textadept-96c85498c019e381d0aeed2e33e626563563ea8c.zip
Documentation overhaul with Discount (Markdown implementation).
The standard LuaDoc template is no longer used. Instead, the new `scripts/markdowndoc.lua` has the template for LuaDoc and `scripts/update_doc` has the template for the Manual. Also added README, CHANGELOG, and THANKS files.
Diffstat (limited to 'core/init.lua')
-rw-r--r--core/init.lua11
1 files changed, 6 insertions, 5 deletions
diff --git a/core/init.lua b/core/init.lua
index 056a212b..8f7fd360 100644
--- a/core/init.lua
+++ b/core/init.lua
@@ -30,23 +30,24 @@ module('_G')]]
-- * `_HOME` [string]
-- Path to the directory containing Textadept.
-- * `_LEXERPATH` [string]
--- Paths to lexers, formatted like [`package.path`][package_path].
+-- Paths to lexers, formatted like [`package.path`][].
-- * `_RELEASE` [string]
-- The Textadept release version.
-- * `_USERHOME` [string]
-- Path to the user's `~/.textadept/`.
-- * `_CHARSET` [string]
-- The character set encoding of the filesystem.
--- This is used in [File I/O](../modules/io.html).
+-- This is used in [File I/O][].
-- * `RESETTING` [bool]
--- If [`reset()`](../modules/_G.html#reset) has been called, this flag is
--- `true` while the Lua state is being re-initialized.
+-- If [`reset()`](#reset) has been called, this flag is `true` while the Lua
+-- state is being re-initialized.
-- * `WIN32` [bool]
-- If Textadept is running on Windows, this flag is `true`.
-- * `OSX` [bool]
-- If Textadept is running on Mac OSX, this flag is `true`.
--
--- [package_path]: http://www.lua.org/manual/5.1/manual.html#pdf-package.path
+-- [`package.path`]: http://www.lua.org/manual/5.2/manual.html#pdf-package.path
+-- [File I/O]: io.html
---
-- Calls `dofile()` on the given filename in the user's Textadept directory.