mirror of
https://github.com/neovim/neovim.git
synced 2025-10-21 09:12:07 +00:00
feat(docs): replace lua2dox.lua
Problem: The documentation flow (`gen_vimdoc.py`) has several issues: - it's not very versatile - depends on doxygen - doesn't work well with Lua code as it requires an awkward filter script to convert it into pseudo-C. - The intermediate XML files and filters makes it too much like a rube goldberg machine. Solution: Re-implement the flow using Lua, LPEG and treesitter. - `gen_vimdoc.py` is now replaced with `gen_vimdoc.lua` and replicates a portion of the logic. - `lua2dox.lua` is gone! - No more XML files. - Doxygen is now longer used and instead we now use: - LPEG for comment parsing (see `scripts/luacats_grammar.lua` and `scripts/cdoc_grammar.lua`). - LPEG for C parsing (see `scripts/cdoc_parser.lua`) - Lua patterns for Lua parsing (see `scripts/luacats_parser.lua`). - Treesitter for Markdown parsing (see `scripts/text_utils.lua`). - The generated `runtime/doc/*.mpack` files have been removed. - `scripts/gen_eval_files.lua` now instead uses `scripts/cdoc_parser.lua` directly. - Text wrapping is implemented in `scripts/text_utils.lua` and appears to produce more consistent results (the main contributer to the diff of this change).
This commit is contained in:

committed by
Lewis Russell

parent
7ad2e3c645
commit
9beb40a4db
@@ -5,22 +5,20 @@ error('Cannot require a meta file')
|
||||
-- (based on revision 4aded588f9531d89555566bb1de27490354b91c7)
|
||||
-- with types being renamed to include the vim namespace and with some descriptions made less verbose.
|
||||
|
||||
---@defgroup vim.lpeg
|
||||
---<pre>help
|
||||
---LPeg is a pattern-matching library for Lua, based on
|
||||
---Parsing Expression Grammars (https://bford.info/packrat/) (PEGs).
|
||||
--- @brief <pre>help
|
||||
--- LPeg is a pattern-matching library for Lua, based on
|
||||
--- Parsing Expression Grammars (https://bford.info/packrat/) (PEGs).
|
||||
---
|
||||
--- *lua-lpeg*
|
||||
--- *vim.lpeg.Pattern*
|
||||
---The LPeg library for parsing expression grammars is included as `vim.lpeg`
|
||||
---(https://www.inf.puc-rio.br/~roberto/lpeg/).
|
||||
--- *lua-lpeg*
|
||||
--- *vim.lpeg.Pattern*
|
||||
--- The LPeg library for parsing expression grammars is included as `vim.lpeg`
|
||||
--- (https://www.inf.puc-rio.br/~roberto/lpeg/).
|
||||
---
|
||||
---In addition, its regex-like interface is available as |vim.re|
|
||||
---(https://www.inf.puc-rio.br/~roberto/lpeg/re.html).
|
||||
--- In addition, its regex-like interface is available as |vim.re|
|
||||
--- (https://www.inf.puc-rio.br/~roberto/lpeg/re.html).
|
||||
---
|
||||
---</pre>
|
||||
--- </pre>
|
||||
|
||||
--- *LPeg* is a new pattern-matching library for Lua, based on [Parsing Expression Grammars](https://bford.info/packrat/) (PEGs).
|
||||
vim.lpeg = {}
|
||||
|
||||
--- @class vim.lpeg.Pattern
|
||||
@@ -88,6 +86,7 @@ function Pattern:match(subject, init) end
|
||||
|
||||
--- Returns the string `"pattern"` if the given value is a pattern, otherwise `nil`.
|
||||
---
|
||||
--- @param value vim.lpeg.Pattern|string|integer|boolean|table|function
|
||||
--- @return "pattern"|nil
|
||||
function vim.lpeg.type(value) end
|
||||
|
||||
|
Reference in New Issue
Block a user