As a matter of fact, I decided to take a hit and sorted the doclint warnings
out for my plugin last night. It only picked up a handful of issues, all of
which were trivial to fix. Admittedly, javadocs in my plugin were already in a
pretty good shape, because my IDEA keeps nagging me to fix them if I am sloppy.
So I'd say, let's fix doclint issues at the time of java6 migration. It is a
one-off effort, but ultimately for a good cause. And Bamboo jobs for Java 8
builds should include either javadoc or site goal to make sure that doclint
checks are part of CI process going forward.
Also, as part of the clean-up, I was able to delete the legacy mojo and plexus
taglet handlers from javadoc plugin configuration. There is no need for them
now, as everything is annotation-driven these days.
--
Sergei
>
>Tuesday, 10 February 2015 17:44 +0000 from Sergei Ivanov
><sergei_iva...@mail.ru>:
>Hi,
>I would argue for keeping the doclint turned on, even though I know it can
>cause a lot of pain. Unfortunately, doclint enforces an all-or-nothing
>approach, where one cannot suppress it for particular classes or methods.
>However, most (if not all) custom javadoc tags in maven world have already
>been replaced with annotations, therefore custom tags should not really be a
>issue. Custom tags will more likely appear in integration tests, not the unit
>tests. In the case of ITs, one can install a custom parent POM in the
>preparation phase of the invoker.
>Please note that javadoc versions from pre-java8 will not accept
>-Xdoclint:none as a parameter. Which means, you'll have to wrap the
>configuration below in a profile that only activates in java 8 or later.
>To summarise, I suggest that we disable doclint only in exceptional cases,
>when there's no other choice available. And we'll still need to figure out how
>to keep the builds portable between different JDK versions.
>--
>Sergei
>>
>>Monday, 9 February 2015 06:53 +0000 from Lennart Jörelid
>><lennart.jore...@gmail.com>:
>>Hello all,
>>While I'm not a huge fan of the rather extensive checks done by the Java 8
>>doclint, there are some nifty checks that it does to simplify all our lives.
>>However, in test scope, one would likely have the ability to use
>>non-compliant javadocs (for things such as testing custom tags in javadoc).
>>Could we - in our parent poms - configure the javadoc plugin with something
>>like:
>><plugins>
>><plugin>
>><groupId>org.apache.maven.plugins</groupId>
>><artifactId>maven-javadoc-plugin</artifactId>
>><configuration>
>><additionalparam>-Xdoclint:none</additionalparam>
>></configuration>
>></plugin>
>></plugins>
>>For the test-javadoc execution only?
>>--
>>--
>>+==============================+
>>| Bästa hälsningar,
>>| [sw. "Best regards"]
>>|
>>| Lennart Jörelid
>>| EAI Architect & Integrator
>>|
>>| jGuru Europe AB
>>| Mölnlycke - Kista
>>|
>>| Email: l...@jguru.se
>>| URL: www.jguru.se
>>| Phone
>>| (skype): jgurueurope
>>| (intl): +46 708 507 603
>>| (domestic): 0708 - 507 603
>>+==============================+
