diff --git a/doc/gopher.nvim.txt b/doc/gopher.nvim.txt index 4b3acd9..b9e4de6 100644 --- a/doc/gopher.nvim.txt +++ b/doc/gopher.nvim.txt @@ -9,7 +9,7 @@ It's not an LSP tool, the main goal of this plugin is add go tooling support in *gopher.nvim-table-of-contents* Table of Contents Configuration...........................................|gopher.nvim-config| - Setup....................................................|gopher.nvim-setup| + Setup.............................................|gopher.nvim-config-setup| ============================================================================== @@ -19,26 +19,13 @@ config it is the place where you can configure the plugin. also this is optional is you're ok with default settings. You can look at default options |gopher.nvim-config-defaults| ------------------------------------------------------------------------------- -Type ~ -gopher.Config - ------------------------------------------------------------------------------- - *gopher.nvim-config.ConfigGoTagTransform* -Possible values for |gopher.Config|.gotag.transform: - -"snakecase" "GopherUser" -> "gopher_user" -"camelcase" "GopherUser" -> "gopherUser" -"lispcase" "GopherUser" -> "gopher-user" -"pascalcase" "GopherUser" -> "GopherUser" -"titlecase" "GopherUser" -> "Gopher User" -"keep" keeps the original field name - ------------------------------------------------------------------------------ *gopher.nvim-config-defaults* -Default values: + `default_config` >lua - { + local default_config = { + --minidoc_replace_end + -- user specified paths to binaries ---@class gopher.ConfigCommand commands = { @@ -58,7 +45,6 @@ Default values: template_dir = nil, -- switch table tests from using slice to map (with test name for the key) -- works only with gotests installed from develop branch - ---@type boolean named = false, }, ---@class gopher.ConfigGoTag @@ -68,20 +54,20 @@ Default values: }, } < -Class ~ +Class {gopher.Config} ------------------------------------------------------------------------------ - *gopher.nvim-setup* + *gopher.nvim-config-setup* `config.setup`({user_config}) Setup function. This method simply merges default configs with opts table. You can read more about configuration at |gopher.nvim-config| Calling this function is optional, if you ok with default settings. Look |gopher.nvim.config-defaults| -Usage ~ +Usage `require("gopher").setup {}` (replace `{}` with your `config` table) -Parameters ~ +Parameters {user_config} `(optional)` gopher.Config diff --git a/lua/gopher/config.lua b/lua/gopher/config.lua index f1e4af1..d767200 100644 --- a/lua/gopher/config.lua +++ b/lua/gopher/config.lua @@ -5,13 +5,13 @@ --- You can look at default options |gopher.nvim-config-defaults| ---@type gopher.Config ---minidoc_replace_start +---@private local config = {} ---minidoc_replace_end ---@tag gopher.nvim-config.ConfigGoTagTransform ---@text Possible values for |gopher.Config|.gotag.transform: --- +---@private ---@alias gopher.ConfigGoTagTransform ---| "snakecase" "GopherUser" -> "gopher_user" ---| "camelcase" "GopherUser" -> "gopherUser" @@ -20,14 +20,15 @@ local config = {} ---| "titlecase" "GopherUser" -> "Gopher User" ---| "keep" keeps the original field name +--minidoc_replace_start { + ---@tag gopher.nvim-config-defaults ----@text Default values: ---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section):gsub(">", ">lua") --- ---@class gopher.Config ---minidoc_replace_start { local default_config = { --minidoc_replace_end + -- user specified paths to binaries ---@class gopher.ConfigCommand commands = { @@ -47,7 +48,6 @@ local default_config = { template_dir = nil, -- switch table tests from using slice to map (with test name for the key) -- works only with gotests installed from develop branch - ---@type boolean named = false, }, ---@class gopher.ConfigGoTag