"no comment" warning for non-public exception (was: Re: "no comment" warnings for non-public entities related to serialization)
Florian Weimer
fw at deneb.enyo.de
Wed Aug 5 17:02:02 UTC 2020
* Florian Weimer:
> * Jonathan Gibbons:
>
>> It would be surprising (bug?) to see a warning being generated for a
>> class that
>> is not being documented. I assume you have not given command-line options
>> to include that class in the documentation. I'm also guessing that this is
>> while using javadoc, where the recent change occurred; not javac.
>>
>> I can also try and recreate the issue, based on what you have said so far.
>
> I can reproduce the issue outside of my strange build environment, so
> it should be easy enough to produce a small reproducer. I'll see if I
> can get something to you by the end of the week.
I was able to reproduce it. Three files are needed:
# src/enyo.core/module-info.java
/**
* Documented.
*/
module enyo.core {
exports enyo.util;
}
# src/enyo.core/enyo/util/E.java
package enyo.util;
class E extends Exception {
}
# src/enyo.core/enyo/util/F.java
package enyo.util;
/**
* Documented.
*/
public class F extends Exception {
}
Then:
$ javadoc -quiet -d doc --module-source-path src --module enyo.core
src/enyo.core/enyo/util/E.java:3: warning: no comment
class E extends Exception {
^
1 warning
This is with a fairly current OpenJDK 16 build (60417:c13af6e1d11f, I think).
More information about the javadoc-dev
mailing list