Fork me on GitHub

Frequently Asked Questions

  1. What is Vdldoc?
  2. How does the generated documentation look like?
  3. Are there other plugins to achieve this?
  4. Is there support for aggregating reports in a multi-module project?
What is Vdldoc?

From OmniFaces Vdldoc' homepage:

Vdldoc is a forked and rewritten version of old JSP TLDdoc Generator as previously available at http://taglibrarydoc.dev.java.net (which is nowhere available right now). Vdldoc has near-complete support for Facelets *.taglib.xml files. The generated documentation has Java 8 javadoc look'n'feel.

[top]

How does the generated documentation look like?

It looks similar to documentation generated by JavaDoc. OmniFaces has great documentation to look at.

[top]

Are there other plugins to achieve this?
When starting this project, I couldn't find any other plugin. However, once this plugin was ready to use and published, someone noticed me about another vdldoc-maven-plugin.

[top]

Is there support for aggregating reports in a multi-module project?
There is currently no support for aggregating multiple Vdldoc reports in a maven multi-module project. If you need this, create a patch and send me a pull-request.

[top]