Tạo tài liệu cho các thành phần phức hợp JSF 2

Question

Tôi đang tìm cách tạo tài liệu cho thư viện thành phần hỗn hợp tùy chỉnh JSF 2. Các thành phần hỗn hợp không được tham chiếu trong bất kỳ tệp faces-config.xml nào, mà đúng hơn là các tệp .xhtml cho các thành phần tổng hợp được lưu trữ trong META-INF/resources và sử dụng thẻ giao diện hỗn hợp mới để xác định giao diện.

Đối với thư viện thẻ JSP, tài liệu có thể được tạo bằng cách sử dụng https://taglibrarydoc.dev.java.net/ và tôi tự hỏi nếu có gì đó tương tự cho thư viện thành phần hỗn hợp JSF 2 của tôi.

Answer 1

giàu khuôn mặt bộ phát triển phần cung cấp chú thích tài liệu http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

Answer 2

Bạn có thể sử dụng OmniFaces Vdldoc để tạo ra tài liệu từ <cc:interface> thẻ của bạn (hoặc tài liệu trong taglib.xml tập tin).

Giả sử các thành phần tổng hợp của bạn nằm trong thư mục /META-INF/resources/myLib. Sau đó bạn sẽ cần một -file myLib.taglib.xml trong thư mục META-INF như thế này:

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

(Đối với một ví dụ hoàn chỉnh hơn, có một cái nhìn tại this question)

Bây giờ bạn có thể sử dụng Vdldoc để tạo ra tài liệu của bạn:

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

cập nhật: Nếu dự án của bạn sử dụng maven có tại là vdldoc-maven-plugin dễ dàng tích hợp nó vào bạn xây dựng. Về cơ bản chỉ tại nó vào <reporting> -section của pom.xml của bạn:

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

Và chạy mvn site để tạo ra các tài liệu hướng dẫn. Xem trang chủ của plugin để biết thêm chi tiết.