Chapter 5. Entwickler-Handbuch zu Kwave

in Arbeit

Sorry, leider muss dieses Kapitel noch geschrieben werden ... im Moment ist der Quellcode fast vollständig mit Tags passend zu den KDE- Dokumentationswerkzeugen dokumentiert. Aktuell bevorzugen wir die Benutzung von doxygen. Vielleicht werden wir eines Tages etwas Zeit erübrigen können, um ein Tool zu schreiben, dass die doxygen Ausgabe in etwas umwandelt, was man in irgendeiner Art und Weise in die Docbook-Quellen (die Quellen, aus denen diese Seite erzeugt wurde) einbinden könnte.

Wenn Sie ein Plugin schreiben und etwas zu diesem Projekt beitragen (oder vielleicht den oben erwähnten Konverter schreiben) wollen, dann scheuen Sie sich nicht, einem der Autoren direkt zu schreiben und / oder der Kwave Mailing-Liste beizutreten. Hilfe ist immer willkommen!

API-Dokumentation erzeugen

Wenn Sie an den Internas von Kwave interessier sind, und doxygen installiert haben, dann können Sie folgendes eingeben:

% make apidoc

um in Ihrem Generierverzeichnis ein Unterverzeichnis apicod/html zu erhalten das die Dokumentation des Quellcodes und der internen Schnittstellen zu enthält.