[ImageJ-devel] mvn javadoc problem with java 8

[Curtis Rueden]

Hi Dscho,

> Curtis, you forgot to say that the `#getSource(long)` probably needs
> to be replaced by a `#getSource(int, int)` because the class has only
> a `getSource` method with the latter signature.

Yeah, my reply's first draft basically said "just fix the invalid javadoc".
Then I actually tried compiling with Java 8 and looked at what would need
to be fixed. Over 100 errors, due to things like missing @param and @return
and @throws. Fixing all of those things would actually be quite involved,
especially across all 200+ repositories, so I begin to see the wisdom of
working around it for now.

> But I agree that Javadocs that are obviously wrong should be fixed
> rather than switching off Javadoc generation in the Maven
> configuration.

Right, we definitely do not want to switch of javadoc generation. However,
there is another way: <additionalparams>-D:doclint:none</additionalparams>.
But it would need to go in a Java-8-specific profile. And again, I am
ambivalent about doing it because in the long term, especially after we
fully switch over to Java 8 some day, I would not want those checks
disabled by default.

Regards,
Curtis

On Wed, Feb 11, 2015 at 10:36 AM, Johannes Schindelin <
johannes.schindelin at gmx.de> wrote:

> Hi Curtis,
>
> On 2015-02-11 17:31, Curtis Rueden wrote:
>
>  I get the following errors when running with java 8
>>> ...
>>>
>>> Works fine with java 7 and java 6.
>>>
>>> Is this a known problem?
>>>
>>
>> Java 8's javadoc tool is much more stringent than previously, due to the
>> addition of doclint checks [1].
>>
>
> Curtis, you forgot to say that the `#getSource(long)` probably needs to be
> replaced by a `#getSource(int, int)` because the class has only a
> `getSource` method with the latter signature.
>
> But I agree that Javadocs that are obviously wrong should be fixed rather
> than switching off Javadoc generation in the Maven configuration.
>
> Ciao,
> Dscho
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://imagej.net/pipermail/imagej-devel/attachments/20150211/ba20cd2b/attachment.html>