You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "hxperl (via GitHub)" <gi...@apache.org> on 2026/09/15 01:44:39 UTC

[PR] Name the parameter the RandomStringGenerator constructor actually takes [commons-text]

hxperl opened a new pull request, #771:
URL: https://github.com/apache/commons-text/pull/771

   `RandomStringGenerator`'s private constructor was changed to take a `Builder`, but the old five-parameter javadoc was left on it. `javadoc -Xdoclint:reference -private` on current master:
   
   ```
   RandomStringGenerator.java:396: error: @param name not found
        * @param minimumCodePoint    smallest allowed code point (inclusive).
                 ^
   ... 5 errors, all on this constructor
   ```
   
   Those five are the only doclint `@param` errors in the module. Nothing is lost by dropping them: each is already documented on the `Builder` setter that sets it (`setWithinRange`, `filteredBy`, `usingRandom`, `selectFrom`). Replaced with `@param builder The builder.`, matching commons-io (`BOMInputStream`, `QueueInputStream`). After the change doclint reports 0.
   
   `mvn test` green on JDK 17 / macOS arm64: 1989 tests, 0 failures, 0 errors, 2 skipped.
   
   - [x] Contribution guidelines; [x] ASF Generative Tooling Guidance.
   - [x] I used AI for part of this PR: Claude Code flagged the constructor with a script comparing `@param` names against signatures. I confirmed it with `javadoc -Xdoclint`, chose the wording, and verified the build.
   - [ ] Unit tests: none, javadoc-only change with no runtime behaviour.
   
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   
   https://claude.ai/code/session_01WZdW1VZpdhcpg3c5iFioSr
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org