Eclipse Community Forums: EMF » Adding Javadoc to the Model

Home » Modeling » EMF » Adding Javadoc to the Model

Adding Javadoc to the Model [message #1446554]

Thu, 16 October 2014 21:50

Eclipse User

Hi,

I'm trying to figure out the correct way of adding documentation to ecore. If anyone has a snippet example that would be great. I tried this:

<eAnnotations
source="http://www.eclipse.org/emf/2002/GenModel">
<details
key="documentation"
value="Inserted Javadoc Inserted Javadoc Inserted Javadoc Inserted Javadoc Inserted Javadoc.;"/>
</eAnnotations>

But no luck. Also I was reading through Lars Vogel's tutorial:

http://www.vogella.com/tutorials/EclipseEMF/article.html#javadoc

And in section 7 he says that the properties view of the diagram editor is supposed to have a "GenModel Doc" tab, but when I open the properties view all I see is a single "Core tab". Any ideas on what I need to do to get the rest of the tabs?

TIA,
- Ole

Re: Adding Javadoc to the Model [message #1446634 is a reply to message #1446554]

Fri, 17 October 2014 00:59

Eclipse User

Ole,

I'd expect to see a tab like this:

You're using the latest Ecore Tools editor?

This is how EcoreUtil finds documentation:

protected static final String GEN_MODEL_PACKAGE_NS_URI =
"http://www.eclipse.org/emf/2002/GenModel";

public static String getDocumentation(EModelElement eModelElement)
{
EAnnotation eAnnotation =
eModelElement.getEAnnotation(GEN_MODEL_PACKAGE_NS_URI);
return eAnnotation == null ? null :
(String)eAnnotation.getDetails().get("documentation");
}

so what you show below looks correct. What did you annotate and where
are you looking for the result?

On 17/10/2014 3:50 AM, Ole Ersoy wrote:
> Hi,
>
> I'm trying to figure out the correct way of adding documentation to
> ecore. If anyone has a snippet example that would be great. I tried
> this:
>
> <eAnnotations
> source="http://www.eclipse.org/emf/2002/GenModel">
> <details
> key="documentation"
> value="Inserted Javadoc Inserted Javadoc Inserted Javadoc
> Inserted Javadoc Inserted Javadoc.;"/>
> </eAnnotations>
>
> But no luck. Also I was reading through Lars Vogel's tutorial:
>
> http://www.vogella.com/tutorials/EclipseEMF/article.html#javadoc
>
> And in section 7 he says that the properties view of the diagram
> editor is supposed to have a "GenModel Doc" tab, but when I open the
> properties view all I see is a single "Core tab". Any ideas on what I
> need to do to get the rest of the tabs?
>
> TIA,
> - Ole

Re: Adding Javadoc to the Model [message #1446635 is a reply to message #1446634]

Fri, 17 October 2014 01:00

Eclipse User

<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
I think I have to post as HTML from Thunderbird for the diagram to
come out: 
 
<img src="https://www.eclipse.org/forums/index.php?t=getfile&id=19545" alt=""> 
 
<div class="moz-cite-prefix">On 17/10/2014 6:59 AM, Ed Merks wrote: 
</div>
<blockquote cite="mid:m1q7pq$tgn$1@xxxxxxxxe.org" type="cite">Ole,
 
 
I'd expect to see a tab like this:
 
 
 
 
You're using the latest Ecore Tools editor?
 
 
This is how EcoreUtil finds documentation:
 
 
protected static final String GEN_MODEL_PACKAGE_NS_URI =
<a class="moz-txt-link-rfc2396E" href="http://www.eclipse.org/emf/2002/GenModel">"http://www.eclipse.org/emf/2002/GenModel"</a>;
 
 
public static String getDocumentation(EModelElement
eModelElement)
 
{
 
 EAnnotation eAnnotation =
eModelElement.getEAnnotation(GEN_MODEL_PACKAGE_NS_URI);
 
 return eAnnotation == null ? null :
(String)eAnnotation.getDetails().get("documentation");
 
}
 
 
so what you show below looks correct. What did you annotate and
where are you looking for the result?
 
 
 
On 17/10/2014 3:50 AM, Ole Ersoy wrote:
 
<blockquote type="cite">Hi,
 
 
I'm trying to figure out the correct way of adding documentation
to ecore. If anyone has a snippet example that would be great.
I tried this:
 
 
 <eAnnotations
 
 source=<a class="moz-txt-link-rfc2396E" href="http://www.eclipse.org/emf/2002/GenModel">"http://www.eclipse.org/emf/2002/GenModel"</a>>
 
 <details
 
 key="documentation"
 
 value="Inserted Javadoc Inserted Javadoc Inserted
Javadoc Inserted Javadoc Inserted Javadoc.;"/>
 
 </eAnnotations>
 
 
But no luck. Also I was reading through Lars Vogel's tutorial:
 
 
<a class="moz-txt-link-freetext" href="http://www.vogella.com/tutorials/EclipseEMF/article.html#javadoc">http://www.vogella.com/tutorials/EclipseEMF/article.html#javadoc</a>
 
 
And in section 7 he says that the properties view of the diagram
editor is supposed to have a "GenModel Doc" tab, but when I open
the properties view all I see is a single "Core tab". Any ideas
on what I need to do to get the rest of the tabs?
 
 
TIA,
 
- Ole
 
</blockquote>
 
</blockquote>
 
</body>
</html>

Attachment: ebghcgje.png
(Size: 8.10KB, Downloaded 193 times)

Re: Adding Javadoc to the Model [message #1447158 is a reply to message #1446635]

Fri, 17 October 2014 18:05

Eclipse User

I'm going to try answering in small segments, because my messages will not send after I switched to hml editing.
So this is just a test. Ignore the below.

On 10/17/2014 12:00 AM, Ed Merks wrote:
> I think I have to post as HTML from Thunderbird for the diagram to come out:
>
>
>
> On 17/10/2014 6:59 AM, Ed Merks wrote:
>> Ole,
>>
>> I'd expect to see a tab like this:
>>
>>
>>
>> You're using the latest Ecore Tools editor?
>>
>> This is how EcoreUtil finds documentation:
>>
>> protected static final String GEN_MODEL_PACKAGE_NS_URI = "http://www.eclipse.org/emf/2002/GenModel";
>>
>> public static String getDocumentation(EModelElement eModelElement)
>> {
>> EAnnotation eAnnotation = eModelElement.getEAnnotation(GEN_MODEL_PACKAGE_NS_URI);
>> return eAnnotation == null ? null : (String)eAnnotation.getDetails().get("documentation");
>> }
>>
>> so what you show below looks correct. What did you annotate and where are you looking for the result?
>>
>>
>> On 17/10/2014 3:50 AM, Ole Ersoy wrote:
>>> Hi,
>>>
>>> I'm trying to figure out the correct way of adding documentation to ecore. If anyone has a snippet example that would be great. I tried this:
>>>
>>> <eAnnotations
>>> source="http://www.eclipse.org/emf/2002/GenModel">
>>> <details
>>> key="documentation"
>>> value="Inserted Javadoc Inserted Javadoc Inserted Javadoc Inserted Javadoc Inserted Javadoc.;"/>
>>> </eAnnotations>
>>>
>>> But no luck. Also I was reading through Lars Vogel's tutorial:
>>>
>>> http://www.vogella.com/tutorials/EclipseEMF/article.html#javadoc
>>>
>>> And in section 7 he says that the properties view of the diagram editor is supposed to have a "GenModel Doc" tab, but when I open the properties view all I see is a single "Core tab". Any ideas on what I need to do to get the rest of the tabs?
>>>
>>> TIA,
>>> - Ole
>>
>

Re: Adding Javadoc to the Model [message #1447184 is a reply to message #1446635]

Fri, 17 October 2014 18:59

Eclipse User

<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div class="moz-cite-prefix">On 10/17/2014 12:00 AM, Ed Merks wrote: 
</div>
<blockquote cite="mid:m1q7ra$tgn$2@xxxxxxxxe.org" type="cite">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
I think I have to post as HTML from Thunderbird for the diagram to
come out: 
 
<img src="cid:part1.05010006.03040208@xxxxxxxx" alt=""> 
 
</blockquote>
I'm using the latest Luna download. I went to Help > Install
Modeling Components and selected Ecore Tools. After the install, I
right clicked the ecore model and created the corresponding
ecore_diagram model. The tabs look like this: 
 
<img alt="image" src="https://www.eclipse.org/forums/index.php?t=getfile&id=19564"
height="395" width="1432"> 
 
I'll answer the second half in different email, in case my markup is
throwing off thunderbird. 
 
Cheers, 
- Ole 
 
</body>
</html>

Attachment: Eclass.png
(Size: 30.83KB, Downloaded 153 times)

Re: Adding Javadoc to the Model [message #1447191 is a reply to message #1446635]

Fri, 17 October 2014 19:10

Eclipse User

<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
 
<blockquote cite="mid:m1q7ra$tgn$2@xxxxxxxxe.org" type="cite">
<blockquote cite="mid:m1q7pq$tgn$1@xxxxxxxxe.org" type="cite">
You're using the latest Ecore Tools editor? 
 
This is how EcoreUtil finds documentation: 
 
protected static final String GEN_MODEL_PACKAGE_NS_URI = <a
moz-do-not-send="true" class="moz-txt-link-rfc2396E"
href="http://www.eclipse.org/emf/2002/GenModel">"http://www.eclipse.org/emf/2002/GenModel"</a>;
 
 
public static String getDocumentation(EModelElement
eModelElement) 
{ 
 EAnnotation eAnnotation =
eModelElement.getEAnnotation(GEN_MODEL_PACKAGE_NS_URI); 
 return eAnnotation == null ? null :
(String)eAnnotation.getDetails().get("documentation"); 
} 
 
so what you show below looks correct. What did you annotate
and where are you looking for the result? 
</blockquote>
</blockquote>
 
OK - This part works - Thanks! Tested from scratch with the library
project instead of using my own. 
 
Thanks again, 
- Ole 
</body>
</html>

Previous Topic:	Create Ecore file programmatically with unique id for every elements
Next Topic:	Performance problem: how to speed up loadPackage() in EPackageImpl class

Goto Forum:

-=] Back to Top [=-

Current Time: Wed May 21 18:08:07 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter