JavaDoc + Wiki = WikiDoc - Kollaborative Dokumentationssystem für Java

Bearbeiter und Betreuer

Diese Arbeit wird bearbeitet von Jing Zhao und betreut von Christopher Oezbek und Prof. Prechelt.

Diese Arbeit wurde ursprünglich begonnen von Robert Wolf.

Beschreibung

In dieser Arbeit sollen ein inline Dokumentationwerkzeug (JavaDoc oder auch Doxygen) um Wiki-Funktionalität erweitert werden. Dies würde verteilten Entwicklungsteams eine bequeme Möglichkeit zur Bearbeitung von Dokumentation geben. Besonders quelloffene Projekte wie in der Open Source und Free Software Szene würden sehr profitieren, wenn die Barriere für die Bereitstellung von Dokumentation-Patches gesenkt wird.

Requirements Analysis

Stage "Code manipulation"

A tool has to be created that can update JavaDoc comments in a selective manner. The interface should look similar to this:

> updateJavadoc de/inffub/agse/wikidoc/coderewriter/test/JavadocModifyTest.Nested.html#JavadocModifyTest.Nested() "New javadoc comment"

The exact syntax for the fully qualified expression that identifies the method, attribute or class to be changed must be fully compatible to the JavaDoc syntax used for the same problem.

Results