Wie kann ich die Seite "Übersicht" in JavaDoc anpassen?

Question

Ich möchte die "Übersicht" Seite meiner Bibliothek Javadoc im Wesentlichen ein Benutzer/API-Leitfaden für die gesamte JAR sein. Ich weiß, dass das Hinzufügen einer package-info.java Klasse zu einem Paket ermöglicht es Ihnen, Paket-Ebene javadocs zu schreiben, aber was ist mit der jar-Ebene?

Ich weiß, dass ich mein Projekt ein README.md in root setzen konnte, aber Ich mag den Readme der als doc für Bibliothek Entwickler denken (das heißt, Menschen, die werden die Bibliothek beibehalten). Aber die JavaDocs sind API-Handbücher für Leute, die unter Verwendung der Bibliothek sein werden.

Answer 1

Sie können eine HTML-Übersichtsdatei erstellen und 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 Übersichtsanforderungen für Dateien finden Sie unter here.