« Return to Thread: UML Display/Show a Classifiers Documentation

Re: UML Display/Show a Classifiers Documentation

by Trey Spiva :: Rate this Message:

Reply to Author | View in Thread

The problem is that this would only work for things like classes, interfaces, and enumerations.  It will not work with operations and attributes.  Then the next question is what happens if more than one comment is attached to the element?  Which could especially occur if the model element is on more than one diagram.  For these reasons I personally think the documentation view is a good solution.

Andrew Hughes wrote:
Hmmm, thats a real shame - especially for reverse engineering. Maybe there is a possible future feature to link associated UML comments to/from javadocs?


On Mon, Jul 21, 2008 at 11:56 PM, Trey Spiva <Trey.Spiva@...> wrote:
UML does not have a way to display a model elements documentation on the diagram.  The only way to display the documentation on a diagram is via the Comment element, but as you stated it does not effect the code generation process.  To make is easier to see and edit the documentation we created the documentation view.  When a model element is selected (via the diagram or project explorer) the documentation view will show the documentation for the selected model element.

To display the documentation view use the menu Window | Other | UML Documentation.  You can also use the keysroke CTRL-SHIFT-D.


Andrew Hughes wrote:
Hi Again,

Q: I have a "class" for example... and in that I can add some documentation about that class (right click properties -> documentation). That's awesome because it's round-trip and goes to/from javadoc, however I can't get the documentation to display in a UML diagram (specifically class diagram for what its worth). Is there a way to display this documentation in the diagram? Because creating external comments and links is overhead and they don't do the impressive round-trip behavior.

Thanks for anyone reading & answering :)



 « Return to Thread: UML Display/Show a Classifiers Documentation