JS/UML Quick Start Guide


  • If you haven't yet done so, install JS/UML and its prerequisites

Check out Examples

  • Back to the downloads page and grab the examples project

  • Unzip the examples project into your Eclipse workspace directory


  • Find the file "jsdoc.js" in the examples project under "diagrams/jsdoc"

  • Right-mouse on the file in the project explorer or navigator view and choose "JS/UML Create Diagram"

  • Choose the "JSDoc" filter and then click "Next"

  • Choose a name and location for the output diagram and click finish

  • The diagram should display in the Papyrus diagram editor

  • Make changes to the example javascript file and run "JS/UML Create Diagram" again

  • View the newly generated diagram and verify the changes are reflected


  • Double click the file "docs.uml" in the "generation/docs" folder - it should open in the Eclipse UML2 model editor

  • The documentation for this file had been generated in the "output" folder

  • Make some modifications to docs.uml in the model editor and save the file

  • Right-mouse on the UML file in the project explorer or navigator view and choose "JS/UML Generate"

  • Choose the templates and output folders under "generation/docs"

  • Go back to the generated documentation files and verify that they have been updated

Read More

Check the documentation on the

  • JavaScript filters for the supported conventions for notating classes and other model elements

  • The documentation generator for information about creating custom documentation templates