Program that takes the root folder of a Java project and builds a UML diagram that corresponds to the provided project.
- Java 11 or later
- Graphviz (optional)
- Clone this repository.
- Run
./gradlew :pdg-launcher:run(if you just want to run this) or./gradlew :pdg-launcher:uberJar(if you want an all-in-one JAR file)
- You need to provide three things for the program to run: the directory of the root path for your project (use the + button next to it that pops open a FileChooser browser to navigate your file system), any packages you want to ignore (please just use the + button to get a popout interface for selecting this, you can click on the packages to open and close them which translate to whether or not the contents of that package will be interpreted for the UML), and where your file will be saved.
- You can also filter out whether the UML will contain instance variables, functions, private instance variables/functions, and/or the constants using the four checkboxes on the right of the screen.
To read the Javadoc for this project, run ./gradlew javadoc then browse
the build/docs/javadoc folder. The Javadoc for the project (especially the API)
is currently incomplete due to the absence of documentation from the upstream.
- API:
The API submodule provides Java parsing library, independent of any GPL code. Thus, this submodule is distributed under the MIT License, matching the upstream license. - GUI:
The GUI submodule involves GPL code, and thus, is distributed under GPLv3. The upstream repository, on the other hand, runs GUI using non-GPL code, and uses the MIT License for GUI as well.
