Doxigen | |
---|---|
Tip de | Generator de documentație |
Dezvoltator | Dimitri van Heesch |
Scris in | C++ |
Interfață | Qt |
Sistem de operare | Linux , Mac OS X , Solaris , Microsoft Windows |
Prima editie | 26 octombrie 1997 [1] |
ultima versiune | 1.9.3 ( 31 decembrie 2021 ) |
Licență | GNU GPL |
Site-ul web | doxygen.org |
Fișiere media la Wikimedia Commons |
Doxygen este un sistem de documentare sursă multiplatformă care acceptă C++ , C , Objective-C , Python , Java , IDL , PHP , C# , Fortran , VHDL și parțial D .
Doxygen generează documentație dintr-un set de coduri sursă și poate fi, de asemenea, configurat pentru a extrage structura programului din codurile sursă nedocumentate. Este posibil să desenați grafice de dependență ale obiectelor programului, diagrame de clasă și coduri sursă cu hyperlinkuri.
Doxygen are suport nativ pentru generarea de documentație în formate HTML , L A Τ Ε Χ , man , RTF și XML . De asemenea, rezultatul poate fi convertit cu ușurință în CHM , PostScript , PDF .
Pentru reprezentarea html a documentației găzduite pe serverele web, există o modalitate convenabilă de a organiza căutarea (folosind modulul PHP creat de Doxygen) și link-uri către documentația externă.
Doxygen este folosit de multe proiecte, inclusiv KDE , Pidgin , Torque Game Engine , AbiWord , Mozilla , FOX toolkit , Crystal Space , Drupal . Există suport încorporat în KDevelop .
Doxygen este un program de consolă în spiritul Unix-ului clasic. Funcționează ca un compilator , analizând codul sursă și generând documentație. Opțiunile de generare a documentației sunt citite dintr-un fișier de configurare care are un format text simplu.
Pentru a simplifica manipularea fișierului de configurare (și conține destul de multe setări), există mai multe utilitare cu interfață grafică. Unul dintre ei, doxywizard , vine cu Doxygen. Anterior, a fost implementat folosind Qt versiunea 3 și nu avea o interfață foarte ușor de utilizat. Ca alternativă, în vara anului 2008, a fost lansat un shell grafic alternativ numit Doxygate ( http://sourceforge.net/projects/doxygate ), care se bazează pe versiunea Qt 4. Dar în curând doxywizard a fost rescris în versiunea Qt 4 și proiectul Doxygate a fost închis (vezi proiectul paginii la sourceforge.net).
Autorul programului este olandezul Dimitri van Heesch. În timp ce lucra la Quasar Technologies (mai târziu Trolltech și Qt Software), a fost implicat în crearea unui sistem de documentare a codului sursă pentru programatori - qDoc. Acest sistem a fost scris în limbi interpretate. După ce a părăsit Trolltech, și-a fondat propriul proiect - Doxygen, deja scris în C++ și ținând cont de neajunsurile qDoc. Până în prezent, Doxygen acceptă mai multe etichete (chei) ale sistemului qDoc pentru compatibilitate.