kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 11:15:14 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: add links to extmarks and namespaces (#21378)

Browse Source 
Co-authored-by: ii14 <ii14@users.noreply.github.com>
This commit is contained in:
ii14 2022-12-12 16:15:31 +01:00 committed by GitHub
parent 8b9bf3e3b9
commit 49c240d3a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
runtime/doc/api.txt
View File

@ -468,7 +468,7 @@ Example: create a float with scratch buffer: >vim
< <
============================================================================== ==============================================================================
Extended marks *api-extended-marks* *extmarks* Extended marks *api-extended-marks* *extmarks* *extmark*
Extended marks (extmarks) represent buffer annotations that track text changes Extended marks (extmarks) represent buffer annotations that track text changes
in the buffer. They can represent cursors, folds, misspelled words, anything in the buffer. They can represent cursors, folds, misspelled words, anything
@ -2485,7 +2485,7 @@ nvim_buf_add_highlight({buffer}, {ns_id}, {hl_group}, {line}, {col_start},
*nvim_buf_clear_namespace()* *nvim_buf_clear_namespace()*
nvim_buf_clear_namespace({buffer}, {ns_id}, {line_start}, {line_end}) nvim_buf_clear_namespace({buffer}, {ns_id}, {line_start}, {line_end})
Clears namespaced objects (highlights, extmarks, virtual text) from a Clears |namespace|d objects (highlights, |extmarks|, virtual text) from a
region. region.
Lines are 0-indexed. |api-indexing| To clear the namespace in the entire Lines are 0-indexed. |api-indexing| To clear the namespace in the entire
@ -2499,7 +2499,7 @@ nvim_buf_clear_namespace({buffer}, {ns_id}, {line_start}, {line_end})
clear to end of buffer. clear to end of buffer.
nvim_buf_del_extmark({buffer}, {ns_id}, {id}) *nvim_buf_del_extmark()* nvim_buf_del_extmark({buffer}, {ns_id}, {id}) *nvim_buf_del_extmark()*
Removes an extmark. Removes an |extmark|.
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer handle, or 0 for current buffer
@ -2511,7 +2511,7 @@ nvim_buf_del_extmark({buffer}, {ns_id}, {id}) *nvim_buf_del_extmark()*
*nvim_buf_get_extmark_by_id()* *nvim_buf_get_extmark_by_id()*
nvim_buf_get_extmark_by_id({buffer}, {ns_id}, {id}, {opts}) nvim_buf_get_extmark_by_id({buffer}, {ns_id}, {id}, {opts})
Gets the position (0-indexed) of an extmark. Gets the position (0-indexed) of an |extmark|.
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer handle, or 0 for current buffer
@ -2525,7 +2525,7 @@ nvim_buf_get_extmark_by_id({buffer}, {ns_id}, {id}, {opts})
*nvim_buf_get_extmarks()* *nvim_buf_get_extmarks()*
nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts}) nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts})
Gets extmarks in "traversal order" from a |charwise| region defined by Gets |extmarks| in "traversal order" from a |charwise| region defined by
buffer positions (inclusive, 0-indexed |api-indexing|). buffer positions (inclusive, 0-indexed |api-indexing|).
Region can be given as (row,col) tuples, or valid extmark ids (whose Region can be given as (row,col) tuples, or valid extmark ids (whose
@ -2570,7 +2570,7 @@ nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts})
*nvim_buf_set_extmark()* *nvim_buf_set_extmark()*
nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts}) nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
Creates or updates an extmark. Creates or updates an |extmark|.
By default a new extmark is created when no id is passed in, but it is By default a new extmark is created when no id is passed in, but it is
also possible to create a new mark by passing in a previously unused id or also possible to create a new mark by passing in a previously unused id or
@ -2699,19 +2699,19 @@ nvim_create_namespace({name}) *nvim_create_namespace()*
Namespace id Namespace id
nvim_get_namespaces() *nvim_get_namespaces()* nvim_get_namespaces() *nvim_get_namespaces()*
Gets existing, non-anonymous namespaces. Gets existing, non-anonymous |namespace|s.
Return: ~ Return: ~
dict that maps from names to namespace ids. dict that maps from names to namespace ids.
*nvim_set_decoration_provider()* *nvim_set_decoration_provider()*
nvim_set_decoration_provider({ns_id}, {*opts}) nvim_set_decoration_provider({ns_id}, {*opts})
Set or change decoration provider for a namespace Set or change decoration provider for a |namespace|
This is a very general purpose interface for having lua callbacks being This is a very general purpose interface for having lua callbacks being
triggered during the redraw code. triggered during the redraw code.
The expected usage is to set extmarks for the currently redrawn buffer. The expected usage is to set |extmarks| for the currently redrawn buffer.
|nvim_buf_set_extmark()| can be called to add marks on a per-window or |nvim_buf_set_extmark()| can be called to add marks on a per-window or
per-lines basis. Use the `ephemeral` key to only use the mark for the per-lines basis. Use the `ephemeral` key to only use the mark for the
current screen redraw (the callback will be called again for the next current screen redraw (the callback will be called again for the next

18
src/nvim/api/extmark.c
View File

@ -66,7 +66,7 @@ Integer nvim_create_namespace(String name)
return (Integer)id; return (Integer)id;
} }
/// Gets existing, non-anonymous namespaces. /// Gets existing, non-anonymous |namespace|s.
/// ///
/// @return dict that maps from names to namespace ids. /// @return dict that maps from names to namespace ids.
Dictionary nvim_get_namespaces(void) Dictionary nvim_get_namespaces(void)
@ -195,7 +195,7 @@ static Array extmark_to_array(const ExtmarkInfo *extmark, bool id, bool add_dict
return rv; return rv;
} }
/// Gets the position (0-indexed) of an extmark. /// Gets the position (0-indexed) of an |extmark|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer handle, or 0 for current buffer
/// @param ns_id Namespace id from |nvim_create_namespace()| /// @param ns_id Namespace id from |nvim_create_namespace()|
@ -249,7 +249,7 @@ ArrayOf(Integer) nvim_buf_get_extmark_by_id(Buffer buffer, Integer ns_id,
return extmark_to_array(&extmark, false, details); return extmark_to_array(&extmark, false, details);
} }
/// Gets extmarks in "traversal order" from a |charwise| region defined by /// Gets |extmarks| in "traversal order" from a |charwise| region defined by
/// buffer positions (inclusive, 0-indexed |api-indexing|). /// buffer positions (inclusive, 0-indexed |api-indexing|).
/// ///
/// Region can be given as (row,col) tuples, or valid extmark ids (whose /// Region can be given as (row,col) tuples, or valid extmark ids (whose
@ -368,7 +368,7 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
return rv; return rv;
} }
/// Creates or updates an extmark. /// Creates or updates an |extmark|.
/// ///
/// By default a new extmark is created when no id is passed in, but it is also /// By default a new extmark is created when no id is passed in, but it is also
/// possible to create a new mark by passing in a previously unused id or move /// possible to create a new mark by passing in a previously unused id or move
@ -814,7 +814,7 @@ error:
return 0; return 0;
} }
/// Removes an extmark. /// Removes an |extmark|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer handle, or 0 for current buffer
/// @param ns_id Namespace id from |nvim_create_namespace()| /// @param ns_id Namespace id from |nvim_create_namespace()|
@ -929,7 +929,7 @@ Integer nvim_buf_add_highlight(Buffer buffer, Integer ns_id, String hl_group, In
return ns_id; return ns_id;
} }
/// Clears namespaced objects (highlights, extmarks, virtual text) from /// Clears |namespace|d objects (highlights, |extmarks|, virtual text) from
/// a region. /// a region.
/// ///
/// Lines are 0-indexed. |api-indexing| To clear the namespace in the entire /// Lines are 0-indexed. |api-indexing| To clear the namespace in the entire
@ -962,12 +962,12 @@ void nvim_buf_clear_namespace(Buffer buffer, Integer ns_id, Integer line_start,
(int)line_end - 1, MAXCOL); (int)line_end - 1, MAXCOL);
} }
/// Set or change decoration provider for a namespace /// Set or change decoration provider for a |namespace|
/// ///
/// This is a very general purpose interface for having lua callbacks /// This is a very general purpose interface for having lua callbacks
/// being triggered during the redraw code. /// being triggered during the redraw code.
/// ///
/// The expected usage is to set extmarks for the currently /// The expected usage is to set |extmarks| for the currently
/// redrawn buffer. |nvim_buf_set_extmark()| can be called to add marks /// redrawn buffer. |nvim_buf_set_extmark()| can be called to add marks
/// on a per-window or per-lines basis. Use the `ephemeral` key to only /// on a per-window or per-lines basis. Use the `ephemeral` key to only
/// use the mark for the current screen redraw (the callback will be called /// use the mark for the current screen redraw (the callback will be called
@ -1051,7 +1051,7 @@ error:
decor_provider_clear(p); decor_provider_clear(p);
} }
/// Gets the line and column of an extmark. /// Gets the line and column of an |extmark|.
/// ///
/// Extmarks may be queried by position, name or even special names /// Extmarks may be queried by position, name or even special names
/// in the future such as "cursor". /// in the future such as "cursor".