kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-19 18:55:14 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #19427 from Maverun/maveBranchDoc

Browse Source 
fix(docs): remove internal function from docs (nvim__*)
This commit is contained in:
bfredl 2022-07-19 12:10:03 +02:00 committed by GitHub
commit 93bd6fb2c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
runtime/doc/api.txt
View File

@ -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.

2
scripts/gen_vimdoc.py
View File

@ -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'