为我的Android项目生成一个Javadoc

Question

我希望有人可以帮助我为我的eclipse项目生成一个javadoc.当我从项目菜单中选择"生成Javadoc"时,我会遇到很多错误

cannot find symbol
symbol  : class ListView

每次引用Android API类的类,所以我只为不引用任何android api的类输出Javadocs.我的应用程序编译并正确运行,并且在项目设置中存在Android 1.6 lib(在构建路径 - 外部jar部分).

什么想法我做错了什么？

谢谢.

大道

Answer 1

通过确保我在Android SDK和AVD Manager中安装了"Android SDK文档"组件,并在Javadoc生成的第2步中选择android.jar作为参考存档,我能够为我的所有类生成Javadocs .

它没有生成指向参考文档的链接,但它确实为我的所有类创建了文档.

Answer 2

我有点顽固,并没有设置Maven ...希望这篇文章可以帮助那些在同一条船上的人.

经过一些试验和错误(以及从多个Web搜索中收集到的大量建议)后,我能够使用特定的ANT脚本,可以通过"Run As - > Ant Build"在Eclipse中运行.

我将此文件"javadoc.xml"保存在我的项目目录中,与AndroidManifest.xml文件并行.

这是文件的内容:

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

Answer 3

对我有用的是将类路径设置为android.jar.在Eclipse中:项目 - >生成javadoc - >"额外的javadoc选项"下的第3步.例如

-classpath "C:\android-sdk-windows\platforms\android-11\android.jar"

Answer 4

对于没有硬编码路径的Ant用户(对于android 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>