[FEATURE] PlantUML Comment support

To start out with i would like to say I’m a big fan of the project, and really love what you are doing here. 😃

Overview of the issue

Often when designing or documenting software, a series of diagrams can help visualize the flow, for example a sequence diagram can show how a service acts when called. And If one is using Microsoft Visio or similar software, it can be hard to merge/track in a version control system. So developers have created a piece of software called http://plantuml.com/ which takes a text input and outputs a diagram.

So, the feature would be to support a comment tag that either points to a file or inline’s the plant-uml code. Could look something like:

/** @diagram LikeCallFlow
 *   Bob->Alice : hello
 */

or

/** @diagram LikeCallFlow ./LikeCallFlow.uml
 */

Which would then output the diagram with the given title on a service or component compodoc page.

There’s already a package for PlantUML on npm, node-plantuml which may be of use. It does depend on Graphviz which i can understand may be a big dependency to have (#313). But a solution could be to have Graphviz as an optional dependency, thereby giving only users with it the features, along the lines of what Doxygen does.

Related issues

https://github.com/compodoc/compodoc/issues/313

I, of course wouldn’t mind help implement this. But it does seem like a rather large feature which may need some discussion before beginning 😃

[stale[bot]]

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.