Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
FreeCAD Class Inheritance Diagram
@startuml
class App::DocumentObject [[https://wiki.freecadweb.org/App_DocumentObject]]
class App::GeoFeature [[https://wiki.freecadweb.org/App_GeoFeature]]
note left [[http://plantuml.com]]
Adds Placement property
end note
App::DocumentObject <|-- App::GeoFeature [[http://plantuml.com/class]] : extends
@enduml
@marcin-ose

This comment has been minimized.

Copy link

@marcin-ose marcin-ose commented May 3, 2020

@gbroques

This comment has been minimized.

Copy link
Owner Author

@gbroques gbroques commented May 3, 2020

You can use it to generate a class diagram.

The way I do this is the following (there are other ways):

  1. Install Visual Studio Code
  2. Install the PlantUML extension
    • Requires you to install Java (the platform for running PlantUML)
    • and install Graphviz (PlantUML requires it to calculate positions in diagram)
  3. This PlantUML extension allows previewing and exporting this file to different formats like SVG and PNG.
    • Press Ctrl + Shift + P to open the Command Palette
    • Type "PlantUML: " and the various options for the extension should auto-populate in the dropdown.
    • Use up and down arrow keys, and Enter to select an option.

Exporting UML Diagram via VS Code Plant UML Extension

export-uml-diagram

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment