Sparx Systems Forum

Enterprise Architect => General Board => Topic started by: PeterS on August 04, 2006, 01:42:16 pm

Title: Documentation of full modell
Post by: PeterS on August 04, 2006, 01:42:16 pm
I have a Projekt like

PROJECT ROOT1
 +-- Package A
 +-- Package B
PROJECT ROOT2
 +-- Package C
 +-- Package D

is there a way to crate the documentation for the whole modell in one step?
I currently know only how to create Project Root1 documentation allone and the Project Root1 documentation.

Thx
Peter
Title: Re: Documentation of full modell
Post by: csousa on August 04, 2006, 01:57:12 pm
Quote
is there a way to crate the documentation for the whole modell in one step?
I currently know only how to create Project Root1 documentation allone and the Project Root1 documentation.

Thx
Peter


You can create a class diagram (in either root, or in a new root called "Project Documentation", add a simple view to that and then create a class diagram.

Add a new class to the diagram and make it a "model document stereotype".

You can now drag the individual packages (A,B,C,D..etc) from both roots and drop them in this container class.

Once that is done, you can click on the model document class and run the document generator which will operate on all four packages at once.
Title: Re: Documentation of full modell
Post by: PeterS on August 14, 2006, 07:52:26 am
Thanks for the answer.
I have tried it for my sample ,which looks like the following:

ROOT DOCUMENTATION
 +-- MyModelView A
       +-- Diagram_MyDocumentation
       +-- Class_MyDocumentation
PROJECT ROOT1
 +-- View A
       +-- Package A1
       +-- Package A2
 +-- ViewB
       +-- Package B1
       +-- Package B2
PROJECT ROOT2
 +-- View C
       +-- Package C1
       +-- Package C2
 +-- View D
       +-- Package D1
       +-- Package D2

There is good and bad news.

good
- It does work for RTF documentation (pressing F8)

bad
- It did not work for my with HTML reports (shift F8).

When I tried to generate HTML it stopped after 2 seconds.
The odd part is, when I do a RTF documentation, I select the node "Class_MyDocumentation" and it produces 700 Pages (that's ok), but when I do a HTML documentation (SHIFT-F8) the selection 'jumps' to "MyModelView A" and does only document the this node, resulting in one page.

I think this is a bug, can someone confirm it?

Best regards
Peter