maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michal Safr (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MJAVADOC-529) File is not accepted in sourcespath
Date Wed, 27 Jun 2018 11:18:00 GMT

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

Michal Safr commented on MJAVADOC-529:
--------------------------------------

Well, I'm not sure about the right terminology but our parent pom.xml lists all the modules.
I've got my maven-javadoc-plugin configuration in the parent pom and run it using
  
{code:java}
mvn javadoc:javadoc -pl :parent-aggregator 
{code}
It seems that maven javadoc plugin doesn't support combining subpackages and sourcefiles 
  
{code:java}
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>3.0.1</version>
  <configuration>
      <subpackages>com.packageA</subpackages>
      <sourcepath>moduleA/src/main/java</sourcepath>
      <sourceFileIncludes>
          <include>moduleB/src/main/java/com/packageB/SomeClass.java</include>
      </sourceFileIncludes>
  </configuration>
</plugin>
{code}
The maven javadoc plugin says for the above that sourceFileIncludes is not used when subpackages
is used but javadoc itself supports combining them.

 

> File is not accepted in sourcespath
> -----------------------------------
>
>                 Key: MJAVADOC-529
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-529
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 3.0.1
>            Reporter: Michal Safr
>            Priority: Critical
>
> Hello guys
> As per official Javadoc spec, sourcepath can accept both directory and a file.
> [https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#documentingboth]
> {noformat}
> javadoc -d C:\home\html -sourcepath C:\home\src java.awt C:\home\src\java\applet\Applet.java
> {noformat}
> However sourcepath in the maven javadoc plugin accepts only directory. From AbstractJavadocMojo:
> {code:java}
> sourcePaths = JavadocUtil.pruneDirs( project, sourcePaths );
> {code}
> I'd need to be able to specify a combination of a package in sourcepath and a specific
java as in the example above.
> Thank you,
> Michal



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

Mime
View raw message