generar - android javadoc

¿Cómo crear JavaDoc usando Android Studio sin R y BuildConfig?

Question

Quiero generar JavaDoc para mi biblioteca, excluyendo R y BuildConfig. La funcionalidad Generate JavaDoc... del menú Tools no tiene la opción de excluir archivos.

¿Cómo crear JavaDoc usando Android Studio sin R y BuildConfig?

Answer 1

La respuesta aceptada es bastante compleja y tengo una mejor.

1. Abra la opción de menú Herramientas -> Javadoc.
2. Seleccione ámbito personalizado. Luego seleccione Project Files
3. Haz clic en OK .

Después de estos, verá que los archivos R y BuildConfig están excluidos.

Answer 2

La respuesta de RocketSpock está casi allí, pero no del todo (al momento de escribir esto). Todavía no puedo comentar, así que describiré el proceso que usé para excluir R.java y BuildConfig.java del BuildConfig.java de mi biblioteca de Android en Android Studio 1.2.2. Básicamente, hay un diálogo adicional que será muy útil:

1. Abra la opción de menú Tools --> Javadoc .

2. Seleccione Custom scope . Todavía no es necesario seleccionar nada del menú desplegable.

3. Haga clic en el icono ... para abrir el cuadro de diálogo Scopes .
4. Agregue un nuevo ámbito personalizado con el ícono verde + . Déle un nombre descriptivo si lo desea.
5. En las Production Classes (no en las Library Classes , dado que son importaciones), navegue a los módulos para los que desea generar Javadoc y seleccione los archivos Java individuales que desee incluir. En su caso, probablemente desee seleccionar un módulo completo, pero excluya manualmente R.java y BuildConfig.java . Cuando haya terminado, haga OK en OK para salir del cuadro de diálogo Ámbitos.
6. En el cuadro de diálogo Specify Generate JavaDoc scope , si su nuevo alcance no está seleccionado en el menú desplegable Custom scope , selecciónelo ahora, así como cualquier otra opción adicional, incluido el directorio de salida.
7. Finalmente, haga OK en OK para generar su Javadoc.

Answer 3

Si desea excluir los archivos generados (R, BuildConfig, etc.), puede especificar un ámbito personalizado para la generación JavaDoc. Para que esto funcione correctamente, deberá:

1. En la vista Proyecto a la izquierda, seleccione el directorio fuente raíz para generar los documentos (por ejemplo, "com" u "org")
2. Abra el diálogo de generación JavaDoc (Herramientas -> Generar JavaDoc ...)
3. Seleccione "Alcance personalizado" (es el quinto botón de radio en mi versión) y seleccione su módulo (por ejemplo, "Módulo ''biblioteca''")
4. Seleccione sus otras propiedades, como el directorio de salida, la visibilidad del método, etc. y haga clic en "Aceptar"

Eso es. Sus JavaDocs deben generarse sin los archivos R o BuildConfig incluidos.