diff options
| author |   mitchell <70453897+667e-11@users.noreply.github.com> | 2012-03-15 13:13:24 -0400 |
|---|---|---|
| committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-03-15 13:13:24 -0400 |
| commit | 23d82529b3703ed4d46fc1dd06f4d0e3e9ea2c09 (patch) | |
| tree | 42ee5a8fd4a57af4e23a98b7b511d8109a473c78 /modules | |
| parent | 3534a4e66eb248f0ba5560014c2e71208a6312cd (diff) | |
| download | textadept-23d82529b3703ed4d46fc1dd06f4d0e3e9ea2c09.tar.gz textadept-23d82529b3703ed4d46fc1dd06f4d0e3e9ea2c09.zip | |
Added documentation for generating API documentation and Lua Adeptsense.
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/textadept/adeptsense.lua | 13 |
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] |