Cartografía del IDE Eclipse

Vincular y acceder al JavaDoc de APIs externas

Cuando estamos escribiendo código Java es muy útil poder acceder al JavaDoc de las APIs externas que estamos utilizando.

Si por ejemplo no tenemos el JavaDoc de la API que pertenece a la clase ClassPathXmlApplicationContext, al posicionar el puntero del ratón sobre esta clase aparece un meú emergente con el mensaje: This element neither has attached source nor attached Javadoc and hence no javadoc could be found.

Para tener acceso al JavaDoc de esta clase vamos a hacer lo siguiente. Primero vamos a hacer clic sobre Window | Preferences

en el cuadro de diálogo Preferences seleccionamos Java | Build Path | User Libraries. En este ejemplo desplegamos la librería SPRING y el fichero org.springframework.context-3.05.RELEASE.jar. Ahora seleccionamos Javadoc location: y hacemos clic sobre el botón Edit...

en el cuadro de diálogo Javadoc For 'org.springframework.context-3.0.5-RELEASE.jar tenemos que rellenar el campo de texto Javadoc location path:. Para ello hacemos clic sobre el botón Browse...

en el cuadro de diálogo Javadoc Location Selection navegamos hasta encontrar la localización de la API en cuestión. En el curso tenemos instalado el JavDoc del framework de Spring en la carpeta C:\IDE\eclipse\eclipse-jee-helios-SR1-win32-librerias\spring-framework-3.0.5.RELEASE\docs\javadoc-api.

Una vez hemos seleccionado la carpeta donde se encuentra el JavaDoc de la API que necesitamos (en este ejemplo javadoc-api), hacemos clic sobre el botón Aceptar.

como podemos ver el campo de texto Javadoc location path: ya está rellenado. Para salir hacemos clic sobre el botón OK.

en el cuadro de diálogo Preferences también podemos ver que el JavaDoc está asociado al fichero jar de la API en cuestión. Para salir hacemos clic sobre el botón OK.

ahora volvemos a posicionar el puntero del ratón sobre la clase en cuestión y nos aparece un meú emergente con la documentación del JavaDoc

si hacemos clic en el botón Open Attached Javadoc in a Browser que se encuentra en la parte inferior del menú emergente podemos ver que en el editor de Eclipse se abre una nueva pestaña con el contenido del JavaDoc.