[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Orekit Developers] puml files



Haisam Ido <haisam.ido@gmail.com> a écrit :

Hi OreKit Team,

Hi Haisam,


I'm curious how you generate the puml files and how you use them.  Are you
able to generate diagrams with them and if so how?

We create the file manually. I have tried numerous automatic reverse engineering tools (both proprietary and free software), but was never convinced. They most often create diagram with too much details and that are completely unreadable.

So I switched to a very very simple tool: plantuml <http://plantuml.sourceforge.net/>. The tool does have limited reverse engineering capabilities in the Eclipse plugin, but I only use thme to start a diagram. After this start phase, I usually edit the diagram manually, and then I can keep things quite simple, showing only the important stuff for the diagram I want. In some cases, I have several different diagrams for the same classes, showing different aspects.

The diagrams are visible in the various pages of the static site automatically generated by maven (you can generate them on your own computer if you want, by running "mvn site"). For example, you can look at <https://www.orekit.org/static/architecture/propagation.html>, or <https://www.orekit.org/static/architecture/orbits.html> or <https://www.orekit.org/static/architecture/frames.html>.

PlantUML can be integrated with maven and Eclipse (we use both), and can also be integrated with Word, LibreOffice, Emacs and many other tools (see <http://plantuml.sourceforge.net/running.html>).

best regards,
Luc


Cheers,
Haisam




----------------------------------------------------------------
This message was sent using IMP, the Internet Messaging Program.