API dokumentáció paraméterezhető generálása Word, LaTeX és HTML formátumban

OData támogatás
Konzulens:
Dr. Simon Balázs
Irányítástechnika és Informatika Tanszék

Az egyre bonyolultabb alkalmazások egyre hosszabb programkódokat eredményeznek. Ennek következtében növekvő igény mutatkozik arra, hogy olyan programokhoz tartozó API dokumentáció álljon rendelkezésre, ami megkönnyítheti a fejlesztést és a karbantartást is.

Következésképpen a főbb platformok elősegítik az API dokumentáció automatikus készítését, sőt néhány esetben (.NET) tartalmazzák az ehhez szükséges beépített eszközöket is. Ezen felül lehetőség van általános, vagyis több platformon is alkalmazható dokumentáció készítő programok használatára (Doxygen, Twintext).

Ezek hasznossága vitathatatlan, de vannak olyan esetek, amikor szükség lehet a kimenet logikai felépítésének meghatározására is. Továbbá előfordulhat, hogy nem beépített stílust kell használni. Ezen felül szükség lehet a kimenetként kapott API dokumentációnak egy már kész dokumentumba való beillesztésére is. Ezen követelményeknek a forgalomban lévő dokumentáció készítő programok nem, vagy csak részben felelnek meg.

A szakdolgozat célja egy olyan dokumentáció készítő program megtervezése és létrehozása, amely a fenti problémákra megoldást nyújt. Ennek megfelelően a kimenet logikai felépítése beállítható; emellett a program támogatja a gyakori kimeneti formátumokat (HTML, LaTeX, Word) és a külső stílusok használatát. Ezen felül főleg a Word esetén megfelelően illeszkedik egy már részben megírt dokumentációhoz.

Letölthető fájlok

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