RFE for doclint

[Jonathan Gibbons]

On 10/28/2013 10:56 AM, Sergey Bylokhov wrote:
> Hello.
> I have a question about additional feature in doclint:
>  - Do we have a plan to deprecate @exception? Probably doclint can 
> highlight it?
>  - In our documentation we have inconsistent code for code snippets. 
> Sometimes we have two empty lines after the code[1], or one line[2] or 
> both cases[3]. It depend how <pre> tag is closed, but is it possible 
> to highlight this by the doclint to unify them? Do we have a good 
> example how it should look?
>
> [1] http://docs.oracle.com/javase/6/docs/api/java/lang/String.html
> [2] 
> http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html#clone%28%29
> [3] http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html
>

There are no plans to deprecate @exception at this point, but I think it 
would be an excellent task for someone to run find/grep over the repos 
to find and cleanup inconsistent use of @throws and @exception

Currently, doclint is primarily focussed on reporting issues that give 
rise to issues in the generated HTML, such as those reported by the 
standard "tidy" program. I note all your examples are for Java 6. Do you 
have any examples of bad output in the latest JDK 8 docs?

-- Jon