Skip to content

Commit

Permalink
auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 23, 2025
1 parent a7aeff5 commit 73e2ecf
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions doc/nvim-dap-view.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ Why? ~

By default, when launching a session, `nvim-dap`’s terminal window takes half
the screen. As a saner default, `nvim-dap-view` hijacks the terminal window
(even if not invoked), making the split take only 12 (configurable) screen
lines.
(even if not invoked), making the split take only 12 (configurable) lines.

>lua
-- Your nvim-dap config
Expand Down Expand Up @@ -83,10 +82,10 @@ The plugin provides 4 "views" that share the same window (so there’s clutter)
- REPL view
- Use REPL provided by nvim-dap

You can also interact with the console provided by nvim-dap (though, arguably,
that’s not a feature from nvim-dap-view). The console has its own window.
However, its default size (height) is resized to match you nvim-dap-view
configuration.
You can also interact with the console provided by `nvim-dap` (though,
arguably, that’s not a feature from `nvim-dap-view`). The console has its own
window. However, its default size (height) is resized to match you
`nvim-dap-view` configuration.


DOCUMENTATION *nvim-dap-view-nvim-dap-view-documentation*
Expand All @@ -100,7 +99,7 @@ Default options ~
return {
winbar = {
show = true,
sections = { "watches", "exceptions", "breakpoints" },
sections = { "watches", "exceptions", "breakpoints", "repl" },
-- Must be one of the sections declared above
default_section = "watches",
},
Expand Down Expand Up @@ -159,6 +158,26 @@ course). An example for the toggle functionality, using the lua API:
<


HIGHLIGHT GROUPS ~

`nvim-dap-view` defines 8 highlight groups:

>lua
NvimDapViewMissingData
NvimDapViewWatchText
NvimDapViewWatchTextChanged
NvimDapViewExceptionFilterEnabled
NvimDapViewExceptionFilterDisabled
NvimDapViewBreakpointFileName
NvimDapViewBreakpointLineNumber
NvimDapViewBreakpointSeparator
<

They are linked to (somewhat) reasonable defaults, but they may look odd with
your colorscheme. Consider contributing to your colorscheme by sending a PR to
add support to `nvim-dap-view`.


ROADMAP *nvim-dap-view-nvim-dap-view-roadmap*

- Watches
Expand Down

0 comments on commit 73e2ecf

Please sign in to comment.