Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
de:entwickler:sourcecode-dokumentation [2012/07/17 21:41]
fasse Fehlende Doxygen-Tags dokumentiert
de:entwickler:sourcecode-dokumentation [2012/07/17 22:07] (current)
fasse [Doxygen]
Line 1: Line 1:
 ====== Sourcecode-Dokumenation ====== ====== Sourcecode-Dokumenation ======
 ==== Doxygen ==== ==== Doxygen ====
-Die Dokumentation unserer Klassen und Funktionen soll mit Hilfe von [[http://​www.doxygen.org|Doxygen]] erfolgen. Dieses Programm kann mit Hilfe von Schlüsselwörtern innerhalb des Kommentarbereichs des Sourcecodes eine [[http://​www.admidio.org/​dokusource|übersichtliche HTML-Dokumentation]] erstellen. Der Vorteil ist eine gute übersichtliche Dokumentation im Sourcecode selber und zusätzlich eine gut formatierte HTML Darstellung ohne dass ein großer Mehraufwand entsteht. Diese Seite soll nun die wichtigsten Schlüsselwörter und Formatierungen von Doxygen beschreiben,​ die wir für Admidio benötigen. Auf der Doxygen-Seite selber findest du auch eine Anleitung zur [[http://​www.stack.nl/​~dimitri/​doxygen/​docblocks.html|Anpassung der Dokumentation]],​ sowie eine [[http://​www.stack.nl/​~dimitri/​doxygen/​commands.html|Übersicht über alle Schlüsselwörter]].+Die Dokumentation unserer Klassen und Funktionen soll mit Hilfe von [[http://​www.doxygen.org|Doxygen]] erfolgen. Dieses Programm kann mit Hilfe von Schlüsselwörtern innerhalb des Kommentarbereichs des Sourcecodes eine [[http://​www.admidio.org/​dokusource|übersichtliche HTML-Dokumentation]] erstellen. Die Dokumenation kann zum Offline-Zugriff auch [[https://​sourceforge.net/​projects/​admidio/​files/​Dokusource/​|heruntergeladen]] werden. Der Vorteil ​der Dokumentation mit Doxygen ​ist eine gute übersichtliche Dokumentation im Sourcecode selber und zusätzlich eine gut formatierte HTML Darstellung ohne dass ein großer Mehraufwand entsteht. Diese Seite soll nun die wichtigsten Schlüsselwörter und Formatierungen von Doxygen beschreiben,​ die wir für Admidio benötigen. Auf der Doxygen-Seite selber findest du auch eine Anleitung zur [[http://​www.stack.nl/​~dimitri/​doxygen/​docblocks.html|Anpassung der Dokumentation]],​ sowie eine [[http://​www.stack.nl/​~dimitri/​doxygen/​commands.html|Übersicht über alle Schlüsselwörter]].
  
 ==== HTML-Ansicht selber generieren ==== ==== HTML-Ansicht selber generieren ====
  • de/entwickler/sourcecode-dokumentation.txt
  • Last modified: 2012/07/17 22:07
  • by fasse