Doxygen - Versionsgeschichte

Ebukadneza: Mehr wikidata in Infobox

2024-02-14T15:21:28Z

Mehr wikidata in Infobox

← Nächstältere Version		Version vom 14. Februar 2024, 17:21 Uhr
Zeile 6:		Zeile 6:
	\|AktuelleVersionFreigabeDatum = <!-- aus Wikidata - https://www.wikidata.org/wiki/Q1253530 -->		\|AktuelleVersionFreigabeDatum = <!-- aus Wikidata - https://www.wikidata.org/wiki/Q1253530 -->
	\|Betriebssystem = [[Linux]], [[macOS]], [[Solaris (Betriebssystem)\|Solaris]], [[Unix]], [[Microsoft Windows NT\|Windows]]		\|Betriebssystem = [[Linux]], [[macOS]], [[Solaris (Betriebssystem)\|Solaris]], [[Unix]], [[Microsoft Windows NT\|Windows]]
	\|Programmiersprache = ~~[[C++]]~~		\|Programmiersprache = <!-- aus Wikidata - https://www.wikidata.org/wiki/Q1253530 -->
	\|Kategorie = [[Software-Dokumentationswerkzeug]]		\|Kategorie = [[Software-Dokumentationswerkzeug]]
	\|Lizenz = ~~[[GNU~~ ~~General~~ ~~Public~~ ~~License\|GPL]]~~		\|Lizenz = <!-- aus Wikidata - https://www.wikidata.org/wiki/Q1253530 -->
	\|Deutsch = ja		\|Deutsch = ja
	\|Website = [https://www.~~doxygen~~.nl/~~index.html~~ ~~www.doxygen.nl]~~		\|Website = <!-- aus Wikidata - https://www.wikidata.org/wiki/Q1253530 -->
	}}		}}

Haraldmmueller: /* Hintergrund und Motivation */ Verbogene Argumentation und großartige Versprechungen entfernt.

2023-05-10T05:42:35Z

Hintergrund und Motivation: Verbogene Argumentation und großartige Versprechungen entfernt.

← Nächstältere Version		Version vom 10. Mai 2023, 07:42 Uhr
Zeile 18:		Zeile 18:
	Durch spezielle Kommentare im [[Quelltext]] können [[Softwareentwickler]] Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche [[Softwaredokumentation#Programmiererdokumentation\|Dokumentation]] erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm\|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)\|Funktionen]], [[Variable (Programmierung)\|Variablen]] sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.		Durch spezielle Kommentare im [[Quelltext]] können [[Softwareentwickler]] Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche [[Softwaredokumentation#Programmiererdokumentation\|Dokumentation]] erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm\|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)\|Funktionen]], [[Variable (Programmierung)\|Variablen]] sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.

	Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Da ~~Programmstrukturen~~ im Quelltext selbst ~~beschrieben~~ ~~werden~~ ~~müssen~~, ~~ist~~ ~~eine~~ ~~parallele~~ ~~Dokumentation~~ ~~der Strukturen~~ (Funktionen, Klassen, Methoden usw.) ~~in einer separaten Entwicklerdokumentation fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem wird dem Entwickler der Aufwand einer separaten Dokumentenerstellung erspart~~ und ~~die Vollständigkeit~~ der Dokumentation ~~gesichert und~~ ~~gesteigert~~.		Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Die Dokumentation im Quelltext selbst kann dabei helfen, das Auseinanderdriften zwischen den Programmstrukturen (Funktionen, Klassen, Methoden usw.) und der Dokumentation zu verringern.

	Mithilfe einer Doxy-Dokumentation ist es ferner möglich, einen unbekannten Code leichter zu verstehen und zu [[Reengineering (Software)\|reengineeren]].

	Als [[grafische Benutzeroberfläche]] dient der sogenannte '''Doxywizard''', mit dem die [[Konfiguration (Computer)\|Einstellungen]], welche Art und Form der Dokumentationserzeugung steuern, einfach vorgenommen werden können.		Als [[grafische Benutzeroberfläche]] dient der sogenannte '''Doxywizard''', mit dem die [[Konfiguration (Computer)\|Einstellungen]], welche Art und Form der Dokumentationserzeugung steuern, einfach vorgenommen werden können.
Zeile 28:		Zeile 26:
	Die erste Doxygen-Version verwendete Quelltext von DOC++, das am [[Konrad-Zuse-Zentrum für Informationstechnik Berlin\|Zuse-Institut Berlin]] von Roland Wunderling und Malte Zöckler entwickelt wurde.		Die erste Doxygen-Version verwendete Quelltext von DOC++, das am [[Konrad-Zuse-Zentrum für Informationstechnik Berlin\|Zuse-Institut Berlin]] von Roland Wunderling und Malte Zöckler entwickelt wurde.

	Doxygen ist kompatibel zur [[Versionierung\|Code-Versionierung]] mit [[Subversion (Software)\|Subversion]], womit automatisch erzeugte Codes für Autoren, Bearbeiter, Datum und Zeitpunkt des Eincheckens in die Doxygen Dokumentation übernommen werden können.		Doxygen ist kompatibel zur [[Versionierung\|Code-Versionierung]] mit [[Subversion (Software)\|Subversion]], womit automatisch erzeugte Codes für Autoren, Bearbeiter, Datum und Zeitpunkt des Eincheckens in die Doxygen-Dokumentation übernommen werden können.

	== Unterstützte Programmiersprachen ==		== Unterstützte Programmiersprachen ==

Schotterebene: Formatierung

2023-05-10T04:57:52Z

Formatierung

← Nächstältere Version		Version vom 10. Mai 2023, 06:57 Uhr
Zeile 58:		Zeile 58:

	== Ähnliche Werkzeuge ==		== Ähnliche Werkzeuge ==
	* [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle ~~(Software)\|Sandcastle]]~~, [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].		* [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], ASDoc, ROBODoc, Sandcastle, AutoDuck, pydoc, HeaderDoc, [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].

	== Weblinks ==		== Weblinks ==
	{{Commonscat}}		{{Commonscat}}
	{{Wikibooks\|C++-Programmierung: Dokumentation mit Doxygen}}		{{Wikibooks\|C++-Programmierung: Dokumentation mit Doxygen}}
	* [https://www.doxygen.nl/ ~~Offizielle Website~~] (englisch)		* [https://www.doxygen.nl/ doxygen.nl] (englisch)
	* [https://sourceforge.net/projects/pas2dox/ Pas2Dox: Ein Pascal-Filter für Doxygen] (englisch)		* [https://sourceforge.net/projects/pas2dox/ Pas2Dox: Ein Pascal-Filter für Doxygen] (englisch)

Aka: https

2021-09-30T12:58:59Z

https

← Nächstältere Version		Version vom 30. September 2021, 14:58 Uhr
Zeile 10:		Zeile 10:
	\|Lizenz = [[GNU General Public License\|GPL]]		\|Lizenz = [[GNU General Public License\|GPL]]
	\|Deutsch = ja		\|Deutsch = ja
	\|Website = [~~http~~://www.doxygen.nl/ www.doxygen.nl]		\|Website = [https://www.doxygen.nl/index.html www.doxygen.nl]
	}}		}}

Mike Krüger: Abschnittlink korrigiert

2021-07-23T06:12:30Z

Abschnittlink korrigiert

← Nächstältere Version		Version vom 23. Juli 2021, 08:12 Uhr
Zeile 31:		Zeile 31:

	== Unterstützte Programmiersprachen ==		== Unterstützte Programmiersprachen ==

	Unterstützte Programmiersprachen sind [[C++]], [[C (Programmiersprache)\|C]], [[Objective-C]], [[Java (Programmiersprache)\|Java]], [[Python (Programmiersprache)\|Python]], [[Fortran]] und [[Interface Description Language\|IDL]]. Sie werden in ihrem vollen Sprachumfang unterstützt. Mit Einschränkungen ist auch die Kommentierung von [[PHP]], [[C-Sharp\|C#]], [[D (Programmiersprache)\|D]] und [[Very High Speed Integrated Circuit Hardware Description Language\|VHDL]] möglich. Ab Version 1.7.5 wird [[Tcl]] unterstützt. Durch zusätzliche Filter kann auch Quellcode in [[Perl (Programmiersprache)\|Perl]] oder [[Object Pascal]] bearbeitet werden.		Unterstützte Programmiersprachen sind [[C++]], [[C (Programmiersprache)\|C]], [[Objective-C]], [[Java (Programmiersprache)\|Java]], [[Python (Programmiersprache)\|Python]], [[Fortran]] und [[Interface Description Language\|IDL]]. Sie werden in ihrem vollen Sprachumfang unterstützt. Mit Einschränkungen ist auch die Kommentierung von [[PHP]], [[C-Sharp\|C#]], [[D (Programmiersprache)\|D]] und [[Very High Speed Integrated Circuit Hardware Description Language\|VHDL]] möglich. Ab Version 1.7.5 wird [[Tcl]] unterstützt. Durch zusätzliche Filter kann auch Quellcode in [[Perl (Programmiersprache)\|Perl]] oder [[Object Pascal]] bearbeitet werden.

	== Unterstützte Ausgabeformate ==		== Unterstützte Ausgabeformate ==
		⚫	Als Ausgabeformat unterstützt Doxygen [[Hypertext Markup Language\|HTML]], [[CHM (Dateiformat)\|CHM]], [[LaTeX]], [[Extensible Markup Language\|XML]], [[Rich Text Format\|RTF]], [[PostScript]], [[PDF]], [[Manpage]]s und [[Markdown]].<ref>{{Internetquelle \|url=https://www.doxygen.nl/manual/markdown.html \|titel=Doxygen Manual: Markdown support \|abruf=2020-08-20}}</ref> Auch lassen sich entsprechende Steuerdaten für die Erstellung von Hilfedateien für das Hilfesystem von [[Qt (Bibliothek)\|Qt]] erstellen. Ab Version 1.8.8 wird auch [[PlantUML]] unterstützt, um [[Unified Modeling Language#Diagramme\|UML-Diagramme]] zu erstellen.<ref>{{Internetquelle \|url=https://www.doxygen.nl/manual/changelog.html \|titel=Doxygen Manual: Changelog \|abruf=2020-08-20}}</ref>

⚫	Als Ausgabeformat unterstützt Doxygen [[Hypertext Markup Language\|HTML]], [[CHM (Dateiformat)\|CHM]], [[LaTeX]], [[Extensible Markup Language\|XML]], [[Rich Text Format\|RTF]], [[PostScript]], [[PDF]], [[Manpage]]s und [[Markdown]].<ref>{{Internetquelle \|url=https://www.doxygen.nl/manual/markdown.html \|titel=Doxygen Manual: Markdown support \|abruf=2020-08-20}}</ref> Auch lassen sich entsprechende Steuerdaten für die Erstellung von Hilfedateien für das Hilfesystem von [[Qt (Bibliothek)\|Qt]] erstellen. Ab Version 1.8.8 wird auch [[PlantUML]] unterstützt, um [[Unified Modeling Language#~~Darstellung in Diagrammen~~\|UML-Diagramme]] zu erstellen.<ref>{{Internetquelle \|url=https://www.doxygen.nl/manual/changelog.html \|titel=Doxygen Manual: Changelog \|abruf=2020-08-20}}</ref>

	== Beispiel ==		== Beispiel ==

	Die Dokumentierung einer Funktion kann wie folgt in den Quelltext eingebettet werden (hier in der Programmiersprache C):		Die Dokumentierung einer Funktion kann wie folgt in den Quelltext eingebettet werden (hier in der Programmiersprache C):
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
Zeile 61:		Zeile 58:

	== Ähnliche Werkzeuge ==		== Ähnliche Werkzeuge ==

	* [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle (Software)\|Sandcastle]], [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].		* [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle (Software)\|Sandcastle]], [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].

Rmcharb: Änderung 210737439 von 213.71.0.50 rückgängig gemacht; bitte WP:Web, WP:V#ANR beachten

2021-04-09T10:07:03Z

Änderung 210737439 von 213.71.0.50 rückgängig gemacht; bitte WP:Web, WP:V#ANR beachten

← Nächstältere Version		Version vom 9. April 2021, 12:07 Uhr
Zeile 62:		Zeile 62:
	== Ähnliche Werkzeuge ==		== Ähnliche Werkzeuge ==

	* ~~[https://dotnet.github.io/docfx/ DocFX],~~ [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle (Software)\|Sandcastle]], [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].		* [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle (Software)\|Sandcastle]], [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].

	== Weblinks ==		== Weblinks ==

213.71.0.50: /* Ähnliche Werkzeuge */

2021-04-09T10:06:11Z

Ähnliche Werkzeuge

← Nächstältere Version		Version vom 9. April 2021, 12:06 Uhr
Zeile 62:		Zeile 62:
	== Ähnliche Werkzeuge ==		== Ähnliche Werkzeuge ==

	* [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle (Software)\|Sandcastle]], [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].		* [https://dotnet.github.io/docfx/ DocFX], [[Javadoc]], [[Natural Docs]], [[phpDocumentor]], [[ASDoc]], [[ROBODoc]], [[Sandcastle (Software)\|Sandcastle]], [[AutoDuck]], [[pydoc]], [[HeaderDoc]], [[Plain Old Documentation]], [[Sphinx (Software)\|Sphinx]], [[WEB (Programmiersprache)\|CWEB]].

	== Weblinks ==		== Weblinks ==

62.12.140.26: /* Hintergrund und Motivation */ Grammatik korrigiert

2021-03-17T12:09:38Z

Hintergrund und Motivation: Grammatik korrigiert

← Nächstältere Version		Version vom 17. März 2021, 14:09 Uhr
Zeile 28:		Zeile 28:
	Die erste Doxygen-Version verwendete Quelltext von DOC++, das am [[Konrad-Zuse-Zentrum für Informationstechnik Berlin\|Zuse-Institut Berlin]] von Roland Wunderling und Malte Zöckler entwickelt wurde.		Die erste Doxygen-Version verwendete Quelltext von DOC++, das am [[Konrad-Zuse-Zentrum für Informationstechnik Berlin\|Zuse-Institut Berlin]] von Roland Wunderling und Malte Zöckler entwickelt wurde.

	Doxygen ist kompatibel zur [[Versionierung\|Code-Versionierung]] mit [[Subversion (Software)\|Subversion]], ~~d. h. damit~~ automatisch erzeugte Codes für Autoren, Bearbeiter, Datum und Zeitpunkt des Eincheckens ~~könnten~~ die ~~die~~ ~~Doxy-~~Dokumentation übernommen werden.		Doxygen ist kompatibel zur [[Versionierung\|Code-Versionierung]] mit [[Subversion (Software)\|Subversion]], womit automatisch erzeugte Codes für Autoren, Bearbeiter, Datum und Zeitpunkt des Eincheckens in die Doxygen Dokumentation übernommen werden können.

	== Unterstützte Programmiersprachen ==		== Unterstützte Programmiersprachen ==

93.220.151.217: Änderung 207244929 von 93.220.151.217 rückgängig gemacht;

2021-01-04T05:59:02Z

Änderung 207244929 von 93.220.151.217 rückgängig gemacht;

← Nächstältere Version		Version vom 4. Januar 2021, 07:59 Uhr
Zeile 16:		Zeile 16:

	== Hintergrund und Motivation ==		== Hintergrund und Motivation ==
	Durch spezielle Kommentare im [[Quelltext]] können [[Softwareentwickler]] Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche [[Softwaredokumentation#Programmiererdokumentation\|Dokumentation]] erstellt ~~wird~~. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm\|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)\|Funktionen]], [[Variable (Programmierung)\|Variablen]] sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.		Durch spezielle Kommentare im [[Quelltext]] können [[Softwareentwickler]] Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche [[Softwaredokumentation#Programmiererdokumentation\|Dokumentation]] erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm\|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)\|Funktionen]], [[Variable (Programmierung)\|Variablen]] sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.

	Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Da Programmstrukturen im Quelltext selbst beschrieben werden müssen, ist eine parallele Dokumentation der Strukturen (Funktionen, Klassen, Methoden usw.) in einer separaten Entwicklerdokumentation fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem wird dem Entwickler der Aufwand einer separaten Dokumentenerstellung erspart und die Vollständigkeit der Dokumentation gesichert und gesteigert.		Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Da Programmstrukturen im Quelltext selbst beschrieben werden müssen, ist eine parallele Dokumentation der Strukturen (Funktionen, Klassen, Methoden usw.) in einer separaten Entwicklerdokumentation fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem wird dem Entwickler der Aufwand einer separaten Dokumentenerstellung erspart und die Vollständigkeit der Dokumentation gesichert und gesteigert.

93.220.151.217: Korrektur unvollständiger Satz

2021-01-04T05:57:35Z

Korrektur unvollständiger Satz

← Nächstältere Version		Version vom 4. Januar 2021, 07:57 Uhr
Zeile 16:		Zeile 16:

	== Hintergrund und Motivation ==		== Hintergrund und Motivation ==
	Durch spezielle Kommentare im [[Quelltext]] können [[Softwareentwickler]] Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche [[Softwaredokumentation#Programmiererdokumentation\|Dokumentation]] erstellt. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm\|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)\|Funktionen]], [[Variable (Programmierung)\|Variablen]] sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.		Durch spezielle Kommentare im [[Quelltext]] können [[Softwareentwickler]] Erläuterungen zu Programmelementen definieren, aus denen Doxygen eine übersichtliche [[Softwaredokumentation#Programmiererdokumentation\|Dokumentation]] erstellt wird. Außerdem ist es möglich, einen zusammenfassenden Überblick über den Aufbau und die Elemente eines bereits existierenden [[Computerprogramm\|Programms]] (verwendete [[Datei]]en, [[Funktion (Programmierung)\|Funktionen]], [[Variable (Programmierung)\|Variablen]] sowie deren jeweilige Rolle im Programmablauf) zu erzeugen.

	Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Da Programmstrukturen im Quelltext selbst beschrieben werden müssen, ist eine parallele Dokumentation der Strukturen (Funktionen, Klassen, Methoden usw.) in einer separaten Entwicklerdokumentation fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem wird dem Entwickler der Aufwand einer separaten Dokumentenerstellung erspart und die Vollständigkeit der Dokumentation gesichert und gesteigert.		Das Ziel einer solchen Dokumentationsmethode ist die Vermeidung von Redundanz und die Steigerung der Übersichtlichkeit des Codes. Da Programmstrukturen im Quelltext selbst beschrieben werden müssen, ist eine parallele Dokumentation der Strukturen (Funktionen, Klassen, Methoden usw.) in einer separaten Entwicklerdokumentation fehleranfällig, da sich diese im Laufe einer Entwicklung häufig ändern. Zudem wird dem Entwickler der Aufwand einer separaten Dokumentenerstellung erspart und die Vollständigkeit der Dokumentation gesichert und gesteigert.