JavaDoc'ta "Genel Bakış" sayfası nasıl özelleştirilir?

Question

Kütüphanemin javadoc'unun "Genel Bakış Genel Bakış" sayfasının asıl amacı, JAR'ın tamamı için bir kullanıcı/API kılavuzu olması. Bir pakete package-info.java sınıfını eklemenin, paket seviyesi javadocs yazmanıza olanak sağladığını biliyorum, ancak kavanoz seviyesinde?

Benim projenin kök bir README.md koyabilirsiniz biliyorum ama kütüphane geliştiriciler için bir doküman olarak README yılların düşünmek (yani, kütüphane muhafaza olacak insanları) gibi. Ancak JavaDocs, kütüphane kullanarak olacak insanlar için API kılavuzlarıdır.

Answer 1

Genel bakış HTML dosyası oluşturabilir ve dilediğiniz yere kaynak ağacınızda yerleştirebilirsiniz. Kongre, overview.html adını vermek ve bunu ağacınızın köküne yerleştirmek, ancak kesinlikle bunu yapmak zorunda değilsiniz. Aslında, farklı amaçlar için çoklu genel bakış dosyaları oluşturabilirsiniz. Javadocs'ınızı oluştururken, -overview bayrağını kullanın ve hedef genel bakış dosyasının yolunu iletin.

Genel bakış dosya gereksinimleri hakkında daha fazla bilgiyi here bulabilirsiniz.