aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.view.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2012-02-10 13:55:34 -0500
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2012-02-10 13:55:34 -0500
commitb3d0b5defde02020ad41225b4b11e82c4ea90af9 (patch)
treea3f3fbfd41b21757630c1e59cbf9d9ed801fa983 /core/.view.luadoc
parentfbcb4f5c1dcfa2ffa45fb82a3bad2e543ee071e9 (diff)
Update LuaDoc with new formatting.
Diffstat (limited to 'core/.view.luadoc')
-rw-r--r--core/.view.luadoc12
1 files changed, 6 insertions, 6 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc
index bf2ed6ee..254390f2 100644
--- a/core/.view.luadoc
+++ b/core/.view.luadoc
@@ -10,8 +10,8 @@ module('view')
-- Markdown:
-- ## Fields
--
--- * `size` [number]: The position of the split resizer (if this view is part of
--- a split view).
+-- * `size` [number]
+-- The position of the split resizer (if this view is part of a split view).
---
-- The buffer this view contains. (Read-only)
@@ -21,8 +21,8 @@ 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.
+-- @param vertical Flag indicating a vertical split. The default value is
+-- `false` for horizontal.
-- @return old view and new view tables.
function view:split(vertical) end
@@ -36,6 +36,6 @@ function view:unsplit() end
-- Generates `BUFFER_BEFORE_SWITCH` and `BUFFER_AFTER_SWITCH` events.
-- @param n A relative or absolute buffer index. An absolute index of `-1` goes
-- to the last buffer.
--- @param relative Flag indicating if `n` is a relative index or not. Defaults
--- to `false`.
+-- @param relative Flag indicating if `n` is a relative index or not. The
+-- default value is `false`.
function view:goto_buffer(n, relative) end