– Contao Documentation Project
Bisher gab es nur für wenige Contao Projekte eine Code Dokumentation. Für Contao selbst war diese immer unter api.contao.org zu finden.
Das Contao Documentation Project (CDP) schafft endlich abhilfe.
Das CDP liefert Code Dokumentation für Contao selbst und alle im Extension Repository frei verfügbaren Erweiterungen.
Als Dokumentationssystem kommt Doxygen zum Einsatz. Im Gegensatz zu anderen Dokumentationssystemen erlaubt Doxygen die Referenzierung anderer Dokumentationen. So werden selbst Abhängigkeiten zwischen Erweiterungen aufgelöst.
Als Beispiel für die Referenzierung zwischen den Erweiterungen betrachte man bspw. die Klasse CssMinimizer, die Klasse stammt aus dem Paket cssMinimizer. CssMinimizer ist Abhängig von der Klasse AbstractMinimizer aus dem Paket compression-api. Man erkennt nicht nur die Abhängigkeit am Klassengraph, die Klassen sind auch untereinander verlinkt.
Unterschied zum Contao Community Code Documentation (CCCD) Projekt
Das CCCD hat das Ziel, die vorhandene Dokumentation zu verbessern und mit neuen Beiträgen aus der Community zu ergänzen. Das CDP hat nicht das Ziel die vorhandene Dokumentation zu verbessern oder zu ergänzen. Es liefert lediglich die vorhandene Code Dokumentation, miteinander Verknüpft und zentralisiert an einem Ort.
Wer die vorhandene Dokumentation verbessern und ergänzen will, sollte sich das CCCD mal anschauen. Helfende Schreiber sind dort immer gern gesehen.