Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add UML diagrams output, like Doxygen does #714

Open
pietrom16 opened this issue Oct 24, 2024 · 4 comments
Open

Add UML diagrams output, like Doxygen does #714

pietrom16 opened this issue Oct 24, 2024 · 4 comments
Labels
Feature Something new that it should do

Comments

@pietrom16
Copy link

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

@vinniefalco
Copy link
Member

It might be very long time, if ever

@alandefreitas
Copy link
Collaborator

alandefreitas commented Oct 25, 2024

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 alandefreitas added the Feature Something new that it should do label Oct 25, 2024
@alandefreitas alandefreitas moved this to Accepted in MrDocs Oct 25, 2024
@pietrom16 pietrom16 changed the title Ad UML diagrams output, like Doxygen does Add UML diagrams output, like Doxygen does Oct 31, 2024
@pietrom16
Copy link
Author

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.

@alandefreitas
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Something new that it should do
Projects
Status: Accepted
Development

No branches or pull requests

3 participants