| Doxigén | |
|---|---|
| Típusú | Dokumentáció generátor |
| Fejlesztő | Dimitri van Heesch |
| Beírva | C++ |
| Felület | Qt |
| Operációs rendszer | Linux , Mac OS X , Solaris , Microsoft Windows |
| Első kiadás | 1997. október 26. [1] |
| legújabb verzió | 1.9.3 ( 2021. december 31. ) |
| Engedély | GNU GPL |
| Weboldal | doxygen.org |
| Médiafájlok a Wikimedia Commons oldalon | |
A Doxygen egy többplatformos forrásdokumentációs rendszer , amely támogatja a C++ , C , Objective-C , Python , Java , IDL , PHP , C# , Fortran , VHDL és részben D formátumokat .
A Doxygen egy sor forráskódból állít elő dokumentációt, és beállítható úgy is, hogy programstruktúrát bontsa ki a nem dokumentált forráskódokból. Lehetőség van programobjektumok, osztálydiagramok és forráskódok függőségi gráfjainak megrajzolására hiperhivatkozásokkal.
A Doxygen natív támogatással rendelkezik a HTML , LA Τ Ε Χ , man , RTF és XML formátumú dokumentáció előállításához . Ezenkívül a kimenet könnyen konvertálható CHM , PostScript , PDF formátumba .
A webszervereken tárolt dokumentáció html -ábrázolásához kényelmes módja van a keresés megszervezésének (a Doxygen által készített PHP modul segítségével) és a külső dokumentációra mutató hivatkozások.
A Doxygen-t számos projekt használja, köztük a KDE , Pidgin , Torque Game Engine , AbiWord , Mozilla , FOX toolkit , Crystal Space , Drupal . A KDevelop beépített támogatással rendelkezik .
A Doxygen egy konzolprogram a klasszikus Unix szellemében. Úgy működik, mint egy fordító , elemzi a forráskódot és generál dokumentációt. A dokumentáció létrehozási beállításai egyszerű szöveges formátumú konfigurációs fájlból kerülnek kiolvasásra.
A konfigurációs fájl kezelésének egyszerűsítése érdekében (és meglehetősen sok beállítást tartalmaz) számos grafikus felülettel rendelkező segédprogram létezik. Az egyik, a doxywizard , a Doxygennel érkezik. Korábban a Qt 3-as verziójával valósították meg, és nem volt túl felhasználóbarát felülete. Alternatív megoldásként 2008 nyarán kiadtak egy alternatív grafikus shellt Doxygate néven ( http://sourceforge.net/projects/doxygate ), amely a Qt 4-es verzióján alapul. Ám hamarosan a doxywizard átíródott a Qt 4-es verziójára, és a Doxygate projekt lezárult (lásd a projekt oldalát a sourceforge.net oldalon).
A műsor szerzője a holland Dimitri van Heesch. A Quasar Technologies -nál (később Trolltech és Qt Software) dolgozva részt vett egy programozói forráskód-dokumentációs rendszer – qDoc – létrehozásában. Ez a rendszer értelmezett nyelveken íródott. Miután elhagyta a Trolltechet, megalapította saját projektjét - a Doxygen-t, amely már C ++-ban íródott, és figyelembe vette a qDoc hiányosságait. A Doxygen a mai napig támogatja a qDoc rendszer számos címkéjét (kulcsát) a kompatibilitás érdekében.