diff --git a/doc/gopher.nvim.txt b/doc/gopher.nvim.txt index e04690b..868d466 100644 --- a/doc/gopher.nvim.txt +++ b/doc/gopher.nvim.txt @@ -12,6 +12,7 @@ Table of Contents Install dependencies..............................|gopher.nvim-install-deps| Configuration...........................................|gopher.nvim-config| Auto implementation of interface methods..................|gopher.nvim-impl| + Setup `nvim-dap` for Go......................................|gopher.nvim-dap| ------------------------------------------------------------------------------ *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: \ No newline at end of file diff --git a/lua/gopher/dap.lua b/lua/gopher/dap.lua index 551416c..6ff326a 100644 --- a/lua/gopher/dap.lua +++ b/lua/gopher/dap.lua @@ -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 c = require "gopher.config" 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() local d = u.sreq "dap" diff --git a/scripts/docgen.lua b/scripts/docgen.lua index a4f5d34..981a6fe 100644 --- a/scripts/docgen.lua +++ b/scripts/docgen.lua @@ -10,7 +10,8 @@ end local files = { "lua/gopher/init.lua", "lua/gopher/config.lua", - "lua/gopher/impl.lua" + "lua/gopher/impl.lua", + "lua/gopher/dap.lua", } minidoc.setup()