docs: update (#103)

* chore: add @dochide annotation

- it's easier to distinguish @private and something i dont want to see in docs

* docs: update

* refactor: move thing out to utils

* fix: lua-ls error

* fixup! refactor: move thing out to utils

* docs: update

lua/gopher/init.lua

@@ -1,12 +1,13 @@
---- *gopher.nvim*
+--- *gopher.nvim* Enhance your golang experience
+---
+--- MIT License Copyright (c) 2025 Oleksandr Smirnov
 ---
 --- ==============================================================================
 ---
 --- gopher.nvim is a minimalistic plugin for Go development in Neovim written in Lua.
 --- It's not an LSP tool, the main goal of this plugin is add go tooling support in Neovim.
-
+---
 --- Table of Contents
----@tag gopher.nvim-table-of-contents
 ---@toc
 
 local log = require "gopher._utils.log"
@@ -16,14 +17,16 @@ local gocmd = require("gopher._utils.gocmd").run
 local gopher = {}
 
 ---@toc_entry Setup
----@tag gopher.nvim-setup
+---@tag gopher.nvim-setup()
 ---@text Setup function. This method simply merges default config with opts table.
 --- You can read more about configuration at |gopher.nvim-config|
 --- Calling this function is optional, if you ok with default settings.
---- See |gopher.nvim.config-defaults|
+--- See |gopher.nvim.config|
 ---
----@usage `require("gopher").setup {}` (replace `{}` with your `config` table)
----@param user_config gopher.Config
+---@usage >lua
+---  require("gopher").setup {} -- use default config or replace {} with your own
+--- <
+---@param user_config gopher.Config See |gopher.nvim-config|
 gopher.setup = function(user_config)
   log.debug "setting up config"
   require("gopher.config").setup(user_config)
@@ -31,7 +34,7 @@ gopher.setup = function(user_config)
 end
 
 ---@toc_entry Install dependencies
----@tag gopher.nvim-install-deps
+---@tag gopher.nvim-dependencies
 ---@text Gopher.nvim implements most of its features using third-party tools.
 --- To install these tools, you can run `:GoInstallDeps` command
 --- or call `require("gopher").install_deps()` if you want to use lua api.