无法从依赖项源聚合Javadoc

时间:2016-08-17 22:11:26

标签: java maven pom.xml javadoc maven-plugin

我正在尝试生成具有指向依赖库的链接的javadoc。我一直关注this教程,并成功生成了XXX-sources.jar和XXX-javadoc.jar。但我不能将依赖javadoc包含到我的项目中,也不能生成带有依赖html文件的有效链接的javadoc。

更具体地说,我的项目取决于org.foo.bar。 bar-core-1.0.0-sources.jarbar-core-1.00-javadoc.jar文件都在本地maven存储库(~/.m2/repository)中可用,并且maven能够解析它们。我的一个源文件导入了库API:

import org.foo.bar.core.Dependency

然后,它在其文档中使用链接:

{@link Dependency} and {@link org.foo.bar.core.AnotherDependency AnotherDependency}

我的pom.xml文件配置如下:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

[...]

<build>
    <plugins>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.4</version>
            <executions>
                <execution>
                    <id>javadoc-jar</id>
                    <phase>package</phase>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                    <configuration>
                        <includeDependencySources>true</includeDependencySources>

                        <dependencySourceIncludes>
                          <dependencySourceInclude>org.foo.bar:*</dependencySourceInclude>
                        </dependencySourceIncludes>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

<dependencies>
    <dependency>
        <groupId>org.foo.bar</groupId>
        <artifactId>core</artifactId>
        <version>1.0.0</version>
    </dependency>
</dependencies>

然后,我使用:

生成javadoc
mvn javadoc:jar

在生成的javadoc中,我自己项目的@link可以正确转换为包含<a>标记的网址。但是,Dependency和AnotherDependency包含<code>标记而不是<a>标记。

0 个答案:

没有答案