DocumentCode
700392
Title
RbG: A documentation generator for scientific and engineering software
Author
Moser, Michael ; Pichler, Josef ; Fleck, Gunther ; Witlatschil, Michael
Author_Institution
Software Analytics & Evolution, Software Competence Center, Hagenberg, Austria
fYear
2015
fDate
2-6 March 2015
Firstpage
464
Lastpage
468
Abstract
This paper demonstrates RbG, a new tool intended for the generation of high-quality documentation from source code of scientific and engineering applications. RbG extracts mathematical formulae and decision tables from program statements by means of static code analysis and generates corresponding documentation in the Open Document Format or LaTeX. Annotations in source code comments are used to define the structure of the generated documents, include additional textual and graphical descriptions, and control extraction of formulae on a fine-grained level. Furthermore, RbG provides an interpreter to generate function plots for extracted formulae. In this tool demonstration we briefly introduce the tool and show its usage for different scenarios such as reverse engineering and re-documentation of legacy code and documentation generation during development and maintenance of software.
Keywords
engineering computing; natural sciences computing; program diagnostics; program interpreters; reverse engineering; software maintenance; source code (software); system documentation; LaTeX; RbG; control extraction; documentation generator; engineering software; function plot generation; graphical description; high-quality documentation generation; interpreter; legacy code redocumentation; open document format; program statements; reverse engineering; scientific software; software development; software maintenance; source code comment annotations; static code analysis; textual description; Abstracts; Documentation; Generators; Programming; Software; Standards; Syntactics;
fLanguage
English
Publisher
ieee
Conference_Titel
Software Analysis, Evolution and Reengineering (SANER), 2015 IEEE 22nd International Conference on
Conference_Location
Montreal, QC
Type
conf
DOI
10.1109/SANER.2015.7081857
Filename
7081857
Link To Document