2012. augusztus 6., hétfő

Doxygen Ruby támogatás


Egy újabb Doxygen kiegészítés következik! Az elmúlt időben egyre többet használom Linuxos projektek alatt a Ruby nyelvet, és néha eljön az idő amikor dokumentációt kell készíteni az elkészített programokhoz. Ilyenkor mindig először a Doxygen nevű dokumentáció készítő programhoz fordulok, mint a múltkori esetben, sajnos azonban néha olyan nyelvet használok, amit nem támogat a fenti program. Így volt ez a Ruby esetében is, azonban rövid keresgélés után találtam egy kiegészítést, amivel Ruby kódokat is dokumentálhatunk Ruby-Doc stílusban. Több, mint egy éve készítette el Vincent Fourmond az említett kiegészítést, és céljai közé tartozik, hogy alkotása bekerüljön a Doxygen fő fejlesztési ágába.
Itt letölthetjük a patchet (mondjuk zip formában), csomagoljuk ki:
unzip fourmond-doxygen-ruby-patch-9a90763.zip
cd fourmond-doxygen-ruby-patch-9a90763.zip
A fordításhoz szükség lesz a következő csomagokra:
sudo apt-get install flex bison
Majd fordítsuk és telepítsük a programot:
./configure
make
sudo make install
Ezekután Doxyfile generálás után (doxygen -g), szerkesztve a Doxyfile-t keressük meg, és állítsuk be a következőket:
RUBY_RDOC_COMPATIBILITY= YES
FILE_PATTERNS          = *.rb
Lehetnek hibák a programban, de eddigi próbálkozásaim során nem futottam bele semmilyen nagyobb bug-ba, remélem hamarosan bekerül alapértelmezetten a támogatott nyelvek közé a Ruby.

Nincsenek megjegyzések:

Megjegyzés küldése