Visitar URL original
Evaluate Javadoc executable code snippets · Issue #3978 · assertj/assertj · GitHub
Skip to content

Evaluate Javadoc executable code snippets #3978

Open

Description

@scordio

Code snippets are extensively used in the AssertJ Javadoc to showcase API usage, and in the past we had a few cases where such snippets were invalid.

Since we now build with Java 25, we could evaluate migrating the existing snippets to executable snippets. However, we should also check the interoperability of this with the Markdown syntax.

Activity

  1. added this to the 4.0.0-M3 milestone on Oct 17, 2025
  2. self-assigned this
    on Oct 17, 2025
  3. Marcono1234 commented on Feb 14, 2026

    @Marcono1234
    Contributor

    Using standard Javadoc {@snippet ... } will probably also improve the formatting of the code snippets. Currently there are issues with inconsistent space:

    • some snippets have a trailing space at the end of the last line where there is a space in front of </code></pre> / }</pre> (when opened with <pre>{@code )
    • some have a leading empty line when the <pre> is on a separate line
    • some have a trailing empty line when the </pre> is on a separate line
    • some have a leading whitespace for all lines due to JDK-8218722
  4. modified the milestones: 4.0.0-M3, 4.x on Jul 5, 2026
  5. modified the milestones: 4.x, 3.x on Jul 5, 2026
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