Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.55 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.55 KB

MatlabUML

This is a small tool to automatically create an UML class diagram from MATLAB code.

Requirements

  • a reasonably recent version of MATLAB
  • graphviz
  • rdir (included)

Features

  • create UML class diagram from code automatically
  • output into any format supported by graphviz (png, pdf, svg, ...)
  • supports public and private properties and methods
  • supports multiple inheritance
  • supports recursive handling of classes in subfolders
  • uses MATLAB's meta.class feature instead of employing its own parser

Usage

Set the folder variable to the folder containing the classes and the output variable to the desired output filename (without extension). Make sure that the dotExecutable Variable points to the path where the dot tool from graphviz can be found.

Once all is set, just run uml.m. You can change the output format by modifying the call to the dot executable at the end of uml.m.

Example

When running MatlabUML on the example classes from UMLgui it generates the following result. Example

Limitations

  • function parameters and return values are not shown
  • GetAccess/SetAccess are not distinguished

License

MatlabUML is licensed under the GPLv3 license.

Contact

Author: Gerhard Kurz

Mail: kurz.gerhard (at) gmail (dot) com

Web: http://www.gerhardkurz.de