Dokumentation für JSF 2-Verbundkomponenten erstellen

Question

Ich möchte eine Dokumentation für eine benutzerdefinierte JSF 2-Verbundkomponentenbibliothek erstellen. Auf die zusammengesetzten Komponenten wird in keiner Datei faces-config.xml verwiesen, sondern die .xhtml-Dateien für die zusammengesetzten Komponenten werden in META-INF/resources gespeichert und verwenden das neue Tag composite: interface, um die Schnittstelle zu definieren.

Für JSP-Tag-Bibliotheken kann die Dokumentation mit https://taglibrarydoc.dev.java.net/ generiert werden und ich frage mich, ob es etwas ähnliches für meine JSF 2 Composite-Komponentenbibliothek gibt.

Answer 1

reich Flächen Komponente Development Kit enthält Dokumentation Anmerkungen http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

Answer 2

Sie OmniFaces Vdldoc Dokumentation von Ihren <cc:interface>-Tags (oder der Dokumentation in taglib.xml Dateien) zu erzeugen, verwenden können.

Angenommen, Ihre Composite-Komponenten befinden sich im Ordner /META-INF/resources/myLib. Sie würden dann brauchen eine myLib.taglib.xml -file im META-INF Ordner wie folgt aus:

<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> 

(Für ein vollständigeres Beispiel, haben einen Blick auf this question)

Sie jetzt Vdldoc Ihre Dokumentation zu erzeugen, verwenden können:

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

Update: Wenn Ihr Projekt maven dort verwendet, ist jetzt vdldoc-maven-plugin zu leicht einbinden bauen. Im Grunde nur um es an die <reporting> -Abschnitt Ihrer 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> 

Und mvn site ausführen, um die Dokumentation zu erzeugen. Weitere Informationen finden Sie auf der Homepage des Plugins.