Eclipse Community Forums: EMF » [XCore] Javadoc style comments?

Home » Modeling » EMF » [XCore] Javadoc style comments?

[XCore] Javadoc style comments? [message #841426]

Wed, 11 April 2012 05:30

Eclipse User

Hi,

As I understand current state of XCore, there is currently no support
for javadoc style comments for specifying a documentation for the
EModelElement.

I know I can do that today by explicitly specifying
@GenModel(documentation="...") annotation.

Is there a plan to use javadoc style comments for this in the future?

Re: [XCore] Javadoc style comments? [message #845545 is a reply to message #841426]

Sun, 15 April 2012 02:27

Eclipse User

Roland,

The latest builds will use the contents of a /* */ comment for the
equivalent of model documentation.

On 11/04/2012 11:30 AM, Roland Tepp wrote:
> Hi,
>
> As I understand current state of XCore, there is currently no support
> for javadoc style comments for specifying a documentation for the
> EModelElement.
>
> I know I can do that today by explicitly specifying
> @GenModel(documentation="...") annotation.
>
> Is there a plan to use javadoc style comments for this in the future?

Re: [XCore] Javadoc style comments? [message #846719 is a reply to message #845545]

Mon, 16 April 2012 10:58

Eclipse User

Thanks :)

15.04.2012 9:27, Ed Merks kirjutas:
> Roland,
>
> The latest builds will use the contents of a /* */ comment for the
> equivalent of model documentation.
>
>
> On 11/04/2012 11:30 AM, Roland Tepp wrote:
>> Hi,
>>
>> As I understand current state of XCore, there is currently no support
>> for javadoc style comments for specifying a documentation for the
>> EModelElement.
>>
>> I know I can do that today by explicitly specifying
>> @GenModel(documentation="...") annotation.
>>
>> Is there a plan to use javadoc style comments for this in the future?

Re: [XCore] Javadoc style comments? [message #1805555 is a reply to message #846719]

Wed, 17 April 2019 08:02

Eclipse User

I just saw this post because I have a similar problem/question.
Is there a possibility to force Xcore to add the javadoc-tags (@param, @return, etc.) to the automatic generated javadoc for each method?

Re: [XCore] Javadoc style comments? [message #1805558 is a reply to message #1805555]

Wed, 17 April 2019 08:20

Eclipse User

You can include these in your /**/ comment and they will end up in the "model-doc" section. That's sufficient isn't it?

Previous Topic:	How to generate model from meta-model?
Next Topic:	EMF Compare and Merge

Goto Forum:

-=] Back to Top [=-

Current Time: Wed Jul 02 23:03:50 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter