Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ This is a generator to create a class-diagram of PlantUML from the C# source cod

**README.md Version revision history**

| Version | Commit | Comment |
| ------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 1.1 | [e73b4fe](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/e73b4feed9cd261271eb990a9c859f53536e8d7c) | Add "-excludeUmlBeginEndTags" option |
| Version | Commit | Comment |
|---------|---------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| 1.3 | [b464639](https://github.com/AnastasiaKallisto/PlantUmlClassDiagramGenerator/commit/b464639c3e8027559f175fae1ac45945e56954be) | Add "-removeSystemCollectionsAssociations" option |
| 1.2 | [cd9eed2](https://github.com/AnastasiaKallisto/PlantUmlClassDiagramGenerator/commit/cd9eed2539f9bac73410e6b6f1566ce979429f6f) | Add "-addPackageTags" option |
| 1.1 | [e73b4fe](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/e73b4feed9cd261271eb990a9c859f53536e8d7c) | Add "-excludeUmlBeginEndTags" option |
| 1.0 | [70bb820](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/70bb8202f7f489aa2d85ce9c25c58121c8f63aed) | Because the README.md for other languages is not always updated at the same time, a version number is needed |

## Roslyn Source Generator
Expand Down Expand Up @@ -39,22 +41,24 @@ dotnet tool install --global PlantUmlClassDiagramGenerator
Run the "puml-gen" command.

```bat
puml-gen InputPath [OutputPath] [-dir] [-public | -ignore IgnoreAccessibilities] [-excludePaths ExcludePathList] [-createAssociation]
puml-gen InputPath [OutputPath] [-dir] [-addPackageTags] [-public | -ignore IgnoreAccessibilities] [-excludePaths ExcludePathList] [-createAssociation]
```

- InputPath: (Required) Sets a input source file or directory name.
- OutputPath: (Optional) Sets a output file or directory name.
- **InputPath:** (Required) Sets a input source file or directory name.
- **OutputPath:** (Optional) Sets a output file or directory name.
If you omit this option, plantuml files are outputted to same directory as the input files.
- -dir: (Optional) Specify when InputPath and OutputPath are directory names.
- -public: (Optional) If specified, only public accessibility members are output.
- -ignore: (Optional) Specify the accessibility of members to ignore, with a comma separated list.
- -excludePaths: (Optional) Specify the exclude file and directory.
- **-dir**: (Optional) Specify when InputPath and OutputPath are directory names.
- **-addPackageTags:** (Optional) If there is "-dir" tag, then program adds "package" tags and puts all relations in the end of include.puml. Relations will not be shown in other files
- **-removeSystemCollectionsAssociations**: (Optional) If there are properties or fields like "IList<T>" and other SystemCollections, there will be no relation with IList, but relation with T will be shown, if it isn't base type (string, int ...)
- **-public:** (Optional) If specified, only public accessibility members are output.
- **-ignore:** (Optional) Specify the accessibility of members to ignore, with a comma separated list.
- **-excludePaths:** (Optional) Specify the exclude file and directory.
Specifies a relative path from the "InputPath", with a comma separated list.
To exclude multiple paths, which contain a specific folder name, preceed the name by "\*\*/". Example: "**/bin"
- -createAssociation: (Optional) Create object associations from references of fields and properites.
- -allInOne: (Optional) Only if -dir is set: copy the output of all diagrams to file include.puml (this allows a PlanUMLServer to render it).
- -attributeRequired: (Optional) When this switch is enabled, only types with "PlantUmlDiagramAttribute" in the type declaration will be output.
- -excludeUmlBeginEndTags: (Optional) When this switch is enabled, it will exclude the \"@startuml\" and \"@enduml\" tags from the puml file.
- **-createAssociation:** (Optional) Create object associations from references of fields and properites.
- **-allInOne:** (Optional) Only if -dir is set: copy the output of all diagrams to file include.puml (this allows a PlanUMLServer to render it).
- **-attributeRequired:** (Optional) When this switch is enabled, only types with "PlantUmlDiagramAttribute" in the type declaration will be output.
- **-excludeUmlBeginEndTags:** (Optional) When this switch is enabled, it will exclude the \"@startuml\" and \"@enduml\" tags from the puml file.

examples
```bat
Expand Down
Loading