Re: [Topcased-users] Antwort: Re: Documenting with GenDoc

Tue, 27 Apr 2010 06:52:20 -0700

Hi Dominik,

Concerning the display of the documentation on an element by method 'getDocumentation', I must add that this method can only be used with raw text documentation (and not HTML Documentation for now). Do you define Documentation on Properties via HTML editor inside Topcased Documentation view?
Properties and Parameters are not in the Documentation of the Operation, unless you explicitly fill the Documentation associated to the Operation with these specific elements.

For the second question on how to get Parameters for Operations, there is an eAttribute 'ownedParameter' on an Operation, that allows you to get the list of parameters of the operation.

1/ You can find all available eAttributes and eOperations on UML model elements in UML ecore model :
One of the ways to obtain the uml ecore model file : from Eclipse 'Package Explorer' view, Right click -> import->Plug-in -> Import from the active target platform, Import as projects with source folder -> org.eclipse.uml2.uml -> Finish
In 'Models' folder, you can find the different .ecore files.

2/ Another way is to use the M2T Acceleo editor inside in such cases. The editor provides auto-completion with available operations and attributes on your model elements.

The reason why Enumerations are seen as DataTypes is because Enumeration extends DataType, so you must check inside DataTypes which ones are Enumerations (using method "oclIsKindOf" for example). But that is something you can see now inside UML metamodel.

Regards,
Anne

[email protected] a écrit :

Hi Tristan,

I now tried to do the Documenting in GenDoc2 and OpenOffice. The Problem here lies I think with the way acceleo get's its documentation from within the Model. My Problem is as follows:

I have a Class-Diagram with many Packages and DataTypes, Enums and so on. The first problem ist, that every time I'm trying to get the Documentation from a Property GenDoc2 won't display anything from this Loop:

<gendoc>

[for(p:Package|self.ownedElement)]

Paket [p.name/]

[p.getDocumentation()/]

[for(c:Class|p.ownedElement)]

Klasse [c.name/]

[for(o:Operation|c.ownedElement)]

Operation [o.name/]

[o.getDocumentation()/]

[/for]

[for(pr:Property|c.ownedElement)]

Property [pr.name/]

[pr.getDocumentation()/]

[/for]

[/for]

[for(dt:DataType|p.ownedElement)]

Datatype [dt.name/]

[dt.getDocumentation()/]

[/for]

[for(e:Enumeration|p.ownedElement)]

Enumeration [e.name/]

[for(el:EnumerationLiteral|e.ownedElement)]

[el.name/]

[el.getDocumentation()/]

[/for]

[/for]

[/for]</gendoc>

I quite don't understand, why GenDoc won't get the Documentation, no error occurs while Generating the Document

The second thing I'm not so enthusiastic about is that all the Parameters of the Operations will not be shown in the Documentation (I think that's because I'm only using c.name, but I don't know which other statement could do what I want) I would like to see the Operation with all its Parameters as heading.

Also something that just occured is that my enums will be Display with the DataTypes. Is that something that should occur??

With my Problem of gendoc1 not displaying the Stereotypes defined in another Project I'm not really further, when i open the gendoc produced .gendoc file in topcased and look at one of the loop Items the browser displays the connection to my other Project with the stereotypes, so I think it's not a problem of linkage. I will try further and give you some info on how it's going.

Regards

Dominik

P.S. with gendoc2 I see no stereotypes at all, which is fine by me. But I would really like to see them Properties and Parameters in the Documentation.



Inaktiv: Details verbergen für topcased-us...@gforge.enseeiht.fr[email protected]



An
[email protected]

Kopie
[email protected]

Thema
Re: [Topcased-users] Documenting with GenDoc

Hi Dominik, glad to see that you use Gendoc !

concerning stereotypes normally no, everything should work normally. Do you use custom acceleo code ? if yes can you post a part of the code ?
if no, i don't really understand why your stereotypes are truncated.

Regards
Tristan

PS : concerning gendoc 2 you can use OpenOffice or Lotus Symphony which can concert doc to odt (and maybe docx) ...

Le 27/04/2010 08:11, [email protected] a écrit :

      Hi Everyone,

      I'd like to do some documenting of my UML Models with GenDoc. It's working fine until I reach some Classes and Operations and Stuff that have special steroetypes wich I have defined in another Project and applied to this one. In the generated DOCX I see Things like "      > <Operation> Clear_TP30 ()" in my opinion it should look like this: "<macro><Operation> ClearTP30()". Somehow GenDoc seems to swallow my own Stereotypes. Do I have to declare the use of the Stereotype Project in my generating .docx File?? Or is this something GenDoc simply can't do??

      Unfortunatelly I can't use GenDoc2, because my Word Version won't let me open the generated docx file although I already installed the Compatibility Pack. It still says my Version is too old.

      Regards

      Dominik Schmid



      _______________________________________________
      Topcased-users mailing list
      [email protected]
      http://lists.gforge.enseeiht.fr/mailman/listinfo/topcased-users(Siehe angehängte Datei: tristan_faure.vcf)_______________________________________________
      Topcased-users mailing list
      [email protected]
      http://lists.gforge.enseeiht.fr/mailman/listinfo/topcased-users 


_______________________________________________
Topcased-users mailing list
[email protected]
http://lists.gforge.enseeiht.fr/mailman/listinfo/topcased-users

-- 


 



  
    

      
        Anne
HAUGOMMARD

        Atos
Origin Intégration 

Téléphone : +33 (0)5 34 36 34 46 

Mail : [email protected]
      

Fax : +33 (0) 5 34 36 31 00

       		
    

  




  
    

      
Développement durable, anticipons pour notre avenir / Sustainability,
advance our future

N'imprimez ce mail que si nécessaire / please consider your
environmental responsibility before printing this e-mail.		
    

    

      Ce message et les
pièces jointes sont confidentiels et réservés à l'usage
exclusif de ses destinataires. Il peut également être protégé par le
secret
professionnel. Si vous recevez ce message par erreur, merci d'en
avertir
immédiatement l'expéditeur et de le détruire.
L'intégrité du message ne pouvant être assurée sur Internet, la
responsabilité
du groupe Atos Origin ne pourra être recherchée quant au contenu de ce
message.
Bien que les meilleurs efforts soient faits pour maintenir cette
transmission
exempte de tout virus, l'expéditeur ne donne aucune garantie à cet
égard et sa
responsabilité ne saurait être recherchée pour tout dommage résultant
d'un virus
transmis.

      

This e-mail and the documents attached are confidential and intended
solely for the addressee; it may also be privileged. If you receive
this e-mail in error, please notify the sender immediately and destroy
it.
As its integrity cannot be secured on the Internet, the Atos Origin
group liability cannot be triggered for the message content. Although
the sender endeavours to maintain a computer virus-free network, the
sender does not warrant that this transmission is virus-free and will
not be liable for any damages resulting from any virus transmitted.		
    

  



_______________________________________________
Topcased-users mailing list
[email protected]
http://lists.gforge.enseeiht.fr/mailman/listinfo/topcased-users

Reply via email to