Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Modeling » EMF "Technology" (Ecore Tools, EMFatic, etc)  » [Texo] documentation fields
[Texo] documentation fields [message #655369] Sun, 20 February 2011 01:41 Go to next message
Ray Kelm is currently offline Ray KelmFriend
Messages: 20
Registered: July 2009
Junior Member
In the Texo annotation model, there are two fields, one called "description" and another called "documentation". The templates seem to include support for adding these strings into the javadoc generated for classes and members, but it doesn't seem to actually work.

Is it supposed to work? Am I doing something wrong?

I am using:

EMFT Texo (Incubation) 0.1.0.v201012091708

test.ecore
<?xml version="1.0" encoding="UTF-8"?>
<ecore:EPackage xmi:version="2.0"
    xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" name="test"
    nsURI="http://example.org/test" nsPrefix="test">
  <eClassifiers xsi:type="ecore:EClass" name="Test">
    <eStructuralFeatures xsi:type="ecore:EAttribute" name="value" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
  </eClassifiers>
</ecore:EPackage>


test-code-gen.annotationsmodel
t<?xml version="1.0" encoding="ASCII"?>
<annotationsmodel:AnnotatedModel xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:annotationsmodel="http://www.eclipse.org/emf/texo/annotations/model" xmlns:modelannotations="http://www.eclipse.org/emf/texo/modelgenerator/modelannotations">
  <annotatedEPackages>
    <ePackage href="test.ecore#/"/>
    <ePackageAnnotations xsi:type="modelannotations:EPackageModelGenAnnotation" description="this is the description" documentation="this is the documentation" name="test" addRuntimeModelBehavior="false" packagePath="org.example.test" modelClassesPackagePath="org.example.test" qualifiedClassName="org.example.test.TestModelPackage" simpleClassName="TestModelPackage" simpleModelFactoryClassName="TestModelFactory" ecoreFileName="test.ecore"/>
    <annotatedEClassifiers xsi:type="annotationsmodel:AnnotatedEClass">
      <eClass href="test.ecore#//Test"/>
      <eClassAnnotations xsi:type="modelannotations:EClassModelGenAnnotation" description="this is the description" name="Test" qualifiedClassName="org.example.test.Test" simpleClassName="Test" generateCode="true" ownerEPackageAnnotation="//@annotatedEPackages.0/@ePackageAnnotations.0" hasSuperEClass="false" serializable="false" abstract="false"/>
      <annotatedEStructuralFeatures xsi:type="annotationsmodel:AnnotatedEAttribute">
        <eAttribute href="test.ecore#//Test/value"/>
        <eAttributeAnnotations xsi:type="modelannotations:EAttributeModelGenAnnotation" description="this is the description" documentation="this is the value" name="value" getter="getValue" type="java.lang.String" objectType="java.lang.String" itemType="java.lang.String" defaultValue="null" setter="setValue" validJavaMemberName="value" many="false" useList="false" reference="false" ownerEClassAnnotation="//@annotatedEPackages.0/@annotatedEClassifiers.0/@eClassAnnotations.0" boolean="false" primitive="false"/>
      </annotatedEStructuralFeatures>
    </annotatedEClassifiers>
  </annotatedEPackages>
</annotationsmodel:AnnotatedModel>
Re: [Texo] documentation fields [message #655451 is a reply to message #655369] Mon, 21 February 2011 08:19 Go to previous messageGo to next message
Martin Taal is currently offline Martin TaalFriend
Messages: 5468
Registered: July 2009
Senior Member
Hi Ray,
This was indeed a bug. I solved it and published a new build.

gr. Martin

On 02/20/2011 02:41 AM, Ray Kelm wrote:
> In the Texo annotation model, there are two fields, one called "description" and another called "documentation". The
> templates seem to include support for adding these strings into the javadoc generated for classes and members, but it
> doesn't seem to actually work.
>
> Is it supposed to work? Am I doing something wrong?
>
> I am using:
> EMFT Texo (Incubation) 0.1.0.v201012091708
>
> test.ecore
>
> <?xml version="1.0" encoding="UTF-8"?>
> <ecore:EPackage xmi:version="2.0"
> xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
> xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" name="test"
> nsURI="http://example.org/test" nsPrefix="test">
> <eClassifiers xsi:type="ecore:EClass" name="Test">
> <eStructuralFeatures xsi:type="ecore:EAttribute" name="value" eType="ecore:EDataType
> http://www.eclipse.org/emf/2002/Ecore#//EString"/>
> </eClassifiers>
> </ecore:EPackage>
>
>
> test-code-gen.annotationsmodel
>
> t<?xml version="1.0" encoding="ASCII"?>
> <annotationsmodel:AnnotatedModel xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI"
> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
> xmlns:annotationsmodel="http://www.eclipse.org/emf/texo/annotations/model"
> xmlns:modelannotations=" http://www.eclipse.org/emf/texo/modelgenerator/modelannotati ons">
> <annotatedEPackages>
> <ePackage href="test.ecore#/"/>
> <ePackageAnnotations xsi:type="modelannotations:EPackageModelGenAnnotation" description="this is the description"
> documentation="this is the documentation" name="test" addRuntimeModelBehavior="false" packagePath="org.example.test"
> modelClassesPackagePath="org.example.test" qualifiedClassName="org.example.test.TestModelPackage"
> simpleClassName="TestModelPackage" simpleModelFactoryClassName="TestModelFactory" ecoreFileName="test.ecore"/>
> <annotatedEClassifiers xsi:type="annotationsmodel:AnnotatedEClass">
> <eClass href="test.ecore#//Test"/>
> <eClassAnnotations xsi:type="modelannotations:EClassModelGenAnnotation" description="this is the description"
> name="Test" qualifiedClassName="org.example.test.Test" simpleClassName="Test" generateCode="true"
> ownerEPackageAnnotation="//@annotatedEPackages.0/@ePackageAnnotations.0 " hasSuperEClass="false" serializable="false"
> abstract="false"/>
> <annotatedEStructuralFeatures xsi:type="annotationsmodel:AnnotatedEAttribute">
> <eAttribute href="test.ecore#//Test/value"/>
> <eAttributeAnnotations xsi:type="modelannotations:EAttributeModelGenAnnotation" description="this is the description"
> documentation="this is the value" name="value" getter="getValue" type="java.lang.String" objectType="java.lang.String"
> itemType="java.lang.String" defaultValue="null" setter="setValue" validJavaMemberName="value" many="false"
> useList="false" reference="false"
> ownerEClassAnnotation=" //@annotatedEPackages.0/@annotatedEClassifiers.0/@eClassAnno tations.0 " boolean="false"
> primitive="false"/>
> </annotatedEStructuralFeatures>
> </annotatedEClassifiers>
> </annotatedEPackages>
> </annotationsmodel:AnnotatedModel>
>


--

With Regards, Martin Taal

Springsite/Elver.org
Office: Hardwareweg 4, 3821 BV Amersfoort
Postal: Nassaulaan 7, 3941 EC Doorn
The Netherlands
Cell: +31 (0)6 288 48 943
Tel: +31 (0)84 420 2397
Fax: +31 (0)84 225 9307
Mail: mtaal@springsite.com - mtaal@elver.org
Web: www.springsite.com - www.elver.org
Re: [Texo] documentation fields [message #656313 is a reply to message #655451] Fri, 25 February 2011 02:34 Go to previous message
Ray Kelm is currently offline Ray KelmFriend
Messages: 20
Registered: July 2009
Junior Member
Awesome, thanks!
Previous Topic: [EEF] EEF and Undo
Next Topic:[EMF Compare] Ecore diagram for EMF Compare metamodel?
Goto Forum:
  


Current Time: Wed Oct 21 14:29:24 GMT 2020

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

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

Back to the top