docs(lua): add luadoc annotations for the LVGL Lua API - #7837
Merged
pfeerick merged 2 commits intoSep 28, 2026
Merged
Conversation
Port of EdgeTX#7771 (2.12) to main. api_colorlcd_lvgl.cpp was identical on main and on 2.12 just before EdgeTX#7771, so this is a clean, comment-only cherry-pick that adds /*luadoc*/ blocks for every lvgl.* function. (cherry picked from commit 8718d24) Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Port of the 2.12 fix to main. A handful of @RetVal field-list bullets in fstat, model.getInput, and model.getSwashRing quoted the field name with straight single quotes ('trimSource') instead of the backtick style used by every other luadoc annotation across the Lua API (`trimSource`). Purely a doc-comment consistency fix, no functional change. (cherry picked from commit 7971904) Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Port of #7771 to
main. It adds/*luadoc*/annotations for everylvgl.*constructor and utility function inradio/src/lua/api_colorlcd_lvgl.cpp, so the Lua reference doc pipeline can extract the LVGL API from source.Why this is a straight cherry-pick
api_colorlcd_lvgl.cpponmainis byte-identical to2.12just before docs(lua): add luadoc annotations for the LVGL Lua API #7771 merged, so the patch applies cleanly. After the cherry-pick, the file matches2.12exactly.lua_lvgl_widget.his also identical. Onmain,lua_lvgl_widget.cpponly has internal refactors (include order,setWindowFlag(NO_CLICK / NO_FORCED_SCROLL), whitespace), and none of them add or remove a Lua-visible property.main(model.get/setSwitchWarning,model.*UserData,FUNC_DISABLE_KEYS) are outside LVGL and aren't affected.The content is what was reviewed in #7771, and the version history in the
@statuslines applies to 3.0 unchanged.Also included
79719040d0: switches a few luadoc@retvalfield bullets infstat,model.getInputandmodel.getSwashRingfrom straight single quotes ('trimSource') to the backtick style used everywhere else. It applied cleanly, and no single-quoted field bullets remain in main's Lua sources.Test plan
origin/2.12:radio/src/lua/api_colorlcd_lvgl.cpp🤖 Generated with Claude Code