Doxygen

Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).

Doxygen ist ein Dokumentationswerkzeug, das aus Kommentaren im Quellcode automatisch Dokumentation generiert. Es unterstützt verschiedene Programmiersprachen und kann auch für andere Zwecke verwendet werden. Es ist ein Open-Source-Projekt und wird von der Firma Doxygen Development Team entwickelt.

Installation

sudo apt-get update
sudo apt-get install doxygen

Verwendung

doxygen -g
doxygen Doxyfile

main.dox

/**
/**
 * \mainpage Doxygen Beispiel
 * \section intro_sec Einführung
 * Dies ist die Einführung.
 * \section install_sec Installation
 * Dies ist der Installationsabschnitt.
 * \section example_sec Beispiel
 * Dies ist der Beispielabschnitt.
 */

Doxyfile

EXTRACT_ALL            = YES

main.c

/**
 * \file main.c
 * \brief Hauptdatei
 * \author Max Mustermann
 * \date 01.01.2021
 * \version 1.0
 */

#include <stdio.h>

/**
 * \brief Hauptfunktion
 * \return 0
 */
int main()
{
    printf("Hello, World!\n");
    return 0;
}

Hinweis: Diese Inhalte wurden mit Unterstützung von Künstlicher Intelligenz erstellt und redaktionell überprüft (Transparenzhinweis gemäß Art. 50 EU AI Act).