Bug 349622 - Display "documentation" in Umbrello's class diagrams
Summary: Display "documentation" in Umbrello's class diagrams
Status: RESOLVED FIXED
Alias: None
Product: umbrello
Classification: Applications
Component: general (show other bugs)
Version: 2.16.2 (KDE Applications 15.04.2)
Platform: Other Linux
: NOR wishlist
Target Milestone: 2.18 (KDE Applications 15.12)
Assignee: Ralf Habacker
URL:
Keywords:
Depends on:
Blocks: 80557
  Show dependency tree / graph
 
Reported: 2015-06-26 12:00 UTC by Ralf Habacker
Modified: 2019-11-13 16:15 UTC (History)
2 users (show)

See Also:
Latest Commit: http://commits.kde.org/umbrello/739f263d374ebe09b192bb7e08beff17ee585838
Version Fixed In: 2.21.80 (KDE Applications 17.03.80)

Attachments
screenshot (50.45 KB, image/png)
2015-06-26 12:00 UTC, Ralf Habacker 		Details
xmi testcase (19.48 KB, application/x-uml)
2015-06-27 16:35 UTC, Ralf Habacker 		Details
testcase (updated) (52.18 KB, application/x-uml)
2015-06-28 07:47 UTC, Ralf Habacker 		Details
testcase (update 2) (72.06 KB, application/xml)
2015-06-29 15:28 UTC, Ralf Habacker 		Details
Show Obsolete (2) View All Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description Ralf Habacker 2015-06-26 12:00:21 UTC 
I got a feature request from the physics department of Harvard University:

we just looked into switching from IBM Rational Modeler to Umbrello for
drawing UML diagrams.  Umbrello seems very clean and fast, so this looks
like a really useful application.  Also, it comes bundled with Red Hat,
which is convenient.

However, we did not see any way how to display the "documentation" in
the diagram itself.  We find this a very useful feature, because it
allows us to annotate with some high-level information.  (Of course we
could use "note" items next to each class we want to annotate; however,
this leads to noisy diagrams and makes moving classes around a pain.)

Interestingly, showing documentation (or "description" how it is called
there) is easy in IBM Rational Modeler, see attached screenshot.

Would you consider adding such a feature to Umbrello?

Reproducible: Always
Comment 1 Ralf Habacker 2015-06-26 12:00:55 UTC 
Created attachment 93348 [details]
screenshot
Comment 2 Ralf Habacker 2015-06-26 12:02:33 UTC 
Umbrello has similar support for displaying attributes, operations, stereotypes through the display page of the diagram or class widget properties dialog or the widget context menu. The display of the documentation would be a good addition.
Comment 3 Andi Fischer 2015-06-26 12:45:58 UTC 
This feature is already implemented.
Click on the class and the documentation should be seen in the documentation dock window.
Comment 4 Ralf Habacker 2015-06-27 12:30:22 UTC 
(In reply to Andi Fischer from comment #3)
> This feature is already implemented.
The request targets another feature. 
>> However, we did not see any way how to display the "documentation" in the diagram itself.
>> We find this a very useful feature, because it allows us to annotate with some high-level information. 

IBM Rational Modeller supports display of class documentation in the class widget, see the screenshot. The documentation is displayed above attributes and operations.
Comment 5 Ralf Habacker 2015-06-27 16:28:55 UTC 
Git commit ae37797a32bca798cabd672f833deb9ce30b80ac by Ralf Habacker.
Committed on 27/06/2015 at 16:28.
Pushed by habacker into branch 'master'.

Add display of documentation for UMLClassifier directly in the class widgets.

This feature is marked as experimental (build only in master branch)
because there are a few issues (see testcase appended to bug).

M  +6    -0    CMakeLists.txt
M  +0    -5    umbrello/CMakeLists.txt
M  +37   -18   umbrello/dialogs/pages/classoptionspage.cpp
M  +1    -0    umbrello/dialogs/pages/classoptionspage.h
M  +4    -0    umbrello/listpopupmenu.cpp
M  +1    -0    umbrello/listpopupmenu.h
M  +7    -0    umbrello/optionstate.cpp
M  +2    -0    umbrello/optionstate.h
M  +4    -0    umbrello/version.h
M  +51   -17   umbrello/widgets/classifierwidget.cpp
M  +1    -0    umbrello/widgets/classifierwidget.h

http://commits.kde.org/umbrello/ae37797a32bca798cabd672f833deb9ce30b80ac
Comment 6 Ralf Habacker 2015-06-27 16:35:37 UTC 
Created attachment 93366 [details]
xmi testcase
Comment 7 Ralf Habacker 2015-06-28 07:47:24 UTC 
Created attachment 93377 [details]
testcase (updated)
Comment 8 Ralf Habacker 2015-06-29 15:25:25 UTC 
Git commit d88e403dfb08bf98d1b32437ba122ea01155f72e by Ralf Habacker.
Committed on 29/06/2015 at 15:23.
Pushed by habacker into branch 'master'.

Fix classifier widget with new documentation display.

The strategy is to display only visible areas, where area is in attribute, documentation and operations.

M  +97   -80   umbrello/widgets/classifierwidget.cpp

http://commits.kde.org/umbrello/d88e403dfb08bf98d1b32437ba122ea01155f72e
Comment 9 Ralf Habacker 2015-06-29 15:25:25 UTC 
Git commit 739f263d374ebe09b192bb7e08beff17ee585838 by Ralf Habacker.
Committed on 29/06/2015 at 15:25.
Pushed by habacker into branch 'master'.

Fix bug not updating classifier widget size after editing documention through the doc window.

M  +6    -0    umbrello/widgets/classifierwidget.cpp
M  +2    -0    umbrello/widgets/classifierwidget.h
M  +1    -1    umbrello/widgets/widgetbase.h

http://commits.kde.org/umbrello/739f263d374ebe09b192bb7e08beff17ee585838
Comment 10 Ralf Habacker 2015-06-29 15:28:06 UTC 
Created attachment 93404 [details]
testcase (update 2)
Comment 11 Ralf Habacker 2016-12-09 16:48:59 UTC 
2.21.0 is already out. Feature will be in next stable release.
Comment 12 Ralf Habacker 2019-11-13 16:15:27 UTC 
Git commit 5dd834d045f003808f6ed19c58fbb979eeca7481 by Ralf Habacker.
Committed on 13/11/2019 at 16:15.
Pushed by habacker into branch 'master'.

Left alignment for lines of documentation displayed in a ClassifierWidget is set

This improves the display.

M  +1    -1    umbrello/umlwidgets/classifierwidget.cpp

https://commits.kde.org/umbrello/5dd834d045f003808f6ed19c58fbb979eeca7481