mrdocs icon indicating copy to clipboard operation
mrdocs copied to clipboard

Add UML diagrams output, like Doxygen does

Open pietrom16 opened this issue 1 year ago • 4 comments

For me, the most useful feature would be a graphics UML output (similar to what provided by Doxygen). Will this feature be added in the future? Thanks

pietrom16 avatar Oct 24 '24 16:10 pietrom16

It might be very long time, if ever

vinniefalco avatar Oct 24 '24 16:10 vinniefalco

If you edit the templates in share/mrdocs/addons, you can get the base classes of the symbol with symbol.bases and so on to get something like the doxygen diagrams in the output. The problem is you will need an external tool to render the image in your output, so it becomes complex to add it to the default templates. For instance, Doxygen uses dot, but many other tools, like mermaid or even embedded SVG, could be more appropriate.

alandefreitas avatar Oct 25 '24 00:10 alandefreitas

No need to reinvent the wheel. dot can be fine, either as an initial temporary tool, or as a long term one.

FYI, there is another project, Sourcetrail, now archived, to which I suggest to have a look. It is similar to Doxygen, but instead of processing the source code all at once, as a first stage, it does it in real time, so the diagrams are updated as soon as the source changes.

pietrom16 avatar Oct 31 '24 12:10 pietrom16

No need to reinvent the wheel. dot can be fine, either as an initial temporary tool, or as a long term one.

Yes. You can use custom templates and the data to include the diagrams however you'd like. In the long term, we're still unsure what we will do about diagrams in the default templates. For instance, I like Mermaid better for Asciidoc templates. Even GitHub supports it natively.

alandefreitas avatar Oct 31 '24 17:10 alandefreitas