Repository navigation
Fixes #5687 : Generate the configuration perspective option tables fr… - #8706
Merged
Merged
Conversation
…les from the plugins The Plugins section of the configuration perspective is now documented from the @ConfigPlugin and @GuiWidgetElement annotations it is built from: 14 plugins, 84 options. A new config-doc module reads the Jandex indexes the build already writes and instantiates each plugin's configClass, so 70 of the 84 defaults are the values the code really uses rather than a copy. The other 14 carry a defaultValue on the annotation, guarded by tests that check each one against what actually loads. It runs as part of a normal build, so changing an option updates the page describing it, and a CI check fails a pull request whose generated pages no longer match the code. Releases skip it: what is committed has already been checked on merge. Also fills in 13 options that had no tooltip in the GUI, and rewrites the General and Look & Feel sections, which had four options that no longer exist, five filed under the wrong tab, and around 30 undocumented. Fixes the welcome dialog option, which read and wrote 'do not show' straight into a checkbox labelled 'show', so ticking it hid the dialog.
mattcasters
reviewed
Oct 1, 2026
mattcasters
left a comment
Contributor
There was a problem hiding this comment.
minor bug. Would merge it as is TBH.
Contributor
Author
|
Thanks Matt, all five addressed:
|
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.
…om the plugins
The Plugins section of the configuration perspective is now documented from the @ConfigPlugin and @GuiWidgetElement annotations it is built from: 14 plugins, 84 options. A new config-doc module reads the Jandex indexes the build already writes and instantiates each plugin's configClass, so 70 of the 84 defaults are the values the code really uses rather than a copy. The other 14 carry a defaultValue on the annotation, guarded by tests that check each one against what actually loads.
It runs as part of a normal build, so changing an option updates the page describing it, and a CI check fails a pull request whose generated pages no longer match the code. Releases skip it: what is committed has already been checked on merge.
Also fills in 13 options that had no tooltip in the GUI, and rewrites the General and Look & Feel sections, which had four options that no longer exist, five filed under the wrong tab, and around 30 undocumented.
Fixes the welcome dialog option, which read and wrote 'do not show' straight into a checkbox labelled 'show', so ticking it hid the dialog.
Please add a meaningful description for your change here
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean install apache-rat:checkto make sure basic checks pass. A more thorough check will be performed on your pull request automatically.git rebase -i.addresses #123), if applicable.To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.