web-dev-qa-db-fra.com

Comment créer JavaDoc en utilisant Android Studio sans R et BuildConfig?

Je souhaite générer le JavaDoc pour ma bibliothèque, à l'exclusion de R et BuildConfig. La fonctionnalité Generate JavaDoc... Du menu Tools n'a pas la possibilité d'exclure des fichiers.

Comment créer JavaDoc en utilisant Android Studio sans R et BuildConfig?

androidandroid-studiojavadoc
50
Jan Deinhard

La réponse de RocketSpock est presque là, mais pas tout à fait (à ce jour). Je ne peux pas encore commenter, alors je vais décrire le processus que j'ai utilisé pour exclure R.Java Et BuildConfig.Java De mon Android la Javadoc de la bibliothèque dans Android Studio 1.2.2. Il existe en gros un dialogue supplémentaire très utile:

  1. Ouvrez l'option de menu Tools --> Javadoc.

  2. Sélectionnez Custom scope. Il n'est pas encore nécessaire de sélectionner quoi que ce soit dans le menu déroulant.

  3. Cliquez sur l'icône ... Pour ouvrir la boîte de dialogue Scopes.
  4. Ajoutez une nouvelle étendue personnalisée avec l’icône verte +. Donnez-lui un nom descriptif si vous le souhaitez.
  5. Dans Production Classes (Pas Library Classes, Car il s'agit d'importations), accédez au (x) module (s) pour lequel/lesquels vous souhaitez générer Javadoc, puis sélectionnez un ou plusieurs individus Java Dans votre cas, vous souhaiterez probablement sélectionner un module entier mais exclure manuellement R.Java et BuildConfig.Java. Lorsque vous avez terminé, cliquez sur OK pour quitter le Dialogue Scopes.
  6. Dans la boîte de dialogue Specify Generate JavaDoc scope, Si votre nouvelle étendue n'est pas sélectionnée dans le menu déroulant Custom scope, Sélectionnez-la maintenant, ainsi que toute autre option supplémentaire, y compris le répertoire de sortie.
  7. Enfin, cliquez sur OK pour générer votre Javadoc.

enter image description here

69
Eric C. Black

La réponse acceptée est assez complexe et j'en ai une meilleure.

  1. Ouvrez l’option de menu Outils -> Javadoc.
  2. Sélectionnez la portée personnalisée. Puis sélectionnez Project Files
  3. Cliquez sur OK.

enter image description here

Après cela, vous verrez les fichiers R et BuildConfig sont exclus.

27
guo

Si vous souhaitez exclure les fichiers générés (R, BuildConfig, etc.), vous pouvez spécifier une étendue personnalisée pour la génération JavaDoc. Pour que cela fonctionne correctement, vous devez:

  1. Dans la vue Projet de gauche, sélectionnez le répertoire source racine pour générer les documents (par exemple, "com" ou "org").
  2. Ouvrez la boîte de dialogue de génération JavaDoc (Outils -> Générer JavaDoc ...).
  3. Sélectionnez "Portée personnalisée" (c'est le 5ème bouton radio de ma version) et sélectionnez votre module (par exemple, "Module 'bibliothèque'").
  4. Sélectionnez vos autres propriétés telles que le répertoire de sortie, la visibilité de la méthode, etc. et cliquez sur "OK".

C'est ça. Vos JavaDocs doivent être générés sans les fichiers R ou BuildConfig inclus.

4
RocketSpock