Book a Demo

Author Topic: Help Generating documents for Interfaces and API's  (Read 2871 times)

David.S

  • EA Novice
  • *
  • Posts: 1
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Help Generating documents for Interfaces and API's
« on: January 23, 2006, 03:19:30 am »
I am trying to generate an interface/API specification from a model.  The model has classes which are stereotyped as:
- <<interface>>
- <<utility>>
- other stereotype classes.

I am trying to generate an RTF document which will show all the attributes and public methods for the <<interface>> and <<utility>> classes, and ignore all the other classes and all private methods.

The model has not yet been populated -  this is an exercise to define the schema before beginning the full design phase.  Therefore, I am open to redefining stereotypes/classes etc.

It is important to define a clear and unambiguous API specification; however, it is equally important that the work to define it is not duplicated - that is to say that once it has been defined in the model that this then cascades to other parts of the model and to the documentation.

Any help would be appreciated.
« Last Edit: January 23, 2006, 05:48:05 am by David.S »