Maven 1.x Javadoc Plugin
  1. Maven 1.x Javadoc Plugin
  2. MPJAVADOC-38

[PATHC] javadoc artifact is installed/deployed with a weird extension

    Details

    • Type: Bug Bug
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.6, 1.6.1
    • Fix Version/s: 1.7
    • Labels:
      None
    • Number of attachments :
      4

      Description

      Right now, javadoc artifacts are installed and/or deployed with a .javadoc extension, even though they are a zip file.
      I'm providing a patch that uses a customized TypeHandler to create the right files.

      PS: if this change is accepted, I can create some test cases too

      1. MPJAVADOC_38_errata.patch
        3 kB
        Felipe Leme
      2. MPJAVADOC_38.patch
        2 kB
        Felipe Leme
      3. MPJAVADOC-38-full.patch
        8 kB
        Felipe Leme

        Activity

        Hide
        Felipe Leme added a comment -

        Patch that fix the problem (without the java files - I will provide it in another attachment)

        Show
        Felipe Leme added a comment - Patch that fix the problem (without the java files - I will provide it in another attachment)
        Hide
        Felipe Leme added a comment -

        Missing java files (as I could not cvs add it)

        Show
        Felipe Leme added a comment - Missing java files (as I could not cvs add it)
        Hide
        Felipe Leme added a comment -

        New patch (previous one didn't have maven.jar on dependencies - my bad)

        Show
        Felipe Leme added a comment - New patch (previous one didn't have maven.jar on dependencies - my bad)
        Hide
        Felipe Leme added a comment -

        Ultimate patch, with test cases and added files (thanks Carlos for the Eclipse tip

        Show
        Felipe Leme added a comment - Ultimate patch, with test cases and added files (thanks Carlos for the Eclipse tip
        Hide
        Felipe Leme added a comment -

        PS: final patch is MPJAVADOC-38-full.patch

        Show
        Felipe Leme added a comment - PS: final patch is MPJAVADOC-38 -full.patch
        Hide
        Arnaud Heritier added a comment -

        Hello Felipe,

        Thx for your work. I will look at it during my holidays (second half of august).
        I agree with you that it is annoying to generate .javadoc files.
        The only problem that I can see is if a user want to create a dependency to the javadoc (don't know why, but ...) it will not work because maven will continue to try to download a javadocs/XXX.javadoc file.
        Another solution might be to not use a javadoc type fot the artifact but a zip type.

        Show
        Arnaud Heritier added a comment - Hello Felipe, Thx for your work. I will look at it during my holidays (second half of august). I agree with you that it is annoying to generate .javadoc files. The only problem that I can see is if a user want to create a dependency to the javadoc (don't know why, but ...) it will not work because maven will continue to try to download a javadocs/XXX.javadoc file. Another solution might be to not use a javadoc type fot the artifact but a zip type.
        Hide
        Felipe Leme added a comment -

        Arnauld,

        I haven't though about the automatic download issue, as I was thinking in the problem from a human being point of view . In our case, for instance, we have trouble distributing our javadocs, as people would try to double click these files.

        Anyway, I would vote for the zip type solution - it would be just a matter of changing one line of code at SQLDistTypeHandler.java

        Feliep

        Show
        Felipe Leme added a comment - Arnauld, I haven't though about the automatic download issue, as I was thinking in the problem from a human being point of view . In our case, for instance, we have trouble distributing our javadocs, as people would try to double click these files. Anyway, I would vote for the zip type solution - it would be just a matter of changing one line of code at SQLDistTypeHandler.java Feliep
        Hide
        Arnaud Heritier added a comment -

        The type for the javadoc is "javadoc.jar" when it is deployed on a repository.

        Show
        Arnaud Heritier added a comment - The type for the javadoc is "javadoc.jar" when it is deployed on a repository.
        Hide
        Milos Kleint added a comment -

        There's one usecase for specifying the javadoc as dependency in your pom. When using IDEs you want the javadocs for your libraries to be available for the IDE as well, not only the jars.

        Show
        Milos Kleint added a comment - There's one usecase for specifying the javadoc as dependency in your pom. When using IDEs you want the javadocs for your libraries to be available for the IDE as well, not only the jars.

          People

          • Assignee:
            Arnaud Heritier
            Reporter:
            Felipe Leme
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 1 hour
              1h
              Remaining:
              Remaining Estimate - 1 hour
              1h
              Logged:
              Time Spent - Not Specified
              Not Specified