yWorks UML Doclet fails to generate UML diagrams

Troubleshooting

Summary

Using yWorks UML Doclet on a set of custom sources, no UML diagrams are generated.

Description

First, you need to specify one of yWorks UML Doclet's UML generation options:

  • -umlgen (generates UML diagrams if the source documentation contains an explicit @y.uml Javadoc tag)
  • -umltypegen (generates UML diagrams for all documented classes and interfaces)
  • -umlpackagegen (generates UML diagrams for all documented packages)
  • -umloverviewgen (generates project overview UML diagrams)
  • -umlautogen (generates all types of UML diagrams)
Second, you need to specify the path to your compiled, unobfuscated Java class files (and all libraries your Java files depend on) in the -docletpath option.
Your .class files (and the libraries) may be located in a .jar file.

yWorks UML Doclet was formerly known as yDoc.

Categories this article belongs to:
yWorks UML Doclet
Applies to:
yWorks UML Doclet: 2.1, 2.2, 3.0
Keywords:
yDoc - UML diagrams