Looking ahead: how to enable doclint checking when building java.* and javax.*

[Joe Darcy]

On 07/10/2013 02:13 PM, Jonathan Gibbons wrote:
> On 07/10/2013 06:38 PM, Joe Darcy wrote:
>> Hello,
>>
>> Over on core-libs-dev, there has been a sequence of bug fixes to 
>> cleanup doclint warnings and errors in the  java.* and javax.* areas 
>> in JDK 8. A few weeks ago, there were over 2,000 doclint issues; 
>> currently there are about 850 remaining and we're making good 
>> progress slogging through the rest.
>>
>> Looking ahead a few weeks when we may have the happy situation of 
>> zero doclint issues in JDK 8, I wanted to ask on build-dev how 
>> doclint warnings and errors can be enabled via the makefiles when 
>> building the java.* and javax.* sources and how doclint issues can be 
>> made fatal. (Making doclint issues fatal will help discourage them 
>> from creeping back in ;-)
>>
>> Thanks,
>>
>> -Joe
>
> javac has a -Xdoclint option, similar to -Xlint that can enable 
> warnings at compile time.  The hope is that engineers will enable that 
> in their compilation environment and fix doc comment errors at the 
> same time as their compilation errors.
>
>

Right; personally, I usually run doclint through javac vs. javadoc.

Just to be clear, once we get doclint-clean, the functionality I'd like 
to see in the JDK build of the java[x].* classes is:

* doclint gets run as part of compiling these types
* doclint errors are fatal
* doclint warnings are fatal too

-Joe