为JSF 2复合组件生成文档

问题描述：

我正在寻找生成自定义JSF 2复合组件库的文档。复合组件不在任何faces-config.xml文件中引用，而是复合组件的.xhtml文件存储在META-INF /资源中，并使用新的composite：interface标记来定义接口。为JSF 2复合组件生成文档

对于JSP标记库，可以使用https://taglibrarydoc.dev.java.net/生成文档，我在想我的JSF 2复合组件库是否有类似的东西。

相关：[如何生成facelets文档？]（http://stackoverflow.com/q/1612932） – BalusC 2016-03-15 10:12:43

答

富面孔组件开发工具包提供了文档注释 http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

虽然这并不真正适用于JSF 2复合组件。 – digitaljoel 2011-02-24 16:29:09

答

您可以使用OmniFaces Vdldoc从您的<cc:interface>标签（或taglib.xml文件的文档）生成文档。

假设您的复合组件位于/META-INF/resources/myLib文件夹中。那么你就需要一个myLib.taglib.xml -file在这样的META-INF文件夹：

<facelet-taglib> 
    <description>Your description</description> 
    <namespace>http://example.com/myLib</namespace> 
    <short-name>my</short-name> 
    <composite-library-name>myLib</composite-library-name> 
</facelet-taglib>

（对于一个更完整的例子，看看this question）

您现在可以使用Vdldoc产生你的文档：

java -jar vdldoc-2.1.jar myLib.taglib.xml

更新： 如果你的项目使用Maven的现在有vdldoc-maven-plugin轻松地集成到您的建立。基本上只是在它的<reporting> -section您pom.xml的：

<reporting> 
    <plugins> 
    <plugin> 
     <groupId>com.github.matinh.vdldoc</groupId> 
     <artifactId>vdldoc-maven-plugin</artifactId> 
     <version>1.0-beta-1</version> 
    </plugin> 
    </plugins> 
</reporting>

和运行mvn site生成的文档。有关更多详细信息，请参阅插件的主页。

为JSF 2复合组件生成文档

相关推荐