Zur der Verwendung einer Programmierbibliothek ist es unerlässlich, eine Referenzdokumentation zur Hand zu haben. Eine Referenzdokumentation beschreibt die Schnittstelle einer Bibliothek. Diese besteht aus öffentliche (public) Klassen, Methoden, Variablen und Funktionen. Z.B. werden Parameter und Rückgabewert von Methoden/Funktionen erläutert. Viele gut-gepflegte Bibliotheken bieten ihre Dokumentation online an (z.B. Boost]] oder Lemon). Leider gibt es oft Gründe, selbst eine Referenz erzeugen zu wollen:

• Die Online-Dokumentation ist nicht mehr aktuell
• Man hat u.U. keine Internetverbindung während man programmiert
• Es werden viele Bibliotheken in einem Projekt verwendet. Wenn man nicht weiß, zu welcher Bibliothek eine Funktion gehört, muss jede einzelne Dokumentationsbeschreibung recherchiert werden.

Zum Glück gibt es Programme, die eine Software-Dokumentation anhand des vorliegenden Quellcodes automatisch generieren können. Doxygen und JavaDoc gehören zu den Standard-Werkzeugen in diesem Umfeld. Neben HTML wird auch das DocBook-Format unterstützt, eine XML-Spezialisierung für technische Dokumente. Leider wird hierbei ein rudimentärer Index erzeugt, der nur innerhalb des Projekts nach Keywords suchen lässt. Deshalb soll im Zuge dieser Arbeit eine Referenzdokumenten-Indizierungssoftware programmiert werden, die das Suchen von Schlüsselwörten in allen technischen Dokumentationen gleichzeitig erlaubt. Als Eingabe wird eine vorgegebene Menge an DocBook Dokumenten verarbeitet. Für die schnelle Suche soll ein Index erzeugt werden, der die passende Klassen/Methoden/Funktions-Beschreibung liefert. Das Programm soll in der Kommandozeile arbeiten und eine einfache Navigation zwischen Suchregister und Dokumentationstext erlauben. Die Programmierumgebung ist frei wählbar (z.B. C mit ncurses und clucene).

Vorzugsweise ist das Thema als Bachelorarbeit angedacht.

Bei Interesse wenden Sie sich bitte an Dominik Köppl.