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

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

DSL Generate Documentation [message #1803063]

Thu, 21 February 2019 10:31

Eclipse User

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.

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

Sat, 23 February 2019 02:55

Eclipse User

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.

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

Mon, 25 February 2019 03:11

Eclipse User

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

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

Mon, 25 February 2019 05:21

Eclipse User

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

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

Mon, 25 February 2019 06:57

Eclipse User

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 06:58] by Moderator

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

Mon, 25 February 2019 07:40

Eclipse User

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

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

Mon, 25 February 2019 07:58

Eclipse User

Yes, I want to document the grammar.

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

Mon, 25 February 2019 08:14

Eclipse User

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

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

Mon, 25 February 2019 08:29

Eclipse User

I didn't know about Xtext syntax view, thanks :D

Previous Topic:	Code completion in VSCode
Next Topic:	How to get the list of classes for scope

Goto Forum:

-=] Back to Top [=-

Current Time: Fri Jun 20 19:28:13 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter