Documentation tab

[Sven Ott]

Hey,

I see that there is a documentation tab shipped with the mbeddr plugins but it looks always empty.

I am wondering how I can fill it with data because I think it would be a nice way to document the concepts of our own DSL?

Thanks in advance!

Best

Sven

[Kolja Dummann]

Hi Sven,

you can take a look at the language “com.mbeddr.doc.aspect”. If you open the mbeddr.doc project in the source source repo it also contains a sample hot to use that language.

In short, you write document in the documentation language and then use annotations on the concept declaration (in the structure aspect of the language) to reference the relevant section of the documentation. 

Cheers,

Kolja

--
You received this message because you are subscribed to the Google Groups "mbeddr-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mbeddr-discus...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Daniel Ratiu]

Hi Sven,

another usage example of the documentation aspect is in the
"com.mbeddr.analyses" project (see screenshot attached).

Dan

[Eugen Schindler]

Hi Kolja, Daniel,

Thanks for this interesting information.

Which annotation do I have to use in order to link back from a concept to a section of the documentation? I tried to do this type of link, but maybe I'm missing some language that needs to be imported?

Also Daniel's example didn't give more insight, since I don't see any links from concepts in structure to a section in the documentation (there are links the other way around though).

Greetings,

Eugen

[Kolja Dummann]

Hi Eugen,

sorry for the confusion. It’s not possible to link from the structure to the docs, only the other way a round because otherwise we would easily introduce a cycle in the model dependencies. 

Cheers,

Kolja