Book a Demo

Author Topic: Documentation of C++ classes?  (Read 1980 times)

ban

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Documentation of C++ classes?
« on: May 10, 2005, 02:57:05 am »
Hello,

I am new in EA and need a little help or instructions to effectively document a C++ classes.  I have two problems here and they are:


1) After the HTML document is generated from the class diagram, the class methods are described as a table with 2 columns: operation & details. The operation column contains the methods prototypes and the note is free to formulate. It is all OK, but what I miss is the description of methods' input parameters. The EA has a feature to descript the parameters, but I don't know how to include them in this documentation form?
OK, it should not be strictly in this table, but anywhere.

2) For all methods I have a activity diagram. Is it possible to connect the diagram with particularly method in the class diagram, so that by mouse-click (in HTML documentation form) I can jump to it. (e.g. if the class uses the pointer to some structure, it is linked with the structure's description).

3) Is it possible to link particulary method with the use-case simbol, and how?


Thanks in advance