Erzeugen eines Javadocs für mein Android-Projekt

Question

Ich hatte gehofft, dass mir jemand bei der Erstellung eines Javadocs für mein Eclipse-Projekt helfen kann. Wenn ich "Generate Javadoc" aus dem Projektmenü auswähle, erhalte ich eine Menge Fehler wie

cannot find symbol
symbol  : class ListView

jedes Mal eine Klasse, die eine Android-API-Klasse referenziert, so dass ich nur Javadocs für die Klassen, die keine Android-API-Sachen referenzieren, ausgegeben werden. Meine App kompiliert und läuft korrekt und auf die Projekt-Einstellung der Android 1.6 Lib vorhanden ist (auf den Build-Pfad - externe Jars Abschnitt).

Irgendwelche Ideen, was ich falsch mache?

Danke.

Dori

Answer 1

Mit Maven können Sie das auf jeden Fall tun. Idealerweise können Sie die Maven Android-Plugin für Ihren kompletten Bau. Dadurch können Sie auch Dinge wie findbugs, checkstyle, pmd und so weiter verwenden.

Die Dokumentation befindet sich im Projekt-Wiki sowie im Buch Maven: Die vollständige Referenz http://www.sonatype.com/books/mvnref-book/reference/Android-dev.html

Answer 2

Für den Fall, dass jemand anderes auf dieses Problem stößt: Android hat den Namen des Dokumentations-Stylesheets von "Android-developer-docs.css" in "doclava-developer-docs.css" in der r21-Version des ADT SDK-Bundles geändert. Ich bin nicht sicher, wann genau die Änderung stattgefunden hat, und wir haben die Änderung gerade erst bemerkt.

Answer 3

Mit Maven:

Abhängigkeit von Android (installiert über Maven Android SDK Bereitstellungsprogramm ):

    <dependency>
        <groupId>android</groupId>
        <artifactId>android</artifactId>
        <version>4.2.2_r2</version>
        <scope>provided</scope>
    </dependency>

Konfiguration des Javadoc Maven Plugin:

<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>

Answer 4

Diese Artikel von ilijamt half mir bei der Erstellung von Javadoc für mein Projekt mit Ant.

Im Grunde genommen müssen Sie diesen Abschnitt zu Ihrem Projekt hinzufügen build.xml

<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>

Dies ermöglicht Ihnen die Ausführung von

ant javadoc

Answer 5

In Eclipse sollten Sie Folgendes hinzufügen android.jar zum Projektklassenpfad hinzufügen, entweder über die Projekteigenschaften oder durch Bearbeiten der <path_to_your_project>/.classpath manuell.

Siehe meine Antwort https://stackoverflow.com/a/23925003/3499937 für Einzelheiten.