Maven Javadoc Plugin
  1. Maven Javadoc Plugin
  2. MJAVADOC-325

Incorrect -link is generated when its URL contains a comma

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 2.8
    • Fix Version/s: 2.8.1
    • Labels:
      None
    • Environment:

      Description

      I consistently get this error when generating javadoc:

      Exit code: 1 - javadoc: error - Illegal package name: ""

      I tracked it down to how the plugin's options file is generated. The new Oracle JDK 1.5 javadoc link is this:
      http://download.oracle.com/javase/1,5,0/docs/api/

      There's a comma between the 1 and the 5. The comma is somehow being used as a separator for the plugin because this gets generated:

      -link
      'http://download.oracle.com/javase/1
      -link
      5.0/docs/api'

      Bascially, I can't generate 1.5 javadoc with the new Oracle link.

        Activity

        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open Closed Closed
        24d 16h 43m 1 Robert Scholte 26/Sep/11 17:10
        Mark Thomas made changes -
        Reporter Paul Benedict [ ID134349 ] Paul Benedict [ paul4christ79 ]
        Mark Thomas made changes -
        Workflow jira [ 12960097 ] Default workflow, editable Closed status [ 12996976 ]
        Mark Thomas made changes -
        Project Import Mon Apr 06 00:11:46 UTC 2015 [ 1428279106587 ]
        Mark Thomas made changes -
        Workflow jira [ 12722557 ] Default workflow, editable Closed status [ 12762352 ]
        Mark Thomas made changes -
        Project Import Sun Apr 05 11:56:47 UTC 2015 [ 1428235007093 ]
        Robert Scholte made changes -
        Resolution Fixed [ 1 ]
        Status Open [ 1 ] Closed [ 6 ]
        Fix Version/s 2.8.1 [ 17354 ]
        Hide
        Robert Scholte added a comment -

        Fixed in rev. 1176059

        Show
        Robert Scholte added a comment - Fixed in rev. 1176059
        Robert Scholte made changes -
        Summary Incorrect -link is generated for 1.5 Incorrect -link is generated when its URL contains a comma
        Robert Scholte made changes -
        Priority Major [ 3 ] Minor [ 4 ]
        Hide
        Robert Scholte added a comment -

        Lowering priority to minor, because there's a workaround for this case: use dots instead of comma's.

        Show
        Robert Scholte added a comment - Lowering priority to minor, because there's a workaround for this case: use dots instead of comma's.
        Robert Scholte made changes -
        Field Original Value New Value
        Assignee Robert Scholte [ rfscholte ]
        Hide
        Paul Benedict added a comment - - edited

        Well, evidently Oracle is not being consistent. As I said, do the google search. You will see 1 COMMA 5 DOT 0 in the URL. I am not kidding. Aside from this fact, there's a bug in that the plugin is improperly taking commas and breaking apart the URL. That's still an issue to be fixed.

        Show
        Paul Benedict added a comment - - edited Well, evidently Oracle is not being consistent. As I said, do the google search. You will see 1 COMMA 5 DOT 0 in the URL. I am not kidding. Aside from this fact, there's a bug in that the plugin is improperly taking commas and breaking apart the URL. That's still an issue to be fixed.
        Hide
        Joerg Schaible added a comment -

        Oracle uses dots for the official links to the various javadoc versions:
        http://www.oracle.com/technetwork/java/javase/documentation/api-jsp-136079.html

        Show
        Joerg Schaible added a comment - Oracle uses dots for the official links to the various javadoc versions: http://www.oracle.com/technetwork/java/javase/documentation/api-jsp-136079.html
        Hide
        Paul Benedict added a comment -

        Herve, google "java 1.5 api" and you will see the web links contain a comma.

        Show
        Paul Benedict added a comment - Herve, google "java 1.5 api" and you will see the web links contain a comma.
        Hide
        Hervé Boutemy added a comment -

        strange: can you give a sample project causing this?

        I don't understand how you get these commas since they are points in sources

        Show
        Hervé Boutemy added a comment - strange: can you give a sample project causing this? I don't understand how you get these commas since they are points in sources
        Hide
        Paul Benedict added a comment -

        I can verify a spurious -link gets generated for each comma in the <link> element. BTW, I configured my plugin in the <build> section.

        Show
        Paul Benedict added a comment - I can verify a spurious -link gets generated for each comma in the <link> element. BTW, I configured my plugin in the <build> section.
        Paul Benedict created issue -

          People

          • Assignee:
            Robert Scholte
            Reporter:
            Paul Benedict
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development