Clean up docs

This commit is contained in:
Ottatop 2024-01-14 20:03:58 -06:00
parent fbef4007ea
commit 8ae7f44580
2 changed files with 8 additions and 0 deletions

View file

@ -34,6 +34,12 @@ function Pinnacle:quit()
end
---Setup Pinnacle.
---
---You must pass in a function that takes in the `Pinnacle` module (it's more like a class but it's pretty much a module). The module is how you'll access the other config modules.
---
---If you want to do a multi-file config, you should have other files return a function taking in necessary modules.
---Or you could cheat and stick the modules into globals :TrollFace:
---
---@param config_fn fun(pinnacle: Pinnacle)
function pinnacle.setup(config_fn)
require("pinnacle.grpc.protobuf").build_protos()

View file

@ -38,6 +38,7 @@ local function build_grpc_request_params(method, data)
}
end
---@nodoc
---@class TagHandleModule
local tag_handle = {}
@ -52,6 +53,7 @@ local tag_handle = {}
---@field id integer
local TagHandle = {}
---@nodoc
---@class TagModule
---@field private handle TagHandleModule
local tag = {}