Skip to content

Evaluate Javadoc migration to Markdown #3977

Description

@scordio

AssertJ extensively uses Javadoc to showcase API usage, which can sometimes become a bit complex to maintain.

Since we now build with Java 25, we could evaluate migrating to Markdown and have a more readable syntax, especially for lists and code snippets.

As we use the Eclipse formatter, we might need to wait for upstream support:

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions