Skip to content

Fix @param name in the private POP3MessageInfo constructor - #408

Open
hxperl wants to merge 1 commit into
apache:masterfrom
hxperl:javadoc-pop3messageinfo-param-size
Open

hxperl wants to merge 1 commit into
apache:masterfrom
hxperl:javadoc-pop3messageinfo-param-size

Conversation

@hxperl

@hxperl hxperl commented Sep 15, 2026

Copy link
Copy Markdown

The three-arg POP3MessageInfo constructor documents @param octets, but the parameter is size. The name came from the public two-arg constructor above it, which really does take octets.

$ javadoc -Xdoclint:reference -private -d /tmp/out \
    src/main/java/org/apache/commons/net/pop3/POP3MessageInfo.java
POP3MessageInfo.java:81: error: @param name not found
     * @param octets The size.
              ^

Renames the tag to size; three trailing spaces keep the description column aligned. Clean after the change.

Limits: the constructor is private, so this does not affect the published API docs — it only shows under -private. mvn javadoc:javadoc and mvn test both pass on macOS arm64, JDK 17 (632 tests, 0 failures).

  • I used AI to create any part of, or all of, this pull request. Written with Claude Code (Claude Opus 5); it found the mismatch, made the one-line edit, and ran the build.

The tag reads @PARAM octets, but the parameter is size, so
javadoc -Xdoclint:reference reports "@PARAM name not found".

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011e7REh3NDrdszg2xJdd5Qy
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.

1 participant