aboutsummaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-01-12 22:59:59 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2012-01-12 22:59:59 -0500
commit884d8f5675bdd3c3c8d308e6f2df4f8497afa1a3 (patch)
tree9757abe329f363e979522b77e5107ad28c87067b /core
parent05646739578258cfbc19f4708d0bde97fb56a841 (diff)
downloadtextadept-884d8f5675bdd3c3c8d308e6f2df4f8497afa1a3.tar.gz
textadept-884d8f5675bdd3c3c8d308e6f2df4f8497afa1a3.zip
Create separate LuaDoc for module table fields.
Diffstat (limited to 'core')
-rw-r--r--core/.view.luadoc7
-rw-r--r--core/gui.lua18
-rw-r--r--core/init.lua7
3 files changed, 27 insertions, 5 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc
index 5aaa1e03..bf2ed6ee 100644
--- a/core/.view.luadoc
+++ b/core/.view.luadoc
@@ -10,11 +10,16 @@ module('view')
-- Markdown:
-- ## Fields
--
--- * `buffer` [table]: The buffer this view contains. (Read-only)
-- * `size` [number]: The position of the split resizer (if this view is part of
-- a split view).
---
+-- The buffer this view contains. (Read-only)
+-- @class table
+-- @name buffer
+local buffer
+
+---
-- Splits the indexed view vertically or horizontally and focuses the new view.
-- @param vertical Flag indicating a vertical split. Defaults to `false` for
-- horizontal.
diff --git a/core/gui.lua b/core/gui.lua
index 03f021ca..4413c68e 100644
--- a/core/gui.lua
+++ b/core/gui.lua
@@ -10,13 +10,11 @@ module('gui')]]
-- ## Fields
--
-- * `title` [string]: The title of the Textadept window.
--- * `menubar` [table]: A table of GTK menus defining a menubar. (Write-only)
-- * `context_menu`: A GTK menu defining the editor's context menu.
-- * `clipboard_text` [string]: The text on the clipboard. (Read-only)
-- * `statusbar_text` [string]: The text displayed by the statusbar.
-- * `docstatusbar_text` [string]: The text displayed by the doc statusbar.
-- (Write-only)
--- * `size` [table]: The size of the Textadept window (`{ width, height }`).
local _L = _L
@@ -408,7 +406,21 @@ end)
events_connect(events.ERROR,
function(...) gui._print(_L['[Error Buffer]'], ...) end)
---[[ The functions below are Lua C functions.
+--[[ The tables below were defined in C.
+
+---
+-- A table of GTK menus defining a menubar. (Write-only)
+-- @class table
+-- @name menubar
+local menubar
+
+---
+-- The size of the Textadept window (`{ width, height }`).
+-- @class table
+-- @name size
+local size
+
+The functions below are Lua C functions.
---
-- Displays a gcocoadialog of a specified type with the given string arguments.
diff --git a/core/init.lua b/core/init.lua
index c1aff4f9..b2ec28ea 100644
--- a/core/init.lua
+++ b/core/init.lua
@@ -34,7 +34,6 @@ module('_G')]]
-- * `_USERHOME` [string]: Path to the user's `~/.textadept/`.
-- * `_CHARSET` [string]: The character set encoding of the filesystem. This is
-- used in [File I/O](../modules/io.html).
--- * `_L` [table]: Contains all messages used by Textadept for localization.
-- * `RESETTING` [bool]: If [`reset()`](../modules/_G.html#reset) has been
-- called, this flag is `true` while the Lua state is being re-initialized.
-- * `WIN32` [bool]: If Textadept is running on Windows, this flag is `true`.
@@ -83,6 +82,12 @@ local _BUFFERS
-- @usage _VIEWS[view] returns the index of the current view in _VIEWS.
local _VIEWS
+---
+-- Contains all messages used by Textadept for localization.
+-- @class table
+-- @name _L
+local _L
+
-- The functions below are Lua C functions.
---