Doxygen API-Referenz¶
Übersicht¶
Die API-Dokumentation wird automatisch aus dem C++-Quellcode generiert. Sie enthält Klassendiagramme, Funktionssignaturen und Quellcode-Referenzen für alle Module.
Dokumentation generieren¶
Die generierte HTML-Dokumentation befindet sich anschließend in docs/html/ und kann lokal im Browser geöffnet werden:
Voraussetzungen
Doxygen und Graphviz müssen installiert sein (siehe Voraussetzungen). Graphviz wird für die Generierung von Klassendiagrammen benötigt.
Dokumentierte Klassen¶
Die wichtigsten im Quellcode dokumentierten Klassen:
| Klasse | Modul | Funktion |
|---|---|---|
optionsClass |
options | Basis-Konfigurationsklasse |
options_wqClass |
worldqual | Worldqual-spezifische Optionen |
options_wq_loadClass |
wq_load | Wq_load-spezifische Optionen |
ClassWQ_load |
wq_load | Nährstoffeintrag-Berechnung |
CROP_CLASS |
wq_load | Ackerbau und Düngung |
LS_CLASS |
wq_load | Viehwirtschaft |
GB_CLASS |
wq_load | Gewässerbilanz |
COUNTRY_CLASS |
general_function | Länderverwaltung |
countryInfoClass |
newton | Länderinformationen |
statisticClass |
wq_stat | Statistische Auswertung |
Konfiguration (Doxyfile)¶
Die Doxygen-Konfiguration befindet sich in docs/Doxyfile. Wichtige Einstellungen:
- INPUT – Quellcode-Verzeichnisse (
src/) - RECURSIVE – Unterverzeichnisse einbeziehen
- GENERATE_HTML – HTML-Output aktiviert
- HAVE_DOT – Graphviz für Diagramme