Doxygen to wolnodostępne narzędzie do generowania dokumentacji na podstawie komentarzy w kodzie źródłowym. Dostępne dla systemów GNU/Linux oraz MS Windows.
Konfiguracja oparta jest o plik tekstowy, domyślnie Doxyfile, który można wygenerować za pomocą polecenia doxygen -g. Edytując wygenerowany plik konfiguracyjny ustala się m.in. format generowanej dokumentacji (dostępne HTML, RTF, LaTeX (PDF)), język i kodowanie znaków.
Dokumentacja generowana jest za pomocą polecenia doxygen, na podstawie komentarzy w kodzie źródłowym. Przykładowy fragment udokumentowanego kodu źródłowego:
/** \file phone.h * \brief Obsługa telefonu poprzez komendy AT. * * Telefon obsługiwany jest poprzez interfejs UART, * w trybie przerwań. */ /** \brief Kod odpowiedzi OK. */ #define AT_OK '0' /** \brief Kod odpowiedzi ERROR. */ #define AT_ERROR '4' /** \brief Inicjalizuje połączenie z telefonem. * * Resetuje telefon, wyłącza sygnał dźwiękowy, * wibracje i podświetlenie. Ustawia powiadamianie * o odebranym SMSie. * * @param uart nr interfejsu UART (0 lub 1) * @return 0 - OK, inna - błąd */ int phone_init(int uart);
Więcej informacji na stronie domowej projektu Doxygen.