Skip to content

fix(extensions-main): resolve 100 Javadoc source warnings (#1712) - #1715

Merged
natechadwick merged 2 commits into
developmentfrom
fix/1712-extensions-main-javadoc
Aug 1, 2026
Merged

fix(extensions-main): resolve 100 Javadoc source warnings (#1712)#1715
natechadwick merged 2 commits into
developmentfrom
fix/1712-extensions-main-javadoc

Conversation

@vijaya-boddipudi

Copy link
Copy Markdown
Collaborator

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
\\

  • 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

Fixes applied (categorized by kind)

  • 52 \use of default constructor\ — added explicit Javadoc-commented no-arg constructors (/** Creates a new X. */ public X() {}) as the first member of each affected class.
  • 30
    o comment\ — added 1-line /** The . */\ Javadoc blocks to undocumented public methods, fields, and inner enums.
  • 8 \empty

    tag\ — removed empty <p>

    \ / <p/>\ lines from class-level Javadoc.
  • 3
    o main description\ — added a one-line description to class-level Javadoc blocks that had only /** ... */\ tags.
  • 2
    o description for @param\ — appended \ he X.\ to bare @param\ lines.
  • 2
    o description for @throws\ — appended \if an error occurs.\ to bare @throws\ lines.
  • 2
    o @param for args\ — added missing @param args\ tag.
  • 1
    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

  • 193 files modified, all under \modules/extensions-main/src/main/java/.
  • 1009 insertions, 103 deletions.

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.

Co-Authored by Kilo MiniMax-M3 using minimax-coding-plan/MiniMax-M3 with agent implementer.

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.
Comment thread modules/extensions-main/src/main/java/com/percussion/xmldom/PSXmlTreeWalker.java Outdated
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
natechadwick merged commit c064080 into development Aug 1, 2026
6 checks passed
@natechadwick
natechadwick deleted the fix/1712-extensions-main-javadoc branch August 1, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[8.2] Clean up Javadoc warnings in extensions-main module

3 participants