Eclipse Community Forums: Java Development Tools (JDT) » Formatting of new {@return ...} javadoc breaks with inner @link

Home » Language IDEs » Java Development Tools (JDT) » Formatting of new {@return ...} javadoc breaks with inner @link(Error in the Javadoc formatter)

Mon, 04 September 2023 13:19

Messages: 2
Registered: July 2009

Junior Member

Since Java 16, there's the option to avoid duplication and instead of

/**
 * Returns a Foo.
 * @return a Foo
 */
Foo getFoo()

writing

/**
 * {@return a Foo}
 */
Foo getFoo()

This works fine in Eclipse. But when I use other Javadoc tags inside of the @return tag, the formatting in Eclipse fails:

/**
 * {@return a {@link Foo} for the bar}
 */
Foo getFoo()

gets displayed as

Returns . a _Foo_ for the bar}

Returns:

I assume a bug in Eclipse here, as the generated Javadoc HTML from a Maven build looks as expected.

Tue, 05 September 2023 05:43

Messages: 33264
Registered: July 2009

Senior Member

Ed Merks
Professional Support: https://www.macromodeling.com/

Tue, 05 September 2023 05:57

Messages: 2
Registered: July 2009

Junior Member

I didn't find the right bugtracker before, thanks. I amended https://github.com/eclipse-jdt/eclipse.jdt.core/issues/1026

Previous Topic:	Java 21 Support for Eclipse
Next Topic:	Java Multithreading: How to Synchronize Threads for Concurrent Access

Goto Forum:

]

Current Time: Wed Jan 15 07:07:27 GMT 2025

.:: Contact :: Home ::.

Sign up to our Newsletter