Migrate to Markdown Javadoc for `assertj-guava` by scordio · Pull Request #4298 · assertj/assertj

scordio · 2026-06-21T15:58:33Z

This migrates the assertj-guava Javadoc to the Markdown syntax.

Relates to:

Evaluate Javadoc migration to Markdown #3977

Blocked by:

[Formatter] Blank /// Markdown line in code block merged with next line into /// /// eclipse-jdt/eclipse.jdt.core#5220

Copilot

Pull request overview

This pull request migrates assertj-guava’s Java API documentation from traditional Javadoc block comments to Markdown documentation comments, improving readability and maintainability (especially for examples and inline formatting) in line with the Java 25 toolchain.

Changes:

Converted Javadoc block comments (/** ... */) to Markdown documentation comments (/// ...) across assertj-guava API and error-message classes.
Reworked examples into fenced Markdown code blocks and replaced inline {@link ...} constructs with Markdown-style references.
Cleaned up some doc-adjacent code (e.g., removed now-unneeded imports where links were moved/rewritten).

Reviewed changes

Copilot reviewed 38 out of 38 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
assertj-guava/src/main/java/org/assertj/guava/util/ExceptionUtils.java	Converted method/ctor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/TableShouldHaveRowCount.java	Converted factory method Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/TableShouldHaveColumnCount.java	Converted factory method Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/TableShouldContainRows.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/TableShouldContainColumns.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/TableShouldContainCell.java	Converted factory method Javadoc (incl. type params) to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/ShouldHaveSize.java	Converted class and factory method Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/ShouldContainValues.java	Converted class Javadoc to Markdown doc comments; adjusted TODO reference.
assertj-guava/src/main/java/org/assertj/guava/error/ShouldContainKeys.java	Converted class and factory method Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeShouldHaveUpperEndpointEqual.java	Converted constructor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeShouldHaveLowerEndpointEqual.java	Converted constructor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeShouldBeOpenedInTheUpperBound.java	Converted constructor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeShouldBeOpenedInTheLowerBound.java	Converted constructor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeShouldBeClosedInTheUpperBound.java	Converted constructor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeShouldBeClosedInTheLowerBound.java	Converted constructor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeSetShouldNotIntersect.java	Converted class/ctor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeSetShouldNotEnclose.java	Converted class/ctor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeSetShouldIntersectAnyOf.java	Converted class/ctor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeSetShouldIntersect.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeSetShouldEncloseAnyOf.java	Converted class/ctor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/RangeSetShouldEnclose.java	Converted class/ctor Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/OptionalShouldBePresentWithValue.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/OptionalShouldBePresent.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/OptionalShouldBeAbsent.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/MultisetShouldContainTimes.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/MultisetShouldContainAtMostTimes.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/error/MultisetShouldContainAtLeastTimes.java	Converted class Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/data/MapEntry.java	Converted class and factory method Javadoc to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/api/TableAssert.java	Converted method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/RangeSetAssert.java	Converted extensive method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/RangeMapAssert.java	Converted class/method Javadocs (incl. deprecation docs) to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/RangeAssert.java	Converted method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/OptionalAssert.java	Converted class/method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/MultisetAssert.java	Converted method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/MultimapAssert.java	Converted method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/InstanceOfAssertFactories.java	Converted interface/field/method Javadocs to Markdown doc comments.
assertj-guava/src/main/java/org/assertj/guava/api/ByteSourceAssert.java	Converted method Javadocs to Markdown doc comments and fenced examples.
assertj-guava/src/main/java/org/assertj/guava/api/Assertions.java	Converted class and utility method Javadocs to Markdown doc comments and fenced examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 7 comments.

scordio · 2026-07-05T22:53:35Z

Switching to draft as there is something wrong with Spotless that I need to analyze.

scordio · 2026-07-24T13:31:32Z

Switching to draft as there is something wrong with Spotless that I need to analyze.

This is likely an Eclipse formatter bug, reported at:

[Formatter] Blank /// Markdown line in code block merged with next line into /// /// eclipse-jdt/eclipse.jdt.core#5220

./mvnw -f assertj-guava/pom.xml -U org.openrewrite.maven:rewrite-maven-plugin:run --define rewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-migrate-java:RELEASE --define rewrite.activeRecipes=org.openrewrite.java.migrate.lang.JavadocToMarkdownDocComment --define rewrite.exportDatatables=true

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

testlens-app · 2026-09-18T15:30:24Z

🚨 All tests passed but jobs failed 🚨

Failed Jobs without Test Failures

❌ CI / Java 25 (macOS-latest)
❌ CI / Java 25 (ubuntu-latest)
❌ CI / Java 25 (windows-latest)
❌ CI / Java 26
❌ CI / Java 27
❌ CI / Java 28

🏷️ Commit: 56c77ef
▶️ Tests: 40409 executed
⚪️ Checks: 19/19 completed

Learn more about TestLens at testlens.app/docs.

github-actions · 2026-09-18T15:33:51Z

Looks good. No mutations were possible for these changes.
See https://pitest.org/

scordio added this to the 3.x milestone Jun 21, 2026

scordio mentioned this pull request Jun 21, 2026

Convert Javadoc to Markdown on assertj-tests modules #4295

Open

scordio force-pushed the guava-javadoc-markdown branch 2 times, most recently from b464516 to 56a1296 Compare June 23, 2026 18:44

scordio force-pushed the guava-javadoc-markdown branch 3 times, most recently from a27e038 to ce39f1f Compare July 1, 2026 21:45

scordio marked this pull request as ready for review July 1, 2026 21:55

scordio requested a review from Copilot July 1, 2026 21:55

Copilot started reviewing on behalf of scordio July 1, 2026 21:56 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

scordio requested a review from Copilot July 3, 2026 00:07

Copilot started reviewing on behalf of scordio July 3, 2026 00:08 View session

Copilot AI reviewed Jul 3, 2026

View reviewed changes

scordio force-pushed the guava-javadoc-markdown branch from 9454980 to 7f1b8e4 Compare July 5, 2026 08:37

scordio mentioned this pull request Jul 5, 2026

Fix javadoc warnings #4211

Closed

scordio force-pushed the guava-javadoc-markdown branch 2 times, most recently from 0a7cb33 to 495c562 Compare July 5, 2026 22:52

scordio marked this pull request as draft July 5, 2026 22:53

scordio mentioned this pull request Jul 24, 2026

[Formatter] Blank /// Markdown line in code block merged with next line into /// /// eclipse-jdt/eclipse.jdt.core#5220

Closed

scordio force-pushed the guava-javadoc-markdown branch from 495c562 to 51bea58 Compare July 24, 2026 13:33

scordio force-pushed the 3.x branch from 39a6003 to 561c429 Compare August 26, 2026 22:09

scordio force-pushed the guava-javadoc-markdown branch from 9f0478e to 9d19d6b Compare September 13, 2026 08:52

scordio and others added 5 commits September 18, 2026 17:29

Polish

08e4955

Apply suggestions from code review

46845c9

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Add AGENTS.md

856b763

Cleanup

989ab99

scordio added 3 commits September 18, 2026 17:29

Pin Eclipse formatter version

6f1d804

Cleanup

dd24580

Upgrade Spotless to 3.10.2 and Eclipse formatter to 4.41

56c77ef

scordio force-pushed the guava-javadoc-markdown branch from 9d19d6b to 56c77ef Compare September 18, 2026 15:29

Uh oh!

Conversation

scordio commented Jun 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

scordio commented Jul 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

scordio commented Jul 24, 2026

Uh oh!

testlens-app Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 All tests passed but jobs failed 🚨

Failed Jobs without Test Failures

Uh oh!

github-actions Bot commented Sep 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

scordio commented Jun 21, 2026 •

edited

Loading

scordio commented Jul 5, 2026 •

edited

Loading

testlens-app Bot commented Sep 18, 2026 •

edited

Loading