Создать документацию для составных компонентов JSF 2

Question

Я ищу для создания документации для специальной составной библиотеки компонентов JSF 2. Компонентные компоненты не ссылаются ни на один файл faces-config.xml, а файлы .xhtml для составных компонентов хранятся в ресурсах META-INF/и используют новый тег: интерфейс для определения интерфейса.

Для библиотек тегов JSP документация может быть сгенерирована с использованием https://taglibrarydoc.dev.java.net/, и мне интересно, есть ли что-то подобное для моей составной библиотеки компонентов JSF 2.

Answer 1

богатые-лика комплект разработки компоненты содержит документацию примечаний http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

Answer 2

Вы можете использовать OmniFaces Vdldoc для генерации документации из ваших <cc:interface> тегов (или документации в taglib.xml файлах).

Скажите, что ваши составные компоненты находятся в папке /META-INF/resources/myLib. Вы бы тогда нужно myLib.taglib.xml -файл в 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 

Update: Если ваш проект использует Maven есть теперь vdldoc-maven-plugin легко интегрировать его в свой строить. В основном только у него на <reporting> -сечением вашего 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 для создания документации. Дополнительную информацию см. На домашней странице плагина.