How to run yWorks UML Doclet from within Eclipse

Questions & Answers

Summary

This article explains how to use yWorks UML Doclet from within the popular Eclipse IDE.

Description

Use the Javadoc generation wizard.

  1. Select Export from the File menu.

  2. Choose Javadoc from Select an export destination.
    Go to the next tab.

  3. Select Use Custom Doclet then specify Doclet name and Doclet class path.

    Name has to be ydoc.doclets.YStandard and path has to be <yid>/lib/ydoc.jar.
    <yid> denotes the absolute path to the yWorks UML Doclet directory.

    Go to the next tab.

  4. If you are using yDoc 2.x, add in Extra Javadoc options either
    -docletpath <yid>/resources:<yid>/lib/class2svg.jar
    or
    -docletpath <yid>/resources;<yid>/lib/class2svg.jar
    depending on wheter your system path separator is ":" or ";".

    If your sources depend on additional libraries, you also need to append the path to these libraries to the above line.

    Any other options you want to use, e.g. -d <destination> or -umlautogen, need to be specified in this input area, too.

  5. Optionally, add -J-Xmx1024m in VM options.
    You may want to play with the numerical value depending on available RAM and project size.
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 - Eclipse