Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-425

Outdated doxia's version is used in plugin

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Fixed
    • 2.10.1
    • 2.10.3
    • None
    • None

    Description

      I've faced problems while generating linkcheck report on our project.
      Links are pointing to methods in javadoc generated html pages, but in final report lots of links are marked as "invalid"
      Analyzing of the problem let me noticed that maven-javadoc-plugin is using doxia libs version 1.0, e.g. snippet from maven-javadoc-plugin version 2.10.1 pom:

      <properties>
      ...
      <doxiaVersion>1.0</doxiaVersion>
      <doxia-sitetoolsVersion>1.0</doxia-sitetoolsVersion>
      ...
      </properties>

      My problem is close to this one http://jira.codehaus.org/browse/DOXIA-397 and as you see it was fixed in doxia 1.4

      Current latest doxia version is 1.6, so I think there's need of updating javadoc plugin.

      Steps of reproducing my problem:

      1) git clone git@github.com:checkstyle/checkstyle.git && cd checkstyle/ && git checkout checkstyle-6.3

      2) mvn clean install -DskipTests -Dpmd.skip=true -Dfindbugs.skip=true -Dcobertura.skip=true

      3) Open target/site/linkcheck.html

      Example of my current report: http://alexkravin.github.io/linkcheck/linkcheck.html

      As you can see - even "invalid" link will redirect you to proper location.

      E.g.:
      apidocs/com/puppycrawl/tools/checkstyle/grammars/GeneratedJavaRecognizer.html
      error ../../../../../com/puppycrawl/tools/checkstyle/grammars/GeneratedJavaRecognizer.html#GeneratedJavaRecognizer(antlr.TokenBuffer,%20int): doesn't exist

      but it's valid
      http://alexkravin.github.io/linkcheck/apidocs/com/puppycrawl/tools/checkstyle/grammars/GeneratedJavaRecognizer.html#GeneratedJavaRecognizer(antlr.TokenBuffer, int)

      One more case:

      http://docs.oracle.com/javase/7/docs/api/org/xml/sax/helpers.DefaultHandler.html?is-external=true: 404 Not Found

      This link is broken because DefaultHandler is preceded by dot instead of '/'.

      All other cases with links to docs.oracle.com/... are valid.

      Attachments

        Activity

          People

            khmarbaise Karl Heinz Marbaise
            kravin Aleksey Nesterenko
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: