Add LDoc annotations for public PIXEL API surface - #64
Merged
Conversation
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/d8703e3b-98fa-499f-ac85-1b39e8e6c91c Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Create documentation for public methods in the codebase
Add LDoc annotations for public PIXEL API surface
May 14, 2026
TomDotBat
requested changes
May 14, 2026
TomDotBat
left a comment
TomDotBat
left a comment
Owner
There was a problem hiding this comment.
Add descriptions to all parameters and returns, also document all registered panels
| PIXEL.UI = PIXEL.UI or {} | ||
| PIXEL.UI.Version = "1.4.1" | ||
|
|
||
| --- Loads all Lua files in a directory, applying client/server include rules. |
Owner
There was a problem hiding this comment.
State what the realm rules are
| return files, folders | ||
| end | ||
|
|
||
| --- Recursively loads Lua files in a directory and its subfolders. |
| end | ||
| end | ||
|
|
||
| --- Returns a new Color copy. |
Owner
There was a problem hiding this comment.
Returns a new instance of a Colour with the same values.
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/67763ae5-257a-43e2-9a05-640f338eac18 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Copilot stopped work on behalf of
TomDotBat due to an error
May 14, 2026 10:21
Owner
|
@copilot continue work pls |
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/4a3f6d2a-418b-48e8-925b-7cade7a95b51 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Contributor
Author
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/295cda3c-e817-48e1-9a7d-fbb7fd86f7c1 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/295cda3c-e817-48e1-9a7d-fbb7fd86f7c1 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/295cda3c-e817-48e1-9a7d-fbb7fd86f7c1 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
TomDotBat
requested changes
May 14, 2026
TomDotBat
left a comment
TomDotBat
left a comment
Owner
There was a problem hiding this comment.
Still missing a bunch of critical methods on a several panels, they need to be documented
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/54fb10ca-5f6d-4486-a95a-474ac8b99ce9 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Agent-Logs-Url: https://github.com/TomDotBat/pixel-ui/sessions/54fb10ca-5f6d-4486-a95a-474ac8b99ce9 Co-authored-by: TomDotBat <11298466+TomDotBat@users.noreply.github.com>
Contributor
Author
Done — I added LDoc docs for the remaining critical panel methods across the core element panels (including params/returns), then pushed a follow-up fix for callback forwarding in text entry internals. Addressed in e44aa64 (docs in 5044bd8). |
TomDotBat
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.