如何暗示m2e(eclipse的Maven插件)将外部javadoc网站附加到工件?

时间:2012-03-14 09:58:57

标签: eclipse maven javadoc m2eclipse

我需要使用工件X,它既没有源也没有javadoc工件。但是,我知道一个外部Web服务器,其中已经公开了X的javadoc。

在“普通”Eclipse中,我可以在构建路径中附加一个URL作为jar的Javadoc Location,然后 Shift - F2 打开一个浏览器到该URL 。

我想让m2e自动为神器X做同样的事情而不改变Maven Central的神器。

示例pom.xml显示:

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>foo</groupId>
    <artifactId>m2e-javadoc</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <project.build.sourceEncoding>ASCII</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>net.sf.jt400</groupId>
            <artifactId>jt400-full</artifactId>
            <version>5.0</version>
        </dependency>
    </dependencies>

</project>

我如何暗示这一点?


编辑:已在http://dev.eclipse.org/mhonarc/lists/m2e-users/msg02386.html

的m2e邮件列表中询问了问题

编辑:在本地存储库中安装缺失工件并放弃让项目执行Maven发布的一些实验之后,我将最新版本(7.10)重新打包到Maven Central。

2 个答案:

答案 0 :(得分:2)

不幸的是,如果创建者没有为特定工件创建适当的工件(-sources和-javadoc),它将无法工作。但是您应该能够为特定工件手动添加javadoc。我建议创建一个单独的包(artifact-javadoc)并将其部署到您的存储库管理器,而不是自动工作。

答案 1 :(得分:2)

您可以通过扩充您的POM,将Maven Javadoc Plugin用于this scenario

  

您可以使用以下命令将交叉引用链接添加到外部项目    参数。例如:

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.8.1</version>
        <configuration>
          <links>
            <link>http://commons.apache.org/dbcp/apidocs/</link>
            <link>http://commons.apache.org/fileupload/apidocs/</link>
          </links>
            ...
        </configuration>
      </plugin>
    </plugins>
  </reporting> (or </build>)
  ...
</project>
  

重要说明:根据Javadoc规范,所有给定的链接   应该有一个fetchable / package-list文件。

使用<offlineLinks/>参数和aggregate goal可以根据需要将文档合并到同一文档树中,从而进一步增强此策略。

documentation for Maven Javadoc Plugin提供了其他方案和示例,涉及其他Javadoc工具,如果您希望也可以这样做。