code_uml 1.0.0
code_uml: ^1.0.0 copied to clipboard
This package help you build UML diagram. You have to copy result from result file and paste in PlantUML
CodeUML #
This package will help you create code for PlantUML, and then use it to build a diagram.
Unrealized features #
- Generics
- Getters, Setters
- Enum
- Global functions, variables
How to use #
The first step is to perform the installation:
Common step #
Install Open JDK 17.
Then:
> dart pub global activate code_uml
MacOS #
You must have java on your computer
> code_uml <dirs_for_analysis> <dir_where_outputs_files_will_be_saved>
Linux #
You must have java on your computer
> code_uml <dirs_for_analysis> <dir_where_outputs_files_will_be_saved>
Windows #
NOT IMPLEMENTED
Console output #
Then you need to run the command to output the code to the console:
> code_uml [<your_path_to_dir>] --console
For example:
> code_uml /home/user/my_dir_code/first_dir --console
or
> code_uml /home/user/my_dir_code/first_dir_for_analysis /home/user/my_dir_code/second_dir_for_analysis --console
File #
If you want to output the result to a file, then run the command:
> code_uml <...your_path_to_dir> <dir_where_outputs_files_will_be_saved>
For example:
> code_uml /home/user/my_dir_code/first_dir /home/user/documents/uml/