Dokumentációgenerálás modelltranszformációs programokból

OData támogatás
Konzulens:
Ujhelyi Zoltán
Méréstechnika és Információs Rendszerek Tanszék

A modellvezérelt rendszerfejlesztés során különféle célokra használnak modelltranszformációkat, mint például modellek formális analízise, vagy kódgenerálás. Ahogy egyre több és nagyobb modellre használjuk a transzformációkat, azok egyre bonyolultabbá válnak. A megfelelő dokumentálás érdekében lényeges a dokumentáció (részben) automatikus elkészítése.

A modelltranszformációk fejlesztésének támogatására készült a Méréstechnika és Információs Rendszerek Tanszéken fejlesztett VIATRA2 (VIsual and Automated TRAnsformations) modelltranszformációs keretrendszer. A keretrendszer transzformációs nyelvében gráf alapú modellek elemi transzformációját gráftranszformációs szabályok végzik, míg komplex transzformációs programokat absztrakt állapotgép (Abstract State Machine, ASM) formalizmus segítségével építhetünk.

A transzformációs programok felépítése hasonlít a hagyományos programozási nyelvek (C++, Java) felépítéséhez. Ez alapján a dolgozat megvizsgálja két általános célú forráskód dokumentációs eszköz (Doxygen, Javadoc) felhasználhatóságát transzformációs programok dokumentálására. Ugyanakkor az azonos hierarchiaszinten álló, de különböző funkciójú elemek (gráftranszformációs és ASM szabály) megkülönböztetését egyik eszköz sem képes megvalósítani, így nem használhatók a cél elérésére.

A dolgozat bemutat egy új megoldást, amely a VIATRA2 transzformációs programjaiból különböző formátumú dokumentumokat képes előállítani. Emellett ismertet egy Eclipse Modelling Framework (EMF) segítségével leírt dokumentációs modellt, amely a program és a dokumentáció közötti strukturális távolságot hidalja át.

A megoldás a dokumentációs modellből sablon alapú kódgenerátor (Java Emitter Templates, JET) használatával wiki forrást állít elő, amiből a Mylyn WikiText eszköz programozottan különféle dokumentumokat generál, például HTML, PDF, Eclipse Help.

A dolgozat HTML dokumentációt előállító esettanulmányon keresztül bemutatja a folyamat gyakorlati alkalmazhatóságát, megállapítja a megoldás korlátait.

Letölthető fájlok

A témához tartozó fájlokat csak bejelentkezett felhasználók tölthetik le.