Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Modeling » EMF » [XCore] Javadoc style comments?
[XCore] Javadoc style comments? [message #841426] Wed, 11 April 2012 09:30 Go to next message
Roland Tepp is currently offline Roland TeppFriend
Messages: 36
Registered: July 2009
Member
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 06:27 Go to previous messageGo to next message
Ed Merks is currently offline Ed MerksFriend
Messages: 33140
Registered: July 2009
Senior Member
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?


Ed Merks
Professional Support: https://www.macromodeling.com/
Re: [XCore] Javadoc style comments? [message #846719 is a reply to message #845545] Mon, 16 April 2012 14:58 Go to previous messageGo to next message
Roland Tepp is currently offline Roland TeppFriend
Messages: 36
Registered: July 2009
Member
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 12:02 Go to previous messageGo to next message
Alexander Fichtinger is currently offline Alexander FichtingerFriend
Messages: 66
Registered: January 2013
Member
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 12:20 Go to previous message
Ed Merks is currently offline Ed MerksFriend
Messages: 33140
Registered: July 2009
Senior Member
You can include these in your /**/ comment and they will end up in the "model-doc" section. That's sufficient isn't it?

Ed Merks
Professional Support: https://www.macromodeling.com/
Previous Topic:How to generate model from meta-model?
Next Topic:EMF Compare and Merge
Goto Forum:
  


Current Time: Wed Apr 24 18:17:50 GMT 2024

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

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

Back to the top