diff options
| author |  mitchell <70453897+667e-11@users.noreply.github.com> | 2011-09-27 21:20:33 -0400 |
|---|---|---|
| committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2011-09-27 21:20:33 -0400 |
| commit | 132e362f44e00cd93e04967efbfc138c53a47ee4 (patch) | |
| tree | 9d68dcdca8d687e922a277f137813a09d9b4b12d /core/.view.luadoc | |
| parent | 43e9f2528415e8f2d43e7ba65f0d4c5b5d5adff4 (diff) | |
Reformatted some LuaDoc.
Diffstat (limited to 'core/.view.luadoc')
| -rw-r--r-- | core/.view.luadoc | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc index 6bf1fe37..dee6a96f 100644 --- a/core/.view.luadoc +++ b/core/.view.luadoc @@ -4,7 +4,7 @@ --- -- The currently focused view. --- It also represents the structure of any view table in 'views'. +-- It also represents the structure of any view table in `_G._VIEWS`. module('view') -- Markdown: @@ -16,7 +16,7 @@ module('view') --- -- Splits the indexed view vertically or horizontally and focuses the new view. --- @param vertical Flag indicating a vertical split. Defaults to false for +-- @param vertical Flag indicating a vertical split. Defaults to `false` for -- horizontal. -- @return old view and new view tables. function view:split(vertical) end @@ -28,9 +28,9 @@ function view:unsplit() end --- -- Goes to the specified buffer in the indexed view. --- Activates the 'buffer_*_switch' signals. --- @param n A relative or absolute buffer index. An absolute index of -1 goes +-- 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. Defaults +-- to `false`. function view:goto_buffer(n, relative) end |