[docgen] Update docs

skip-checks: true
This commit is contained in:
Github Actions 2022-10-24 15:41:13 +00:00
parent 3b3ed01a7a
commit 89fb911271
4 changed files with 44 additions and 0 deletions

View file

@ -240,7 +240,9 @@ require("aerial").setup({
["zc"] = "actions.tree_close",
["H"] = "actions.tree_close_recursive",
["zC"] = "actions.tree_close_recursive",
["zr"] = "actions.tree_increase_fold_level",
["zR"] = "actions.tree_open_all",
["zm"] = "actions.tree_decrease_fold_level",
["zM"] = "actions.tree_close_all",
["zx"] = "actions.tree_sync_folds",
["zX"] = "actions.tree_sync_folds",
@ -577,6 +579,8 @@ hi AerialGuide2 guifg=Blue
- [tree_close_all(bufnr)](doc/api.md#tree_close_allbufnr)
- [tree_open_all(bufnr)](doc/api.md#tree_open_allbufnr)
- [tree_set_collapse_level(bufnr, level)](doc/api.md#tree_set_collapse_levelbufnr-level)
- [tree_increase_fold_level(bufnr, count)](doc/api.md#tree_increase_fold_levelbufnr-count)
- [tree_decrease_fold_level(bufnr, count)](doc/api.md#tree_decrease_fold_levelbufnr-count)
- [tree_open(opts)](doc/api.md#tree_openopts)
- [tree_close(opts)](doc/api.md#tree_closeopts)
- [tree_toggle(opts)](doc/api.md#tree_toggleopts)

View file

@ -80,7 +80,9 @@ OPTIONS *aerial-option
["zc"] = "actions.tree_close",
["H"] = "actions.tree_close_recursive",
["zC"] = "actions.tree_close_recursive",
["zr"] = "actions.tree_increase_fold_level",
["zR"] = "actions.tree_open_all",
["zm"] = "actions.tree_decrease_fold_level",
["zM"] = "actions.tree_close_all",
["zx"] = "actions.tree_sync_folds",
["zX"] = "actions.tree_sync_folds",
@ -447,6 +449,20 @@ tree_set_collapse_level({bufnr}, {level}) *aerial.tree_set_collapse_leve
{bufnr} `integer`
{level} `integer` 0 is all closed, use 99 to open all
tree_increase_fold_level({bufnr}, {count}) *aerial.tree_increase_fold_level*
Increase the fold level of the symbol tree
Parameters:
{bufnr} `integer`
{count} `nil|integer`
tree_decrease_fold_level({bufnr}, {count}) *aerial.tree_decrease_fold_level*
Decrease the fold level of the symbol tree
Parameters:
{bufnr} `integer`
{count} `nil|integer`
tree_open({opts}) *aerial.tree_open*
Open the tree at the selected location

View file

@ -20,6 +20,8 @@
- [tree_close_all(bufnr)](#tree_close_allbufnr)
- [tree_open_all(bufnr)](#tree_open_allbufnr)
- [tree_set_collapse_level(bufnr, level)](#tree_set_collapse_levelbufnr-level)
- [tree_increase_fold_level(bufnr, count)](#tree_increase_fold_levelbufnr-count)
- [tree_decrease_fold_level(bufnr, count)](#tree_decrease_fold_levelbufnr-count)
- [tree_open(opts)](#tree_openopts)
- [tree_close(opts)](#tree_closeopts)
- [tree_toggle(opts)](#tree_toggleopts)
@ -203,6 +205,26 @@ Set the collapse level of the symbol tree
| bufnr | `integer` | |
| level | `integer` | 0 is all closed, use 99 to open all |
## tree_increase_fold_level(bufnr, count)
`tree_increase_fold_level(bufnr, count)` \
Increase the fold level of the symbol tree
| Param | Type | Desc |
| ----- | -------------- | ---- |
| bufnr | `integer` | |
| count | `nil\|integer` | |
## tree_decrease_fold_level(bufnr, count)
`tree_decrease_fold_level(bufnr, count)` \
Decrease the fold level of the symbol tree
| Param | Type | Desc |
| ----- | -------------- | ---- |
| bufnr | `integer` | |
| count | `nil\|integer` | |
## tree_open(opts)
`tree_open(opts)` \

View file

@ -40,6 +40,8 @@ aerial.sync_folds aerial.txt /*aerial.sync_folds*
aerial.toggle aerial.txt /*aerial.toggle*
aerial.tree_close aerial.txt /*aerial.tree_close*
aerial.tree_close_all aerial.txt /*aerial.tree_close_all*
aerial.tree_decrease_fold_level aerial.txt /*aerial.tree_decrease_fold_level*
aerial.tree_increase_fold_level aerial.txt /*aerial.tree_increase_fold_level*
aerial.tree_open aerial.txt /*aerial.tree_open*
aerial.tree_open_all aerial.txt /*aerial.tree_open_all*
aerial.tree_set_collapse_level aerial.txt /*aerial.tree_set_collapse_level*