Genera documentazione per componenti compositi JSF 2

Question

Sto cercando di generare documentazione per una libreria di componenti compositi JSF 2 personalizzata. I componenti compositi non sono referenziati in alcun file faces-config.xml, ma i file .xhtml per i componenti compositi sono memorizzati in META-INF/resources e usano il nuovo tag composito: interface per definire l'interfaccia.

Per le librerie di tag JSP, la documentazione può essere generata utilizzando https://taglibrarydoc.dev.java.net/ e mi chiedo se c'è qualcosa di simile per la mia libreria di componenti compositi JSF 2.

Answer 1

ricchi di volti kit di sviluppo componente fornisce le annotazioni di documentazione http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

Answer 2

È possibile utilizzare OmniFaces Vdldoc per generare la documentazione dal tuo <cc:interface> tag (o la documentazione in taglib.xml file).

Dire che i componenti compositi si trovano nella cartella /META-INF/resources/myLib. Si sarebbe quindi bisogno di un -file myLib.taglib.xml nella cartella META-INF in questo modo:

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

(Per un esempio più completo, dare un'occhiata a this question)

È ora possibile utilizzare Vdldoc per generare la documentazione:

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

Aggiornamento: Se il progetto utilizza Maven ora c'è vdldoc-maven-plugin di integrare facilmente nella tua costruire. Fondamentalmente proprio al <reporting> -sezione del vostro 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> 

E correre mvn site per generare la documentazione. Vedi la homepage del plugin per maggiori dettagli.