Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Fix duplicate entries on docs [skip ci] #416

Merged
merged 1 commit into from
Oct 4, 2024
Merged

docs: Fix duplicate entries on docs [skip ci] #416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/loader/src/Maid.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
maid:DoCleaning()
```

@ignore
@class Maid
]=]
-- luacheck: pop
Expand All @@ -32,6 +33,7 @@ Maid.ClassName = "Maid"
local maid = Maid.new()
```

@ignore
@return Maid
]=]
function Maid.new()
Expand All @@ -48,6 +50,7 @@ end
print(Maid.isMaid(nil)) --> false
```

@ignore
@param value any
@return boolean
]=]
Expand All @@ -67,6 +70,7 @@ end
print(maid._current) --> nil
```

@ignore
@param index any
@return MaidTask
]=]
Expand Down Expand Up @@ -94,6 +98,7 @@ end
Maid[key] = nil Removes a named task.
```

@ignore
@param index any
@param newTask MaidTask
]=]
Expand Down Expand Up @@ -138,6 +143,7 @@ end
--[=[
Gives a task to the maid for cleanup and returns the resulting value

@ignore
@param task MaidTask -- An item to clean
@return MaidTask
]=]
Expand All @@ -158,6 +164,7 @@ end
--[=[
Gives a task to the maid for cleanup, but uses an incremented number as a key.

@ignore
@param task MaidTask -- An item to clean
@return number -- taskId
]=]
Expand All @@ -179,6 +186,7 @@ end
--[=[
Gives a promise to the maid for clean.

@ignore
@param promise Promise<T>
@return Promise<T>
]=]
Expand Down Expand Up @@ -213,6 +221,8 @@ end
However, adding tasks while cleaning is not generally a good idea, as if you add a
function that adds itself, this will loop indefinitely.
:::

@ignore
]=]
function Maid:DoCleaning()
local tasks = self._tasks
Expand Down Expand Up @@ -257,6 +267,7 @@ end
--[=[
Alias for [Maid.DoCleaning()](/api/Maid#DoCleaning)

@ignore
@function Destroy
@within Maid
]=]
Expand Down
Loading