为我的 Android 项目生成一个 Javadoc

android java javadoc

2022-09-01 20:16:58

我希望有人能帮助我为我的eclipse项目生成一个javadoc。当我从项目菜单中选择“生成Javadoc”时，我收到很多错误，例如

cannot find symbol
symbol  : class ListView

每次一个类引用Android API类时，我只为不引用任何Android API的类输出Javadocs。我的应用可以正确编译和运行，并且在项目设置上存在 Android 1.6 lib（在构建路径 - 外部 jars 部分）。

任何想法我做错了什么？

谢谢。

多里

答案 1

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

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

答案 2

我有点固执，没有设置Maven...希望这篇文章能帮助其他在同一条船上的人。

经过一些试验和错误（以及从多个网络搜索中收集的大量建议），我能够使用特定的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>