Comment référencer des javadocs aux dépendances dans le plugin Eclipse de Maven lorsque javadoc n'est pas attaché à la dépendance

Question

J'utilise Eclipse, Maven et Java dans mon développement.J'utilise Maven pour télécharger les dépendances (fichiers jar et javadoc lorsqu'ils sont disponibles) et le plug-in Eclipse de Maven pour générer les fichiers .project et .classpath pour Eclipse.Lorsque la dépendance téléchargée n'a pas de javadoc joint, j'ajoute manuellement un lien pour le javadoc dans le fichier .classpath afin que je puisse voir le javadoc de la dépendance dans Eclipse.Ensuite, lorsque j'exécute le plugin Eclipse de Maven pour régénérer le fichier .classpath, cela efface bien sûr ce changement.

Existe-t-il un moyen de configurer le plug-in Eclipse de Maven pour ajouter automatiquement des attributs de chemin de classe pour javadoc lors de l'exécution du plug-in Eclipse de Maven ?

Je ne m'intéresse qu'aux réponses où le javadoc et/ou les sources ne sont pas fournis pour la dépendance dans le référentiel maven, ce qui est le cas le plus souvent pour moi.L'utilisation des propriétés downloadSources et/ou downloadJavadocs ne résoudra pas ce problème.

Answer 1

Vous pourriez envisager d'éviter complètement ce problème en installant manuellement le fichier javadoc dans votre référentiel local à l'aide du objectif du fichier d'installation et en passant l'option -Dclassifier=javadoc.Une fois que vous faites cela, le .classpath généré par mvn devrait être correct.

Si vous utilisez un dépôt distant comme proxy vers le dépôt central, vous pouvez également déployer les javadocs sur ce dépôt, puis tous les autres utilisateurs de ce proxy obtiendront désormais automatiquement les javadocs.

Answer 2

Depuis le plugin Maven Eclipse FAQ

L'exemple suivant montre comment procéder dans la ligne de commande:

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

ou dans votre 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 3

J'utilise STS 2.8.1 qui est essentiellement des outils Eclipse + Spring ;Dans un projet maven existant, j'ai fait un clic droit sur le projet -> maven -> Télécharger les sources et télécharger JavaDocs

Answer 4

Comme mentionné dans Comment télécharger des sources et des artefacts javadoc avec le plugin Maven Eclipse depuis un autre référentiel ?, tu peux le faire:

Dans Eclipse, allez dans Windows-> Préférences-> Maven.Cochez la case qui dit "Téléchargez l'artefact Javadoc". Cela a bien fonctionné pour moi.

Answer 5

Généralement, les Javadocs ne sont pas principalement utilisés comme dépendances.Parce que ceux-ci ne sont ni requis à la compilation ni à l’exécution.C'est juste pour aider le développeur lors du développement ou du débogage.

En supposant que nous utilisons l'IDE Java Eclipse, nous pouvons utiliser la documentation Java comme référencée.Voici les approches que nous pouvons associer aux javadocs/sources aux fichiers jar respectifs.

1.S'il s'agit d'un projet non-maven :

Téléchargez le fichier jar javadocs ou le fichier zippé, quel qu'il soit disponible et placez-le dans un répertoire.Faites un clic droit sur le projet d'application dans l'IDE Eclipse, cliquez sur Propriétés et choisissez Java Build Path, puis sélectionnez l'onglet Bibliothèques sous Java Build Path.Développez maintenant le fichier jar que vous souhaitez lier avec java docs/source.Sélectionnez le lien d'emplacement Javadoc et cliquez sur le bouton Modifier, une nouvelle fenêtre apparaît dans laquelle nous devons choisir le chemin du pot javadocs.Cliquez sur OK et nous avons lié le javadoc/source aux fichiers jar respectifs.

2.Si c'est un projet maven

Si nous utilisons le projet Maven, accédez aux fichiers jar sous la dépendance Maven sous le projet dans la vue Explorateur de projet, comme indiqué ci-dessous.Maintenant, faites un clic droit sur le fichier jar auquel vous souhaitez ajouter le Javadoc/source,  choisissez Maven puis cliquez sur Javadoc ou Source que vous souhaitez lier au projet.Désormais, l'IDE téléchargera automatiquement le javadoc/source requis et le liera au fichier jar correspondant dans le projet.

Vous pouvez le vérifier en cliquant avec le bouton droit sur le projet dans l'EDI et en cliquant sur Java Build Path et en sélectionnant l'onglet Bibliothèques sous le Java Build Path, puis en développant le fichier jar souhaité. Ici, lorsque vous cliquez sur le bouton Modifier, vous verrez le chemin lié de le Javadoc/Source avec le pot respectif comme indiqué ci-dessous dans l'image.

3.S'il s'agit d'un projet Maven et que nous définissons le comportement par défaut :

Eclipse téléchargera aquatiquement le javadoc/source ainsi que le fichier jar principal requis au début.Par défaut, définissez l'instruction sur Maven pour télécharger le Javadoc/sources pour tous les fichiers jar liés au projet.

Cliquez sur Windows – préférences – sélectionnez Maven et cochez la case Télécharger Artifact Javadoc comme indiqué ci-dessous

Maintenant, cliquez sur Appliquer et enregistrez-le. Désormais, lorsque vous créez un nouveau projet Maven, par défaut, les Javadocs seront téléchargés et liés à tous les fichiers jar dépendants du projet.
Vous pouvez vérifier en cliquant avec le bouton droit sur le projet et les propriétés et sous le chemin de construction Java, vous pouvez voir que les javadocs sont liés à tous les fichiers jar, comme indiqué ci-dessous.

Si votre projet est un projet Maven, il est toujours préférable d'utiliser la deuxième approche car en utilisant cette approche, l'EDI et Maven se chargent de télécharger la version correcte du Javadoc/source et de la lier également au fichier jar relatif.

L'approche 3ème est un peu coûteuse car les javadoc/sources seront téléchargés pour tous les jars dépendants, peut-être que vous n'êtes pas intéressé par les javadocs/sources pour tous les jars dépendants.

Answer 6

Est-ce que le fait d'avoir les sources de la dépendance serait utile ?Vous pouvez demander au plugin Eclipse de les télécharger (et d'y faire référence dans le .classpath) avec -DdownloadSources=true