Come fare riferimento a javadocs alle dipendenze del plugin Eclipse di Maven quando javadoc non è collegato alla dipendenza

Io uso Eclipse, Maven e Java nel mio sviluppo. Uso Maven per scaricare le dipendenze (file jar e javadoc quando disponibili) e il plug-in Eclipse di Maven per generare i file .project e .classpath per Eclipse. Quando la dipendenza scaricata non ha allegato javadoc, aggiungo manualmente un collegamento per javadoc nel file .classpath in modo che possa vedere javadoc per la dipendenza in Eclipse. Quindi, quando eseguo il plugin Eclipse di Maven per rigenerare il file .classpath, questo ovviamente cancella quel cambiamento.

C’è un modo per configurare il plug-in Eclipse di Maven per aggiungere automaticamente gli attributi del classpath per javadoc quando si esegue il plug-in Eclipse di Maven?

Mi interessano solo le risposte in cui javadoc e / o fonti non sono fornite per la dipendenza dal repository maven, che è il caso più frequente per me. L’utilizzo di downloadSources e / o downloadJavadocs non aiuterà a risolvere questo problema.

Potresti considerare di evitare completamente questo problema installando manualmente javadoc jar nel tuo repository locale utilizzando l’ objective del file di installazione e passando l’opzione -Dclassifier = javadoc. Una volta fatto questo, il percorso .class generato da MVN dovrebbe essere corretto.

Se si utilizza un repository remoto come proxy per il centralino, è ansible anche distribuire i javadoc a quel repository e quindi tutti gli altri che utilizzano quel proxy ora otterranno automaticamente anche i javadoc.

Dalle FAQ del plug-in Maven Eclipse

L’esempio seguente mostra come eseguire questa operazione nella riga di comando:

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

o nel tuo pom.xml:

  [...]  [...]  [...]  org.apache.maven.plugins maven-eclipse-plugin  true true   [...]  [...]  [...]  

Sto usando STS 2.8.1 che è fondamentalmente eclisse + strumenti di spring; In un progetto di maven esistente, ho fatto clic con il tasto destro del mouse sul progetto -> maven -> Download Sources and Download JavaDocs

Come menzionato in Come scaricare fonti e risorse javadoc con il plugin Maven Eclipse da un altro repository? , Puoi farlo:

In Eclipse vai su Windows-> Preferenze-> Maven. Seleziona la casella “Scarica artefatto Javadoc”. Questo ha funzionato bene per me.

Preferenze Maven

Generalmente Javadocs non viene utilizzato principalmente come dipendenza. Perché questi non sono richiesti né in fase di compilazione né in fase di esecuzione. È solo per aiutare lo sviluppatore durante lo sviluppo o il debug.

Supponendo di usare java IDE Eclipse possiamo usare i documenti java come riferimento. Di seguito sono riportati gli approcci che possiamo associare a javadocs / sources con i rispettivi jar.

1. Se è un progetto non-maven:

Scarica il jar javadocs o il file zippato, qualunque sia disponibile e inserito in qualche directory. Fare clic con il tasto destro del mouse sul progetto dell’applicazione in IDE Eclipse, fare clic su Proprietà e scegliere Percorso build Java, quindi selezionare Librerie tabulazioni sotto il percorso di creazione Java. Ora espandi il jar che vuoi colbind con java docs / source. Selezionare il collegamento di posizione Javadoc e fare clic sul pulsante Modifica, viene visualizzata una nuova finestra in cui è necessario scegliere il percorso jar javadocs. Fare clic su OK e abbiamo collegato il javadoc / source con i rispettivi vasi.

inserisci la descrizione dell'immagine qui

2. Se si tratta di un progetto maven

Se stiamo usando il progetto Maven, passiamo ai file jar sotto la dipendenza Maven sotto il progetto nella vista Esplora progetti, come mostrato di seguito. Ora fai clic destro sul file jar che vuoi aggiungere Javadoc / source,  scegli Maven e poi fai clic su Javadoc o Source che vuoi colbind al progetto. Ora IDE scaricherà automaticamente il javadoc / source richiesto e lo collegherà al relativo jar nel progetto.

inserisci la descrizione dell'immagine qui

Puoi verificarlo facendo clic con il tasto destro del mouse sul progetto nell’IDE e facendo clic su Java Build Path e selezionando la scheda Libraries sotto il Java Build Path e quindi espandendo il jar desiderato, qui quando fai clic sul pulsante Edit vedrai il percorso collegato di il Javadoc / Source con il rispettivo jar come mostrato di seguito nell’immagine.

inserisci la descrizione dell'immagine qui

3. Se è un progetto Maven e stiamo impostando il comportamento predefinito:

Eclipse scaricherà acquaticamente javadoc / source insieme al barattolo principale richiesto all’inizio. Per impostazione predefinita, impostare le istruzioni su Maven per scaricare Javadoc / sources per tutti i jar collegati nel progetto.

Fai clic su Windows – Preferenze – seleziona Maven e fai clic sulla casella Scarica artefatto Javadoc come mostrato di seguito

inserisci la descrizione dell'immagine qui

Ora fai clic su Applica e salvalo e ora quando crei un nuovo progetto Maven, per impostazione predefinita i Javadoc verranno scaricati e collegati a tutti i vasi dipendenti nel progetto.
Puoi verificare facendo clic con il tasto destro del mouse sul progetto e Properties e in Java Build path puoi vedere che i javadocs sono collegati con tutti i vasi come mostrato di seguito.

inserisci la descrizione dell'immagine qui

Se il tuo progetto è un progetto Maven, allora è sempre meglio usare il 2o approccio perché usando questo approccio IDE e Maven, si occupa di scaricare la versione corretta di Javadoc / source e di collegarla con il relativo jar.

L’approccio 3 è un po ‘costoso perché i javadoc / sources verranno scaricati per tutti i jar dipendenti, potrebbe essere che non sei interessato a javadocs / sources per tutti i jar dipendenti.

Avrebbe le fonti per la dipendenza aiutare? Puoi dire al plugin di eclipse di scaricarli (e fare riferimento ad essi nel .classpath) con -DdownloadSources=true