aboutsummaryrefslogtreecommitdiff
path: root/core/.view.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2009-07-25 23:34:13 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2009-07-25 23:34:13 -0400
commit033416a15fe60fe10387119e0e63bb9ed9e8aedd (patch)
tree31bc4d91e15b484c336eadf25c0008f7bd17facc /core/.view.lua
parentb9e5e58446c95344b550c0a6ab91aa57ee9468ef (diff)
downloadtextadept-033416a15fe60fe10387119e0e63bb9ed9e8aedd.tar.gz
textadept-033416a15fe60fe10387119e0e63bb9ed9e8aedd.zip
Documentation overhaul.
Diffstat (limited to 'core/.view.lua')
-rw-r--r--core/.view.lua16
1 files changed, 6 insertions, 10 deletions
diff --git a/core/.view.lua b/core/.view.lua
index 6cdb4336..ea576265 100644
--- a/core/.view.lua
+++ b/core/.view.lua
@@ -5,19 +5,15 @@
---
-- The currently focused view.
-- It also represents the structure of any view table in 'views'.
--- [Dummy file]
module('view')
----
--- The currently focused view.
--- It also represents the structure of any view table in 'views'.
--- @class table
--- @name view
--- @field doc_pointer The pointer to the document associated with this view's
+-- Markdown:
+-- ## Fields
+--
+-- * `doc_pointer`: The pointer to the document associated with this view's
-- buffer. (Used internally; read-only)
--- @field size The integer position of the split resizer (if this view is part
--- of a split view).
-view = { doc_pointer = nil, size = nil }
+-- * `size`: The integer position of the split resizer (if this view is part of
+-- a split view).
---
-- Splits the indexed view vertically or horizontally and focuses the new view.