: I think the problem is that the HLL class, which is public, references the : ISchemaVersion interface in its public API, which is pkg-private? So : javadoc does not generate documentation for ISchemaVersion (since it is : pkg-private) but still builds links to it from HLL since it is referenced : in public methods?
yeah ... i missed that when looking at this example. Poking at a few other examples, it seems like similar problems throughout -- but why haven't these visibility errors triggered documentation-lint errors before today? It looks like the "trigger" that started causing the documentation-lint failures was erik creating a org/apache/solr/util package under solr-solrj (even though that package already existed under solr-core). If i revert 1715864 from branch_5x, documentation-lint passes because w/ that directory existing, the generated javadocs don't bother to try and create links for these package private classes, so there's no error from the link checker. (one exception is the DateFormatEvaluator -> DateMathParser linkage, which is a perfectly valid public -> public dependency, it's just thatwith thta extra directory javadoc gets confused about where to link to for that class and uses the wrong directory) Does anybody understand the javadoc link generation enough to understand why it isn't always trying to create links for these package private classes? is there a way we can force it to always create links so we can find API bugs like this with the link checker? (or an alternative static analysis tool we can use to find these bad API visibility bugs) (i'll open a jira to clean these up these specific ones now that we know about them) : : Le lun. 23 nov. 2015 à 19:36, Chris Hostetter <[email protected]> a : écrit : : : > : > I'm seeing the failures from documentation-lint on the 5x branch when : > running ant precommit (both using java7 and java8) ... see below. : > : > 1) is it my imagination of are the smokerelease jobs on jenkins not : > running documentation-lint? i don't see it in the logs... : > : > https://builds.apache.org/job/Lucene-Solr-SmokeRelease-5.x/lastBuild/consoleText : > : > 2) some of these broken links seem to be coming from links programatically : > generated by javadoc itself? : > : > example the auto-generated HTML for the "toBytes(ISchemaVersion)" method : > (in both the "Method Summary" table and "Method Detail" lists) on the : > HLL.html page has the broken link to : > : > ../../../../../../solr-solrj/org/apache/solr/util/hll.ISchemaVersion.html?is-external=true : > : > ? : > : > : > -Hoss : > http://www.lucidworks.com/ : > : > : > : > : > : > -documentation-lint: : > [jtidy] Checking for broken html (such as invalid tags)... : > [delete] Deleting directory : > /home/hossman/lucene/5x_dev/lucene/build/jtidy_tmp : > [echo] Checking for broken links... : > [exec] : > [exec] Crawl/parse... : > [exec] : > [exec] Verify... : > [exec] : > [exec] : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-core/org/apache/solr/util/SimplePostTool.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/SimplePostTool.GlobFileFilter.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/SimplePostTool.GlobFileFilter.html : > [exec] : > [exec] : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-core/org/apache/solr/util/ConcurrentLRUCache.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/ConcurrentLRUCache.CacheEntry.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/ConcurrentLRUCache.CacheEntry.html : > [exec] : > [exec] : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-dataimporthandler/org/apache/solr/handler/dataimport/DateFormatEvaluator.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/DateMathParser.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/DateMathParser.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/DateMathParser.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/DateMathParser.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/DateMathParser.html : > [exec] : > [exec] : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-core/org/apache/solr/util/ConcurrentLFUCache.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/ConcurrentLFUCache.CacheEntry.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/ConcurrentLFUCache.CacheEntry.html : > [exec] : > [exec] : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-core/org/apache/solr/util/hll/HLL.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/hll.ISchemaVersion.html : > [exec] BROKEN LINK: : > : > file:///home/hossman/lucene/5x_dev/solr/build/docs/solr-solrj/org/apache/solr/util/hll.ISchemaVersion.html : > [exec] : > [exec] Broken javadocs links were found! : > : > : > : > --------------------------------------------------------------------- : > To unsubscribe, e-mail: [email protected] : > For additional commands, e-mail: [email protected] : > : > : -Hoss http://www.lucidworks.com/
--------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
