tag:blogger.com,1999:blog-741750605858169835.post6822447049374135891..comments2024-01-24T14:53:02.919+00:00Comments on Stephen Colebourne's blog: Turning off doclint in JDK 8 JavadocStephen Colebournehttp://www.blogger.com/profile/01454237967846880639noreply@blogger.comBlogger40125tag:blogger.com,1999:blog-741750605858169835.post-88167613640463099012018-01-26T12:30:33.490+00:002018-01-26T12:30:33.490+00:00There is now a doclint property in the Maven plugi...There is now a doclint property in the Maven plugin.Stephen Colebournehttps://www.blogger.com/profile/01454237967846880639noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-48895658438717262022018-01-26T11:08:00.891+00:002018-01-26T11:08:00.891+00:00In addition to my previous comment: additionalpara...In addition to my previous comment: additionalparam replaced with additionalOptions (https://issues.apache.org/jira/browse/MJAVADOC-475), so the one just need to rename corresponding element in the scriptSergeynoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-13009088964695008142018-01-26T10:50:24.259+00:002018-01-26T10:50:24.259+00:00Unfortunately, it stopped worked with maven-javado...Unfortunately, it stopped worked with maven-javadoc-plugin:3.0.0 (org.apache.maven.plugins:maven-javadoc-plugin:3.0.0)Sergeynoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-16785912490852988092017-12-21T22:04:15.378+00:002017-12-21T22:04:15.378+00:00HTML5 still has captions on tables, so it isn'...HTML5 still has captions on tables, so it isn't like it would fix your broken tables anyway. The point of having captions is so that people without vision can get an overview of what's in the table without having to navigate all of it to figure that out. By turning off linting instead of fixing the issue, you are basically raising a middle finger to accessibility.Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-77765032705077249132017-09-28T21:05:22.606+01:002017-09-28T21:05:22.606+01:00Those problems you are referring to are warnings a...Those problems you are referring to are warnings and will not "fail" the build. What will fail the build are HTML and link issues. Which I agree should also be warnings.Anonymoushttps://www.blogger.com/profile/02183625729006292236noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-41607011426647709532016-11-30T21:16:56.581+00:002016-11-30T21:16:56.581+00:00Thanks for this...I've been writing Javadoc wi...Thanks for this...I've been writing Javadoc with embedded tables for years (since 2006). It is ridiculous to have to go back and fix all that pre-existing Javadoc. <br /><br />This all came to my attention when trying to use an XJC plugin in a Gradle build to generate code and build Javadoc which was working fine under JDK 1.7 and then failed in 1.8 <br /><br />Xdoclint:none to the rescue!<br /><br />It is silly though. HTML 4.01 is last century! HTML5 would be much better.Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-34013985829325673862016-10-12T02:12:37.260+01:002016-10-12T02:12:37.260+01:00I was able to maintain the former behavior in a ba...I was able to maintain the former behavior in a backwards-compatible way by using a Maven profile activated by the JDK version:<br /><br />http://www.hastebin.com/iqeyododaw.xml<br /><br />Tested on JDK 7 and JDK 8.Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-60805445193170550492016-10-03T13:30:16.886+01:002016-10-03T13:30:16.886+01:00In my team the contrary is true. Most our document...In my team the contrary is true. Most our documentation fails typically because we don't explain what we return or what the parameters are because we think them self-explanatory, or sometimes because we change the signature but forget to change the doc, etc; now, with a strict javadoc overseeing what we call "documentation", we are going to have to be more professional at thatAnonymoushttps://www.blogger.com/profile/12346152467032914216noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-34185685533017234642016-10-02T15:22:03.723+01:002016-10-02T15:22:03.723+01:00Very nice! I was struggling with the javadoc in m...Very nice! I was struggling with the javadoc in maven...tia, adymAnonymoushttps://www.blogger.com/profile/03895218831343927968noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-21997020849923664282016-08-26T10:24:40.933+01:002016-08-26T10:24:40.933+01:00Thank you Stephen Colebourne. It worked.Thank you Stephen Colebourne. It worked.Anonymoushttps://www.blogger.com/profile/09420079361164350098noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-67205489894232901112016-08-16T04:56:07.375+01:002016-08-16T04:56:07.375+01:00Isn't HTML4 a subset of HTML5?Isn't HTML4 a subset of HTML5?Unknownhttps://www.blogger.com/profile/15686538495254349818noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-73227026916246970342016-08-16T04:45:46.596+01:002016-08-16T04:45:46.596+01:00You shouldn't be running doclint against gener...You shouldn't be running doclint against generated classes anyway. Turn it off for that. Turn warnings off too - you don't get any benefits from those if you can't fix the code anyway.<br /><br />That said, JAXB does generate some of the worst code known to man, so I wish they would fix their shit too.<br /><br />But generated code aside, I think these checks are a perfectly good idea for running against code that you're creating yourself. We have found quite a bit of actual invalid markup being generated from ours just from using this tool. And I don't mean the old compiler used to fix it - it would dumbly output the content straight into the output HTML, and result in missing links and the like.<br /><br />So I think that in general people should turn as many checks on as possible. We run with all lint options turned on and doclint turned on as well.<br />Unknownhttps://www.blogger.com/profile/15686538495254349818noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-12559635028216136012016-04-18T19:32:38.123+01:002016-04-18T19:32:38.123+01:00It's pretty sad this is still not fixed :/ Any...It's pretty sad this is still not fixed :/ Any Jaxb generated classes break the javadoc linter in JDK8. Get your props together Oracle!schrepflerhttps://www.blogger.com/profile/11267562525453712517noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-31680716543251290532016-02-15T06:27:59.334+00:002016-02-15T06:27:59.334+00:00mvn javadoc:javadoc -Dadditionalparam=-Xdoclint:no...mvn javadoc:javadoc -Dadditionalparam=-Xdoclint:noneAnonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-21622969067472629602015-12-02T16:38:30.212+00:002015-12-02T16:38:30.212+00:00javadoc {
logging.captureStandardError LogLevel.I...javadoc {<br /> logging.captureStandardError LogLevel.INFO<br /> logging.captureStandardOutput LogLevel.INFO // suppress "## warnings" message<br />}Anonymoushttps://www.blogger.com/profile/16771621003412406946noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-16472522882717333952015-11-25T06:28:01.147+00:002015-11-25T06:28:01.147+00:00I dont see any restrictions to @default tags in ja...I dont see any restrictions to @default tags in java8. But my build fails saying AnnotationProcessing issue. Are there strict rules for it too, (@defaultpermissions)Ramyahttps://www.blogger.com/profile/04241772281729094626noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-4340178625875913692015-11-13T10:01:37.730+00:002015-11-13T10:01:37.730+00:00This is possible: http://asciidoctor.org/news/2013...This is possible: http://asciidoctor.org/news/2013/06/03/asciidoclet-announcement/Wim Deblauwehttps://www.blogger.com/profile/03337874063532092969noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-49719587442017562962015-08-06T00:00:32.878+01:002015-08-06T00:00:32.878+01:00Completely disable doclint is a bad advice. Javado...Completely disable doclint is a bad advice. Javadoc doclint can be configured to enable/disable some types of checks.<br />For example to disable all checks except html we can set additionalparam to <br />-Xdoclint:syntax -Xdoclint:missing -Xdoclint:accessibility -Xdoclint:reference -Xdoclint:syntax<br />http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.htmlturbanoffhttps://www.blogger.com/profile/09633147320771966932noreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-43253794331515320822015-07-28T02:48:13.423+01:002015-07-28T02:48:13.423+01:00+1. Never gonna happen though.+1. Never gonna happen though.Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-79484099108157893752015-04-27T12:12:49.402+01:002015-04-27T12:12:49.402+01:00I doesn't work for jdk7, but at least it works...I doesn't work for jdk7, but at least it works for jdk8Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-31867225618499893242014-11-27T10:12:57.659+00:002014-11-27T10:12:57.659+00:00Saved my day!Saved my day!Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-3208563744920859062014-11-07T10:29:03.169+00:002014-11-07T10:29:03.169+00:00See https://github.com/dropwizard/dropwizard/blob/...See https://github.com/dropwizard/dropwizard/blob/master/pom.xml#L247-L255<br />and https://github.com/dropwizard/dropwizard/blob/master/pom.xml#L367-L382<br /><br />for a backwards compatible way of doing this<br />Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-16674308192936641342014-09-15T20:12:59.878+01:002014-09-15T20:12:59.878+01:00Yup. Event OpenJDK 8 itself disables doclint for l...Yup. Event OpenJDK 8 itself disables doclint for large parts of the build :)<br /><br />http://mail.openjdk.java.net/pipermail/build-dev/2013-December/011435.htmlAnonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-71519247678513111912014-07-23T14:53:43.072+01:002014-07-23T14:53:43.072+01:00This! I like the idea of cleaning up our JavaDocs...This! I like the idea of cleaning up our JavaDocs, but I don't want to manually change auto-generated XJC Java files. Since I can't correctly fix the XJC generated Java files the whole thing feels pointless.Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-741750605858169835.post-81343464647228571762014-07-04T11:56:04.736+01:002014-07-04T11:56:04.736+01:00Also the wsimport tool from JDK8 generates code wh...Also the wsimport tool from JDK8 generates code which is not compatible with this new regime. It seems the tools in JDK8 package have not been tested for doclint compliance.Anonymousnoreply@blogger.com