Comment faire pour que les API javadocs pour les API Google Play Services et les API Firebase apparaissent dans Android Studio plutôt que des classes décompilées sans docs?

Lorsque je clique sur une API Google Play Services ou une API Firebase que j'utilise dans mon projet android dans Android Studio, L'IDE m'amène à une version décompilée de la classe où les noms de variables sont obscurcis et il n'y a pas de documents sur l'une des méthodes. Des idées pour voir les documents directement dans L'IDE?

Je soupçonne que la raison en est que les services play et les services firebase ne sont pas open source et je suis ok avec Pas en voyant les impls, je comprends qu'ils veulent protéger que. Mais je bénéficierais vraiment de voir les documents directement dans L'IDE plutôt que d'alt-tabulation dans un navigateur. Merci pour votre aide.

22
demandé sur Creos 2016-07-09 16:41:56

2 réponses

Javadocs devrait vraiment être distribué avec les bibliothèques clientes. Nous avons un problème ouvert dans Google, mais je n'ai pas de calendrier de quand une solution appropriée sera disponible. Cependant, je peux vous donner une solution de contournement que vous pouvez appliquer à votre projet. Ce n'est pas une bonne solution, mais c'est quelque chose.

Sur ma machine OSX, le SDK Android est installé ici:

/Users/[myusername]/Library/Android/sdk

Et la copie locale pour les Services Play et Firebase javadocs sont ici (les vôtres peuvent varier):

/Users/[myusername]/Library/Android/sdk/extras/google/google_play_services/docs/reference/

Vous peut réellement attacher ce chemin à vos bibliothèques client Firebase dans Android Studio avec cette procédure:

  1. recherchez les bibliothèques client Firebase/Play dans la vue projet sous "bibliothèques externes".
  2. faites un clic droit sur celui qui vous intéresse le plus. Par exemple, pour Firebase Realtime Database, vous pouvez utiliser "firebase-database-9.2.0".
  3. dans le menu contextuel, cliquez sur Propriétés de la bibliothèque en bas.
  4. dans la fenêtre Propriétés de la Bibliothèque, il y a bouton qui a un signe+. Cliquez qui. Cela vous permet d'attacher un chemin javadoc aux classes de cette bibliothèque.
  5. naviguez / collez votre chemin javadoc depuis le haut dans la boîte de dialogue.
  6. dans la boîte de dialogue suivante, dites-lui "JavaDocs".

Maintenant, lorsque vous invoquez javadoc pour les classes dans cette bibliothèque, vous le verrez. Cependant, vous devrez le faire pour chaque bibliothèque où vous voulez javadoc.

Si vous n'avez pas installé javadocs local pour une raison quelconque, vous pouvez joindre l'url distante pour le javadoc. Pour cela, utilisez le bouton plus avec la Petite Terre en dessous, et collez l'url javadoc. Pour Firebase, c'est https://firebase.google.com/docs/reference/android et pour les services de jeu, c'est https://developers.google.com/android/reference/

Ce n'est pas génial de faire tout ce travail manuel, mais au moins il vous obtient javadoc dans votre IDE.

Si vous voulez écrire un script pour l'attacher à tout ce que vous utilisez, sachez que cette procédure essentiellement juste modifie les fichiers sous .idée/bibliothèques. Vous pouvez assez facilement observer l'élément XML javadoc qui est modifié lorsque vous apportez des modifications dans L'IDE, et vous pouvez écrire/éditer les modifications vous-même si vous le souhaitez.

35
répondu Doug Stevenson 2017-03-09 05:50:28

Dans mon cas, l'ajout de ce https://firebase.google.com/docs/reference/android/packages a fonctionné.

0
répondu hojin 2017-12-03 13:31:36