Generar documentación para componentes compuestos JSF 2

Question

Estoy buscando generar documentación para una biblioteca de componentes compuestos JSF 2 personalizada. Los componentes compuestos no se referencian en ningún archivo faces-config.xml, sino que los archivos .xhtml para los componentes compuestos se almacenan en META-INF/resources y usan la nueva etiqueta compuesta: interface para definir la interfaz.

Para las bibliotecas de etiquetas JSP, la documentación se puede generar utilizando https://taglibrarydoc.dev.java.net/ y me pregunto si hay algo similar para mi biblioteca de componentes compuestos JSF 2.

Answer 1

ricos-caras kit de desarrollo de componentes proporciona anotaciones de documentación http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

Answer 2

Puede utilizar OmniFaces Vdldoc para generar la documentación de sus <cc:interface> etiquetas (o la documentación en los archivos taglib.xml).

Digamos que sus componentes compuestos residen en la carpeta /META-INF/resources/myLib. A continuación, tendría un -file myLib.taglib.xml en la carpeta META-INF así:

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

(Para un ejemplo más completo, echar un vistazo a this question)

Ahora puede utilizar Vdldoc para generar la documentación:

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

actualización: Si su proyecto utiliza experto, no hay ahora vdldoc-maven-plugin integrar fácilmente en su construir. Básicamente, sólo en ella a la <reporting> -section de su 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> 

Y corre mvn site para generar la documentación. Vea la página principal del plugin para más detalles.