Generating documentation from model transformation programs

OData support
Dr. Ujhelyi Zoltán
Department of Measurement and Information Systems

Model transformations, utilized for various tasks, such as formal model analysis or code generation, are key elements of model-driven development processes. As the complexity of developed model transformations grow it becomes more and more important to generate documentation in a (partially) automated manner.

The VIATRA2 (VIsual and Automated TRAnsformations) transformation framework developed at the Department of Measurement and Information Systems supports the creation of model transformations. The framework uses a high-level transformation language combining elementary graph transformation rules with abstract state machines (ASM) as control structure.

The structure of transformation programs is similar to the structure of traditional programming languages (e.g. C++, Java). To take advantage of the similarities the usability of documentation generation tools (e.g. Doxygen, Javadoc) for such languages for model transformations.

As both tools use only a single level of calls (e.g. functions, methods) they cannot distinguish between the different kinds of rules in \viatra model transformation programs (graph transformation and ASM rules).

To overcome this challange this thesis describes a new system that creates documentation from \viatra transformation programs. As the structure of documentation differs greatly it also introduces a documentation model created in Eclipse Modeling Framework (EMF).

The system uses template based code generators (Java Emitter Templates, JET) to create wiki source from the model. Then the Mylyn WikiText tool is used to create the final documentations in different formats such as HTML, PDF, Eclipse Help.

This thesis evaluates the system with HTML documentation generated from different transformation programs and lists the limitations.


Please sign in to download the files of this thesis.