From 4e3699d13a13ab07cb344f43c3fdd474ca72535e Mon Sep 17 00:00:00 2001 From: Maverun Date: Tue, 19 Jul 2022 05:03:22 -0400 Subject: [PATCH] fix(docs): remove internal function from docs (nvim__*) --- runtime/doc/api.txt | 28 ---------------------------- scripts/gen_vimdoc.py | 2 ++ 2 files changed, 2 insertions(+), 28 deletions(-) diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index c67187d857..9758959f4e 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -536,12 +536,6 @@ created for extmark changes. ============================================================================== Global Functions *api-global* -nvim__get_hl_defs({ns_id}) *nvim__get_hl_defs()* - TODO: Documentation - -nvim__get_lib_dir() *nvim__get_lib_dir()* - TODO: Documentation - nvim__get_runtime({pat}, {all}, {*opts}) *nvim__get_runtime()* Find files in runtime directories @@ -608,15 +602,6 @@ nvim__inspect_cell({grid}, {row}, {col}) *nvim__inspect_cell()* NB: if your UI doesn't use hlstate, this will not return hlstate first time. -nvim__runtime_inspect() *nvim__runtime_inspect()* - TODO: Documentation - -nvim__screenshot({path}) *nvim__screenshot()* - TODO: Documentation - - Attributes: ~ - |api-fast| - nvim__set_hl_ns({ns_id}) *nvim__set_hl_ns()* Set active namespace for highlights. @@ -638,12 +623,6 @@ nvim__stats() *nvim__stats()* Return: ~ Map of various internal stats. -nvim__unpack({str}) *nvim__unpack()* - TODO: Documentation - - Attributes: ~ - |api-fast| - nvim_call_atomic({calls}) *nvim_call_atomic()* Calls many API methods atomically. @@ -2124,13 +2103,6 @@ affected. You can use |nvim_buf_is_loaded()| or |nvim_buf_line_count()| to check whether a buffer is loaded. - *nvim__buf_redraw_range()* -nvim__buf_redraw_range({buffer}, {first}, {last}) - TODO: Documentation - -nvim__buf_stats({buffer}) *nvim__buf_stats()* - TODO: Documentation - nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()* Activates buffer-update events on a channel, or as Lua callbacks. diff --git a/scripts/gen_vimdoc.py b/scripts/gen_vimdoc.py index 22fd155d32..74b35b4e9b 100755 --- a/scripts/gen_vimdoc.py +++ b/scripts/gen_vimdoc.py @@ -897,6 +897,8 @@ def fmt_doxygen_xml_as_vimhelp(filename, target): doc = fmt_node_as_vimhelp(fn['desc_node'], fmt_vimhelp=True) if not doc and fn['brief_desc_node']: doc = fmt_node_as_vimhelp(fn['brief_desc_node']) + if not doc and name.startswith("nvim__"): + continue if not doc: doc = 'TODO: Documentation'