Quickstart Doxygen - Versionsgeschichte

Dennis.fleer@stud.hshl.de: /* Was ist Doxygen */

2024-10-18T10:16:20Z

Was ist Doxygen

← Nächstältere Version		Version vom 18. Oktober 2024, 10:16 Uhr
Zeile 3:		Zeile 3:

	== Was ist Doxygen ==		== Was ist Doxygen ==
			Doxygen ist ein Tool womit Quellcode-Dokumentationen der Sprachen C,C++ oder HTML.

	== Anleitung ==		== Anleitung ==

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T10:15:32Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 10:15 Uhr
Zeile 144:		Zeile 144:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| ingroup \|\| Code-Element \|\| Ordnet Code zu Gruppen zusammen \|\|		\| ingroup \|\| Code-Element \|\| Ordnet Code zu Gruppen zusammen \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
			/**
			* @ingroup MathFunctions
			* @brief Diese Funktion gehört zur Gruppe der mathematischen Funktionen.
			*/
			</syntaxhighlight>
	\|-		\|-
	\| def \|\| Definition \|\| Dokumentiert ein #define-Definition \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| def \|\| Definition \|\| Dokumentiert ein #define-Definition \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T10:14:40Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 10:14 Uhr
Zeile 130:		Zeile 130:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| namespace \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| namespace \|\| Namespace \|\| Dokumentiert einen Namespace \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
	/**		/**
	* @namespace mynamespace		* @namespace mynamespace
Zeile 160:		Zeile 160:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| bug \|\| Modul, Datei, Funktion \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| bug \|\| Modul, Datei, Funktion \|\| Dokumentiert fehlerhaften Code \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
	/**		/**
	* @bug Diese Funktion gibt bei negativen Zahlen falsche Ergebnisse zurück.		* @bug Diese Funktion gibt bei negativen Zahlen falsche Ergebnisse zurück.
Zeile 166:		Zeile 166:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| test \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| test \|\| Test-Funktion \|\| Dokumentiert einen Testfall \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
	/**		/**
	* @test Test mit den Werten 1 und 2 für die Summe.		* @test Test mit den Werten 1 und 2 für die Summe.
Zeile 172:		Zeile 172:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| dot \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| dot \|\| Überall \|\| Fügt DOT-Code für ein Graphviz-Diagramm hinzu \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
	/**		/**
	* @dot		* @dot

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T10:12:13Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 10:12 Uhr
Zeile 130:		Zeile 130:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| namespace \|\| ~~Beispiel~~		\| namespace \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
			/**
			* @namespace mynamespace
			* @brief Namespace für spezielle Funktionen.
			*/
			</syntaxhighlight>
	\|-		\|-
	\| file \|\| Datei \|\| Gibt den Dateinamen an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| file \|\| Datei \|\| Gibt den Dateinamen an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
Zeile 166:		Zeile 171:
	*/		*/
	</syntaxhighlight>		</syntaxhighlight>
	\|-
	~~\| namespace \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">~~

	~~</syntaxhighlight>~~
	\|-		\|-
	\| dot \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">		\| dot \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T10:11:30Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 10:11 Uhr
Zeile 149:		Zeile 149:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| todo \|\| Modul, Datei, Funktion \|\| Dokumentiert eine zukünftige Veränderung \|\|		\| todo \|\| Modul, Datei, Funktion \|\| Dokumentiert eine zukünftige Veränderung \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
			/**
			* @todo Fehlerbehandlung verbessern.
			*/
			</syntaxhighlight>
	\|-		\|-
	\| bug \|\| ~~Beispiel~~		\| bug \|\| Modul, Datei, Funktion \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
			/**
			* @bug Diese Funktion gibt bei negativen Zahlen falsche Ergebnisse zurück.
			*/
			</syntaxhighlight>
	\|-		\|-
	\| test \|\| ~~Beispiel~~		\| test \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
			/**
			* @test Test mit den Werten 1 und 2 für die Summe.
			*/
			</syntaxhighlight>
	\|-		\|-
	\| namespace \|\| ~~Beispiel~~		\| namespace \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">

			</syntaxhighlight>
	\|-		\|-
	\| dot \|\| ~~Beispiel~~		\| dot \|\| \|\| \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small">
			/**
			* @dot
			* digraph G {
			* A -> B;
			* B -> C;
			* }
			* @enddot
			*/
			</syntaxhighlight>
	\|}		\|}

	=== Schritt 5: Dokumentation generieren ===		=== Schritt 5: Dokumentation generieren ===
	Am Schluss müssen Sie nur noch auf den Knopf "Fertig stellen" klicken und die Dokumentation sowie gegebenenfalls die Konfigurationsdatei wird erstellt		Am Schluss müssen Sie nur noch auf den Knopf "Fertig stellen" klicken und die Dokumentation sowie gegebenenfalls die Konfigurationsdatei wird erstellt

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T09:58:00Z

Schritt 4: Kommentare in deinem Code hinzufügen

Änderungen zeigen

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T09:45:05Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 09:45 Uhr
Zeile 23:		Zeile 23:
	Kommentare in dem C-Code können einfach über das C-Projekt selber eingefügt werden. Es gibt allerdings Tags die Doxygen erkennt und diese anders verarbeitet.		Kommentare in dem C-Code können einfach über das C-Projekt selber eingefügt werden. Es gibt allerdings Tags die Doxygen erkennt und diese anders verarbeitet.
	{\| class="wikitable"		{\| class="wikitable"
	\|+ ~~Text der Überschrift~~		\|+ C-Code Tags
	\|-		\|-
	! Tag !! Target !! Bedeutung !! Beispiel		! Tag !! Target !! Bedeutung !! Beispiel
Zeile 91:		Zeile 91:
	</syntaxhighlight>		</syntaxhighlight>
	\|-		\|-
	\| ~~Beispiel~~ \|\| ~~Beispiel~~		\| enum \|\| Enum \|\| Beschreibt eine Aufzählung \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @enum Color		* @enum Color
	* @brief Enumeration für Farben.		* @brief Enumeration für Farben.
	*/		*/

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T09:43:49Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 09:43 Uhr
Zeile 27:		Zeile 27:
	! Tag !! Target !! Bedeutung !! Beispiel		! Tag !! Target !! Bedeutung !! Beispiel
	\|-		\|-
	\| brief \|\| ~~Funktion~~, ~~Klasse~~, ~~Modul~~ \|\| Kurzbeschreibung \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| brief \|\| Modul, Datei, Funktion \|\| Kurzbeschreibung \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @brief Berechnet die Summe von zwei Ganzzahlen		* @brief Berechnet die Summe von zwei Ganzzahlen
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| details \|\| ~~Funktion~~, ~~Klasse~~, ~~Modul~~ \|\| Ausführliche Beschreibung des Verhaltens \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| details \|\| Modul, Datei, Funktion \|\| Ausführliche Beschreibung des Verhaltens \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @brief Berechnet die Summe von zwei Ganzzahlen		* @brief Berechnet die Summe von zwei Ganzzahlen
	* @details Diese Funktion nimmt zwei Integer als Eingabe und addiert diese zusammen und gibt ihre Summe zurück.		* @details Diese Funktion nimmt zwei Integer als Eingabe und addiert diese zusammen und gibt ihre Summe zurück.
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| param \|\| Parameter \|\| Beschreibung des Funktionsparameters \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| param \|\| Parameter \|\| Beschreibung des Funktionsparameters \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
Zeile 43:		Zeile 43:
	\| return \|\| Funktion \|\| Beschreibung des Rückgabewerts \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| return \|\| Funktion \|\| Beschreibung des Rückgabewerts \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @return Die Summe von a und b.		* @return Die Summe von a und b.
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| retval \|\| Funktion \|\| Beschreibung möglicher Rückgabewerte \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| retval \|\| Funktion \|\| Beschreibung möglicher Rückgabewerte \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @retval 0 Erfolgreich.		* @retval 0 Erfolgreich.
	* @retval -1 Fehlerhafte Eingabe.		* @retval -1 Fehlerhafte Eingabe.
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| author \|\| ~~Funktion~~, ~~Modul~~, ~~Klasse~~ \|\| Gibt den Autor des Codes an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| author \|\| Modul, Datei, Funktion \|\| Gibt den Autor des Codes an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @author Daniel Mustermann		* @author Daniel Mustermann
	/* </syntaxhighlight>		/* </syntaxhighlight>
	\|-		\|-
	\| version \|\| ~~Funktion~~, ~~Modul~~, ~~Klasse~~ \|\| Gibt die Versionsnummer des Codes an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| version \|\| Modul, Datei, Funktion \|\| Gibt die Versionsnummer des Codes an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @version 1.0		* @version 1.0
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| see \|\| Funktion~~, Klasse~~ \|\| Gibt Verweise auf andere Funktionen oder Klassen an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| see \|\| Modul, Datei, Funktion \|\| Gibt Verweise auf andere Funktionen oder Klassen an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @see multiply()		* @see multiply()
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| deprecated \|\| ~~Funktion~~, ~~Modul~~, ~~Klasse~~ \|\| Markiert eine Funktion, Klasse oder Modul als veraltet \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| deprecated \|\| Modul, Datei, Funktion \|\| Markiert eine Funktion, Klasse oder Modul als veraltet \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @deprecated Diese Funktion wird in der nächsten Version entfernt		* @deprecated Diese Funktion wird in der nächsten Version entfernt
	/* </syntaxhighlight>		*/ </syntaxhighlight>
	\|-		\|-
	\| warning \|\| ~~Funktion~~, ~~Modul~~, ~~Klasse~~ \|\| Fügt eine Warnung für den Benutzer hinzu \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**		\| warning \|\| Modul, Datei, Funktion \|\| Fügt eine Warnung für den Benutzer hinzu \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
	* @warning Diese Funktion darf nicht als Interrupt verwendet werden!		* @warning Diese Funktion darf nicht als Interrupt verwendet werden!
	/* </syntaxhighlight>		/* </syntaxhighlight>
	\|-		\|-
	\| ~~Beispiel~~ \|\| ~~Beispiel~~		\| struct \|\| Struktur \|\| Beschreibt eine Struktur \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
			* @struct Point
			* @brief Stellt einen Punkt im 2D-Raum dar.
			*/
			struct Point {
			int x;
			int y;
			};
			</syntaxhighlight>
	\|-		\|-
	\| ~~Beispiel~~ \|\| ~~Beispiel~~		\| union \|\| Union \|\| Beschreibt eine Union-Datenstruktur \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
			* @union Data
			* @brief Eine Union, die entweder einen Integer oder einen Float speichert.
			*/
			union Data {
			int i;
			float f;
			};
			*/
			</syntaxhighlight>
	\|-		\|-
	\| Beispiel \|\| Beispiel		\| Beispiel \|\| Beispiel
			* @enum Color
			* @brief Enumeration für Farben.
			*/
			enum Color {
			RED,
			GREEN,
			BLUE
			};
	\|-		\|-
	\| Beispiel \|\| Beispiel		\| Beispiel \|\| Beispiel

Dennis.fleer@stud.hshl.de: /* Schritt 4: Kommentare in deinem Code hinzufügen */

2024-10-18T09:20:13Z

Schritt 4: Kommentare in deinem Code hinzufügen

← Nächstältere Version		Version vom 18. Oktober 2024, 09:20 Uhr
Zeile 58:		Zeile 58:
	/* </syntaxhighlight>		/* </syntaxhighlight>
	\|-		\|-
	\| ~~Beispiel~~ \|\| ~~Beispiel~~		\| see \|\| Funktion, Klasse \|\| Gibt Verweise auf andere Funktionen oder Klassen an \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
			* @see multiply()
			/* </syntaxhighlight>
	\|-		\|-
	\| ~~Beispiel~~ \|\| ~~Beispiel~~		\| deprecated \|\| Funktion, Modul, Klasse \|\| Markiert eine Funktion, Klasse oder Modul als veraltet \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
			* @deprecated Diese Funktion wird in der nächsten Version entfernt
			/* </syntaxhighlight>
	\|-		\|-
	\| ~~Beispiel~~ \|\| ~~Beispiel~~		\| warning \|\| Funktion, Modul, Klasse \|\| Fügt eine Warnung für den Benutzer hinzu \|\| <syntaxhighlight lang="cpp" style="border: none; background-color: #8f5e15; font-size:small"> /**
			* @warning Diese Funktion darf nicht als Interrupt verwendet werden!
			/* </syntaxhighlight>
	\|-		\|-
	\| Beispiel \|\| Beispiel		\| Beispiel \|\| Beispiel

Dennis.fleer@stud.hshl.de: /* Schritt 5: Dokumentation generieren */

2024-10-18T09:16:22Z

Schritt 5: Dokumentation generieren

← Nächstältere Version		Version vom 18. Oktober 2024, 09:16 Uhr
Zeile 92:		Zeile 92:

	=== Schritt 5: Dokumentation generieren ===		=== Schritt 5: Dokumentation generieren ===
			Am Schluss müssen Sie nur noch auf den Knopf "Fertig stellen" klicken und die Dokumentation sowie gegebenenfalls die Konfigurationsdatei wird erstellt