docs(lua): change *lua-foo* -> *vim.foo*

This commit is contained in:
Lewis Russell
2023-07-17 15:13:54 +01:00
parent 0ac3c4d631
commit c2d7c2826c
10 changed files with 44 additions and 38 deletions

View File

@@ -208,7 +208,7 @@ CONFIG = {
'helptag_fmt': lambda name: (
'*lua-vim*' if name.lower() == '_editor' else
'*lua-vimscript*' if name.lower() == '_options' else
f'*lua-{name.lower()}*'),
f'*vim.{name.lower()}*'),
'fn_helptag_fmt': lambda fstem, name: (
f'*vim.opt:{name.split(":")[-1]}()*' if ':' in name and name.startswith('Option') else
# Exclude fstem for methods
@@ -1160,6 +1160,10 @@ def main(doxygen_config, args):
if doc:
doc_list.append(doc)
# Can't use '.' in @defgroup, so convert to '--'
# "vim.json" => "vim-dot-json"
groupname = groupname.replace('-dot-', '.')
section_docs[groupname] = "\n".join(doc_list)
# Generate docs for all functions in the current module.

View File

@@ -416,6 +416,11 @@ function TLua2DoX_filter.filter(this, AppStamp, Filename)
magic = table.concat(magic_split, ' ')
if magic_split[1] == 'defgroup' or magic_split[1] == 'addtogroup' then
-- Can't use '.' in defgroup, so convert to '--'
magic = magic:gsub('%.', '-dot-')
end
outStream:writeln('/// @' .. magic)
fn_magic = checkComment4fn(fn_magic, magic)
end