docs: fix documentation of modules

.neoconf.json

@@ -2,7 +2,7 @@
   "neodev": {
     "library": {
       "enabled": true,
-      "plugins": true
+      "plugins": ["lazy.nvim"]
     }
   },
   "neoconf": {
@@ -14,7 +14,8 @@
   },
   "lspconfig": {
     "lua_ls": {
-      "Lua.format.enable": false
+      "Lua.format.enable": false,
+      "Lua.diagnostics.globals": ["packer_plugins"]
     }
   }
 }

lua/astrotheme/init.lua

@@ -1,8 +1,19 @@
+---AstroTheme
+---
+--- The default colorscheme used by AstroNvim an aesthetic and feature-rich
+--- neovim config that is extensible and easy to use with a great set of
+--- plugins
+---
+---This module can be loaded with `local astrotheme = require "astrotheme"`
+---
+---copyright 2023 license GNU General Public License v3.0 @class astrocore
+---@class astrotheme
+---@field config AstroThemeOpts
+local M = { config = {} }
+
 C = {}
 local util = require "astrotheme.lib.util"
 
-local M = { config = {} }
-
 --- Load a specific theme given a palette name
 ---@param theme string?
 function M.load(theme)

lua/astrotheme/lib/config.lua

@@ -1,3 +1,11 @@
+---AstroTheme Configuration
+---
+---Default configuration of AstroTheme
+---
+---This module can be loaded with `local astrotheme_config = require "astrotheme.lib.config"`
+---
+---copyright 2023 license GNU General Public License v3.0 @class astrocore
+---@class astrotheme.lib.config
 M = {}
 
 ---@type AstroThemeOpts

lua/astrotheme/lib/util.lua

@@ -1,3 +1,11 @@
+---AstroTheme Utilities
+---
+---Various utilities for use within AstroTheme
+---
+---This module can be loaded with `local astrotheme_utils = require "astrotheme.lib.util"`
+---
+---copyright 2023 license GNU General Public License v3.0 @class astrocore
+---@class astrotheme.lib.util
 local M = {}
 
 --- Reload a given theme