web-dev-qa-db-fra.com

Comment attacher un fichier javadoc ou une source à un fichier jar dans le dossier libs?

Nouvelle version du plug-in ADT r17 pour Eclipse ajoutée à la fonctionnalité permettant de configurer automatiquement les dépendances JAR. Tous les fichiers .jar du dossier/libs sont maintenant ajoutés à la configuration de la construction. Malheureusement, Android Le conteneur de classpath des dépendances n'est pas modifiable.

Non modifiable Android dependencies classpath

Comment puis-je attacher des sources javadoc et des sources au dossier .jar inséré automatiquement (à partir du dossier/libs)?

androideclipseadtjavadoc
253
Sergii Pechenizkyi

La meilleure façon de répondre à votre question est de résumer les réponses de Xavier , plastiv , VinceFR et Christopher .

Guide étape par étape

Pour lier les sources et le javadoc à une bibliothèque .jar automatiquement liée par Eclipse, vous devez procéder comme suit:

  1. Placez le fichier .jar de la bibliothèque dans le dossier libs et les fichiers source .jar et doc .jar associés dans des sous-dossiers distincts, tels que libs/src et libs/docs . Vous pouvez utiliser un nom autre que src et docs si vous le souhaitez, mais il est important que les fichiers .jar ne soient pas directement dans le dossier libs .
  2. Créez un fichier .properties dans le dossier libs avec le nom exact de la bibliothèque actuelle .jar (voir l'exemple). Assurez-vous de conserver la partie . Jar .
  3. Spécifiez les chemins relatifs vers les sources et le fichier .jar javadoc dans le fichier .properties.
  4. Fermez et rouvrez le projet Eclipse! Eventuellement, actualisez le projet en appuyant sur F5.
  5. Sélectionnez un objet de la bibliothèque liée dans le code source.
  6. Ouvrez la vue Javadoc dans Eclipse pour consulter la documentation (voir la capture d'écran).
  7. Ouvrez la déclaration du code source (raccourci par défaut: F3) de l'objet sélectionné.


Exemple

L'exemple utilise la bibliothèque Gson .

Structure de répertoire du dossier libs:

libs
├── docs
│   └── gson-2.2.2-javadoc.jar
├── gson-2.2.2.jar
├── gson-2.2.2.jar.properties
└── src
    └── gson-2.2.2-sources.jar

Contenu de gson-2.2.2.jar.properties

src=src/gson-2.2.2-sources.jar
doc=docs/gson-2.2.2-javadoc.jar


Information additionnelle

Vous pouvez bien sûr déplacer le javadoc et les sources .jar dans d’autres dossiers et spécifier des chemins relatifs. C'est à toi de voir. Il est possible de placer les fichiers jar source et javadoc directement dans le dossier lib , mais n'est pas recommandé , car cela entraîne la documentation et le code source doivent être inclus dans votre application .


Capture d'écran du panneau Eclipse JavaDoc:

JavaDoc view in Eclipse

Capture d'écran d'un projet Eclipse utilisant Gson avec Android 4.2.2.:

Eclipse test project screenshot

Référencement de javadocs décompressés

Si vous souhaitez référencer des javadocs qui ne sont pas fournis sous forme de .jar compressé, mais simplement sous forme de fichiers et de dossiers comme demandé par Développeur Android dans les commentaires procédez comme suit:

  1. Placez la bibliothèque .jar dans le dossier libs/

  2. Créez un fichier yourlibraryname.jar.properties (( n'oubliez pas le .jar)) avec le contenu suivant:

     doc=docs

  3. Ajoutez les dossiers javadocs au dossier libs/.

Vous devriez trouver la structure de dossiers suivante:

├── docs
│   ├── allclasses-frame.html
│   ├── allclasses-noframe.html
│   ├── com
│   │   └── google
│   │       └── ads
│   │           ├── Ad.html
│   │           │   ....
│   │           └── package-tree.html
│   │   ...
│   └── stylesheet.css
├── GoogleAdMobAdsSdk-6.4.1.jar
└── GoogleAdMobAdsSdk-6.4.1.jar.properties

N'oubliez pas de fermer et rouvrir le projet Eclipse mentionné ci-dessus! Voici une capture d'écran d'un exemple de projet fonctionnel faisant référence à la [GoogleAdMobAds Android bibliothèque] .

GoogleAdMobAds Android library Eclipse project

401
JJD

Sous Windows, vous devez échapper à la barre oblique inversée pour les références aux chemins doc et src dans le fichier de propriétés. Par exemple, pour Android-support-v4.jar, le contenu du fichier de propriétés est similaire à:

doc=C:\\Program Files (x86)\\Android\\Android-sdk\\extras\\Android\\support\\v4\\docs
src=C:\\Program Files (x86)\\Android\\Android-sdk\\extras\\Android\\support\\v4\\src
25
farid_z

Une réponse provient de http://code.google.com/p/Android/issues/detail?id=27490#c21

Dans votre dossier libs, vous devez avoir:

doc(folder)
    foo_doc(folder)
        index.html
        ...
        ...
foo.jar
foo.jar.properties

Et dans votre foo.jar.properties, mettez simplement doc=./doc/foo_doc

Peut-être devrez-vous rafraîchir votre projet, le nettoyer, le fermer et le rouvrir.

Ça marche pour moi!

17
VinceFR

J'ai essayé tout ce qui précède et aucun d'entre eux n'a fonctionné pour moi. J'ai imaginé une méthode qui fonctionnera toujours. Fondamentalement, le coupable est la façon dont l'ADT traite le dossier "libs", je quitte donc le dossier "libs". Au lieu de cela, j'ai créé un dossier "bibliothèques" et je l'ai utilisé.

Vous pouvez faire ce qui suit et cela fonctionnera toujours - même si le filtre ADT doit changer la façon dont il modifie la manière dont il traite le dossier "libs" à l'avenir:

  1. Créez un dossier "bibliothèques".
  2. Créez un sous-dossier pour chaque bibliothèque.
  3. Placez tous les fichiers de chaque bibliothèque dans le dossier approprié (fichier JAR Java, fichier JAR source, fichier JAV javadoc, etc.).
  4. Ajoutez le fichier jar Java de chaque projet dans l'onglet "Bibliothèques" du chemin de construction Java en cliquant sur le bouton Add Jars... bouton pour ajouter le fichier jar du sous-dossier library dans le dossier "libraries".
  5. Joignez les sources/javadocs à chaque projet en l’ouvrant dans l’onglet "Bibliothèques", en sélectionnant l’élément souhaité et en cliquant sur le bouton de la souris. Edit... bouton pour ajouter la source/javadocs à partir du sous-dossier library dans le dossier "libraries".
  6. Cochez la case pour chaque projet dans l'onglet "Commander et exporter" du chemin de construction Java.
  7. Après avoir vérifié que toutes les bibliothèques ont été déplacées, supprimez le dossier "libs".

En suivant la procédure ci-dessus, votre projet aura des dossiers ressemblant à ceci:

enter image description here

Votre chemin de construction Java ressemblera à ceci:

enter image description here

Dans Order and Export, les bibliothèques sont cochées:

enter image description here

10
Danny Remington - OMS

Pour l'instant, déplacez la bibliothèque sur laquelle vous souhaitez que Javadoc soit lib. Ils ajoutent cette bibliothèque au Build Path et ajoutent le Javadoc.

Vérifiez ceci commentaire dans les numéros Android.

5
Carlos Sobrinho

Sur ADT 22, je ne pouvais pas accéder à Javadoc pour les deux commons-io-2.4.jar et Android-support-v4.jar

Voici comment je l'ai corrigé:

  1. Condition préalable: les deux bibliothèques sont répertoriées sous "Bibliothèques référencées".

  2. Cliquez avec le bouton droit sur commons-io-2.4.jar et sélectionnez Propriétés. Cette fenêtre apparaît:

enter image description here

commons-io-2.4.jar est fourni avec commons-io-2.4-javadoc.jar, j'ai donc spécifié le Javadoc dans le chemin d'archivage du fichier externe.

J'ai fait la même chose pour la bibliothèque d'assistance: cliquez avec le bouton droit de la souris sur Android-support-v4.jar et sélectionnez Propriétés. Cet écran apparaît:

enter image description here

Cette fois, j'ai spécifié le chemin d'accès au répertoire source.

4
Javide

La référence de la bibliothèque à commons-io-2.0.1.jar était rompue lors de la mise à niveau vers SDK Tools et ADT révision 17.

Pour résoudre le problème, j'ai utilisé Projet -> Propriétés -> Java Chemin de construction et j'ai sélectionné l'onglet Bibliothèques. J'ai supprimé toute référence à commons-io-2.0.1.jar, puis utilisé Add Jar pour ajouter à nouveau commons-io-2.0.1.jar au projet. Ensuite, je clique sur la flèche ">" située à côté du nom de la bibliothèque pour développer la référence de la bibliothèque et j’ai utilisé les boutons d’édition pour définir la pièce jointe source et l’emplacement Javadoc.

Désolé, je ne peux pas publier une image car je n'ai pas assez de représentants (s'il vous plaît ...).

3
Mark Gittoes

Cela semble être une cible mouvante mais, après avoir rassemblé des fragments de nombreux endroits (y compris des réponses à cette question qui a aidé mais n'a pas permis de décrire tous les détails nécessaires, ou peut-être que le système avait légèrement changé entre-temps), cela semble être le cas. la solution, au moins à partir de maintenant (28 août 2013).

  • Ouvrez un dossier pour vos javadocs quelque part pas dans votre projet.
  • Mettez vos javadocs là décompressé, chacun dans son propre dossier.
  • Dans votre dossier lib, ajoutez un fichier xxx.jar.properties pour chaque bibliothèque à laquelle vous souhaitez associer un javadoc.
  • Dans ce fichier de propriétés, reportez-vous au dossier vous avez décompressé le fichier javadoc approprié dans (sous Windows, échappez les barres obliques inverses):

doc=d:\\Android\\javadoc\\libGoogleAnalyticsServices

  • Fermez et rouvrez votre projet dans Eclipse (l'actualisation ne suffit pas). Vous devriez maintenant voir les info-bulles lorsque vous survolez les classes appropriées.

Ne pas respecter l'une de ces étapes (ne pas décompresser le javadoc, référencer un fichier au lieu d'un dossier, etc.) semble le casser.

1
Gábor

Je sais que cette question est assez ancienne, mais lorsque j’étais confronté au même problème hier et que la solution indiquée ci-dessus était trop ennuyeuse pour moi, j’ai découvert qu’on pouvait facilement ajouter une définition de chemin source au fichier .classpath du projet. Eclipse l'adaptera ensuite et vous pourrez parcourir la source.

entrée de classpath avant:

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]"/>

Après avoir ajouté le chemin à la source

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]" sourcepath="[PATH_TO_MY_SOURCE_JAR]"/>

J'espère que cela t'aides

1
zersaegen

Ma solucion:

Téléchargez un plugin Eclipse intitulé: "Java Source Attacher Feature".

Plus tard, sélectionnez un fichier jar et attachez le code source en utilisant ce plugin. Cliquez dans le fichier jar pour le sélectionner, à droite de la souris, puis sélectionnez "joindre Java source".

Lorsque vous avez le code source, vous avez automatiquement le javadoc.

Vous pouvez maintenant utiliser F2 sur les classes pour afficher le javadoc associé.

Prendre plaisir

0
Antonio Martin

Pour un fichier jar donné, si vous souhaitez voir l'aide Javadoc dans l'info-bulle lors du codage, procédez comme suit: Cliquez avec le bouton droit de la souris sur votre projet> Propriétés> Java Chemin de construction> onglet Bibliothèques. Cliquez sur la flèche à côté de votre pot pour l'agrandir.

pièce jointe source devrait indiquer l'emplacement du fichier JAR actuel (probablement dans votre dossier Java).

emplacement Javadoc: Vous avez le choix entre deux options: URL et archive. Si vos javadocs pour ce fichier jar se présentent sous la forme d’un dossier contenant un fichier index.html au premier niveau, choisissez "URL Javadoc" et pointez sur ce dossier. Si vos javadocs sont dans un jar, choisissez "Javadoc dans archive" et pointez sur le jar. N'oubliez pas de redémarrer votre espace de travail/fermer et de rouvrir votre projet pour mettre à jour l'info-bulle avec les informations Javadoc.

J'espère que cela aide à donner une réponse simple à ce que j'estime être une tâche très simple.

0
Casey Murray

il suffit de mettre à jour le plugin ADT. Cela a fonctionné pour moi !!

  1. Démarrez Eclipse, puis sélectionnez Aide> Installer un nouveau logiciel.
  2. Cliquez sur Ajouter dans le coin supérieur droit.
  3. Dans la boîte de dialogue Ajouter un référentiel qui apparaît, entrez "ADT Plugin" pour le nom et l'URL suivante pour l'emplacement: https://dl-ssl.google.com/Android/Eclipse/ Remarque: La Android Le site de mise à jour des outils de développement requiert une connexion sécurisée. Assurez-vous que l'URL du site de mise à jour que vous entrez commence par HTTPS.
  4. Cliquez sur OK. Dans la boîte de dialogue Logiciels disponibles, cochez la case en regard de Outils de développement, puis cliquez sur Suivant.
  5. Dans la fenêtre suivante, vous verrez une liste des outils à télécharger. Cliquez sur Suivant.
  6. Lisez et acceptez les contrats de licence, puis cliquez sur Terminer.
  7. Si vous recevez un avertissement de sécurité indiquant que l'authenticité ou la validité du logiciel ne peut pas être établie, cliquez sur OK.
  8. Une fois l'installation terminée, redémarrez Eclipse.

J'espère que ça t'as aidé!

0
akshay