mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2024-12-26 21:58:10 +01:00
Remove stuff that shouldn't be in docs
This commit is contained in:
parent
2dd170cf10
commit
643f694478
4 changed files with 11 additions and 0 deletions
|
@ -35,6 +35,7 @@ local Client = {}
|
||||||
---@field response_type string?
|
---@field response_type string?
|
||||||
---@field data table
|
---@field data table
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---Send a synchronous unary request to the compositor.
|
---Send a synchronous unary request to the compositor.
|
||||||
---
|
---
|
||||||
---If `request_type` is not specified then it will default to
|
---If `request_type` is not specified then it will default to
|
||||||
|
@ -84,6 +85,7 @@ function Client:unary_request(grpc_request_params)
|
||||||
return response
|
return response
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---Send a async server streaming request to the compositor.
|
---Send a async server streaming request to the compositor.
|
||||||
---
|
---
|
||||||
---`callback` will be called with every streamed response.
|
---`callback` will be called with every streamed response.
|
||||||
|
@ -144,6 +146,7 @@ function Client:server_streaming_request(grpc_request_params, callback)
|
||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@return Client
|
---@return Client
|
||||||
function client.new(loop)
|
function client.new(loop)
|
||||||
local sock = socket.connect({
|
local sock = socket.connect({
|
||||||
|
|
|
@ -442,6 +442,7 @@ function OutputHandle:tags()
|
||||||
return self:props().tags
|
return self:props().tags
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@return Output
|
---@return Output
|
||||||
function output.new(config_client)
|
function output.new(config_client)
|
||||||
---@type Output
|
---@type Output
|
||||||
|
@ -452,6 +453,7 @@ function output.new(config_client)
|
||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---Create a new `OutputHandle` from its raw name.
|
---Create a new `OutputHandle` from its raw name.
|
||||||
---@param output_name string
|
---@param output_name string
|
||||||
function output_handle.new(config_client, output_name)
|
function output_handle.new(config_client, output_name)
|
||||||
|
|
|
@ -453,6 +453,7 @@ function TagHandle:output()
|
||||||
return self:props().output
|
return self:props().output
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@return Tag
|
---@return Tag
|
||||||
function tag.new(config_client)
|
function tag.new(config_client)
|
||||||
---@type Tag
|
---@type Tag
|
||||||
|
@ -463,6 +464,7 @@ function tag.new(config_client)
|
||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---Create a new `TagHandle` from an id.
|
---Create a new `TagHandle` from an id.
|
||||||
---@param config_client Client
|
---@param config_client Client
|
||||||
---@param tag_id integer
|
---@param tag_id integer
|
||||||
|
@ -477,6 +479,7 @@ function tag_handle.new(config_client, tag_id)
|
||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@param config_client Client
|
---@param config_client Client
|
||||||
---@param tag_ids integer[]
|
---@param tag_ids integer[]
|
||||||
---@return TagHandle[]
|
---@return TagHandle[]
|
||||||
|
|
|
@ -583,6 +583,7 @@ function WindowHandle:tags()
|
||||||
return self:props().tags
|
return self:props().tags
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@param config_client Client
|
---@param config_client Client
|
||||||
---@return Window
|
---@return Window
|
||||||
function window.new(config_client)
|
function window.new(config_client)
|
||||||
|
@ -594,6 +595,7 @@ function window.new(config_client)
|
||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---Create a new `WindowHandle` from an id.
|
---Create a new `WindowHandle` from an id.
|
||||||
---@param config_client Client
|
---@param config_client Client
|
||||||
---@param window_id integer
|
---@param window_id integer
|
||||||
|
@ -608,6 +610,7 @@ function window_handle.new(config_client, window_id)
|
||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---@nodoc
|
||||||
---@param config_client Client
|
---@param config_client Client
|
||||||
---@param window_ids integer[]
|
---@param window_ids integer[]
|
||||||
---
|
---
|
||||||
|
|
Loading…
Reference in a new issue