Skip to content

Commit

Permalink
Ignore generate to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
st-Wook committed Oct 5, 2023
1 parent 299cf25 commit 722d171
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/loader/src/Queue.lua
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
--[=[
@ignore
Private queue class for loading system.
@private
Expand All @@ -10,6 +12,8 @@ Queue.ClassName = "Queue"
Queue.__index = Queue

--[=[
@ignore
Constructs a new queue
@return Queue<T>
]=]
Expand All @@ -21,6 +25,8 @@ function Queue.new()
end

--[=[
@ignore
Pushes an entry to the left of the queue
@param value T
]=]
Expand All @@ -30,6 +36,8 @@ function Queue:PushLeft(value)
end

--[=[
@ignore
Pushes an entry to the right of the queue
@param value T
]=]
Expand All @@ -39,6 +47,8 @@ function Queue:PushRight(value)
end

--[=[
@ignore
Pops an entry from the left of the queue
@return T
]=]
Expand All @@ -55,6 +65,8 @@ function Queue:PopLeft()
end

--[=[
@ignore
Pops an entry from the right of the queue
@return T
]=]
Expand All @@ -71,6 +83,8 @@ function Queue:PopRight()
end

--[=[
@ignore
Returns true if the queue is empty
@return boolean
]=]
Expand Down
20 changes: 20 additions & 0 deletions src/loader/src2/Maid.lua
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
--[=[
@ignore
Manages the cleaning of events and other things. Useful for
encapsulating state and make deconstructors easy.
Expand Down Expand Up @@ -26,6 +28,8 @@ local Maid = {}
Maid.ClassName = "Maid"

--[=[
@ignore
Constructs a new Maid object
```lua
Expand All @@ -41,6 +45,8 @@ function Maid.new()
end

--[=[
@ignore
Returns true if the class is a maid, and false otherwise.
```lua
Expand All @@ -56,6 +62,8 @@ function Maid.isMaid(value)
end

--[=[
@ignore
Returns Maid[key] if not part of Maid metatable
```lua
Expand All @@ -79,6 +87,8 @@ function Maid:__index(index)
end

--[=[
@ignore
Add a task to clean up. Tasks given to a maid will be cleaned when
maid[index] is set to a different value.
Expand Down Expand Up @@ -136,6 +146,8 @@ function Maid:__newindex(index, newTask)
end

--[=[
@ignore
Gives a task to the maid for cleanup and returnsthe resulting value
@param task MaidTask -- An item to clean
Expand All @@ -156,6 +168,8 @@ function Maid:Add(task)
end

--[=[
@ignore
Gives a task to the maid for cleanup, but uses an incremented number as a key.
@param task MaidTask -- An item to clean
Expand All @@ -177,6 +191,8 @@ function Maid:GiveTask(task)
end

--[=[
@ignore
Gives a promise to the maid for clean.
@param promise Promise<T>
Expand All @@ -199,6 +215,8 @@ function Maid:GivePromise(promise)
end

--[=[
@ignore
Cleans up all tasks and removes them as entries from the Maid.
:::note
Expand Down Expand Up @@ -255,6 +273,8 @@ function Maid:DoCleaning()
end

--[=[
@ignore
Alias for [Maid.DoCleaning()](/api/Maid#DoCleaning)
@function Destroy
Expand Down

0 comments on commit 722d171

Please sign in to comment.