Something went wrong. Try again.
Library of 45+ independent Lua modules improving Neovim experience with minimal effort nvim-mini.org/mini.nvim
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293--- Test `@alias` section
---@alias var_one fun(type: string, data: any)---@alias var_two table<string,number> Another data structure.--- Its description spans over multiple lines.---@alias %bad_name* This alias has bad name and should still work.
---@param x var_one---@param y var_two---@param z var_three Should be enclosed as custom classes are allowed.---@alias var_three This alias shouldn't be applied to previous line as it is defined after it.
--- Aliases also expand inside text: var_one
--- Test of `MiniDoc.current.aliases`------@eval return vim.inspect(MiniDoc.current.aliases)
---@alias aaa number---@alias _bbb1 string---@alias ccc_ table---@alias union number|nil---@alias unionOther string | table
--- Aliases should not be replaced when they are obviously not meant to------@param a1 aaaClass Should not be replaced---@param a2 aaa_bbb1 Should not be replaced---@param a3 ccc_bbb1 Should not be replaced------@text None of these should be replaced: aaaA _bbb1_ other.ccc_------@return aaaClass---@return aaa_bbb1---@return ccc_bbb1------@text All next ones should be replaced as they are inside allowed syntax------@param b1 aaa?---@param b2 _bbb1?---@param b3 ccc_?------@param c1 aaa|_bbb1|ccc_---@param c2 aaa[]---@param c3 [aaa,_bbb1,ccc_]---@param c4 {[aaa]:_bbb1}---@param c5 table<aaa,_bbb1>---@param c6 {key1:aaa,key2:_bbb1}---@param c7 fun(arg1:aaa,arg2:_bbb1):ccc_------@text Union types should try to "smartly" add parenthesis------@param d1 union---@param D1 unionOther---@param d2 union?---@param D2 unionOther?---@param d3 union[]---@param D3 unionOther[]---@param d4 [union,unionOther]---@param D4 [unionOther,union]---@param d5 [union, unionOther]---@param D5 [unionOther, union]---@param d6 [ union, unionOther ]---@param D6 [ unionOther, union ]---@param d7 [ union , unionOther ]---@param d8 {[union]:unionOther}---@param D8 {[unionOther]:union}---@param d9 { [union]: unionOther }---@param D9 { [unionOther]: union }---@param d10 table<union,unionOther>---@param D10 table<unionOther,union>---@param d11 table<union, unionOther>---@param D11 table<unionOther, union>---@param d12 {key1:union,key2:unionOther}---@param D12 {key1:unionOther,key2:union}---@param d13 { key1:union, key2:unionOther }---@param D13 { key1:unionOther, key2:union }---@param d14 { key1: union, key2: unionOther }---@param d15 fun(arg1:union,arg2:unionOther):union---@param D15 fun(arg1:unionOther,arg2:union):unionOther---@param d16 fun(arg1: union, arg2: unionOther): union---@param D16 fun(arg1: unionOther, arg2: union): unionOther
--- There should not be replacements in some special cases------@param aaa aaa Parameter name should not be replaced.------@class aaa Class name should not be replaced---@field aaa aaa Field name should not be replaced.------@tag aaa---@toc_entry aaa (no alias replacement)