Gera��o de Javadoc permite
gerar Javadoc. � uma interface com o usu�rio para a ferramenta javadoc.exe dispon�vel no JDK do Java. Visite a p�gina Ferramenta
Javadoc da Sun para obter a documenta��o completa da ferramenta
Javadoc.
O assistente de
Gera��o de Javadoc permite
gerar Javadoc. � uma interface com o usu�rio para a ferramenta javadoc.exe dispon�vel no JDK do Java. Visite a p�gina Ferramenta
Javadoc da Sun para obter a documenta��o completa da ferramenta
Javadoc.
Sele��o de Tipo:
|
Op��o |
Descri��o |
|---|---|
|
Comando Javadoc |
Especifica qual comando usar para gerar o javadoc. |
|
Selecione os tipos para os quais o Javadoc ser� gerado |
Na lista, selecione ou limpe as caixas para especificar exatamente os tipos que deseja exportar. Essa lista � inicializada pela sele��o do ambiente de trabalho. |
|
Criar Javadoc para membros com visibilidade |
|
|
Utilizar o Doclet Padr�o |
Inicie o comando Javadoc com o doclet padr�o (padr�o)
|
|
Utilizar o Doclet Customizado |
Utilize um doclet personalizado para gerar documenta��o
|
Argumentos Padr�o do Doclet (dispon�vel quando Utilizar doclet padr�o est� selecionado):
|
Op��o |
Descri��o |
|---|---|
|
T�tulo do documento |
Especifique um t�tulo para o documento. |
| Gerar p�gina para utiliza��o | Selecione esta op��o para que a documenta��o contenha uma p�gina Utilizar. |
| Gerar �rvore de hierarquia | Selecione esta op��o para que a documenta��o contenha uma p�gina �rvore. |
|
Gerar barra do navegador |
Selecione esta op��o para que a documenta��o contenha uma barra de navega��o (cabe�alho e rodap�). |
| Gerar �ndice | Selecione esta op��o para que a documenta��o contenha uma p�gina �ndice. |
| Separar �ndice por Letra | Criar um �ndice por letra. Ativando quando Gerar �ndice estiver selecionado. |
| @author | Selecione esta op��o para que a marca��o @author seja documentada. |
| @version | Selecione esta op��o para que a marca��o @version seja documentada. |
| @deprecated | Selecione esta op��o para que a marca��o @deprecated seja documentada. |
| lista reprovada | Selecione esta op��o para que a documenta��o contenha uma p�gina Reprovada. Ativado quando a op��o @deprecated est� selecionada. |
| Selecione os arquivos e projetos referenciados aos quais os links devem ser gerados |
Especifique em que outra documenta��o o Javadoc deve criar links quando outros tipos forem referidos.
|
| Folha de Estilo | Selecione a p�gina de estilo a ser utilizada |
Op��es Gerais do Javadoc:
|
Op��o |
Descri��o |
|---|---|
|
Vis�o Geral |
Especifica que Javadoc deve recuperar o texto da documenta��o da vis�o geral do arquivo fornecido. Ele ser� colocado em overview-summary.html. |
|
Op��es da VM |
Inclui qualquer n�mero de op��es extras da VM aqui. |
|
Op��es Extras de Javadoc |
Inclui qualquer n�mero de op��es extras aqui: Op��es de doclet customizadas ou op��es de compatibilidade do JRE 1.4. |
|
Compatibilidade de Origem JRE |
A compatibilidade de origem JRE a ser aceita pela ferramenta javadoc. |
|
Salvar as defini��es desta exporta��o de Javadoc como um script Ant |
Especificar para armazenar um script Ant que executar� a exporta��o especificada de Javadoc sem a necessidade de utilizar o assistente. O script Ant existente pode ser modificado com este assistente (Utilize o assistente para Abrir Javadoc no menu de contexto no script Ant gerado) |
| Abrir arquivo de �ndice gerado no navegador | Abre o arquivo index.html gerado no navegador (dispon�vel apenas ao utilizar o doclet padr�o) |
Pressione Concluir para iniciar a gera��o de Javadoc. Se o destino for diferente da localiza��o configurada para a p�gina Localiza��o de Javadoc do projeto, ser� perguntado se voc� deseja definir a localiza��o de Javadoc do projeto para a nova pasta de destino. Desse modo, todas as chamadas de Abrir Javadoc Externo utilizar�o a documenta��o criada agora.
Um novo processo ser� iniciado e a gera��o executada no segundo plano. Abra a visualiza��o Console (Janela > Mostrar Visualiza��o > Console) para ver o progresso e o status da gera��o.
