[THRIFT-5485] @SuppressWarnings is placed above Javadoc

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.15.0
• Fix Version/s: 0.17.0
• Component/s: Java - Compiler
• Assignee: Liu Jiayu
• Reporter: Marcono1234
• Created: 02/Dec/21 21:05
• Updated: 26/Oct/22 23:46
• Resolved: 19/Apr/22 09:43

Description

The Java compiler places in multiple situations the @SuppressWarnings annotation above the Javadoc (see usage of java_suppressions in t_java_generator.cc), example:

@SuppressWarnings({"cast", "rawtypes", "serial", "unchecked", "unused"})
/**
 * Structs can also be exceptions, if they are nasty.
 */
@javax.annotation.Generated(value = "Autogenerated by Thrift Compiler (0.15.0)", date = "...")
public class InvalidOperation extends org.apache.thrift.TException ... {
    ...
}

At least for the javadoc command line tool and IntelliJ IDEA this prevent the Javadoc from being recognized.
The Thrift Java compiler should place the @SuppressWarnings annotation below the Javadoc.

As side note: It would also be good to change the autogen_comment (see t_generator.h) to a regular Java block comment (/* ... */). Currently it is a 'dangling' Javadoc comment (/** ... */). Apparently this does not affect the javadoc tool negatively, but it would be best not to rely on that.

Issue Links

• links to: GitHub Pull Request #2573