Come creare JavaDoc utilizzando Android Studio senza R e BuildConfig?

Question

Voglio generare il JavaDoc per la mia libreria escludendo R e BuildConfig. La funzionalità Generate JavaDoc... dal menu Tools non ha l'opzione per escludere i file.

Come creare JavaDoc utilizzando Android Studio senza R e BuildConfig?

Answer 1

La risposta di RocketSpock è quasi lì, ma non del tutto (al momento della stesura di questo documento). Non posso ancora commentare, quindi descriverò il processo che ho utilizzato per escludere R.java e BuildConfig.java dal Javadoc della mia libreria Android in Android Studio 1.2.2. C'è fondamentalmente una finestra di dialogo in più che in molto pratico:

1. opzione Aprire il menu Tools --> Javadoc.

2. Selezionare Custom scope. Non è necessario selezionare nulla dal menu a discesa .

3. Fare clic sull'icona ... per aprire la finestra di dialogo Scopes.
4. Aggiungi un nuovo ambito personalizzato con l'icona verde +. Dagli un nome descrittivo se lo desideri.
5. In Production Classes (non Library Classes, dal momento che queste sono importazioni) vai al modulo (s) che si desidera generare Javadoc per, e selezionare i file qualsiasi individuo Java che si desidera includere. Nel caso , probabilmente si desidera selezionare un intero modulo ma escludere manualmente R.java e BuildConfig.java. Quando hai finito, fai clic su OK per uscire dalla finestra di dialogo Scopes.
6. Nella finestra di Specify Generate JavaDoc scope, se il vostro nuovo campo di applicazione è non è selezionato nel menu Custom scope a discesa, selezionare ora, come così come tutte le altre opzioni aggiuntive, tra cui directory di output.
7. Infine, fare clic su OK per generare Javadoc.

Answer 2

Se si desidera escludere i file generati (R, BuildConfig, ecc.), È possibile specificare un ambito personalizzato per la generazione di JavaDoc. Per questo correttamente il lavoro è necessario:

1. Nella vista Progetto a sinistra, selezionare la directory sorgente principale per generare la documentazione per (ad esempio "com" o "org")
2. Aprire il JavaDoc finestra di generazione (Strumenti -> Genera JavaDoc ...)
3. Seleziona "Ambito personalizzato" (è il quinto pulsante di opzione nella mia versione) e seleziona il tuo modulo (ad es. "Libreria modulo" ")
4. Seleziona le tue altre proprietà come directory di output, visibilità del metodo, ecc. e fare clic su "OK"

Questo è tutto. I tuoi JavaDocs dovrebbero essere generati senza i file R o BuildConfig inclusi.

Answer 3

La risposta accettata è piuttosto complessa e ne ho una migliore.

1. Opzione di menu Apri Strumenti -> Javadoc.
2. Selezionare Ambito personalizzato. Quindi selezionare Project Files
3. Fare clic su OK.

Dopo questi vedrete i file di ricerca e di BuildConfig sono esclusi.