Cómo hacer referencia a javadocs a las dependencias en el plugin Eclipse de Maven cuando javadoc no está conectado a la dependencia

Question

Uso Eclipse, Maven y Java en mi desarrollo. Uso Maven para descargar dependencias (archivos jar y javadoc, cuando estén disponibles) y el complemento Eclipse de Maven para generar los archivos .project y .classpath para Eclipse. Cuando la dependencia descargada no tiene javadoc adjunto, añado manualmente un enlace para javadoc en el archivo .classpath para que pueda ver el javadoc de la dependencia en Eclipse. Luego, cuando ejecuto el plugin Eclipse de Maven para regenerar el archivo .classpath, por supuesto, elimina ese cambio.

¿Hay alguna manera de configurar el complemento Eclipse de Maven para agregar automáticamente los atributos classpath para javadoc cuando se ejecuta el complemento Eclipse de Maven?

Solo me interesan las respuestas donde el javadoc y/o las fuentes no se proporcionan para la dependencia en el repositorio de maven, que es el caso más frecuente para mí. Usar downloadSources y/o descargar las propiedades de Javacs no ayudará a este problema.

Answer 1

Considere la posibilidad de evitar completamente este problema instalando manualmente el javadoc jar en su repositorio local utilizando el install-file goal y pasando la opción -Dclassifier = javadoc. Una vez que hagas eso, el .classpath que mvn genera debería ser correcto.

Si usa un repositorio remoto como proxy para central, también puede implementar los javadocs en ese repositorio y luego todos los demás que usen ese proxy ahora también obtendrán los javadocs automáticamente.

Answer 2

¿Tendrían las fuentes para la ayuda de dependencia? Se puede decir que el plugin de Eclipse para descargar los (y se refieren a ellos en el .classpath) con -DdownloadSources=true

Answer 3

Desde el Maven Eclipse Plugin FAQ

El siguiente ejemplo muestra cómo hacer esto en el de comandos línea:

mvn eclipse:eclipse -DdownloadSources=true -DdownloadJavadocs=true 

o en su pom.xml:

<project> 
    [...] 
    <build> 
    [...] 
    <plugins> 
     [...] 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-eclipse-plugin</artifactId> 
     <configuration> 
      <downloadSources>true</downloadSources> 
      <downloadJavadocs>true</downloadJavadocs> 
     </configuration> 
     </plugin> 
     [...] 
    </plugins> 
    [...] 
    </build> 
    [...] 
</project> 

Answer 4

Estoy ejecutando STS 2.8.1 que es básicamente eclipse + herramientas de resorte; En un proyecto Maven existente, que se pulsa sobre el proyecto -> Maven -> Descargar Fuentes y Descarga JavaDocs

Answer 5

Como se mencionó en How to download sources and javadoc artifacts with Maven Eclipse plugin from other repository?, usted puede hacer esto:

En Eclipse ir a Windows-> Preferencias> Maven. Marque la casilla que dice "Descargar Artifact Javadoc". Eso funcionó bien para mí.

Answer 6

Generalmente Javadocs no se utilizan principalmente como dependencia. Porque estos no son necesarios en compilación ni en tiempo de ejecución. Es solo para ayudar al desarrollador mientras se desarrolla o depura.

Asumiendo que usando el IDE Eclipse de Java podemos usar los documentos de Java como se hace referencia. Los siguientes son los enfoques que podemos asociar los javadocs/fuentes con los respectivos jar.

1.Si no es un proyecto convencional:

Descargue el archivo javadocs o el archivo comprimido, lo que esté disponible y colóquelo en algún directorio. Haga clic con el botón derecho en el proyecto de la aplicación en IDE Eclipse, haga clic en Propiedades y elija Java Build Path, luego seleccione tab Libraries en Java Build Path. Ahora expanda el archivo jar que desea vincular con java docs/source. Seleccione el enlace de la ubicación de Javadoc y haga clic en el botón Editar, aparece una nueva ventana donde tenemos que elegir la ruta del jar de javadocs. Haga clic en Aceptar y hemos vinculado el javadoc/fuente con los respectivos jar.

2. Si se trata de un proyecto Maven

Si estamos utilizando el proyecto Maven luego ir a archivos jar bajo la dependencia Maven bajo el proyecto en Project vista del explorador, como se muestra a continuación. Ahora haga clic con el botón derecho en el archivo jar al que desea agregar el Javadoc/fuente,  elija Maven y luego haga clic en Javadoc o Fuente que desea vincular con el proyecto. Ahora IDE descargará automáticamente el javadoc/fuente requerido y lo vinculará con el jar respectivo en el proyecto.

Usted puede verificar esto haciendo clic derecho en el proyecto en el IDE y haga clic en Java Build Path y seleccionar las bibliotecas pestaña bajo el Java Build Path y expanda el frasco deseada, aquí cuando hace clic en el El botón Editar verá la ruta vinculada de Javadoc/Fuente con el contenedor respectivo, como se muestra a continuación en la imagen.

3. Si se trata de proyectos Maven y estamos preparando el comportamiento por defecto:

Eclipse descargará medio acuático del javadoc/fuente junto con el principal jar necesarios en la partida. De manera predeterminada, se establecen instrucciones para que Maven descargue Javadoc/sources para todas las jarras vinculadas en el proyecto.

clic en Windows - preferencias - seleccionar Maven y haga clic en la casilla de verificación Descargar Artefacto Javadoc como se muestra a continuación

Ahora haga clic en aplicar y guardar y ahora cuando se crea nuevo proyecto Maven, por defecto el Javadocs se descargarán y vincularán con todos los archivos jar dependientes del proyecto.
Puede verificar haciendo clic con el botón derecho en el proyecto y en Propiedades y en la ruta de compilación de Java puede ver que los javadocs están vinculados con todos los archivos jar como se muestra a continuación.

Si su proyecto es el proyecto Maven entonces Siempre es mejor utilizar segundo enfoque, ya que mediante el uso de este enfoque, el IDE y Maven, se encarga de descargar la versión correcta del Javadoc/fuente y vinculado con el vaso relativo también.

Enfoque tercero es un poco costoso porque el javadoc/fuentes se descargarán para todos los frascos dependientes, puede ser que no esté interesado en javadocs/fuentes para todos los frascos dependientes.