I think what Uwe meant to say is that it's not a technical error but a logical one: why would you want to expose an internal (package private) class in a public JavaDoc if nobody should be able to use it?
Dawid On Mon, Jan 7, 2013 at 1:01 PM, Shai Erera <[email protected]> wrote: > It was helpful in this case, but I was referring to when you put a {@link > PackagePrivateClass} in javadocs. That's allowed, the generated jdocs don't > include any link, just 'PackagePrivateClass' text. > However, documentation-lint will fail in that case. > > Shai > > > On Mon, Jan 7, 2013 at 1:44 PM, Uwe Schindler <[email protected]> wrote: >> >> I think the warning may be misleading in that case. But an API the >> returns/wants package private classes is broken and needs fixing – because >> nobody can ever call this class through the public API (because the symbols >> are unknown to the compiler). In your case the fix was to hide the >> CategoryPathUtils class, too. So the error was helpful in this case! >> >> >> >> ----- >> >> Uwe Schindler >> >> H.-H.-Meier-Allee 63, D-28213 Bremen >> >> http://www.thetaphi.de >> >> eMail: [email protected] >> >> >> >> From: Shai Erera [mailto:[email protected]] >> Sent: Monday, January 07, 2013 7:39 AM >> To: [email protected] >> Subject: Re: [JENKINS] Lucene-Solr-trunk-MacOSX (64bit/jdk1.7.0) - Build # >> 58 - Failure! >> >> >> >> I don't like this failure. CategoryPathUtils contains some {@link >> CharBlockArray} mentions, while the latter is package-private. When I run >> 'ant javadocs' the generated javadocs just include the text CharBlockArray >> with no link. I don't think that's a true error? >> >> Anyway, this made me think that CategoryPathUtils should be >> package-private itself, since its API relies on package-private API, so I >> committed that change. >> >> I hope that documentation-lint will be happier now. >> >> But in general I think that this failure was a false positive. We should >> be allowed to put such links in jdocs - the generated jdocs don't display >> them as links, so end-user wise there's no problem. >> >> Shai >> >> >> >> On Mon, Jan 7, 2013 at 7:57 AM, Policeman Jenkins Server >> <[email protected]> wrote: >> >> Build: http://jenkins.thetaphi.de/job/Lucene-Solr-trunk-MacOSX/58/ >> Java: 64bit/jdk1.7.0 -XX:+UseConcMarkSweepGC >> >> All tests passed >> >> Build Log: >> [...truncated 25815 lines...] >> -documentation-lint: >> [echo] checking for broken html... >> [jtidy] Checking for broken html (such as invalid tags)... >> [delete] Deleting directory >> /Users/jenkins/jenkins-slave/workspace/Lucene-Solr-trunk-MacOSX/lucene/build/jtidy_tmp >> [echo] Checking for broken links... >> [exec] >> [exec] Crawl/parse... >> [exec] >> [exec] Verify... >> [exec] >> [exec] >> file:///build/docs/facet/org/apache/lucene/facet/taxonomy/class-use/CategoryPath.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] >> [exec] >> file:///build/docs/facet/org/apache/lucene/facet/taxonomy/writercache/cl2o/CategoryPathUtils.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] BROKEN LINK: >> file:///build/docs/core/org/apache/lucene/facet.taxonomy.writercache.cl2o.CharBlockArray.html >> [exec] >> [exec] Broken javadocs links were found! >> >> BUILD FAILED >> >> /Users/jenkins/jenkins-slave/workspace/Lucene-Solr-trunk-MacOSX/build.xml:60: >> The following error occurred while executing this line: >> >> /Users/jenkins/jenkins-slave/workspace/Lucene-Solr-trunk-MacOSX/lucene/build.xml:242: >> The following error occurred while executing this line: >> >> /Users/jenkins/jenkins-slave/workspace/Lucene-Solr-trunk-MacOSX/lucene/common-build.xml:1961: >> exec returned: 1 >> >> Total time: 81 minutes 29 seconds >> Build step 'Invoke Ant' marked build as failure >> Archiving artifacts >> Recording test results >> Description set: Java: 64bit/jdk1.7.0 -XX:+UseConcMarkSweepGC >> Email was triggered for: Failure >> Sending email for trigger: Failure >> >> >> >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: [email protected] >> For additional commands, e-mail: [email protected] >> >> > > --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
