Skip to main content



      Home
Home » Modeling » TMF (Xtext) » DSL Generate Documentation
DSL Generate Documentation [message #1803063] Thu, 21 February 2019 10:31 Go to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous messageGo to next message
Eclipse UserFriend
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 Go to previous message
Eclipse UserFriend
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:
  


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

Powered by FUDForum. Page generated in 0.06102 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top