Kombinieren Sie Javadoc für mehrere Module in einer einzigen Sammlung

9

Ich habe eine Java-Anwendung, die aus mehreren Modulen besteht. Ich möchte Javadoc für alle zusammen generieren: das heißt, von diesen verschiedenen Modulen möchte ich eine einzelne Sammlung von HTML-Dateien mit einem einzelnen index.html , einem einzelnen allclasses-frame.html usw. und den verschiedenen Hyperlinks sollten über Module hinweg funktionieren.

Ich benutze Maven, aber ich bin nicht unbedingt auf Maven-spezifische Lösungen beschränkt. Dies wird durch einen Cron-Job ausgeführt, so dass auch andere Tools verwendet werden können.

Was ist der einfachste Weg, Javadoc in diesem Fall automatisch zu generieren?

    
Dan 28.06.2011, 16:10
quelle

2 Antworten

3

Wenn Sie es verwalten können, kann javadoc die kombinierte Dokumentation generieren, sofern Sie die Eingabequellen kombinieren. Vielleicht gibt es eine elegantere Lösung; aber warum nicht alle Quellen in einen kombinierten Baum kopieren und dann javadoc ?

ausführen

Die andere Option besteht darin, die Option -link zu verwenden, und die Dokumentation einer Site verweist auf die Dokumentation einer anderen Site. Wenn Sie diese Option wählen, sollten Sie auch die Option linkoffline für Flexibilität in Ihren javadoc-Builds verwenden (es sei denn, Sie verwalten die Dokumentation in der richtigen Reihenfolge auf den Webservern, bevor sie von nachfolgenden Builds benötigt wird).

    
Edwin Buck 28.06.2011, 16:13
quelle
1

Wenn Sie Eclipse IDE verwenden, gibt es eine Option, um Javadocs für Ihr Projekt im Projektmenü zu generieren. Weitere Informationen finden Sie unter link

    
Rakesh 28.06.2011 16:58
quelle

Tags und Links