Bug 315417 - Umbrello documentation and code import
Summary: Umbrello documentation and code import
Status: RESOLVED FIXED
Alias: None
Product: umbrello
Classification: Applications
Component: general (show other bugs)
Version: 2.8.5
Platform: openSUSE Linux
: NOR wishlist
Target Milestone: ---
Assignee: Umbrello Development Group
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-02-18 21:21 UTC by Andre Hasekamp
Modified: 2014-11-24 07:52 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In: 4.12.1


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andre Hasekamp 2013-02-18 21:21:54 UTC
Hello,

First of all my compliments for your Umbrello program. As long as I do not touch code import (I have not tried code generation) it works really nice and the program is self explanatory.

This is not a bug report, I just want to make 2 suggestions on the following topics.

- Umbrello documentation.

- Code import functionality (from C++ in my case).

As far as documentation is concerned, it is my opinion that hardly any documentation is required as long as you do not use code import. Maybe code import is also self explanatory and there was just a bug when I tried to use it.

Docbook format will undoubtedly be the highest and most crucial level attainable for communication within the scientific community, but as a simple programmer I am looking for "human readable" documentation (i.e. HTML or PDF format). When I tried some scripts to convert the docbook format, they gave me an infinite number of errors and the result was but a few readable sentences. Yes, this is the fault of the conversion scripts. What I tried to read was the document on code import and generation to see if I had done anything wrong while using that functionality. After conversion of the document to HTML the first and last thing I could see is that C++ code is supported, but if the document contains more, that never got converted. Is it really vital to explain the working of Umbrello to your users in docbook format?

And then code import. Here is my user story on that issue. My Umbrello version is 2.8.5 and it runs under openSUSE 12.2. It crashed when I tried to import a number of my C++ header files. The Umbrello class diagram contains about 25 of the most critical classes of my design. The other 30 classes or so are straightforward. Therefore I do not bother to enter all the information from my header files into an UML diagram when I primarily use Umbrello to document the interesting parts of my application. When I tried to supply crash information, I was informed that there was not enough information available.

Now here is my point after having seen what I think is the functionality of code import. Is your target in this respect not a little too ambitious? Actually, all I had hoped for was to right click on a class and tell the program to import code for that class from a C++ header file which can be found on a disk location I specify. Upon code import from the header file of that class, Umbrello need not bother about inheritance, relations to other classes, etc. because Umbrello has excellent functionality for that purpose. The comments in my header file may also be omitted. Once this kind of functionality works in Umbrello, you could take a next step and maybe eventually you could try to import all the header files of an application (but for me, as mentioned, import of the header files of only a number of classes would be sufficient).

Hopefully you consider this as constructive comment and not in any way as critique on the excellent program Umbrello.

Good luck with the further development of Umbrello.

Kind regards,
Andre Hasekamp.
Comment 1 Ralf Habacker 2014-01-27 23:08:45 UTC
> I am looking for "human readable" documentation (i.e. HTML or PDF format)
I guess in the meantime you have found some online resources for umbrello docs like http://umbrello.kde.org/documentation.php

An easy receipt on a linux host system for generating html docs from umbrello docbook sources is listed below. Requirements are a KDE4 development environment as requires to compile umbrello. This includes the meinproc4 helper tool and the docbook xsl stylesheets package.

cd <some-temp-dir>
git clone git://anongit.kde.org/umbrello 
cd umbrello/doc
meinproc4 --stylesheet /usr/share/xml/docbook/stylesheet/nwalsh/current/html/docbook.xsl -o index.html index.docbook
Comment 2 Ralf Habacker 2014-02-06 21:33:49 UTC
Git commit 4ed6b691304442ca4bfcf5a1f2284a6eca340839 by Ralf Habacker.
Committed on 20/01/2014 at 08:00.
Pushed by habacker into branch '315417'.

Add import file and project from list view.

M  +72   -0    umbrello/basictypes.cpp
M  +2    -0    umbrello/basictypes.h
M  +4    -0    umbrello/icon_utils.cpp
M  +2    -0    umbrello/icon_utils.h
M  +13   -0    umbrello/listpopupmenu.cpp
M  +2    -0    umbrello/listpopupmenu.h
M  +56   -0    umbrello/uml.cpp
M  +2    -0    umbrello/uml.h
M  +8    -0    umbrello/umllistview.cpp

http://commits.kde.org/umbrello/4ed6b691304442ca4bfcf5a1f2284a6eca340839
Comment 3 Ralf Habacker 2014-02-06 21:33:49 UTC
Git commit 1138d35b6a2c9bc4bdc339c3e28dd186f6954193 by Ralf Habacker.
Committed on 03/02/2014 at 09:04.
Pushed by habacker into branch '315417'.

Make importfiles callable from main.

M  +5    -0    umbrello/main.cpp
M  +1    -1    umbrello/uml.cpp
M  +1    -2    umbrello/uml.h

http://commits.kde.org/umbrello/1138d35b6a2c9bc4bdc339c3e28dd186f6954193
Comment 4 Ralf Habacker 2014-02-06 21:33:50 UTC
Git commit 2ec19418b46105821ffbb2cf37e43ca74bbbd927 by Ralf Habacker.
Committed on 05/02/2014 at 22:38.
Pushed by habacker into branch '315417'.

command line options  import-fixes  fixes

M  +1    -0    umbrello/main.cpp

http://commits.kde.org/umbrello/2ec19418b46105821ffbb2cf37e43ca74bbbd927
Comment 5 Ralf Habacker 2014-02-06 21:34:51 UTC
Git commit f68b285f95e30de60f1911d89580c4c32072baaa by Ralf Habacker.
Committed on 05/02/2014 at 22:38.
Pushed by habacker into branch '315417'.

Fix of command line options  --import-files.

M  +1    -0    umbrello/main.cpp

http://commits.kde.org/umbrello/f68b285f95e30de60f1911d89580c4c32072baaa
Comment 6 Ralf Habacker 2014-02-06 21:56:54 UTC
Git commit 00959d7a24c4a82f536a59b161d1da2872cfb83f by Ralf Habacker.
Committed on 20/01/2014 at 08:00.
Pushed by habacker into branch '330788-3.5-cpp-parser'.

Add import file and project from list view.

M  +72   -0    umbrello/basictypes.cpp
M  +2    -0    umbrello/basictypes.h
M  +4    -0    umbrello/icon_utils.cpp
M  +2    -0    umbrello/icon_utils.h
M  +13   -0    umbrello/listpopupmenu.cpp
M  +2    -0    umbrello/listpopupmenu.h
M  +56   -0    umbrello/uml.cpp
M  +2    -0    umbrello/uml.h
M  +8    -0    umbrello/umllistview.cpp

http://commits.kde.org/umbrello/00959d7a24c4a82f536a59b161d1da2872cfb83f
Comment 7 Ralf Habacker 2014-02-07 13:21:11 UTC
Git commit c7862718557a609c068150aad8a7054f30889054 by Ralf Habacker.
Committed on 20/01/2014 at 08:00.
Pushed by habacker into branch '330788-3.5-cpp-parser'.

Add import file and project from list view.

M  +72   -0    umbrello/basictypes.cpp
M  +2    -0    umbrello/basictypes.h
M  +4    -0    umbrello/icon_utils.cpp
M  +2    -0    umbrello/icon_utils.h
M  +13   -0    umbrello/listpopupmenu.cpp
M  +2    -0    umbrello/listpopupmenu.h
M  +56   -0    umbrello/uml.cpp
M  +2    -0    umbrello/uml.h
M  +8    -0    umbrello/umllistview.cpp

http://commits.kde.org/umbrello/c7862718557a609c068150aad8a7054f30889054
Comment 8 Ralf Habacker 2014-02-07 13:21:12 UTC
Git commit 8a4e93e6b634a736a3a693522f486a1fc8b839c7 by Ralf Habacker.
Committed on 03/02/2014 at 09:04.
Pushed by habacker into branch '330788-3.5-cpp-parser'.

Make importfiles callable from main.

M  +5    -0    umbrello/main.cpp
M  +1    -1    umbrello/uml.cpp
M  +1    -2    umbrello/uml.h

http://commits.kde.org/umbrello/8a4e93e6b634a736a3a693522f486a1fc8b839c7
Comment 9 Ralf Habacker 2014-02-07 13:21:13 UTC
Git commit 058de99987ae035ed12c138ca46ddd91fd17be5b by Ralf Habacker.
Committed on 05/02/2014 at 22:38.
Pushed by habacker into branch '330788-3.5-cpp-parser'.

Fix of command line options  --import-files.

M  +1    -0    umbrello/main.cpp

http://commits.kde.org/umbrello/058de99987ae035ed12c138ca46ddd91fd17be5b
Comment 10 Ralf Habacker 2014-02-11 23:57:37 UTC
Git commit afe6c4bc5174841cc0d8e4cb79a6469e2e1bca6c by Ralf Habacker.
Committed on 20/01/2014 at 08:00.
Pushed by habacker into branch 'master'.

Add import file and project from list view for quick import support.
GUI

M  +72   -0    umbrello/basictypes.cpp
M  +2    -0    umbrello/basictypes.h
M  +4    -0    umbrello/icon_utils.cpp
M  +2    -0    umbrello/icon_utils.h
M  +13   -0    umbrello/listpopupmenu.cpp
M  +2    -0    umbrello/listpopupmenu.h
M  +56   -0    umbrello/uml.cpp
M  +2    -0    umbrello/uml.h
M  +8    -0    umbrello/umllistview.cpp

http://commits.kde.org/umbrello/afe6c4bc5174841cc0d8e4cb79a6469e2e1bca6c
Comment 11 Ralf Habacker 2014-02-11 23:57:57 UTC
Git commit eb0c585ff333df547b4632386a9d0e22173612e9 by Ralf Habacker.
Committed on 03/02/2014 at 09:04.
Pushed by habacker into branch 'master'.

Add --import-files command line option as initial support of automated imports tests.
GUI

M  +6    -0    umbrello/main.cpp
M  +1    -1    umbrello/uml.cpp
M  +1    -2    umbrello/uml.h

http://commits.kde.org/umbrello/eb0c585ff333df547b4632386a9d0e22173612e9
Comment 12 Ralf Habacker 2014-02-12 00:20:19 UTC
Git commit e4410e4dd881307bc359694d544d75a0d0c62b03 by Ralf Habacker.
Committed on 12/02/2014 at 00:12.
Pushed by habacker into branch 'master'.

Refactor --import-files command line switch to use filenames after the switch.

M  +8    -5    umbrello/main.cpp

http://commits.kde.org/umbrello/e4410e4dd881307bc359694d544d75a0d0c62b03
Comment 13 Ralf Habacker 2014-11-24 07:51:09 UTC
> It crashed when I tried to import a number of my C++ header files.
Since 2.8.5  many crash has been fixed. If the problem still persists please provide a test case.  

> Actually, all I had hoped for was to right click on a class and tell the program to import code for that class from a C++ header file which can be found on a disk location I specify. 

For importing a single class this approach may be useful, but for more then one class there is additional effort required to create each class before importing.  

Umbrello now has a feature to be able to import single files  from the tree view by right clicking on "Logical View" and then select "Import File(s)".  In the following dialog you can select one or more files  for importing.