diff options
author | Lewis Russell <lewis6991@gmail.com> | 2023-07-17 15:13:54 +0100 |
---|---|---|
committer | Lewis Russell <lewis6991@gmail.com> | 2023-07-17 16:25:29 +0100 |
commit | c2d7c2826ca77b0ca31bec511fdcdf1e4abaf946 (patch) | |
tree | 72bda675f18c6a1d27f6dc3cf196e7d1fae680fb /scripts | |
parent | 0ac3c4d6314df5fe40571a83e157a425ab7ce16d (diff) | |
download | rneovim-c2d7c2826ca77b0ca31bec511fdcdf1e4abaf946.tar.gz rneovim-c2d7c2826ca77b0ca31bec511fdcdf1e4abaf946.tar.bz2 rneovim-c2d7c2826ca77b0ca31bec511fdcdf1e4abaf946.zip |
docs(lua): change *lua-foo* -> *vim.foo*
Diffstat (limited to 'scripts')
-rwxr-xr-x | scripts/gen_vimdoc.py | 6 | ||||
-rw-r--r-- | scripts/lua2dox.lua | 5 |
2 files changed, 10 insertions, 1 deletions
diff --git a/scripts/gen_vimdoc.py b/scripts/gen_vimdoc.py index eacf4dc24d..984939a692 100755 --- a/scripts/gen_vimdoc.py +++ b/scripts/gen_vimdoc.py @@ -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. diff --git a/scripts/lua2dox.lua b/scripts/lua2dox.lua index b0eb4c086c..3f0d0505dd 100644 --- a/scripts/lua2dox.lua +++ b/scripts/lua2dox.lua @@ -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 |