Flowgen: Flowchart-Based Documentation for C++ Codes
Abstract
We present the Flowgen tool, which generates flowcharts from annotated C++ source code. The tool generates a set of interconnected high-level UML activity diagrams, one for each function or method in the C++ sources. It provides a simple and visual overview of complex implementations of numerical algorithms. Flowgen is complementary to the widely-used Doxygen documentation tool. The ultimate aim is to render complex C++ computer codes accessible, and to enhance collaboration between programmers and algorithm or science specialists. We describe the tool and a proof-of-concept application to the VINCIA plug-in for simulating collisions at CERN's Large Hadron Collider.
- Publication:
-
arXiv e-prints
- Pub Date:
- May 2014
- DOI:
- 10.48550/arXiv.1405.3240
- arXiv:
- arXiv:1405.3240
- Bibcode:
- 2014arXiv1405.3240K
- Keywords:
-
- Computer Science - Software Engineering;
- Computer Science - Computational Engineering;
- Finance;
- and Science;
- High Energy Physics - Experiment;
- High Energy Physics - Lattice;
- High Energy Physics - Phenomenology
- E-Print:
- 17 pages, 10 figures, supplemental material (two ancillary files)