docs(comment): add doc

This commit is contained in:
Smirnov Oleksandr 2024-04-02 17:48:58 +03:00
parent beed143e64
commit c9b7d35cbd
3 changed files with 15 additions and 0 deletions

View file

@ -15,6 +15,7 @@ Table of Contents
Auto implementation of interface methods..................|gopher.nvim-impl|
Generating unit tests boilerplate......................|gopher.nvim-gotests|
Iferr....................................................|gopher.nvim-iferr|
Generate comments.....................................|gopher.nvim-comments|
Setup `nvim-dap` for Go......................................|gopher.nvim-dap|
------------------------------------------------------------------------------
@ -200,6 +201,14 @@ Usage ~
execute `:GoIfErr` near any err variable to insert the check
==============================================================================
------------------------------------------------------------------------------
*gopher.nvim-comments*
Usage ~
Execute `:GoCmt` to generate a comment for the current function/method/struct/etc on this line.
This module provides a way to generate comments for Go code.
==============================================================================
------------------------------------------------------------------------------
*gopher.nvim-dap*

View file

@ -1,3 +1,8 @@
---@toc_entry Generate comments
---@tag gopher.nvim-comments
---@usage Execute `:GoCmt` to generate a comment for the current function/method/struct/etc on this line.
---@text This module provides a way to generate comments for Go code.
local function generate(row, col)
local ts_utils = require "gopher._utils.ts"
local comment, ns = nil, nil

View file

@ -14,6 +14,7 @@ local files = {
"lua/gopher/impl.lua",
"lua/gopher/gotests.lua",
"lua/gopher/iferr.lua",
"lua/gopher/comment.lua",
"lua/gopher/dap.lua",
}