Dokumentation

Die Dokumentation zu diesem Projekt wird mit Doxygen und Graphviz automatisch generiert.

Eine gute Einführung in Doxygen ist beispielsweise hier zu finden.

Allen öffentlichen Methoden und Attribute sollen so beschrieben werden, dass sich die Benutzung der Klasse alleine anhand der Dokumentation erschließt. Aus diesem Grunde sollten auch die von einer Methode erwarteten Übergabeparameter sowie deren Rückgabeewerte ausreichend detailliert beschrieben werden.

Eine klare und saubere Dokumentation vereinfacht in allen Fällen die Zusammenarbeit im Team wesentlich.

Beispiele für den in diesem Projekt verwendeten Dokumentationsstil finden sich etwa in inc/Tile.h.