Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

API documentation in Enterprise Architect

This is my first time using EA. I used it to generate a class diagram from my C++ header files. Is there a way to add documentation to each method and/or variable and to generate a document that describes all the class' API?

like image 586
Amir Rachum Avatar asked Dec 06 '10 19:12

Amir Rachum


People also ask

How do I create an enterprise architecture document?

Type or select the location and filename for the generated documentation. button to navigate to the location. Enter the appropriate file extension for the document format in which to generate the report - PDF, RTF or DOCX. Click on the drop-down arrow and select the name of the template to use for your document report.


1 Answers

Everything in an EA model includes a Notes property. You can edit this by using the Notes window, among other ways (for instance, when working with a class's properties, the Attributes and Operations windows have an area for entering notes).

These notes will appear when you use the various tools on the Project->Documentation submenu.

like image 185
John Saunders Avatar answered Sep 27 '22 23:09

John Saunders