El asistente
Generación de Javadoc permite generar un Javadoc. Es una interfaz de usuario para la herramienta
javadoc.exe disponible en el JDK Java. Visite la página Sun's Javadoc Tool
para obtener la documentación completa de la herramienta Javadoc.
Selección de tipo:
Opción |
Descripción |
---|---|
Seleccionar tipos para los que se generará Javadoc |
En la lista, para especificar exactamente los tipos que desea exportar a un archivo JAR, ponga una marca en los recuadros o quítela. La selección efectuada en el entorno de trabajo inicializa esta lista. Solo se puede seleccionar un proyecto a la vez, ya que únicamente es posible utilizar una vía de acceso de clases de proyecto en un momento dado al ejecutar la herramienta Javadoc. |
Crear Javadoc para miembros con visibilidad |
|
Utilizar doclet estándar |
Iniciar el mandato Javadoc con el doclet estándar (valor predeterminado).
|
Utilizar doclet personalizado |
Utilizar un doclet personalizado para generar la documentación.
|
Los argumentos de doclet estándar (disponibles si se ha seleccionado Utilizar doclet estándar) son:
Opción |
Descripción |
---|---|
Título de documento |
Especifique el título de un 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 (de cabecera y pie de página). |
Generar índice | Seleccione esta opción si desea que la documentación contenga una página de índice. |
Generar índice por letra | Permite crear un índice por letra. Está habilitada si se ha seleccionado Generar índice. |
@author | Seleccione esta opción si desea que el código @author esté documentado. |
@version | Seleccione esta opción si desea que el código @version esté documentado. |
@deprecated | Seleccione esta opción si desea que el código @deprecated esté documentado. |
Lista de obsoletos | 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 el Javadoc cuando se hace
referencia a otros tipos.
|
Hoja de estilo | Seleccione la hoja de estilo que debe utilizarse. |
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 a partir del archivo dado. Se colocará en el archivo 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 con JRE 1.4. |
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 que haga falta utilizar el asistente. El script Ant existente se puede modificar con este asistente (utilice el asistente Abrir Javadoc del menú contextual del script Ant generado). |
Abrir archivo de índice generado en navegador | El archivo index.html generado se abre en el navegador (solo 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 preguntará si desea establecer la ubicación del Javadoc del proyecto en la nueva carpeta destino. Si lo hace, la documentación creada ahora se utilizará en todas las invocaciones de Abrir Javadoc externo.
Se iniciará un proceso nuevo y la generación se realizará en segundo plano. Abra la vista Consola (Ventana > Mostrar vista > Consola) para ver cómo avanza la generación y cuál es su estado.
Crear documentación de Javadoc