docs(libmodal): add missing `@class` annotations

This should help the LSP reason about what is being imported
pull/14/head
Iron-E 2 years ago
parent a81c06464b
commit 70c3585da3
No known key found for this signature in database
GPG Key ID: 19B71B7B7B021D22

@ -1,5 +1,5 @@
local globals = require 'libmodal/src/globals'
local utils = require 'libmodal/src/utils'
local utils = require 'libmodal/src/utils'
--- @class libmodal.Prompt
--- @field private completions table<string>|nil
@ -9,7 +9,7 @@ local utils = require 'libmodal/src/utils'
--- @field private input libmodal.utils.Vars
--- @field private instruction function|table<string, function|string>
--- @field private name string
local Prompt = utils.classes.new()
local Prompt = utils.classes.new(nil)
local HELP = 'help'
local REPLACEMENTS =

@ -1,3 +1,6 @@
--- @class libmodal.collections
--- @field private ParseTable libmodal.collections.ParseTable
--- @field private Stack libmodal.collections.Stack
return
{
ParseTable = require 'libmodal/src/collections/ParseTable',

@ -1,7 +1,16 @@
local VIM_FALSE = 0
local VIM_TRUE = 1
return {
--- @class libmodal.globals
--- @field private ESC_NR number
--- @field private TYPE_FUNC string
--- @field private TYPE_NUM string
--- @field private TYPE_STR string
--- @field private TYPE_TBL string
--- @field private VIM_FALSE number
--- @field private VIM_TRUE number
return
{
--- the key-code for the escape character.
ESC_NR = 27,

@ -1,3 +1,10 @@
--- @class libmodal
--- @field private collections libmodal.collections
--- @field private globals libmodal.globals
--- @field private Layer libmodal.Layer
--- @field private Mode libmodal.Mode
--- @field private Prompt libmodal.Prompt
--- @field private utils libmodal.utils
return
{
collections = require 'libmodal/src/collections',

@ -1,6 +1,6 @@
local globals = require 'libmodal/src/globals'
local Indicator = require 'libmodal/src/utils/Indicator'
--- @class libmodal.utils.api
local api = {}
--- echo a list of `Indicator`s with their associated highlighting.

@ -1,3 +1,4 @@
--- @class libmodal.utils.classes
return
{
--- define a metatable.

@ -1,6 +1,13 @@
--- @class libmodal.utils
--- @field private completions libmodal.utils.api
--- @field private classes libmodal.utils.classes
--- @field private Indicator libmodal.utils.Indicator
--- @field private Help libmodal.utils.Help
--- @field private Popup libmodal.utils.Popup
--- @field private Vars libmodal.utils.Vars
return
{
api = require 'libmodal/src/utils/api',
api = require 'libmodal/src/utils/api',
classes = require 'libmodal/src/utils/classes',
Indicator = require 'libmodal/src/utils/Indicator',
Help = require 'libmodal/src/utils/Help',

Loading…
Cancel
Save