Skip to content

Javadoc Technical Debt - #1476

Merged
scottf merged 5 commits into
mainfrom
much-javadoc
Nov 10, 2025
Merged

scottf merged 5 commits into
mainfrom
much-javadoc

Conversation

@scottf

@scottf scottf commented Nov 9, 2025 •

Copy link
Copy Markdown
Contributor

NO FUNCTIONAL CODE WAS CHANGED. ALL CHANGES ARE STRICTLY API DOCUMENTATION.

While cleaning gradle and considering moving to Java 21 for building (still will target Java 8, but also may target Java 17 and Java 21 in separate jars), new versions of Javadoc are more particular about javadoc warnings.

• One of the most common was

/**
 * @return the foo
 */
public String getFoo() { ... }

Which requires change to include a description other than the return

/**
 * Get the foo
 * @return the foo
 */
public String getFoo() { ... }

• Another common one was constants did not have javadoc comments. It seemed redundant when well named.

• Another was objects with only no-parameter constructors, so in reality had no constructor code. Javadoc didn't like this so no-parameter constructors were made and javadoc'ed

• There were some legitimate missing api, but almost entirely self documenting setters and getters.

@scottf
scottf requested a review from MauriceVanVeen November 9, 2025 16:32
@scottf
scottf removed the request for review from MauriceVanVeen November 9, 2025 23:19
void protocol(String op, String text);

/**
* Called when the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing part of the doc

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixing

@scottf
scottf merged commit 71d1862 into main Nov 10, 2025
4 checks passed
@scottf
scottf deleted the much-javadoc branch November 10, 2025 14:25
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.

2 participants