Generación de Javadoc

Este asistente permite la generación de Javadoc. Es una interfaz de usuario para la herramienta javadoc.exe disponible en el JDK de Java. Consulte la página de la herramienta Javadoc de Sun para obtener la documentación completa de la herramienta Javadoc.
para ejecutar este asistente, debe configurarse un mandato Javadoc en la página de preferencias de Javadoc (Ventana > Preferencias > Java > Javadoc).

Primera página

 
Selección de tipo
Opción
Descripción
Seleccionar tipos para los que se generará Javadoc.
En la lista, marque o desmarque los recuadros para especificar exactamente los tipos que desea exportar al archivo JAR. La selección efectuada en el entorno de trabajo inicializa esta lista. Sólo puede seleccionarse un proyecto a la vez, ya que sólo puede utilizarse una vía de acceso de clases de proyecto simultáneamente al ejecutar la herramienta Javadoc.
Crear Javadoc para miembros con visibilidad
  • Privada: se documentarán todos los miembros
  • Paquete: sólo se documentarán los miembros con visibilidad por omisión, protegida o pública
  • Protegida: sólo se documentarán los miembros con visibilidad protegida o pública
  • Pública: sólo se documentarán los miembros con visibilidad pública (valor por omisión)
Utilizar doclet estándar
Iniciar el mandato Javadoc con el doclet estándar (valor por omisión) 
  • Destino: seleccione el destino en el que el doclet estándar grabará la documentación generada. El destino es un argumento específico de doclet, y por tanto no está habilitado si se utiliza un doclet personalizado.
Utilizar doclet personalizado
Utilizar un doclet personalizado para generar la documentación 
  • Nombre de doclet: nombre de tipo calificado del doclet
  • Vía de acceso de clases del doclet: vía de acceso de clases necesaria para la clase de doclet

Argumentos de doclet estándar

 
Argumentos de doclet estándar (disponible si se ha seleccionado  Utilizar doclet estándar)
Opción
Descripción
Título del documento
Especifique un título de documento.
Generar página de uso Seleccione esta opción si desea que la documentación contenga una página de uso.
Generar árbol de jerarquía Seleccione esta opción si desea que la documentación contenga una página de árbol.
Generar barra de navegador
Seleccione esta opción si desea que la documentación contenga una barra de navegación (superior e inferior).
Generar índice Seleccione esta opción si desea que la documentación contenga una página de índice.
Generar índice por letra Crear un índice por letra. Está habilitada si se ha seleccionado Generar índice
@author Seleccione esta opción si desea que el identificador @author esté documentado.
@version Seleccione esta opción si desea que el identificador @version esté documentado.
@deprecated Seleccione esta opción si desea que el identificador @deprecated esté documentado.
lista obsoleta Seleccione esta opción si desea que la documentación contenga una página Obsoleto. Está habilitada si se ha seleccionado la opción @deprecated.
Seleccionar clases referenciadas para las que Javadoc debe crear enlaces Especifique con qué otra documentación debe crear enlaces Javadoc cuando se hace referencia a otros tipos. 
  • Seleccionar todo: crear enlaces con todas las demás ubicaciones de documentación
  • Borrar todo: no crear enlaces con otras ubicaciones de documentación
  • Configurar: configurar la ubicación de Javadoc de un JAR o proyecto al que se hace referencia.
Hoja de estilo Seleccione la hoja de estilo que debe utilizarse

Argumentos generales

 
Opciones generales de Javadoc
Opción
Descripción
Visión general
Especifica que Javadoc debe recuperar el texto de la documentación de visión general del archivo dado. Se sustituirá en overview-summary.html.
Opciones adicionales de Javadoc
Añada cualquier número de opciones adicionales: opciones de doclet personalizado, opciones de VM u opciones de compatibilidad de JRE 1.4.
Tenga en cuenta que los argumentos que contengan espacios deben entrecomillarse. En los argumentos que especifiquen código html (por ejemplo, -header), utilice los códigos   o " para evitar los espacios y las comillas.
Guardar los valores de esta exportación de Javadoc como script Ant
Especifique que debe almacenarse un script Ant que realizará la exportación de Javadoc especificada sin necesidad e utilizar el asistente. El script Ant existente puede modificarse con este asistente (utilice el asistente Abrir Javadoc del menú de contexto del script Ant generado)
Abrir archivo de índice generado en navegador Abre el archivo index.html generado en el navegador (sólo está disponible si se utiliza el doclet estándar)

Pulse Finalizar para iniciar la generación de Javadoc.
Si el destino es diferente de la ubicación configurada en la página de ubicación de Javadoc del proyecto, se le solicitará si desea establecer la ubicación del Javadoc del proyecto en la nueva carpeta destino. Si lo hace, todas las llamadas a la operación Abrir Javadoc externo utilizarán la documentación que acaba de crearse.
 

Se iniciará un proceso nuevo y la generación se realizará en segundo plano. Abra la vista Consola (Ventana > Mostrar vista > Consola) para ver el progreso y el estado de la generación.
 

Tareas relacionadas

Crear documentación Javadoc


Consulta relacionada

Acciones de archivo
Preferencias de Javadoc
Propiedades de ubicación de Javadoc


 Copyright IBM Corporation 2000, 2002. Reservados todos los derechos.