组件报告

这个组件报告模块允许您为模块中的所有组件(组件库或Tapestry应用程序)生成全面的文档。

对于每个组件,将显示继承、描述和完整的参数集(包括继承的参数)。

文档是由JavaDoc和类本身的注释以及您可能提供的外部文档混合生成的。

外部文档

外部文档是可选的,采用文件的形式,存储在与组件类相同的包中,扩展名为“.xdoc”。

外部文档位于Maven XDoc格式,可以认为它是XHTML的一个有点僵化、精简的版本。

组件报告将提取<body>元素的内容,并将其添加到自动生成的文档中。它还将复制任何图像(型钢混凝土属性)添加到相应的输出文件夹。

文档生成到模拟包结构的目录结构中;因此,同一个包中组件的组件文档链接只是同一文件夹中另一个文件(扩展名为.html)的链接。

例子:

<文档><body><节name=“相关组件”><ul><li>Foo公司<li><a href=“Bar.html”>酒吧</a></ul></ul></节><section name=“示例”><p>Baz组件可用于生成gloop风格的界面:</p><p><img src=“baz_ref.png”/></p>. . .

外部文档文件(.xdoc文件和任何相关的图像文件)可以位于Java主路径(即src/main/Java)或资源路径(src/maint/resources)。此时,您应该将它们放在src/main/java下,这样文件就不会打包在库JAR或应用程序WAR中。

生成报告

只需将以下内容添加到POM的报告/插件部分:

<插件>org.apache.tapestry组织<artifactId>磁带组件报告<版本>5.0.x<配置><rootPackage>org.example.myapp</rootPackage</配置></plugin>

确保更新<版本>元素,并更新<rootPackage>元素的值(这将与您在web.xml网站).

在5.3中增加

在5.3版中,Maven插件的配置以向后不兼容的方式更改。配置需要<rootPackages>元素,可能有几个<rootPackage>元素。您应该按如下所示更改插件配置,否则您仍然可以使用插件的5.2.4版本,而无需更改任何内容。

<插件>org.apache.tapestry组织<artifactId>磁带组件报告<版本>5.3.x<配置><rootPackages><rootPackage>org.example.myapp</rootPackage<rootPackage>com.acme.lib</rootPackages></配置></plugin>

限制

无法从另一个库中为基类生成参数;这些工具假设组件在当前模型中是完全独立的。