Qu: JDK-8247901, Multiple conflicting @return for FlightRecorderMXBean

[David Holmes]

Hi Jon,

Redirecting to hotspot-jfr-dev

Cheers,
David

On 19/06/2020 12:45 pm, Jonathan Gibbons wrote:
> I have filed JDK-8247901, to cover an issue detected by doclint, regarding
> two conflicting @return descriptions for a single method.
> 
> I can make the fix, if you want, but I need confirmation of which one 
> should
> be deleted and which should be retained.  I can make an informed guess
> (one of them refers to `null` in the context of a `long` return code!)
> but I would prefer that someone with domain-specific knowledge make the 
> call.
> 
> -- Jon
> 
> JBS: https://bugs.openjdk.java.net/browse/JDK-8247901
> 
> Here, if it helps, is the description from the bug:
> 
> doclint reports:
> open/src/jdk.management.jfr/share/classes/jdk/management/jfr/FlightRecorderMXBean.java:213: 
> warning: @return has already been specified
>       * @return a unique ID that can be used for reading recording data.
>         ^
> 1 warning
> 
> The source shows:
>       * @return a snapshot of all available recording data, not {@code 
> null}
>       *
>       * @throws java.lang.SecurityException if a security manager exists 
> and the
>       *         caller does not have {@code 
> ManagementPermission("control")}
>       *
>       * @return a unique ID that can be used for reading recording data.
> 
>