docs(dap): add doc

This commit is contained in:
Smirnov Oleksandr 2024-04-02 17:10:20 +03:00
parent dba618d387
commit 34d742824f
3 changed files with 17 additions and 2 deletions

View file

@ -12,6 +12,7 @@ Table of Contents
Install dependencies..............................|gopher.nvim-install-deps| Install dependencies..............................|gopher.nvim-install-deps|
Configuration...........................................|gopher.nvim-config| Configuration...........................................|gopher.nvim-config|
Auto implementation of interface methods..................|gopher.nvim-impl| Auto implementation of interface methods..................|gopher.nvim-impl|
Setup `nvim-dap` for Go......................................|gopher.nvim-dap|
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*gopher.nvim-setup* *gopher.nvim-setup*
@ -114,4 +115,12 @@ simple example:
< <
==============================================================================
------------------------------------------------------------------------------
*gopher.nvim-dap*
This module sets up `nvim-dap` for Go.
Usage ~
just call `require("gopher.dap").setup()`, adn you're good to go.
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl:

View file

@ -1,3 +1,8 @@
---@toc_entry Setup `nvim-dap` for Go
---@tag gopher.nvim-dap
---@text This module sets up `nvim-dap` for Go.
---@usage just call `require("gopher.dap").setup()`, and you're good to go.
local u = require "gopher._utils" local u = require "gopher._utils"
local c = require "gopher.config" local c = require "gopher.config"
local dap = {} local dap = {}
@ -106,7 +111,7 @@ dap.configuration = {
}, },
} }
---setup `nvim-dap` for Go -- sets ups nvim-dap for Go in one function call.
function dap.setup() function dap.setup()
local d = u.sreq "dap" local d = u.sreq "dap"

View file

@ -10,7 +10,8 @@ end
local files = { local files = {
"lua/gopher/init.lua", "lua/gopher/init.lua",
"lua/gopher/config.lua", "lua/gopher/config.lua",
"lua/gopher/impl.lua" "lua/gopher/impl.lua",
"lua/gopher/dap.lua",
} }
minidoc.setup() minidoc.setup()