maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Vincent Massol (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MJAVADOC-329) Allow generation of empty javadoc JARs
Date Sat, 01 Dec 2018 16:53:00 GMT

    [ https://issues.apache.org/jira/browse/MJAVADOC-329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16705913#comment-16705913
] 

Vincent Massol commented on MJAVADOC-329:
-----------------------------------------

Hi [~rfscholte]. Small note that I never said I wanted a fully empty javadoc, I even mentioned
this:

{quote}
The problem is that the javadoc plugin doesn't generate any JAR if there are no java files
matching (even if I have other files such as a package.html file in my src/main/javadoc/*
directories).
I'd like it to be possible to generate an "empty" javadoc JAR containing only a package.html
file for example.
{quote}

It's a bit weird that the javadoc plugin wouldn't support having only a package.html file
and that this issue is closed a won't fix. But the doc says that package-info.java is now
preferred over package.html so I guess it's acceptable. See https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#packagecomment
:

bq. The package-info.java file can contain the package declaration, package annotations, package
comments, and Javadoc tags. This file is preferred.



> Allow generation of empty javadoc JARs
> --------------------------------------
>
>                 Key: MJAVADOC-329
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-329
>             Project: Maven Javadoc Plugin
>          Issue Type: Improvement
>    Affects Versions: 2.8
>            Reporter: Vincent Massol
>            Assignee: Robert Scholte
>            Priority: Major
>
> Here's my use case:
> * I want to be able to deploy my artifacts to Maven Central. There's a requirement that
a javadoc jar exists for the arifact to deploy
> * However I have some maven modules of type packaging = jar that have java files but
these files are located in an "internal" package (internal api that we don't expose to end
users since it's not part of our public API contract) which we exclude from the javadoc generation
> The problem is that the javadoc plugin doesn't generate any JAR if there are no java
files matching (even if I have other files such as a package.html file in my src/main/javadoc/*
directories).
> I'd like it to be possible to generate an "empty" javadoc JAR containing only a package.html
file for example.
> Thanks a lot



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message