From 23d82529b3703ed4d46fc1dd06f4d0e3e9ea2c09 Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Thu, 15 Mar 2012 13:13:24 -0400
Subject: Added documentation for generating API documentation and Lua
 Adeptsense.

---
 modules/textadept/adeptsense.lua | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'modules/textadept')

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]
-- 
cgit v1.2.3