diff --git a/.github/workflows/ldoc.yml b/.github/workflows/ldoc.yml index 5a0cc3c..60c0580 100644 --- a/.github/workflows/ldoc.yml +++ b/.github/workflows/ldoc.yml @@ -41,9 +41,9 @@ jobs: - name: Setup dependencies run: luarocks install ldoc - name: Generate LDoc compatible code - run: cd ./ldoc_gen && cargo run -- -p ../api/lua + run: mv ldoc_gen .. && cd ../ldoc_gen && cargo run -- -p ../pinnacle/api/lua - name: Build docs - run: cd ./ldoc_gen/.ldoc_gen && cp ../../api/lua/ldoc.css ../../api/lua/config.ld . && ldoc . && cd ../.. + run: cd ../ldoc_gen/.ldoc_gen && cp ../../pinnacle/api/lua/ldoc.css ../../pinnacle/api/lua/config.ld . && ldoc . - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: @@ -70,12 +70,12 @@ jobs: - name: Setup dependencies run: luarocks install ldoc - name: Generate LDoc compatible code - run: cd ./ldoc_gen && cargo run -- -p ../api/lua_grpc + run: mv ldoc_gen .. && cd ../ldoc_gen && cargo run -- -p ../pinnacle/api/lua_grpc - name: Build docs - run: cd ./ldoc_gen/.ldoc_gen && cp ../../api/lua/ldoc.css ../../api/lua/config.ld . && ldoc . && cd ../.. + run: cd ../ldoc_gen/.ldoc_gen && cp ../../pinnacle/api/lua/ldoc.css ../../pinnacle/api/lua/config.ld . && ldoc . - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./ldoc_gen/.ldoc_gen/doc + publish_dir: ../ldoc_gen/.ldoc_gen/doc destination_dir: ${{ env.BRANCH_NAME }}/lua_grpc diff --git a/api/lua_grpc/pinnacle.lua b/api/lua_grpc/pinnacle.lua index 0b1bdd8..6bd5ff0 100644 --- a/api/lua_grpc/pinnacle.lua +++ b/api/lua_grpc/pinnacle.lua @@ -7,6 +7,7 @@ local pinnacle = { version = "v0alpha1", } +---@classmod ---@class Pinnacle ---@field private config_client Client ---@field input Input @@ -16,6 +17,7 @@ local pinnacle = { ---@field window Window local Pinnacle = {} +---Quit Pinnacle. function Pinnacle:quit() self.config_client:unary_request({ service = "pinnacle.v0alpha1.PinnacleService", diff --git a/api/lua_grpc/pinnacle/output.lua b/api/lua_grpc/pinnacle/output.lua index d28b220..75932d5 100644 --- a/api/lua_grpc/pinnacle/output.lua +++ b/api/lua_grpc/pinnacle/output.lua @@ -38,6 +38,7 @@ end ---@class OutputHandleModule local output_handle = {} +---@classmod ---@class OutputHandle ---@field private config_client Client ---@field name string The unique name of this output diff --git a/api/lua_grpc/pinnacle/tag.lua b/api/lua_grpc/pinnacle/tag.lua index c118871..cd716ac 100644 --- a/api/lua_grpc/pinnacle/tag.lua +++ b/api/lua_grpc/pinnacle/tag.lua @@ -41,6 +41,7 @@ end ---@class TagHandleModule local tag_handle = {} +---@classmod ---@class TagHandle ---@field private config_client Client ---@field id integer diff --git a/api/lua_grpc/pinnacle/window.lua b/api/lua_grpc/pinnacle/window.lua index 29f6ed0..ff183d1 100644 --- a/api/lua_grpc/pinnacle/window.lua +++ b/api/lua_grpc/pinnacle/window.lua @@ -44,6 +44,7 @@ end ---@class WindowHandleModule local window_handle = {} +---@classmod ---@class WindowHandle ---@field private config_client Client ---@field id integer