如何在带有maven程序集插件的单个jar中包含javadoc

时间:2017-09-25 11:43:25

标签: maven jar javadoc

我有一个库,我想在一个jar文件中提供javadoc。我使用maven程序集插件来获得单个程序集。我在pom.xml中有以下设置:

   <build>
    ...
    <plugins>
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>

                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
                <appendAssemblyId>false</appendAssemblyId>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.4</version>
            <executions>
                <execution>
                    <id>attach-javadoc</id>
                    <phase>compile</phase>
                </execution>
            </executions>
        </plugin>
    </plugins>
    ...
   <build>

要获得一个jar,我运行这个maven命令:

clean compile assembly:single

但是不要在生成的jar中获取javadoc。除此之外我该怎么做?

1 个答案:

答案 0 :(得分:0)

maven的标准方法是创建一个jar,它只包含你的应用程序而没有javadoc / sources 。如果您想向库的用户提供javadoc / sources,那么您应该使用attach-sources / attach-javadoc作为文档:attach-source-javadoc-artifacts

这样,您将在maven存储库中获取名称为

的其他文件
  • <yourlibrary>-1.0-SNAPSHOT.jar
  • <yourlibrary>-1.0-SNAPSHOT-sources.jar
  • <yourlibrary>-1.0-SNAPSHOT-javadoc.jar