mirror of
https://github.com/neovim/neovim.git
synced 2024-12-20 03:05:11 -07:00
4e9298ecdf
Problem:
For function definitions to be included in the vimdoc (formatted) and
to be exported as mpack data (unformatted), we had two internal
representations of the same function/API metadata in duplicate;
one is FunctionDoc (which was previously a dict), and the other is
doxygen XML DOM from which vimdoc (functions sections) was generated.
Solution:
We should have a single path and unified data representation
(i.e. FunctionDoc) that contains all the metadata and information about
function APIs, from which both of mpack export and vimdoc are generated.
I.e., vimdocs are no longer generated directly from doxygen XML nodes,
but generated via:
(XML DOM Nodes) ------------> FunctionDoc ------> mpack (unformatted)
Recursive Internal |
Formatting Metadata +---> vimdoc (formatted)
This refactoring eliminates the hacky and ugly use of `fmt_vimhelp` in
`fmt_node_as_vimhelp()` and all other helper functions! This way,
`fmt_node_as_vimhelp()` can simplified as it no longer needs to handle
generating of function docs, which needs to be done only in the topmost
level of recursion.
|
||
|---|---|---|
| .. | ||
| autoload | ||
| colors | ||
| compiler | ||
| doc | ||
| ftplugin | ||
| indent | ||
| keymap | ||
| lua | ||
| macros | ||
| pack/dist/opt | ||
| plugin | ||
| queries | ||
| spell | ||
| syntax | ||
| tools | ||
| tutor | ||
| CMakeLists.txt | ||
| delmenu.vim | ||
| filetype.lua | ||
| ftoff.vim | ||
| ftplugin.vim | ||
| ftplugof.vim | ||
| indent.vim | ||
| indoff.vim | ||
| macmap.vim | ||
| makemenu.vim | ||
| menu.vim | ||
| mswin.vim | ||
| neovim.ico | ||
| nvim.appdata.xml | ||
| nvim.desktop | ||
| nvim.png | ||
| optwin.vim | ||
| synmenu.vim | ||
