Question

我正在使用Tapestry组件库，并希望使用maven javadoc插件和Tapestry标记添加javadoc。

我在pom.xml中添加了以下内容：

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.8.1</version>
            <configuration>
                <linksource>true</linksource>
                <taglet>org.apache.tapestry5.javadoc.TapestryDocTaglet</taglet>
                <tagletArtifact>
                    <groupId>org.apache.tapestry</groupId>
                    <artifactId>tapestry-javadoc</artifactId>
                    <version>${tapestry-release-version}</version>
                </tagletArtifact>
            </configuration>
        </plugin>
    </plugins>
</reporting>

并在我的组件java类中添加了以下内容：

/**
 * @tapestrydoc
 */
public class SomeComponent {
    ...
}

然后我跑了：

mvn javadoc:javadoc

但请注意以下事项：

...警告 - @tapestrydoc是一个未知标记。

组件参数未添加到javadoc ...

我在这里做错了什么？

Answer 1

请参阅此博客文章了解howto：JavaDoc Plugin For Component Reference Documentation。您需要将tapestry配置添加到报告插件。

如果将此配置放入报告标记，则仅在通过 mvn site 生成报告时使用。调用 mvn javadoc：javadoc 不使用报告标记。 但是，您可以通过将其置于构建代码中轻松解决问题。

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.8</version>
        <configuration>
          ...
          <taglet>org.apache.tapestry5.javadoc.TapestryDocTaglet</taglet>
          <tagletArtifact>
             <groupId>org.apache.tapestry</groupId>                       
             <artifactId>tapestry-javadoc</artifactId>                       
             <version>5.3-rc-3</version>                   
          </tagletArtifact>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>

tapestrydoc是一个未知的标签

1 个答案: