Book a Demo

Author Topic: generate interfaces documentation  (Read 3545 times)

Yann

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
generate interfaces documentation
« on: December 20, 2004, 06:25:03 am »
Hi everybody,

I m trying to generate documentation, with Enterprise Architect, on interfaces. I can do it if I use on diagram the big box interface icone.

If I use an assembly link, required or provided link (small icone with only a wire and a ball or a half ball). I am not able to generate my link properties in documentation.

Can someone help me ?

Thanks in advance

Yann

thomaskilian

  • Guest
Re: generate interfaces documentation
« Reply #1 on: December 20, 2004, 06:56:29 am »
Hi Yann,
the assembly is just being used to wire components. What you need is the Interface icon from the toolbox (Structure, 3rd from top). You may also read here
http://www.sparxsystems.com.au/cgi-bin/yabb/YaBB.pl?board=suggestions;action=display;num=1079374894

potterm

  • EA User
  • **
  • Posts: 126
  • Karma: +0/-0
    • View Profile
Re: generate interfaces documentation
« Reply #2 on: December 23, 2004, 07:02:55 am »
Actually I think Yann has a fair point.  I'm putting together a component model which has ports.  The ports in turn expose required and provided interfaces.  If I generate documentation for this model (either RTF or HTML - doesn't matter) I see the list of ports associated with each component in a table, but there's nothing at all about the required/provided interfaces associated with each port.

This is an important part of the model, and shouldn't really be missing IMO.  I'll therefore need to think of other ways of getting this documentation out (probably via the automation interface).

Not sure whether this is a bug or just a "missing feature"  ;)

Martin.

Yann

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: generate interfaces documentation
« Reply #3 on: December 28, 2004, 05:42:47 am »
Thanks for your understanding Potterm.

I found a way to generate documentation about port properties. You need to select it and make a documentation by clicking on "element" then "documentation" . This way it is a bit long if you have many ports.

Keep me inform if you find a better way.

Yours,

Yann