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.

Doxygen Bash szkript támogatás

A Doxygen egy dokumentáció generáló eszköz, amellyel viszonylag könnyen szinkronban tudjuk tartani a dokumentációnkat a kóddal, mert a dokumentációt a kódba kell írni kommentek formájában. Elég sokféle programozási nyelvet támogat, azonban például Bash szkriptek dokumentálására alapértelmezetten nem képes ez a program.

Kis módosítással azonban írhatunk akár teljes dokumentációt is a segítségével.

A Doxygen a legtöbb disztribúció fő szoftvertárolóiban szerepel, szóval telepíthetjük apt-get-tel:

sudo apt-get install doxygen

Doxyfile generálás:

doxygen -g

Ezután már szerkeszthetjük a Doxyfile-t, hogy testreszabjuk a dokumentációnkat:

gedit Doxyfile

A Bash szkriptek támogatásához a következő módosításokat tegyük meg (a megoldást egy amerikai fiatalember honlapján találtam meg):

FILE_PATTERNS = *.sh

INPUT_FILTER = "sed -e 's|##|//!|'"
FILTER_SOURCE_FILES = YES

 Ezután dupla kettőskereszt (##) után írhatjuk a dokumentációt, azonban csak kivonatok (brief description) formájában tehetjük meg. Ebben az esetben az egy oldalra szánt dokumentációkat sorfolytonosan, összefüggően kell megírni; valamint elég sok Doxygen parancsot nem használhatunk.

Én a következő parancsokat szoktam használni (az összes parancs leírása itt található):

@author

@file

@version

@mainpage

@page

@section

@subsection

@param

@return

@details

\code - \endcode

Természetesen működik néhány parancs még, de ezeket teszteltem.

A Doxygen hivatalos oldala

A Doxygen Wikipedia oldala