O assistente
Geração de Javadoc
permite gerar Javadoc. Trata-se de uma interface para a ferramenta javadoc.exe disponível no JDK Java. Visite a página da Ferramenta de Javadoc de Sun para obter a documentação completa de uma ferramenta de Javadoc.
Selecção do Tipo:
Opção |
Descrição |
---|---|
Seleccionar tipos para onde será gerado o Javadoc |
Na lista, seleccione ou desmarque as caixas para especificar exactamente os tipos que pretende exportar para o ficheiro JAR. Esta lista é iniciada pela selecção da área de trabalho. Apenas pode ser seleccionado um projecto se uma vez, visto que apenas pode ser utilizado um caminho de classe do projecto de cada vez quando executar a ferramenta de Javadoc. |
Criar Javadoc para membros com visibilidade |
|
Utilizar Doclet Padrão |
Iniciar o comando de Javadoc com o doclet padrão (predefinição)
|
Utilizar Doclet Personalizado |
Utilizar um doclet personalizado para gerar documentação
|
Argumentos de Doclet Padrão (disponíveis quando Utilizar doclet padrão for seleccionado):
Opção |
Descrição |
---|---|
Título do documento |
Especifique um título do documento. |
Gerar página utilizar | Seleccione esta opção se pretende que a documentação contenha m uma página Utilizar. |
Gerar árvore de hierarquia | Seleccione esta opção caso pretenda que a documentação contenha uma página Árvore. |
Gerar barra de navegador |
Seleccione esta opção caso pretenda que a documentação contenha uma barra de navegação (cabeçalho e pá de página). |
Gerar índice | Seleccione esta opção caso pretenda que esta documentação contenha uma página Índice. |
Gerar índice por letra | Criar um índice por letra. Activado quando Gerar Índice for seleccionado. |
@author | Seleccione esta opção caso pretenda que o identificador @author seja documentado. |
@version | Seleccione esta opção caso pretenda que o identificador @version seja documentado. |
@deprecated | Seleccione esta opção caso pretenda que o identificador @deprecated seja documentado. |
lista desactualizada | Seleccione esta opção caso pretenda que a documentação contenha uma página Obsoleto. Activado quando a opção @deprecated for seleccionada. |
Seleccionar classes referenciadas a que o Javadoc deve criar ligações |
Especifique a que outra documentação o Javadoc deve criar ligações quando forem referenciados outros tipos.
|
Folha de estilo | Seleccionar a folha de estilo a utilizar |
Opções Gerais de Javadoc:
Opção |
Descrição |
---|---|
Descrição Geral |
Especifica que o Javadoc deve obter o texto para a documentação de descrição geral de um determinado ficheiro. Será colocado em overview-summary.html. |
Opções extra de Javadoc |
Adicione aqui os número de opções extra: Opções personalizadas de doclet, opções da VM ou opções de compatibilidade de JRE 1.4. |
Guardar as definições desta exportação de Javadoc como um script Ant |
Especifique o armazenamento de um script Ant que vai executar a exportação especificada de Javadoc sem ter de utilizar o assistente. O script Ant existente pode ser modificado com este assistente (Utilizar 'Abrir assistente de Javadoc' no menu contextual no script Ant gerado) |
Abrir o ficheiro de índice gerado no browser | Abre o ficheiro index.html gerado no browser (Apenas disponível ao utilizar o doclet padrão) |
Prima Terminar para iniciar a geração de Javadoc. Se o destino for diferente para a localização configurada na página Localização de Javadoc do projecto, Ser-lhe-á perguntado se pretende definir a localização de Javadoc do projecto na nova pasta de destino. Ao fazê-lo, todas as invocações de Abrir Javadoc Externo utilizarão a documentação agora criada.
Será iniciado um novo processo e a geração será executada em segundo plano. Abra a vista Consola (Janela > Mostrar Vista > Consola) para ver o progresso e o estado da geração.