Ich möchte, dass die Seite Übersicht meiner Javadoc-Bibliothek im Wesentlichen ein Benutzer- / API-Leitfaden für das gesamte JAR ist. Ich weiß, dass das Hinzufügen einer package-info.java -Klasse zu einem Paket Ihnen erlaubt, package-level javadocs zu schreiben, aber was ist mit der JAR-Ebene ?
Ich weiß, dass ich ein README.md in das Stammverzeichnis meines Projekts schreiben könnte, aber ich denke gerne an README's als Dokument für Bibliotheksentwickler (also Leute, die die Bibliothek beibehalten ). Die JavaDocs sind jedoch API-Handbücher für Personen, die die Bibliothek verwenden .
Sie können eine HTML-Übersichtsdatei erstellen und sie in Ihrem Quellbaum beliebig platzieren. Die Konvention ist, sie overview.html zu nennen und sie an der Wurzel Ihres Baumes zu platzieren, aber Sie sind dazu sicherlich nicht verpflichtet. Tatsächlich können Sie mehrere Übersichtsdateien für verschiedene Zwecke erstellen. Wenn Sie Ihre Javadocs generieren, verwenden Sie das Flag -overview und übergeben Sie den Pfad zur Zielübersichtsdatei.
Weitere Informationen zu den Anforderungen für Übersichtsdateien finden Sie hier .