From 643f694478e987ac1776cbc1c01ab43566467b98 Mon Sep 17 00:00:00 2001 From: Ottatop Date: Tue, 16 Jan 2024 16:21:38 -0600 Subject: [PATCH] Remove stuff that shouldn't be in docs --- api/lua/pinnacle/grpc/client.lua | 3 +++ api/lua/pinnacle/output.lua | 2 ++ api/lua/pinnacle/tag.lua | 3 +++ api/lua/pinnacle/window.lua | 3 +++ 4 files changed, 11 insertions(+) diff --git a/api/lua/pinnacle/grpc/client.lua b/api/lua/pinnacle/grpc/client.lua index da9623b..594d99a 100644 --- a/api/lua/pinnacle/grpc/client.lua +++ b/api/lua/pinnacle/grpc/client.lua @@ -35,6 +35,7 @@ local Client = {} ---@field response_type string? ---@field data table +---@nodoc ---Send a synchronous unary request to the compositor. --- ---If `request_type` is not specified then it will default to @@ -84,6 +85,7 @@ function Client:unary_request(grpc_request_params) return response end +---@nodoc ---Send a async server streaming request to the compositor. --- ---`callback` will be called with every streamed response. @@ -144,6 +146,7 @@ function Client:server_streaming_request(grpc_request_params, callback) end) end +---@nodoc ---@return Client function client.new(loop) local sock = socket.connect({ diff --git a/api/lua/pinnacle/output.lua b/api/lua/pinnacle/output.lua index 3555ab7..8e5415c 100644 --- a/api/lua/pinnacle/output.lua +++ b/api/lua/pinnacle/output.lua @@ -442,6 +442,7 @@ function OutputHandle:tags() return self:props().tags end +---@nodoc ---@return Output function output.new(config_client) ---@type Output @@ -452,6 +453,7 @@ function output.new(config_client) return self end +---@nodoc ---Create a new `OutputHandle` from its raw name. ---@param output_name string function output_handle.new(config_client, output_name) diff --git a/api/lua/pinnacle/tag.lua b/api/lua/pinnacle/tag.lua index 84b367b..3b34ccb 100644 --- a/api/lua/pinnacle/tag.lua +++ b/api/lua/pinnacle/tag.lua @@ -453,6 +453,7 @@ function TagHandle:output() return self:props().output end +---@nodoc ---@return Tag function tag.new(config_client) ---@type Tag @@ -463,6 +464,7 @@ function tag.new(config_client) return self end +---@nodoc ---Create a new `TagHandle` from an id. ---@param config_client Client ---@param tag_id integer @@ -477,6 +479,7 @@ function tag_handle.new(config_client, tag_id) return self end +---@nodoc ---@param config_client Client ---@param tag_ids integer[] ---@return TagHandle[] diff --git a/api/lua/pinnacle/window.lua b/api/lua/pinnacle/window.lua index c41b08e..376e263 100644 --- a/api/lua/pinnacle/window.lua +++ b/api/lua/pinnacle/window.lua @@ -583,6 +583,7 @@ function WindowHandle:tags() return self:props().tags end +---@nodoc ---@param config_client Client ---@return Window function window.new(config_client) @@ -594,6 +595,7 @@ function window.new(config_client) return self end +---@nodoc ---Create a new `WindowHandle` from an id. ---@param config_client Client ---@param window_id integer @@ -608,6 +610,7 @@ function window_handle.new(config_client, window_id) return self end +---@nodoc ---@param config_client Client ---@param window_ids integer[] ---