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

Diacritics (accents) in project path prevent the plugin from working on Windows.

    Details

    • Type: Bug Bug
    • Status: Open Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 2.7, 2.8
    • Fix Version/s: None
    • Labels:
      None
    • Environment:
      Win7
    • Number of attachments :
      2

      Description

      My project is located in "E:\Programování\Java\beam-3D-data-viewer". Notice the diacritics in the path.

      When launching the javadoc:javadoc goal, the build fails:
      .
      .
      .
      [ERROR] javadoc: warning - No source files for package org.esa.beam.util
      [ERROR] javadoc: error - No public or protected classes found to document.

      I looked on the generated "options" file, and that's the problem. Windows apparentely don't have their filenames encoded in UTF8 when passing them to the command line, but the options file is saved in UTF8. That's the reason why the plugin cannot find the source files. When I manually edit the file and save it in cp1250 encoding, running javadoc.bat works perfectly.

      This should obviously be fixed, but is there a quick workaround? Eg. a way to alter the generated javadoc.bat to prepend a call to iconv or something else.

      Now I can use the generated files, manually edit the options file, and run the task, but if I want to run the jar goal, this bug makes it impossible.

      Thanks for cooperation!

      1. options
        0.6 kB
        Martin Pecka
      2. pom.xml
        4 kB
        Martin Pecka

        Activity

        Hide
        Herve Boutemy added a comment -

        there were little improvements lately
        can you check if the problem is still here with latest snapshot, please?

        Show
        Herve Boutemy added a comment - there were little improvements lately can you check if the problem is still here with latest snapshot, please?
        Hide
        Martin Pecka added a comment -

        Where can I access the snapshot?
        2.8-SNAPSHOT and 2.9-SNAPSHOT don't exist.
        2.8.1-SNAPSHOT seems to work, but no files are downloaded during the build - I thought this is what the snapshot versions should do...

        So I tested it with 2.8.1 and the same error (the bug was reported for 2.8).

        Show
        Martin Pecka added a comment - Where can I access the snapshot? 2.8-SNAPSHOT and 2.9-SNAPSHOT don't exist. 2.8.1-SNAPSHOT seems to work, but no files are downloaded during the build - I thought this is what the snapshot versions should do... So I tested it with 2.8.1 and the same error (the bug was reported for 2.8).
        Hide
        Herve Boutemy added a comment -

        you need to build it yourself from source, it's not complex, just checkout http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-javadoc-plugin/

        Show
        Herve Boutemy added a comment - you need to build it yourself from source, it's not complex, just checkout http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-javadoc-plugin/
        Hide
        Martin Pecka added a comment -

        ok, tried with home-built 2.9-SNAPSHOT - without a change...

        Show
        Martin Pecka added a comment - ok, tried with home-built 2.9-SNAPSHOT - without a change...
        Hide
        Herve Boutemy added a comment -

        can you attach option file to the issue?

        Show
        Herve Boutemy added a comment - can you attach option file to the issue?
        Hide
        Martin Pecka added a comment - - edited

        I've attached my pom.xml. Is this the kind of option file you meant? We're talking about target javadoc:javadoc.

        Show
        Martin Pecka added a comment - - edited I've attached my pom.xml. Is this the kind of option file you meant? We're talking about target javadoc:javadoc.
        Hide
        Herve Boutemy added a comment -

        thank you for the pom.xml, now I need the generated options file

        Show
        Herve Boutemy added a comment - thank you for the pom.xml, now I need the generated options file
        Hide
        Martin Pecka added a comment -

        I've attached the options file. Note that it is in UTF-8 encoding (Programování) while maven reads it in CP1250 (ProgramovánĂ­) which is wrong (maven creates a directory D:\ProgramovánĂ­\Java\beam-3D-data-viewer\target\site\apidocs and then reports it has no source files).

        Show
        Martin Pecka added a comment - I've attached the options file. Note that it is in UTF-8 encoding (Programování) while maven reads it in CP1250 (ProgramovánĂ­) which is wrong (maven creates a directory D:\ProgramovánĂ­\Java\beam-3D-data-viewer\target\site\apidocs and then reports it has no source files).
        Hide
        Martin Pecka added a comment -

        Outch! This site is not served in UTF8 and so the diacritics in my previous comment are wrong. Manually set this page to display as UTF8 to see it correctly.

        Show
        Martin Pecka added a comment - Outch! This site is not served in UTF8 and so the diacritics in my previous comment are wrong. Manually set this page to display as UTF8 to see it correctly.

          People

          • Assignee:
            Unassigned
            Reporter:
            Martin Pecka
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated: