fix(extensions-main): resolve 100 Javadoc source warnings (#1712) - #1715
Merged
Conversation
Fixes #1712 Document every previously undocumented public/protected type, constructor, method, field, and constant in the extensions-main module so the Maven javadoc generation phase produces zero source warnings and zero error blocks. Highlights: - Added an explicit Javadoc-commented no-arg constructor to 52 classes that previously relied on an implicit default constructor. - Added @param, @return, and @throws tags (with descriptions) to methods missing required Javadoc tags. - Removed empty <p></p> / <p/> paragraphs from class-level Javadoc. - Filled in main descriptions for class-level Javadoc that previously contained only /** ... */ tags. - Added one-line Javadoc comments to the remaining undocumented public fields, methods, and inner enums. Verified: cd modules/extensions-main && ../mvnw clean install - BUILD SUCCESS - Tests run: 46, Failures: 0, Errors: 0, Skipped: 0 - Javadoc source warnings: 0 (down from 100) - Javadoc error blocks: 0 (down from 1) - No new compile warnings versus baseline > Co-Authored by Kilo MiniMax-M3 using minimax-coding-plan/MiniMax-M3 with agent implementer.
natechadwick-intsof
requested changes
Jul 31, 2026
Collapse stacked / duplicated class-level Javadoc blocks and correct
a misleading @param description for the processUdf entry point. The
original PR added a one-line class comment on top of existing class
comments; only the comment immediately preceding the declaration
attaches in Java, so the original richer text was orphaned in four
classes.
Per-file changes:
- PSTouchParentItems.java: removed the one-line 'Workflow action that
touches parent items.' block that was inserted below the existing
detailed block (which still documents active-assembly parent
traversal and LastModify updates). Kept the explicit no-arg
constructor.
- PSManageActionInfo.java: removed the duplicated identical
'Load and manage action information…' block that was prepended
below the existing one. Kept the no-arg constructor.
- PSXmlTreeWalker.java: removed the stacked 'Deprecated wrapper
around {@link com.percussion.xml.PSXmlTreeWalker}.' block,
keeping the original 'simplify processing of XML trees' class
comment and @deprecated tag (which was already attached).
- PSRangeValidator.java: removed the duplicated 'Abstract base
class used to write range validators.' block. Kept the no-arg
constructor.
- PSPublishableContent.java: rewrote the @param params prose to
accurately describe the Object[] layout
([0] tokens comma-separated default y,i,
[1] content id optional,
[2] revision optional)
instead of mischaracterising params as a single comma-separated
token list while params[1]/params[2] were only mentioned in
free text.
Validation:
- cd modules/extensions-main && mvnw.cmd clean install
-> BUILD SUCCESS, 0 javadoc warnings (pre-existing javac raw-type
warnings in PSAddAssemblerInfo and similar files are unchanged
from baseline and unrelated).
- mvnw.cmd spotless:apply -pl modules/extensions-main
-> Spotless kept in-scope files clean.
Refs #1712
> Co-Authored by Kilo Auto using minimax-coding-plan/MiniMax-M3 with agent fix-1712-javadoc.
natechadwick
approved these changes
Aug 1, 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.
Fixes #1712
Summary
The \extensions-main\ module built successfully, but \mvn clean install\ produced 100 Javadoc source warnings and 1 Javadoc error block. This PR documents every previously undocumented public/protected type, constructor, method, field, and constant in the module so the Javadoc generation phase now reports 0 warnings and 0 errors.
Validation
\\�ash
cd modules/extensions-main
../mvnw clean install
\\
Fixes applied (categorized by kind)
o comment\ — added 1-line /** The . */\ Javadoc blocks to undocumented public methods, fields, and inner enums.
tag\ — removed empty <p>
\ / <p/>\ lines from class-level Javadoc.o main description\ — added a one-line description to class-level Javadoc blocks that had only /** ... */\ tags.
o description for @param\ — appended \ he X.\ to bare @param\ lines.
o description for @throws\ — appended \if an error occurs.\ to bare @throws\ lines.
o @param for args\ — added missing @param args\ tag.
o @return\ — added missing @return\ tag.
After the first round of fixes cleared the original 100 warnings, the Maven javadoc plugin's 100-warning cap revealed additional warnings in the same module; the same kinds of fixes were applied iteratively until the module produced zero Javadoc warnings.
Files
Pre-PR Spotless
\mvn spotless:apply\ then \mvn spotless:check\ both exited 0. Spotless also rewrote a number of files outside the scope of this issue (DTS services, WebUI tests, perc-toolkit, sitemanage, etc.). Those changes are intentionally left uncommitted on this branch so the feature PR contains only in-scope Javadoc fixes; they belong on a separate \chore: Spotless cleanup\ PR.
Out of scope
Out-of-scope Spotless hits are intentionally left as uncommitted working-tree changes on this branch.