1
General Board / Object API library style documentation
« on: June 07, 2004, 01:14:06 pm »
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.
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.