Sparx Systems Forum

Enterprise Architect => Automation Interface, Add-Ins and Tools => Topic started by: fmaymone on January 21, 2008, 04:58:20 am

Title: Documentation Template
Post by: fmaymone on January 21, 2008, 04:58:20 am

Hi All.. This is my first day at forum.

Well, At the moment I wanna know how can I create a template for the documentation of a class.

I want that, when I create a method on a class, on the "NOTES", I have some text pre-defined inside.

Something like:
"
@author Fernando Maymone
@date 17/01/2008
@param ActionMapping
@param HttpServletRequest
@param HttpServletResponse
@return ActionForward"

Thanks a Lot!!

Title: Re: Documentation Template
Post by: thomaskilian on January 23, 2008, 07:18:04 am

Are you talking of code gen or RTF?

Title: Re: Documentation Template
Post by: fmaymone on January 23, 2008, 09:39:16 am

None of them.

I want a template "inside" the EA. I want then when I create a Class, for example, inside the notes of the class, some part of text was pre-written.

I dont know if i am being clear, sorry if not!!!

Title: Re: Documentation Template
Post by: «Midnight» on January 23, 2008, 10:16:12 am

I don't think you can do exactly what you want.

However, take a look at Use Template Templates in EA help (look up Template | Element in the index). This might give you something. I do not know if you can successfully set up and enter attributes.

David

Title: Re: Documentation Template
Post by: Luis J. Lobo on January 24, 2008, 01:12:59 am

There is an easy way to do this:

1. Create a package named, i.e "My templates"
2. Create a Class inside
3. Configure the Class with the default values (your notes)
4. Select the package "My templates"
5. Click on menu "Settings | Template package..."
6. Now, the "My templates" package contains the default elements.
7. Create a Class anywhere. The class should contains your notes.

Title: Re: Documentation Template
Post by: fmaymone on January 24, 2008, 03:21:15 am

Hi Luiz, thanks for the reply..

I have thinked about it, and try to do.. But it only works with Diagrams, not with elements :(

Do you try and works on your machine?

Thanks again