Add support for inline diagraming through Mermaid.
The new @mermaid tag can be used to describe Mermaid diagrams through code. It works similarly to how @example
works, where the code gets placed in individual lines after defining the tag.
Example:
/**
* @description My Class' description
* @mermaid
* sequenceDiagram
* participant dotcom
* participant iframe
* participant viewscreen
* dotcom->>iframe: loads html w/ iframe url
* iframe->>viewscreen: request template
* viewscreen->>iframe: html & javascript
* iframe->>dotcom: iframe ready
* dotcom->>iframe: set mermaid data on iframe
* iframe->>iframe: render mermaid
*/
public class MyClass {
}
The diagram displays as
Note that to be able to make use of this feature you need to use a Markdown reader that supports rendering Mermaid (for example, Github's markdown reader has it built-into it).
Add support for inline diagraming through Mermaid.
The new
@mermaidtag can be used to describe Mermaid diagrams through code. It works similarly to how@exampleworks, where the code gets placed in individual lines after defining the tag.Example:
The diagram displays as
Note that to be able to make use of this feature you need to use a Markdown reader that supports rendering Mermaid (for example, Github's markdown reader has it built-into it).