Eclipse Community Forums: EMF » Documentation generator for Ecore models

Home » Modeling » EMF » Documentation generator for Ecore models(Generating static HTML documentation sites for Ecore models with Maven)

Show: Today's Messages :: Show Polls :: Message Navigator

Documentation generator for Ecore models [message #1851444]

Tue, 05 April 2022 21:40

Pavel Vlasov

Messages: 7
Registered: March 2013

Junior Member

Hello,

There is a documentation generator for Ecore models which I created some time ago and finally found time to document.

It supports generation of UML diagrams and rich documentation of model elements with Markdown.

More details are here, including examples - https://docs.nasdanika.org/modules/html/modules/ecore/index.html

I hope it might be helpful for the EMF community!
---
Regards, Pavel.

[Updated on: Tue, 05 April 2022 21:42]

Report message to a moderator

Re: Documentation generator for Ecore models [message #1852012 is a reply to message #1851444]

Mon, 25 April 2022 19:11

Ewoud Werkman

Messages: 28
Registered: January 2018

Junior Member

Hi Pavel,

Thanks for mentioning this and thanks for your work.
We've been using your efforts already for a few years, back when there was an Eclipse plugin (in the MarketPlace) that could generate a HTML site by right-clicking the .genmodel.
When the plugin was removed from the marketplace a few years ago, I went through your repository and adapted the code from the time that plugin was created.

I still need to find time to publish the source code of my adaptations, as I've created a executable jar that uses your original YAML configuration file to generate the site by double-clicking on it. It's not as fancy as your current version, but suffices for us. An example can be found here: https://energytransition.github.io . Users of our models use it a lot as a reference guide for this large model. So thanks a lot!

Kind regards,
Ewoud

Report message to a moderator