Switched documentation format to LDoc from LuaDoc.

LuaDoc is obsolete and LDoc is the recommended replacement.

Author: orbitalquark

Makefile

@@ -4,14 +4,10 @@
 
 ta = ../..
 cwd = $(shell pwd)
-docs: luadoc README.md
+docs: README.md
 README.md: init.lua
-	cd $(ta)/scripts && luadoc --doclet markdowndoc $(cwd)/$< > $(cwd)/$@
+	cd $(ta)/scripts && ldoc --filter markdowndoc.ldoc $(cwd)/$< > $(cwd)/$@
 	sed -i -e '1,+4d' -e '6c# Lua REPL' -e '7d' -e 's/^##/#/;' $@
-luadoc: init.lua
-	cd $(ta)/modules && luadoc -d $(cwd) --doclet lua/tadoc $(cwd)/$< \
-		--ta-home=$(shell readlink -f $(ta))
-	sed -i 's/_HOME.\+\?_HOME/_HOME/;' tags
 
 # Releases.
 

README.md

@@ -18,16 +18,6 @@ Lines may be optionally prefixed with '=' (similar to the Lua prompt) to print a
 
 ## Functions defined by `lua_repl`
 
-<a id="M.open"></a>
-### `M.open`(*new*)
-
-Creates or switches to a Lua REPL.
-If *new* is `true`, creates a new REPL even if one already exists.
-
-Parameters:
-
-* *`new`*: Flag that indicates whether or not to create a new REPL even if one already exists.
-
 <a id="lua_repl.complete_lua"></a>
 ### `lua_repl.complete_lua`()
 
@@ -49,6 +39,16 @@ Cycle backward through command history, taking into account commands with multip
 Evaluates as Lua code the current line or the text on the currently selected lines.
 If the current line has a syntax error, it is ignored and treated as a line continuation.
 
+<a id="lua_repl.open"></a>
+### `lua_repl.open`(*new*)
+
+Creates or switches to a Lua REPL.
+If *new* is `true`, creates a new REPL even if one already exists.
+
+Parameters:
+
+- *new*:  Flag that indicates whether or not to create a new REPL even if one already exists.
+
 
 ## Tables defined by `lua_repl`
 
@@ -58,6 +58,10 @@ If the current line has a syntax error, it is ignored and treated as a line cont
 Lua command history.
 It has a numeric `pos` field that indicates where in the history the user currently is.
 
+Fields:
+
+- `pos`: 
+
 <a id="lua_repl.keys"></a>
 ### `lua_repl.keys`
 

init.lua

@@ -1,6 +1,5 @@
 -- Copyright 2014-2023 Mitchell. See LICENSE.
 
---[[ This comment is for LuaDoc
 ---
 -- A Textadept module for loading an interactive Lua REPL using the editor's Lua State, similar
 -- to Lua's interactive REPL.
@@ -17,8 +16,7 @@
 -- to evaluate and type Enter to evaluate the entire chunk.
 --
 -- Lines may be optionally prefixed with '=' (similar to the Lua prompt) to print a result.
-module('lua_repl')]]
-
+-- @module lua_repl
 local M = {}
 
 -- Localizations.
@@ -43,14 +41,11 @@ local env = setmetatable({
 ---
 -- Lua command history.
 -- It has a numeric `pos` field that indicates where in the history the user currently is.
--- @class table
--- @name history
 M.history = {pos = 0}
 
 ---
 -- Evaluates as Lua code the current line or the text on the currently selected lines.
 -- If the current line has a syntax error, it is ignored and treated as a line continuation.
--- @name evaluate_repl
 function M.evaluate_repl()
   local s, e = buffer.selection_start, buffer.selection_end
   local code, last_line
@@ -94,9 +89,7 @@ function M.evaluate_repl()
   buffer:set_save_point()
 end
 
----
--- Shows a set of Lua code completions for the current position.
--- @name complete_lua
+--- Shows a set of Lua code completions for the current position.
 function M.complete_lua()
   local line, pos = buffer:get_cur_line()
   local symbol, op, part = line:sub(1, pos - 1):match('([%w_.]-)([%.:]?)([%w_]*)$')
@@ -125,9 +118,7 @@ function M.complete_lua()
   buffer:auto_c_show(#part - 1, table.concat(cmpls, string.char(buffer.auto_c_separator)))
 end
 
----
--- Cycle backward through command history, taking into account commands with multiple lines.
--- @name cycle_history_prev
+--- Cycle backward through command history, taking into account commands with multiple lines.
 function M.cycle_history_prev()
   if buffer:auto_c_active() then
     buffer:line_up()
@@ -143,9 +134,7 @@ function M.cycle_history_prev()
   buffer:add_text(M.history[M.history.pos])
 end
 
----
--- Cycle forward through command history, taking into account commands with multiple lines.
--- @name cycle_history_next
+--- Cycle forward through command history, taking into account commands with multiple lines.
 function M.cycle_history_next()
   if buffer:auto_c_active() then
     buffer:line_down()
@@ -161,20 +150,16 @@ function M.cycle_history_next()
   buffer:add_text(M.history[M.history.pos])
 end
 
--- LuaFormatter off
----
--- Table of key bindings for the REPL.
--- @class table
--- @name keys
+--- Table of key bindings for the REPL.
+M.keys = {} -- empty declaration to avoid LDoc processing
 M.keys = {
-  ['\n'] = M.evaluate_repl,
-  ['ctrl+ '] = M.complete_lua,
-  ['ctrl+up'] = M.cycle_history_prev,
-  ['ctrl+down'] = M.cycle_history_next,
-  ['ctrl+p'] = M.cycle_history_prev,
+  ['\n'] = M.evaluate_repl, --
+  ['ctrl+ '] = M.complete_lua, --
+  ['ctrl+up'] = M.cycle_history_prev, --
+  ['ctrl+down'] = M.cycle_history_next, --
+  ['ctrl+p'] = M.cycle_history_prev, --
   ['ctrl+n'] = M.cycle_history_next
 }
--- LuaFormatter on
 
 -- Cannot initially define keys in `keys.lua` because that table does not exist yet and will
 -- be overwritten by the Lua language module. Instead, define keys here.