From 91fcdb58bfe43b368f1bf32edc16ed7dba8c40cd Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Mon, 8 Oct 2012 11:40:17 -0400
Subject: Use '@field' LuaDoc for events defined in modules.

---
 modules/textadept/mime_types.lua |  8 +++-----
 modules/textadept/run.lua        | 17 ++++++++---------
 2 files changed, 11 insertions(+), 14 deletions(-)

(limited to 'modules')

diff --git a/modules/textadept/mime_types.lua b/modules/textadept/mime_types.lua
index 4a77efc4..7c71fa7f 100644
--- a/modules/textadept/mime_types.lua
+++ b/modules/textadept/mime_types.lua
@@ -5,15 +5,13 @@ local M = {}
 --[[ This comment is for LuaDoc.
 ---
 -- Handles file type detection.
---
--- ## Mime-type Events
---
--- * `_G.events.LANGUAGE_MODULE_LOADED`
+-- @field _G.events.LANGUAGE_MODULE_LOADED (string)
 --   Called after loading a language-specific module.
 --   This is useful for overriding a language-specific module's key bindings
 --   or other properties since the module is not loaded when Textadept starts.
 --   Arguments:
---     * `lang`: The language lexer name.
+--
+--   * `lang`: The language lexer name.
 module('_M.textadept.mime_types')]]
 
 -- Events.
diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua
index 56fb06c1..c19c681f 100644
--- a/modules/textadept/run.lua
+++ b/modules/textadept/run.lua
@@ -10,23 +10,22 @@ local M = {}
 -- extension.
 --
 -- [language-specific modules]: _M.html#Compile.and.Run
---
--- ## Run Events
---
--- * `_G.events.COMPILE_OUTPUT`
+-- @field _G.events.COMPILE_OUTPUT (string)
 --   Called after a compile command is executed.
 --   By default, compiler output is printed to the message buffer. To override
 --   this behavior, connect to the event with an index of `1` and return `true`.
 --   Arguments:
---     * `lexer`: The lexer language.
---     * `output`: The output from the command.
--- * `_G.events.RUN_OUTPUT`
+--
+--   * `lexer`: The lexer language.
+--   * `output`: The output from the command.
+-- @field _G.events.RUN_OUTPUT (string)
 --   Called after a run command is executed.
 --   By default, output is printed to the message buffer. To override this
 --   behavior, connect to the event with an index of `1` and return `true`.
 --   Arguments:
---     * `lexer`: The lexer language.
---     * `output`: The output from the command.
+--
+--   * `lexer`: The lexer language.
+--   * `output`: The output from the command.
 module('_M.textadept.run')]]
 
 -- Events.
-- 
cgit v1.2.3