Approach 1: Doxygen + Graphviz Dot + Mscgen (Windows-centric)
Provides clickable UML, takes some setup time for initial setup.
- Install Doxygen: http://www.stack.nl/~dimitri/doxygen/
- Install Graphviz Dot: http://www.graphviz.org/Download_windows.php
- Install Mscgen: http://www.mcternan.me.uk/mscgen/
- Configure Doxygen GUI frontend (Doxywizard)
- Specify project name, src and destination dirs (choose path close to root to avoid Windows path length issues)
- Choose Mode: Java/C#
- Choose Output: e.g. HTML with nav panel & search function
- Choose Chart type: Use dot tool
- Under Expert > Dot
- The Mscgen_path, probably: Program Files (x86)\Mscgen
- Dot_path, probably: Program Files (x86)/Graphviz2.38/bin
- Turn on Have_Dot, Class_graph, Collaboration_graph, Group_graphs, Call_graph, Caller_graph
- I would set Dot_image_format to SVG and turn on Interactive_svg
- Start a Doxygen run to generate documentation (if you don't get any graphs, a path is not set properly)
- Save your configuration (you get a "Doxyfile" file), and check it in (I wouldn't put generated html in version management, it is better hosted in a different way)
- If you want to see SVG graph thumbnails in Explorer: https://svgextension.codeplex.com/releases/view/118790
If you have chosen HTML as format you can see the project overview under:
Classes > Class Hierarchy > Go to the graphical class hierarchy
This shows global UMLs of the project, where elements are clickable. You can also go to a class with the search function, and click through the UML to navigate.
For Salesforce Apex projects:
- Same as above, and…
- Enable *.cls extension under Expert/Input/File_Patterns
- Under Expert/Project/Extension_Mapping add cls=Java
- Enable EXTRACT_ALL to EXTRACT_LOCAL_METHODS under Export/Build
Aanpak 2: Doxygen + Mscgen + Msc-generator
For flow structograms, but without the Visio mouse RSI hassle.Easily create structograms to describe a project/change, without graphical editing, and so that it works together with version control (text-only)
- Install Mscgen as per Doxygen (Affero GNU Public License) http://sourceforge.net/projects/msc-generator/
- Open Msc generator
- Enter structogram code as on their site
- Check your *.signalling chart src and possibly. a screenshot in version control at the project
https://marketplace.atlassian.com/plugins/com.addteq.jira.plugin.mscgen.JIRA-Mscgen