Object API library style documentation

[joyce]

Hello, been wracking our brains to no avail:
We have a large business object library.  We want to generate documentation for end programmers who will use our library as an "api".

Problem is that we want to generate docs showing PUBLIC scoped methods and attributes only, EA doesn't seem to allow this as an option, or allow an option for selecting specific stereotypes only for classes to document.

Is there a recommended method of approaching this situation?

(Note that we are coding in C# and will be using NDOC to make programmers API reference anyway, this is just about using EA to make a visual diagram showing classes and their relationships and public properties.)

Kind of thinking of those nice big charts Microsoft gives you with visual studio showing the API class relationships in a nice clean graphical manner.


Any thoughts would be greatly appreciated.

[thomaskilian]

Hi ,
there is a nice automation example distributed by Sparx (http://www.sparxsystems.com.au/AutIntVB.htm). I think you should be able to adopt this one for your needs when you create a dll out of it. Still a bit of work though.

[sargasso]

Hi ,

I'm a bit confused here.

If you are trying to show only public features in the graphic, then this is available in the diagram options - right click on blank space in the diagram - select diagram properties - on the RHS you should see a group box title "Visible Class Members" where you can set the overriding feature visibility for the diagram.

If you are talking about the textual part of the generated documents, then Thomas' is the way to go.

Bruce