| Summary: | Display "documentation" in Umbrello's class diagrams | ||
|---|---|---|---|
| Product: | [Applications] umbrello | Reporter: | Ralf Habacker <ralf.habacker> |
| Component: | general | Assignee: | Ralf Habacker <ralf.habacker> |
| Status: | RESOLVED FIXED | ||
| Severity: | wishlist | CC: | andi.fischer, apcomptec |
| Priority: | NOR | ||
| Version: | 2.16.2 (KDE Applications 15.04.2) | ||
| Target Milestone: | 2.18 (KDE Applications 15.12) | ||
| Platform: | Other | ||
| OS: | Linux | ||
| Latest Commit: | http://commits.kde.org/umbrello/739f263d374ebe09b192bb7e08beff17ee585838 | Version Fixed In: | 2.21.80 (KDE Applications 17.03.80) |
| Sentry Crash Report: | |||
| Bug Depends on: | |||
| Bug Blocks: | 80557 | ||
| Attachments: |
screenshot
xmi testcase testcase (updated) testcase (update 2) |
||
|
Description
Ralf Habacker
2015-06-26 12:00:21 UTC
Created attachment 93348 [details]
screenshot
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. This feature is already implemented. Click on the class and the documentation should be seen in the documentation dock window. (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. 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 Created attachment 93366 [details]
xmi testcase
Created attachment 93377 [details]
testcase (updated)
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 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 Created attachment 93404 [details]
testcase (update 2)
2.21.0 is already out. Feature will be in next stable release. 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 |