From 8ae7f44580697d12b4d3ffa68dd31fe1f335b358 Mon Sep 17 00:00:00 2001 From: Ottatop Date: Sun, 14 Jan 2024 20:03:58 -0600 Subject: [PATCH] Clean up docs --- api/lua_grpc/pinnacle.lua | 6 ++++++ api/lua_grpc/pinnacle/tag.lua | 2 ++ 2 files changed, 8 insertions(+) diff --git a/api/lua_grpc/pinnacle.lua b/api/lua_grpc/pinnacle.lua index 33c9b93..8cb5e20 100644 --- a/api/lua_grpc/pinnacle.lua +++ b/api/lua_grpc/pinnacle.lua @@ -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() diff --git a/api/lua_grpc/pinnacle/tag.lua b/api/lua_grpc/pinnacle/tag.lua index d1b3914..84b367b 100644 --- a/api/lua_grpc/pinnacle/tag.lua +++ b/api/lua_grpc/pinnacle/tag.lua @@ -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 = {}