Geração de Javadoc

Este assistente permite gerar Geração de Javadoc. É uma interface de 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.

Primeira Página

Seleção de Tipo:

Opção

Descrição

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 para o arquivo JAR. Essa lista é inicializada pela seleção do workbench.Apenas um projeto pode ser selecionado de cada vez, da mesma forma que um único caminho de classe de projeto pode ser utilizado de cada vez, ao executar a ferramenta Javadoc.

Criar Javadoc para membros com visibilidade

  • Particular: Todos os membros serão documentados
  • Pacote: Apenas membros com visibilidade padrão, protegida ou pública serão documentados
  • Protegido: Apenas membros com visibilidade protegida ou pública serão documentados
  • Público: Apenas membros com visibilidade pública serão documentados (padrão)


Utilizar Doclet Padrão

Inicie o comando Javadoc com o doclet padrão (padrão) 

  • Destino: selecione o destino no qual o doclet padrão gravará a documentação gerada.O destino é um argumento específico do doclet e, portanto, não ativado ao utilizar um doclet personalizado.


Utilizar Doclet Personalizado

Utilize um doclet personalizado para gerar documentação 

  • Nome do doclet: Nome qualificado do tipo do doclet
  • Caminho da classe do doclet: Caminho de Classe necessário pela classe de doclet


Argumentos Padrão do Doclet

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.
Gerar í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 classes referidas às quais Javadoc deve criar links Especifique em que outra documentação o Javadoc deve criar links quando outros tipos forem referidos. 
  • Selecionar Tudo: Criar links em todas as outras localizações da documentação
  • Limpar Tudo: Não criar links em outras localizações da documentação
  • Configurar: Configurar a localização de Javadoc de um JAR ou projeto referido.
Folha de Estilo Selecione a página de estilo a ser utilizada

Argumentos Gerais

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 Extras de Javadoc

Incluir qualquer número de opções extras aqui: opções personalizadas de doclet, opções de VM ou opções de compatibilidade JRE 1.4.
Observe que os argumentos que contêm espaços devem ser incluídos entre aspas. Para argumentos que especifiquem código html (por ex., -header) utilize   ou " para evitar espaços e aspas.

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.

Tarefas Relacionadas

Criando a Documentação Javadoc

Referência Relacionada

Ações do arquivo
Propriedades da Localização do Javadoc