lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <>
Subject [jira] [Commented] (LUCENE-4011) Check for broken documentation links in hudson
Date Mon, 23 Apr 2012 14:51:33 GMT


Robert Muir commented on LUCENE-4011:

The last solr broken link (on java7, on java6, there are more)
seems to be a bug in javadocs?

     [exec] build/docs/api/constant-values.html
     [exec]   BROKEN ANCHOR: build/docs/api/org/apache/solr/client/solrj/beans/Field.html#DEFAULT
     [exec] build/docs/api/solrj/constant-values.html
     [exec]   BROKEN ANCHOR: build/docs/api/solrj/org/apache/solr/client/solrj/beans/Field.html#DEFAULT

The problem is that this Field is an annotation with a 'public static final String DEFAULT',
and javadocs doesn't generate any documentation for this constant in Field.html itself,
but refers to it elsewhere.

I think we can exclude this one in the checker since its not our fault... unless I am missing
> Check for broken documentation links in hudson
> ----------------------------------------------
>                 Key: LUCENE-4011
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Task
>          Components: general/javadocs
>            Reporter: Robert Muir
>             Fix For: 4.0
>         Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch,
> Mike added a cool script to dev-tools ( that checks 
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
>   for example you can do this:
>   {noformat}
>   {@link java.lang.JavaDocsSucks}
>   {noformat}
>   and nothing will ever give you any warning: just a broken link. thats because javadocs
>   external linking is fundamentally package-driven, broken by design for compile-time
>   verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't
> * this checker finds real API bugs that javadocs won't warn about, such as protected
>   returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson,
> to prevent our documentation from growing wildly out of date.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:!default.jspa
For more information on JIRA, see:


To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message