Generar un Javadoc para mi proyecto de Android
Esperaba que alguien pudiera ayudarme a generar un javadoc para mi proyecto eclipse. Cuando selecciono 'Generar Javadoc' desde el menú del proyecto obtengo muchos errores como
cannot find symbol symbol : class ListView
Cada vez que una clase hace referencia a una clase de API de Android, por lo que solo obtengo Javadocs en salida para las clases que no hacen referencia a ninguna información de api de android. Mi aplicación se compila y se ejecuta correctamente y en el proyecto de configuración de la lib de Android 1.6 está presente (en la ruta de construcción – jars sección externa).
- Crear javadoc en eclipse
- Gradle Javadoc tarea sin advertencias
- Añadir local javadoc a local aar en Android-Studio
- ¿Cómo utilizar Gradle para generar JavaDoc en Android Studio?
- La documentación de Kotlin no admite etiquetas como '<p>' well
¿Alguna idea de lo que estoy haciendo mal?
Gracias.
Dori
- ¿Cómo puedo habilitar javadoc para la biblioteca de soporte de Android?
- Generar Android Javadoc con Ant
- Eclipse no tiene java doc para mostrar información sobre clases y métodos. Cómo adjuntar esos? Androide
- Cómo corregir "Error al generar el archivo final: Encontró el archivo duplicado para APK: doc / allclasses-frame.html"
- ¿Por qué Android Studio muestra documentos rápidos para literales de cadenas?
- Gradle build Javadoc tarea falla con 'etiqueta desconocida: attr'
- Cómo generar javadoc para la biblioteca de Android cuando tiene dependencias que también son bibliotecas aar?
- generar Java docs android studio
Fui capaz de obtener Javadocs generados para todas mis clases, asegurándome de tener el componente "Documentación para Android SDK" instalado en el SDK de Android y el Administrador de AVD, y seleccionar android.jar como archivo de referencia en el paso 2 de la generación Javadoc .
No generó enlaces a los documentos de referencia, pero creó documentos para todas mis clases.
Yo era un poco terco, y no configurar Maven … espero que este post ayuda a alguien que está en el mismo barco.
Después de un poco de prueba y error (Y un montón de sugerencias recogidas de múltiples búsquedas web), pude conseguir esto trabajando con un script ANT específico, que se puede ejecutar en Eclipse por "Run As -> Ant Build".
He guardado este archivo, "javadoc.xml", en el directorio de mi proyecto, en paralelo con el archivo AndroidManifest.xml.
Aquí está el contenido del archivo:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <project basedir="." default="doc" name="api docs"> <target name="doc" description="my docs"> <javadoc destdir="docs" doctitle="Testing the Title" verbose="on" use="true" classpath="C:\Android\android-sdk_r04-windows\android-sdk-windows\platforms\android-2.1\android.jar;.\libs\admob-sdk-android.jar" sourcepath="gen;src" linkoffline="http://d.android.com/reference C:\Android\android-sdk_r04-windows\android-sdk-windows\docs\reference" stylesheetfile="C:\Android\android-sdk_r04-windows\android-sdk-windows\docs\assets\android-developer-docs.css" > </javadoc> </target> </project>
Lo que me funcionó fue establecer el classpath en android.jar. En Eclipse: project -> generate javadoc -> 3er paso bajo "opciones extra javadoc." P.ej
-classpath "C:\android-sdk-windows\platforms\android-11\android.jar"
Y para los usuarios de hormigas sin ruta codificada (para androide sdk r20)
<target name="javadoc" depends="-set-debug-mode,-build-setup"> <echo>Generating javadoc</echo> <property name="project.target.class.path" refid="project.target.class.path"/> <property name="project.all.jars.path" refid="project.all.jars.path"/> <javadoc access="private" classpath="${project.target.class.path}:${project.all.jars.path}" destdir="docs" packagenames="${project.app.package}.*" source="1.5" sourcepath="gen:src" /> </target>
Ciertamente hay un problema para generar android javadoc desde Eclipse. He encontrado una solución con maven y el complemento javadoc con la siguiente configuración ( pom.xml
):
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>group</groupId> <artifactId>artifact</artifactId> <version>0.0.5-SNAPSHOT</version> <build> <sourceDirectory>src</sourceDirectory> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.6.1</version> <configuration> <links> <link>file:/opt/android-sdk/docs/reference/</link> </links> </configuration> </plugin> </plugins> </build> <dependencies> <dependency> <groupId>android</groupId> <artifactId>android</artifactId> <version>1.5</version> <scope>provided</scope> </dependency> </dependencies> </project>
Adaptar su directorio androide sdk ( /opt/android-sdk/
en el ejemplo). Las libs de Android también deberían estar disponibles en tu repositorio local de maven, puedes usar el script android-mvn-install para instalarlas.
Una vez que este pom.xml
esté en el directorio raíz del proyecto, podrá ejecutar As -> Maven build … y configurar un javadoc: javadoc goal (siempre que eclipse tenga plugin m2eclipse instalado). De forma predeterminada, la salida estará en target
directorio de target
.
Definitivamente puede hacer eso con Maven. Idealmente, puedes usar el Maven Android Plugin para tu compilación completa. Eso también le permitirá utilizar cosas como findbugs, checkstyle, pmd y así sucesivamente.
La documentación está en el wiki del proyecto, así como en el libro Maven: The Complete Reference http://www.sonatype.com/books/mvnref-book/reference/android-dev.html
En caso de que alguien más se enfrente a este problema: Android cambió el nombre de la hoja de estilo de documentación de 'android-developer-docs.css' a 'doclava-developer-docs.css' en la versión r21 del paquete ADT SDK. No estoy seguro exactamente cuándo ocurrió el cambio, y acabamos de notar el cambio.
Con Maven:
Dependencia de Android (instalado a través de Maven Android SDK Deployer ):
<dependency> <groupId>android</groupId> <artifactId>android</artifactId> <version>4.2.2_r2</version> <scope>provided</scope> </dependency>
Configuración del complemento Javadoc Maven:
<reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.9.1</version> <configuration> <additionalDependencies> <additionalDependency> <groupId>android</groupId> <artifactId>android</artifactId> <version>4.2.2_r2</version> </additionalDependency> </additionalDependencies> </configuration> <reportSets> <reportSet><!-- by default, id = "default" --> <reports><!-- select non-aggregate reports --> <report>javadoc</report> </reports> </reportSet> </reportSets> </plugin> </plugins> </reporting>
Este artículo de ilijamt me ayudó a generar Javadoc para mi proyecto usando Ant.
Básicamente, es necesario agregar esta sección al build.xml
su proyecto
<property name="docs.dir" location="javadoc" /> <property name="bin.dir" location="bin" /> <property name="source.dir" location="src" /> <property name="gen.dir" location="gen" /> <target name="javadoc" description="Generate JavaDoc documentation" > <xmlproperty collapseAttributes="true" file="AndroidManifest.xml" prefix="tm" /> <mkdir dir="${docs.dir}" /> <javadoc access="private" author="true" classpath="${sdk.dir}/platforms/${target}/android.jar" destdir="${docs.dir}" linkoffline="http://d.android.com/reference ${sdk.dir}/docs/reference" linksource="true" sourcepath="${source.dir};${gen.dir}" use="true" version="true" /> <jar basedir="${docs.dir}" compress="${jar.compress}" jarfile="${bin.dir}/${tm.manifest.package}_${tm.manifest.android:versionName}_javadoc.jar" /> </target> <target name="clean" depends="android_rules.clean" > <delete dir="${docs.dir}" /> </target>
Que le permite ejecutar
ant javadoc
En Eclipse, debe agregar android.jar
al classpath del proyecto, ya sea a través de las propiedades del proyecto o editando manualmente el <path_to_your_project>/.classpath
.
Vea mi respuesta https://stackoverflow.com/a/23925003/3499937 para más detalles.
Si utiliza Intellij IDEA, vaya a Tools - Generate JavaDoc...
Especifique todas las configuraciones y defina params: -bootclasspath [path]\android-sdk\platforms\android-{version}\android.jar -encoding UTF-8 -docencoding utf-8 -charset utf-8
Más información está en este post .
- La instalación de Visual Studio 2015 se cuelga en la configuración de SDK de Android (niveles de API 19 y 21) y en el nivel 22
- EditText setError () con el icono pero sin mensaje Popup