Submodule unter Git nutzen

Manchmal möchte man Git-Repository in einer bestimmten Art strukturieren. So will man unter Umständen mehrere Repositories logisch zu einem Repository gesellen. Dafür gibt es unter Git Submodule. Gegeben sei folgende Repositorystruktur:

Framework
Library1
Library2
Library3

Möchte man die Bibliotheken Library1, Library2 und Library3 logisch in das Repository Framework einbinden, kann man die Submodule nutzen. Dazu geht man in das Repository Framework und fügt die andere Repositories als Submodule hinzu:

git submodule add :Library1
git submodule add :Library2
git submodule add :Library3

Damit wird im Repository Framework eine Datei mit dem Namen .gitmodules angelegt, in welcher folgender Inhalt zu finden ist:

[submodule "Library1"]
	path = Library1
	url = :Library1

[submodule "Library2"]
	path = Library2
	url = :Library2

[submodule "Library3"]
	path = Library3
	url = :Library3

Diese Datei kann dann per Commit dem Repository hinzugefügt werden. Beim klonen eines solchen Repositories, muss man nur darauf achten das es rekursiv geklont und gepullt (git submodule foreach git pull) wird, damit die Submodule ebenfalls aktualisiert werden.

Doxygen Ausgabe anpassen

Die Ausgabe welche das Dokumentationsframework Doxygen erzeugt sieht leider etwas altgebacken aus. Glücklicherweise kann man das Doxygen-Design relativ einfach anpassen. Vorgefertigte Designs gibt es unter anderem auf GitHub.

Die angepasst Doxygen Ausgabe

Die angepasst Doxygen Ausgabe

Nachdem das Repsitory geklont wurde, müssen die Dateien header.html, footer.html und customdoxygen.css zur Konfigurationsdatei gepackt werden. In der Konfigurationsdatei müssen folgende Parameter angepasst werden:

HTML_HEADER       = header.html 
HTML_FOOTER            = footer.html 
HTML_STYLESHEET        = customdoxygen.css

Nachdem die neue Dokumentation erzeugt wurde, muss die Datei doxy-boot.js in den HTML-Ausgabe-Ordner kopiert werden. Anschließend kann die Dokumentation genutzt werden.