Skip to content

Spotless messes up <pre>{@code ...}</pre> in Javadoc #195

Description

@Zabuzard

The idiomatic

/** * ... * <pre> * {@code * ... * } * </pre> */

which is used in code examples in Javadoc, gets messed up by Spotless (or something else?). It replaces all occurences of @ by &#64;. Which, in general, is good, for example for @Override and other annotations that are actually part of the code.

But since @code is a Javadoc-meta-annotation, it should not be converted.

Otherwise it messes up the rendering, as seen here:
in code
rendered

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationinactivity-closedIssues that have been closed due to inactivity, but are otherwise valid and might be reopened laterpriority: normalstale

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions