Opened 9 years ago

Closed 9 years ago

#1940 closed enhancement (fixed)

Fix javadoc warnings

Reported by: Nicklas Nordborg Owned by: Nicklas Nordborg
Priority: minor Milestone: BASE 3.6
Component: documentation Version:
Keywords: Cc:

Description

The javadoc tool in Java 8 generate a lot of warnings and error messages by default. It was turned off in [6866] to just get everything to compile (see comment:5:ticket:1926).

I don't know if it is worth trying to fix all issues, but maybe some of them. For more information see the -Xdoclint parameter for the javadoc documentation ​http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#BEJEFABE

Change History (6)

comment:1 by Nicklas Nordborg, 9 years ago

Owner: changed from everyone to Nicklas Nordborg
Status: new → assigned

comment:2 by Nicklas Nordborg, 9 years ago

(In [6881]) References #1940: Fix javadoc warnings

Enabled Xdoclint=html,accessibility and fixed all warnings from those. Most due to unclosed html tags and other similar mistakes.

comment:3 by Nicklas Nordborg, 9 years ago

Xdoclint=missing gives up after finding 100 warnings in a handful of files. I guess there will be several thousands so it is not something that we are going to fix now.

comment:4 by Nicklas Nordborg, 9 years ago

(In [6897]) References #1940: Fix javadoc warnings

Added Xdoclint:reference and fixed a few warnings.

comment:5 by Nicklas Nordborg, 9 years ago

(In [6898]) References #1940: Fix javadoc warnings

Added Xdoclint:syntax and fixed all warnings/errors emitted by it.

This means that everything except missing checks are fixed.

comment:6 by Nicklas Nordborg, 9 years ago

Resolution: → fixed
Status: assigned → closed

The javadoc now builds without warnings or errors using -Xdoclint:all,-missing.

Note: See TracTickets for help on using tickets.