Add LDoc for extended verison 'admin-house'

.github/workflows/deploy.yml

@@ -13,8 +13,6 @@ jobs:
         uses: actions/checkout@v3
       - name: Generate docs with LDoc
         uses: lunarmodules/ldoc@v1.5.0
-        with:
-            args: main.lua
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:

config.ld

@@ -1,9 +1,9 @@
 project = "f3x-wrapper"
 title = "f3x-wrapper"
-description = "f3x-wrapper is an unofficial F3X Sync API wrapper."
+description = "Unofficial F3X Sync API Wrapper"
 format = "discount"
 backtick_references = false
-file = "main.lua"
+file = {"main.lua","extended/admin-house.lua"}
 dir = "public"
 style = "!new"
 -- vim: ft=lua

extended/README.md

@@ -1,3 +1,3 @@
 # f3x-wrapper Extended
-- [`admin-house.lua`](admin-house.lua): For Roblox  [Admin House!](https://www.roblox.com/games/333164326/Admin-House) game
+- [`admin-house.lua`](admin-house.lua): For Roblox  [Admin House!](https://www.roblox.com/games/333164326/Admin-House) game by [@Kaderth](https://www.roblox.com/users/87471875/profile/)
 - ...

extended/admin-house.lua

@@ -1,3 +1,10 @@
+--- Extended version of f3x-wrapper for the game 'Admin House!' by Kaderth
+-- @module f3x-wrapper-extended-admin-house
+-- @author bqmb3
+-- @license MIT
+-- @copyright bqmb3 2024
+
+
 _G.F3X__init_func = function()
    if _G.F3X__init_debounce then return end
    _G.F3X__init_debounce = true
@@ -9,7 +16,7 @@ end
 local F3X = loadstring(game:HttpGet("https://raw.githubusercontent.com/bqmb3/f3x-wrapper/main/main.lua", true))()
 
 --- Gets the list of builds.
--- @treturn List table of build names
+-- @treturn table List of build names
 function F3X:GetBuilds()
    local tbl = game:GetService('ReplicatedStorage').Network.BuildSaving:InvokeServer({'GET'})
    local builds = {}
@@ -21,14 +28,14 @@ end
 
 --- Checks if a build exists.
 -- @tparam string buildName Name of the build
--- @treturn True boolean if the build exists, false otherwise
+-- @treturn boolean True if the build exists, false otherwise
 function F3X:HasBuild(buildName)
    return game:GetService('ReplicatedStorage').Network.BuildSaving:InvokeServer({'GET'})[buildName] ~= nil
 end
 
 --- Loads a build.
 -- @tparam string buildName Name of the build
--- @treturn List table of instances in the build
+-- @treturn table List of instances in the build
 function F3X:LoadBuild(buildName)
    local result = game:GetService('ReplicatedStorage').Network.BuildSaving:InvokeServer({'LOAD', buildName})
    assert(result, 'Build not found.')
@@ -66,7 +73,7 @@ function F3X:SetLockModeToOnlyMe()
 end
 
 --- Gets the list of whitelisted players.
--- @treturn List table of whitelisted players
+-- @treturn table List of whitelisted players
 function F3X:GetWhitelistedPlayers()
    return game:GetService('ReplicatedStorage').Network.BuildLocking:InvokeServer({"GETWHITELIST"})
 end