README.md

PlantUMLGenerator

PlantUML Generator is a jar application to automatically generate PlantUML class diagrams from source code.

Usage

1. Download the PlantUMLGenerator jar.
2. Download the PlantUML jar and place it in the same folder of the previous jar.
3. Open a terminal and navigate to the location of both jars and choose one of the following commands.

1. Generate a class diagram for the entire project

java -jar PlantUMLGenerator.jar [PROJECT_ROOT_PATH] [OUTPUT_FILE_PATH].puml

View example

Example with Nice Places Android App:

java -jar PlantUMLGenerator.jar niceplaces-android-app/app/src/main/java niceplaces.puml

2. Generate a class diagram for a specific package of the project

java -jar PlantUMLGenerator.jar [PACKAGE_PATH] [OUTPUT_FILE_PATH].puml

View example

Example with Nice Places Android App

java -jar PlantUMLGenerator.jar niceplaces-android-app/app/src/main/java/com/niceplaces/niceplaces/activities niceplaces-activities.puml

View output

3. Generate a class diagram for a specific class of the project

java -jar PlantUMLGenerator.jar [PROJECT_ROOT_PATH] [OUTPUT_FILE_PATH].puml [TARGET_CLASS_NAME]

View example

Example with Nice Places Android App

java -jar PlantUMLGenerator.jar niceplaces-android-app/app/src/main/java niceplaces-menuactivity.puml MenuActivity

View output

❤️ Support

Building software is awesome, making it free and open source is even more so. However, this requires dedication, efforts, and time. If you use this software or find it valuable, please support my commitment in developing and maintaining this project through one or more of the following methods:

• Follow me on GitHub, Twitter or LinkedIn.
• Share or star the project.
• Make a donation.

Your support would be very precious for me.

Thank you,

Lorenzo