爲JSF 2複合組件生成文檔

我正在尋找生成自定義JSF 2複合組件庫的文檔。複合組件不在任何faces-config.xml文件中引用，而是複合組件的.xhtml文件存儲在META-INF /資源中，並使用新的composite：interface標記來定義接口。爲JSF 2複合組件生成文檔

對於JSP標記庫，可以使用https://taglibrarydoc.dev.java.net/生成文檔，我在想我的JSF 2複合組件庫是否有類似的東西。

來源

2010-03-05 digitaljoel

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

富面孔組件開發工具包提供了文檔註釋 http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

來源

2011-02-24 16:00:09

雖然這並不真正適用於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生成的文檔。有關更多詳細信息，請參閱插件的主頁。

來源

2016-03-15 09:11:59

爲JSF 2複合組件生成文檔

回答

相關問題