diff options
| author | Gregory Anders <8965202+gpanders@users.noreply.github.com> | 2023-09-13 08:38:28 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-13 08:38:28 -0500 |
| commit | 27a566f3f8e07a4cebb426674800bdf9a7f4f222 (patch) | |
| tree | 3212fd672bdf21e10766580d61f107d51f69d659 /runtime/doc/develop.txt | |
| parent | 4607807f9fcb83d4e183f6f67e705ffd7f451077 (diff) | |
| download | rneovim-27a566f3f8e07a4cebb426674800bdf9a7f4f222.tar.gz rneovim-27a566f3f8e07a4cebb426674800bdf9a7f4f222.tar.bz2 rneovim-27a566f3f8e07a4cebb426674800bdf9a7f4f222.zip | |
feat(vimdoc): support Markdown code blocks (#25127)
Support Markdown code blocks in addition to <pre> blocks in Doxygen doc
comments.
Update doc comments in iter.lua as a test.
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index b3f7d1fadc..0ed537c248 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -192,7 +192,7 @@ Docstring format: `@note`, `@param`, `@returns` - Limited markdown is supported. - List-items start with `-` (useful to nest or "indent") -- Use `<pre>` for code samples. +- Use ``` for code samples. Code samples can be annotated as `vim` or `lua` Example: the help for |nvim_open_win()| is generated from a docstring defined @@ -202,10 +202,16 @@ in src/nvim/api/win_config.c like this: > /// ... /// /// Example (Lua): window-relative float - /// <pre>lua - /// vim.api.nvim_open_win(0, false, - /// {relative='win', row=3, col=3, width=12, height=3}) - /// </pre> + /// + /// ```lua + /// vim.api.nvim_open_win(0, false, { + /// relative='win', + /// row=3, + /// col=3, + /// width=12, + /// height=3, + /// }) + /// ``` /// /// @param buffer Buffer to display /// @param enter Enter the window |