mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2025-01-13 08:01:05 +01:00
Clean up docs
This commit is contained in:
parent
fbef4007ea
commit
8ae7f44580
2 changed files with 8 additions and 0 deletions
|
@ -34,6 +34,12 @@ function Pinnacle:quit()
|
||||||
end
|
end
|
||||||
|
|
||||||
---Setup Pinnacle.
|
---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)
|
---@param config_fn fun(pinnacle: Pinnacle)
|
||||||
function pinnacle.setup(config_fn)
|
function pinnacle.setup(config_fn)
|
||||||
require("pinnacle.grpc.protobuf").build_protos()
|
require("pinnacle.grpc.protobuf").build_protos()
|
||||||
|
|
|
@ -38,6 +38,7 @@ local function build_grpc_request_params(method, data)
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@class TagHandleModule
|
---@class TagHandleModule
|
||||||
local tag_handle = {}
|
local tag_handle = {}
|
||||||
|
|
||||||
|
@ -52,6 +53,7 @@ local tag_handle = {}
|
||||||
---@field id integer
|
---@field id integer
|
||||||
local TagHandle = {}
|
local TagHandle = {}
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@class TagModule
|
---@class TagModule
|
||||||
---@field private handle TagHandleModule
|
---@field private handle TagHandleModule
|
||||||
local tag = {}
|
local tag = {}
|
||||||
|
|
Loading…
Reference in a new issue