Lucene - Core
  1. Lucene - Core
  2. LUCENE-4011

Check for broken documentation links in hudson

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 4.0-ALPHA
    • Component/s: general/javadocs
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      Mike added a cool script to dev-tools (checkJavadocLinks.py) 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:
          {@link java.lang.JavaDocsSucks}
          

        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 catch.
      • this checker finds real API bugs that javadocs won't warn about, such as protected methods
        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, helping
      to prevent our documentation from growing wildly out of date.

      1. LUCENE-4011-solr-links.patch
        7 kB
        Chris Male
      2. LUCENE-4011-lucene-links.patch
        13 kB
        Chris Male
      3. LUCENE-4011-core-links.patch
        12 kB
        Chris Male
      4. LUCENE-4011.patch
        3 kB
        Robert Muir

        Activity

        Robert Muir created issue -
        Chris Male made changes -
        Field Original Value New Value
        Attachment LUCENE-4011-core-links.patch [ 12523728 ]
        Chris Male made changes -
        Attachment LUCENE-4011-lucene-links.patch [ 12523735 ]
        Chris Male made changes -
        Attachment LUCENE-4011-solr-links.patch [ 12523737 ]
        Robert Muir made changes -
        Attachment LUCENE-4011.patch [ 12523741 ]
        Robert Muir made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Uwe Schindler made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Robert Muir
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development