Como documentar a overview?

[danimac13]

Olá pessoal.
Pode parecer uma pergunta idiota, mas até agora não achei nenhuma resposta.
Alguém sabe como documentar a página principal do javadoc.

[aleck]

Na dúvida edite o html

[thingol]

O overview é gerado criando-se um arquivo chamado package-info.java (dentro do pacote onde você quer documentar o overview) e escrevendo o overview como se fosse um comentário javadoc. Como esse arquivo não é compilável, já que tem um traço no nome, então ele só será entendido pela ferramenta javadoc.

http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#newfeatures

package-info.java: You can now create a source file with this name to store package comments and annotations. It can be used in place of package.html (which supports only comments, not annotations). If package-info.java is present, javadoc should ignore package.html and look instead for the package doc comment immediately preceding the (possibly annotated) package declaration. The javadoc tool handles the selection and parsing of package-info.java and package.html and passes the doc comments to the doclet.

Não edite diretamente o html gerado porque ele será destruído se você chamar a ferramenta javadoc diretamente.