Eclipse Community Forums: TMF (Xtext) » Generate documentation from xtext grammar

Help

Home

Home » Modeling » TMF (Xtext) » Generate documentation from xtext grammar

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

Generate documentation from xtext grammar [message #725640]

Thu, 15 September 2011 12:02

Kiran Subbaraman

Messages: 9
Registered: May 2011

Junior Member

I have created a .xtext grammar file. I have also included comments within this grammar, so that the elements and their purpose is less ambiguous.
I was wondering if there is a facility in Xtext to generate documentation from this .xtext file (Html documentation on the lines of what javaDoc generates is a what I have in mind).

I noticed that there is an earlier similar unanswered question in this forum: http://www.eclipse.org/forums/index.php/m/674399/.

Any thoughts?

Or if I have to do this myself, where should I start? I was thinking of walking through an AST of my .xtext file and generating html content based on it. Or is there a better way to do this?

Thank you,
Kiran

Report message to a moderator

Re: Generate documentation from xtext grammar [message #725918 is a reply to message #725640]

Fri, 16 September 2011 07:38

Jan Koehnlein

Messages: 760
Registered: July 2009
Location: Hamburg

Senior Member

I am not aware of any efforts in that direction.
A good starting point would be the default implementation of the hover
API, e.g. IEObjectDocumentationProvider.

Am 15.09.11 14:02, schrieb Kiran Subbaraman:
> I have created a .xtext grammar file. I have also included comments
> within this grammar, so that the elements and their purpose is less
> ambiguous.
> I was wondering if there is a facility in Xtext to generate
> documentation from this .xtext file (Html documentation on the lines of
> what javaDoc generates is a what I have in mind).
>
> I noticed that there is an earlier similar unanswered question in this
> forum: http://www.eclipse.org/forums/index.php/m/674399/.
>
> Any thoughts?
>
> Or if I have to do this myself, where should I start? I was thinking of
> walking through an AST of my .xtext file and generating html content
> based on it. Or is there a better way to do this?
>
> Thank you,
> Kiran

--
Need professional support for Eclipse Modeling?
Go visit: http://xtext.itemis.com

---
Get professional support from the Xtext committers at www.typefox.io

Report message to a moderator

Re: Generate documentation from xtext grammar [message #725921 is a reply to message #725918]

Fri, 16 September 2011 07:42

Jos Warmer

Messages: 114
Registered: October 2010

Senior Member

Kiran,

You might want to take a look at Generate EBNF-Descriptions for Xtext-based DSL. This describes how to generate a clean EBNF grammar from an Xtext grammar.

Jos

Report message to a moderator

Re: Generate documentation from xtext grammar [message #727378 is a reply to message #725921]

Wed, 21 September 2011 06:20

Kiran Subbaraman

Messages: 9
Registered: May 2011

Junior Member

On Friday 16 September 2011 01:12 PM, Jos Warmer wrote:
> Kiran,
>
> You might want to take a look at
> http://xtexterience.wordpress.com/2011/05/13/an-ebnf-grammar-in-xtext/.
> This describes how to generate a clean EBNF grammar from an Xtext grammar.
>
> Jos

Jos,
This is really useful stuff. Thank you.
Kiran

Report message to a moderator

Re: Generate documentation from xtext grammar [message #727379 is a reply to message #725918]

Wed, 21 September 2011 06:20

Kiran Subbaraman

Messages: 9
Registered: May 2011

Junior Member

On Friday 16 September 2011 01:08 PM, Jan Koehnlein wrote:
> I am not aware of any efforts in that direction.
> A good starting point would be the default implementation of the hover
> API, e.g. IEObjectDocumentationProvider.
>
>
> Am 15.09.11 14:02, schrieb Kiran Subbaraman:
>> I have created a .xtext grammar file. I have also included comments
>> within this grammar, so that the elements and their purpose is less
>> ambiguous.
>> I was wondering if there is a facility in Xtext to generate
>> documentation from this .xtext file (Html documentation on the lines of
>> what javaDoc generates is a what I have in mind).
>>
>> I noticed that there is an earlier similar unanswered question in this
>> forum: http://www.eclipse.org/forums/index.php/m/674399/.
>>
>> Any thoughts?
>>
>> Or if I have to do this myself, where should I start? I was thinking of
>> walking through an AST of my .xtext file and generating html content
>> based on it. Or is there a better way to do this?
>>
>> Thank you,
>> Kiran
>
>

Jan,
Will try that out. Thank you.
Kiran

Report message to a moderator

Previous Topic:	Change Javadoc tooltip dynamically?
Next Topic:	xtext editor for GMF node features

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Wed Sep 25 08:18:10 GMT 2024

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter