Eclipse Community Forums: TMF (Xtext) » DSL Generate Documentation

Help

Home

Home » Modeling » TMF (Xtext) » DSL Generate Documentation

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

DSL Generate Documentation [message #1803063]

Thu, 21 February 2019 15:31

Noslen Acesnof

Messages: 23
Registered: February 2019

Junior Member

Hello.

I'm building a DSL and I'm wondering if with Xtext or Xtend we can generate documentation of the DSL, as javadoc does with java programs.

Report message to a moderator

Re: DSL Generate Documentation [message #1803136 is a reply to message #1803063]

Sat, 23 February 2019 07:55

Uli Merkel

Messages: 245
Registered: June 2013

Senior Member

It seems just like a matter to extend your Generator.

You can use the AST
to generate an additional file
with all documentation you like.

Report message to a moderator

Re: DSL Generate Documentation [message #1803191 is a reply to message #1803136]

Mon, 25 February 2019 08:11

Noslen Acesnof

Messages: 23
Registered: February 2019

Junior Member

Thanks, I will try, but I'm kinda new at creating DSLs, do you have any tip how I to do that?

Report message to a moderator

Re: DSL Generate Documentation [message #1803206 is a reply to message #1803191]

Mon, 25 February 2019 10:21

Christian Dietrich

Messages: 13071
Registered: July 2009

Senior Member

please have a look at the generator tutorial https://www.eclipse.org/Xtext/documentation/103_domainmodelnextsteps.html
instead of java files simply generate .txt .html .md or whatever textformat you wish

Need professional support for Xtext, Xpand, EMF?
Go to: https://www.itemis.com/en/xtext/
Twitter : @chrdietrich
Blog : https://www.dietrich-it.de

Report message to a moderator

Re: DSL Generate Documentation [message #1803217 is a reply to message #1803206]

Mon, 25 February 2019 11:57

Noslen Acesnof

Messages: 23
Registered: February 2019

Junior Member

Christian Dietrich wrote on Mon, 25 February 2019 10:21

please have a look at the generator tutorial https://www.eclipse.org/Xtext/documentation/103_domainmodelnextsteps.html
instead of java files simply generate .txt .html .md or whatever textformat you wish

I think that I was miss understood. What I meant to say is that I have a DSL totally built, but now I want to generate documentation automatically for it. But like Uli MerkelFriend, I can't do that without creating a generator for documentation too, right?

[Updated on: Mon, 25 February 2019 11:58]

Report message to a moderator

Re: DSL Generate Documentation [message #1803222 is a reply to message #1803217]

Mon, 25 February 2019 12:40

Christian Dietrich

Messages: 13071
Registered: July 2009

Senior Member

Please explain. What exactly do you want to document ? The grammar ?

Need professional support for Xtext, Xpand, EMF?
Go to: https://www.itemis.com/en/xtext/
Twitter : @chrdietrich
Blog : https://www.dietrich-it.de

Report message to a moderator

Re: DSL Generate Documentation [message #1803226 is a reply to message #1803222]

Mon, 25 February 2019 12:58

Noslen Acesnof

Messages: 23
Registered: February 2019

Junior Member

Yes, I want to document the grammar.

Report message to a moderator

Re: DSL Generate Documentation [message #1803228 is a reply to message #1803226]

Mon, 25 February 2019 13:14

Christian Dietrich

Messages: 13071
Registered: July 2009

Senior Member

There is nothing

You can write a own grammar fragment and add it to the workflow

Or you manually use the Xtext syntax view and create something out of it

Need professional support for Xtext, Xpand, EMF?
Go to: https://www.itemis.com/en/xtext/
Twitter : @chrdietrich
Blog : https://www.dietrich-it.de

Report message to a moderator