Closed krisztianb closed 4 years ago
Looking through all the documentation generation tools for TypeDoc I haven't found a single one that supports UML diagrams.
@meirgottlieb your plugin is great and enables one to define all kinds of UML diagrams everywhere in the comments. Terrific job!
What I found is that people usually only want some kind of basic class diagram in their documentation. Having to write all the PlantUML for this in ever single file is very tiresome. So I decided to create an option that does this automatically.
Please review the code and tell me what you think about it. Thanks a lot.
I had some new ideas for improving my code. I'll update the code and create a new pull request soon.
Use the new option
--umlAddClassDiagram
to automatically add UML class diagrams to classes and interfaces.Here is how it works:
--umlAddClassDiagram
(value =above|below
) when executing TypeDoc.<uml>
tag is added to the comment of the class/interface. The tag includes a basic class diagram showing the class/interface and its extended/implemented types.