aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/adeptsense.lua
diff options
context:
space:
mode:
Diffstat (limited to 'modules/textadept/adeptsense.lua')
-rw-r--r--modules/textadept/adeptsense.lua13
1 files changed, 13 insertions, 0 deletions
diff --git a/modules/textadept/adeptsense.lua b/modules/textadept/adeptsense.lua
index a4a0cb2e..b1004fd2 100644
--- a/modules/textadept/adeptsense.lua
+++ b/modules/textadept/adeptsense.lua
@@ -331,6 +331,19 @@ module('_M.textadept.adeptsense')]]
-- You will have to do something similar if you are writing an Adeptsense for a
-- child lexer language.
--
+-- ### Generating Lua Adeptsense
+--
+-- You can generate Lua Adeptsense for your own modules using the Lua language
+-- module's `adeptsensedoc.lua` module with [LuaDoc][]:
+--
+-- luadoc -d . --doclet _HOME/modules/lua/adeptsensedoc [module(s)]
+--
+-- where `_HOME` is where Textadept is installed. The `tags` and `api` files are
+-- output to the current directory and can be loaded via
+-- [`load_ctags()`](#load_ctags) and [`api_files`](#api_files) respectively.
+--
+-- [LuaDoc]: http://keplerproject.github.com/luadoc/
+--
-- ### Other Adeptsense Settings
--
-- * `always_show_globals` [bool]