mirror of
https://github.com/neovim/neovim.git
synced 2025-09-10 13:28:19 +00:00
docs: support inline markdown
- Tags are now created with `[tag]()` - References are now created with `[tag]` - Code spans are no longer wrapped
This commit is contained in:

committed by
Lewis Russell

parent
0e28493914
commit
ade1b12f49
@@ -43,7 +43,7 @@ void api_extmark_free_all_mem(void)
|
||||
map_destroy(String, &namespace_ids);
|
||||
}
|
||||
|
||||
/// Creates a new namespace or gets an existing one. \*namespace\*
|
||||
/// Creates a new namespace or gets an existing one. [namespace]()
|
||||
///
|
||||
/// Namespaces are used for buffer highlights and virtual text, see
|
||||
/// |nvim_buf_add_highlight()| and |nvim_buf_set_extmark()|.
|
||||
@@ -284,7 +284,7 @@ ArrayOf(Integer) nvim_buf_get_extmark_by_id(Buffer buffer, Integer ns_id,
|
||||
/// their start position is less than `start`
|
||||
/// - type: Filter marks by type: "highlight", "sign", "virt_text" and "virt_lines"
|
||||
/// @param[out] err Error details, if any
|
||||
/// @return List of [extmark_id, row, col] tuples in "traversal order".
|
||||
/// @return List of `[extmark_id, row, col]` tuples in "traversal order".
|
||||
Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object end,
|
||||
Dict(get_extmarks) *opts, Arena *arena, Error *err)
|
||||
FUNC_API_SINCE(7)
|
||||
@@ -390,7 +390,7 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
|
||||
/// of the screen line (just like for diff and
|
||||
/// cursorline highlight).
|
||||
/// - virt_text : virtual text to link to this mark.
|
||||
/// A list of [text, highlight] tuples, each representing a
|
||||
/// A list of `[text, highlight]` tuples, each representing a
|
||||
/// text chunk with specified highlight. `highlight` element
|
||||
/// can either be a single highlight group, or an array of
|
||||
/// multiple highlight groups that will be stacked
|
||||
@@ -425,7 +425,7 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
|
||||
///
|
||||
/// - virt_lines : virtual lines to add next to this mark
|
||||
/// This should be an array over lines, where each line in
|
||||
/// turn is an array over [text, highlight] tuples. In
|
||||
/// turn is an array over `[text, highlight]` tuples. In
|
||||
/// general, buffer and window options do not affect the
|
||||
/// display of the text. In particular 'wrap'
|
||||
/// and 'linebreak' options do not take effect, so
|
||||
@@ -1040,17 +1040,27 @@ void nvim_buf_clear_namespace(Buffer buffer, Integer ns_id, Integer line_start,
|
||||
/// @param ns_id Namespace id from |nvim_create_namespace()|
|
||||
/// @param opts Table of callbacks:
|
||||
/// - on_start: called first on each screen redraw
|
||||
/// ```
|
||||
/// ["start", tick]
|
||||
/// ```
|
||||
/// - on_buf: called for each buffer being redrawn (before
|
||||
/// window callbacks)
|
||||
/// window callbacks)
|
||||
/// ```
|
||||
/// ["buf", bufnr, tick]
|
||||
/// ```
|
||||
/// - on_win: called when starting to redraw a specific window.
|
||||
/// ```
|
||||
/// ["win", winid, bufnr, topline, botline]
|
||||
/// ```
|
||||
/// - on_line: called for each buffer line being redrawn.
|
||||
/// (The interaction with fold lines is subject to change)
|
||||
/// ```
|
||||
/// ["line", winid, bufnr, row]
|
||||
/// ```
|
||||
/// - on_end: called at the end of a redraw cycle
|
||||
/// ```
|
||||
/// ["end", tick]
|
||||
/// ```
|
||||
void nvim_set_decoration_provider(Integer ns_id, Dict(set_decoration_provider) *opts, Error *err)
|
||||
FUNC_API_SINCE(7) FUNC_API_LUA_ONLY
|
||||
{
|
||||
|
Reference in New Issue
Block a user