diff options
| -rw-r--r-- | runtime/doc/api.txt | 3 | ||||
| -rwxr-xr-x | scripts/gen_vimdoc.py | 6 |
2 files changed, 7 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 9c3c143045..6c4d63e4c9 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -594,7 +594,8 @@ nvim__id_float({flt}) *nvim__id_float()* its argument. nvim__inspect_cell({grid}, {row}, {col}) *nvim__inspect_cell()* - TODO: Documentation + NB: if your UI doesn't use hlstate, this will not return + hlstate first time. nvim__runtime_inspect() *nvim__runtime_inspect()* TODO: Documentation diff --git a/scripts/gen_vimdoc.py b/scripts/gen_vimdoc.py index 433fec828e..1b7f88cb2a 100755 --- a/scripts/gen_vimdoc.py +++ b/scripts/gen_vimdoc.py @@ -843,7 +843,9 @@ def extract_from_xml(filename, target, width): 'seealso': [], } if fmt_vimhelp: - fn['desc_node'] = desc # HACK :( + # HACK :( + fn['desc_node'] = desc + fn['brief_desc_node'] = brief_desc for m in paras: if 'text' in m: @@ -891,6 +893,8 @@ def fmt_doxygen_xml_as_vimhelp(filename, target): # Generate Vim :help for parameters. if fn['desc_node']: doc = fmt_node_as_vimhelp(fn['desc_node']) + if not doc and fn['brief_desc_node']: + doc = fmt_node_as_vimhelp(fn['brief_desc_node']) if not doc: doc = 'TODO: Documentation' |