Documentation options

[Craigh]

Hi, can anyone tell me whether it is possible to generate documentation (preferably RTF) from a class diagram so that it only includes public methods and properties (attributes) and excludes the property getters and setters if present.

I thought there would be similar options to that of the diagram itself but can't seem to get the desired results.

Regards,

Craig Hynd

[thomaskilian]

Hello Craig,
I didn't try this so far, but probably the automation interface will offer something for you. Alternatively it would be possible to extract the desired data directly from the database (where you're able to select only public methods a.s.o.).

[CJ]

G'day,

What do you mean by documentation?

If you set the display properties for the diagram to show only public attributes and operations, would the diagram itself suffice as documentation?

You could use notes, linked to element features, to externalize some of an element's internal documentation.

[sargasso]

would the diagram itself suffice as documentation?

Grrrr. Jason, self.apply_that_hammer_in_your_sig;  

[Craigh]

Thanks for the suggestions.

The diagram options do help when viewing on screen but as the diagram is quite large I need to generate a report for off-line review.

The problem is that the RTF documentation produced is pretty large and includes a lot of information that is not needed for this purpose.

Maybe an option for Documentation to respect diagram view options would be a start but I would prefer these to be configurable independently for each document.

Craig

[CJ]

Grrrr. Jason, self.apply_that_hammer_in_your_sig;

Be nice Bruce.  Give a man a chance to have his hot caffeinated brew.

Craig,

Here's an idea that may be too much work and not very practical, but I'll let you decide.

Say class A has some private attributes/operations that you want hidden from the documentation.  Then:

• Setup a parent class for A, say class A_private;
  
• Move your private attributes/operations from A to A_private;
  
• Setup a package hierarchy that looks like this:  Package "Main" with subpackages "Public" and "Private"
  
• Put class A in the "Public" package, including all of the other things that you want to appear for one set of documentation
  
• Put class A_private in the "Private" package, including all of the other things you want to appear in the second set of documentation
  
• To create your public documentation, generate documentation for the "Public" package
  
• To create your private documentation, generate documentation for the "Main" package
  

("Virtual Documents" might be helpful with this idea.)

[Javier]

Craigh,

Seems to me that you would get better mileage if you submitted this as a feature request in one of the other folders.  It should not be that tough for the company to add omit documentation.

Regards,

Javier