Comment attacher javadoc ou sources aux jars dans le dossier libs?

Question

Nouvelle version du plugin ADT r17 pour Eclipse ajouté pour configurer automatiquement les dépendances JAR. Tous les fichiers .jar dans le dossier / libs sont ajoutés à la configuration de construction maintenant. Malheureusement, le conteneur classpath d'Android Dependencies n'est pas modifiable.

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

Answer 1

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

Guide étape par étape de

Afin de relier les sources et la javadoc pour une .bibliothèque jar qui est automatiquement lié par Eclipse, vous devez faire ce qui suit:

1. Place de la bibliothèque .fichier jar dans le libs dossier, et la source associée .jar et doc .les fichiers jar dans des sous-dossiers tels que les libs/src et libs/docs. Vous pouvez utiliser un autre nom que src et docs si vous le souhaitez, mais il est important que l' .les fichiers jar ne sont pas directement dans les libs dossier.
2. Créer un .properties le fichier dans la libs dossier avec le nom exact de la bibliothèque actuelle .bocal (voir l'exemple). Assurez-vous de garder le .jar partie.
3. Spécifier les chemins d'accès relatifs aux sources et de la javadoc .bocal en .properties le fichier.
4. Fermez et ré-ouvrez le projet Eclipse! Vous pouvez également actualiser le projet en appuyant sur F5.
5. Sélectionnez un objet de la bibliothèque de liens dans le code source.
6. Ouvrir la Javadoc vue dans Eclipse pour vérifier les documents (voir capture d'écran).
7. Ouvrir le code source de la déclaration (raccourci par défaut: F3) de l'objet sélectionné.

Exemple

L'exemple utilise la Gson de la bibliothèque.

Structure du 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.propriétés

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

Des informations supplémentaires

Vous pouvez bien sûr déplacer la javadoc et les sources .jar dans d'autres dossiers et spécifier les chemins d'accès relatifs. C'est à vous. En plaçant la source et la javadoc pots directement dans le répertoire lib du dossier est possible, mais pas recommandé, tant que les causes de la documentation et le code source pour être inclus dans votre demande.

Capture d'écran de l'Éclipse JavaDoc:panneau de

Capture d'écran d'un projet Eclipse à l'aide de Gson avec Android 4.2.2.:

---

Référencement déballé javadoc

Dans le cas où vous souhaitez faire référence à la documentation javadoc qui ne sont pas prévues comme des paniers - .jar , mais simplement que les fichiers et dossiers comme demandé par le développeur android dans les commentaires effectuer les opérations suivantes:

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

2. Créer un .properties le fichier avec le contenu suivant:

    doc=docs
   

3. Ajouter la javadoc des dossiers à l' libs/ le dossier.

Vous devriez venir avec 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

Ne pas oublier de fermer et ré-ouvrir le projet Eclipse comme mentionné ci-dessus! Voici une capture d'écran d'un exemple de projet référencement de la GoogleAdMobAds Android bibliothèque.

Answer 2

Sur Windows, vous devez échapper à la barre oblique inverse pour les références aux chemins doc et src dans le fichier de propriétés. Exemple, pour android-support-v4.jar le contenu du fichier de propriétés est quelque chose comme:

 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
 

Answer 3

Une réponse vient 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 aurez-vous besoin de rafraîchir votre projet, de le nettoyer, de le fermer et de le rouvrir.

Ça marche pour moi!

Answer 4

J'ai essayé tous les éléments ci-dessus n'a pas fonctionné pour moi. J'ai trouvé une méthode qui fonctionnera toujours. Fondamentalement, le coupable, c'est la manière dont l'ADT traite de la "libs" dossier donc j'ai quitté à l'aide de la "libs" le dossier. Au lieu de cela, j'ai créé un "bibliothèques" du dossier et de s'en servir.

Vous pouvez effectuer les opérations suivantes et il le sera toujours - même si celui-ci devrait changer la façon dont il change la façon dont il traite de la "libs" dossier dans le futur:

1. Créer un "bibliothèques" du dossier.
2. Créer un sous-dossier pour chaque bibliothèque.
3. Mettre tous les fichiers de chaque bibliothèque dans le dossier approprié (java jar fichier source fichier jar, javadoc fichier jar, etc).
4. Ajouter le jar java fichier pour chaque projet dans les "Bibliothèques" de l'onglet pour le Java Build Path, en cliquant sur les Add Jars... bouton pour ajouter le bocal de la bibliothèque de sous-dossier dans le dossier "bibliothèques" du dossier.
5. Fixez la source/la documentation javadoc pour chaque projet par l'ouverture du projet dans les "Bibliothèques" de l'onglet, sélectionner l'élément souhaité, et en cliquant sur Modifier... bouton pour ajouter la source/la documentation javadoc de la bibliothèque de sous-dossier dans le dossier "bibliothèques" du dossier.
6. Cochez la case pour chaque projet dans la rubrique "Exportation" de l'onglet pour le Java Build Path.
7. Après avoir vérifié que toutes les bibliothèques ont été déplacés supprimer le "libs" le dossier.

En suivant la procédure ci-dessus votre projet auront des dossiers qui ressemblent à ceci:

Votre Java Build Path va ressembler à quelque chose comme ceci:

Dans l'Ordre et à l'Exportation, les bibliothèques sont cochées:

Answer 5

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

Vérifiez ce commentaire dans les problèmes android.