diff options
Diffstat (limited to 'core')
| -rw-r--r-- | core/.buffer.luadoc | 6 | ||||
| -rw-r--r-- | core/.ui.dialogs.luadoc | 6 | ||||
| -rw-r--r-- | core/args.lua | 3 |
3 files changed, 8 insertions, 7 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index a0e73409..080cfb13 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -595,7 +595,7 @@ -- Whether or not pressing [`buffer.rectangular_selection_modifier`]() when -- selecting text normally with the mouse turns on rectangular selection. -- The default value is `false`. --- @field modify (bool) +-- @field modify (bool, Read-only) -- Whether or not the buffer has unsaved changes. -- @field move_extends_selection (bool) -- Whether or not regular caret movement alters the selected text. @@ -3138,8 +3138,8 @@ function text_range(buffer, start_pos, end_pos) end -- Converts the current buffer's contents to encoding *encoding*. -- @param buffer A buffer. -- @param encoding The string encoding to set. Valid encodings are ones that GNU --- iconv accepts. --- @usage buffer:set_encoding('ASCII') +-- iconv accepts. If `nil`, assumes a binary encoding. +-- @usage buffer:set_encoding('CP1252') function set_encoding(buffer, encoding) end --- diff --git a/core/.ui.dialogs.luadoc b/core/.ui.dialogs.luadoc index d8592864..0a6579d1 100644 --- a/core/.ui.dialogs.luadoc +++ b/core/.ui.dialogs.luadoc @@ -507,9 +507,9 @@ function colorselect(options) end -- -- * `title`: The dialog's title text. -- * `text`: The font preview text. --- * `font-name`: The initially selected font name. --- * `font-size`: The initially selected font size. The default value is `12`. --- * `font-style`: The initially selected font style. The available options +-- * `font_name`: The initially selected font name. +-- * `font_size`: The initially selected font size. The default value is `12`. +-- * `font_style`: The initially selected font style. The available options -- are `"regular"`, `"bold"`, `"italic"`, and `"bold italic"`. The default -- value is `"regular"`. -- * `float`: Show the dialog on top of all desktop windows. The default value diff --git a/core/args.lua b/core/args.lua index c9eb3116..0dbf0efb 100644 --- a/core/args.lua +++ b/core/args.lua @@ -24,7 +24,8 @@ local switches = {} -- @param short The string short version of the switch. -- @param long The string long version of the switch. -- @param narg The number of expected parameters for the switch. --- @param f The Lua function to run when the switch is tripped. +-- @param f The Lua function to run when the switch is tripped. It is passed +-- *narg* string arguments. -- @param description The string description of the switch for command line -- help. -- @name register |