Android 上的 Javadoc (Eclipse)

发布于 2024-09-12 06:09:36 字数 481 浏览 8 评论 0 原文

我正在尝试在 Eclipse 中为我的 Android 项目生成 Javadoc html 页面。我尝试使用 -linkoffline 参数,如 此处建议,以及使用指向我的 android.jar 文件的 -classpath 参数。这些都不起作用,因为我仍然收到 package android.app does not exit (和其他)警告。我还尝试从命令行运行 javadoc 工具,而不是使用 Eclipse。

理想情况下,我希望为我的类生成自己的页面,所有 android.* 和 java.* 类都链接到在线页面。我使用的是 Mac OS 10.6 和 Java 版本 1.6.0_20。

I am trying to generate Javadoc html pages for my Android project in Eclipse. I have tried using the -linkoffline argument, as suggested here, as well as using the -classpath argument pointing to my android.jar file. Neither of these worked, as I still get package android.app does not exist (and other) warnings. I have also tried running the javadoc tool from the command line, rather than using Eclipse.

Ideally I would like to have my own generated pages for my classes, with all android.* and java.* classes linking to the online pages. I am using Mac OS 10.6 with Java version 1.6.0_20.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

暗地喜欢 2024-09-19 06:09:36

在尝试自己解决类似问题时,我发现的两个要点是:

  • 将要链接到的 android.jar 文件包含在 android.jar 的 classpath 属性中>javadoc Ant 任务。这意味着类似以下内容:

    <前><代码>

  • 在 javadoc 任务下添加链接子项,以便将在线 Android 参考 URL 与 Android 参考包列表的本地副本相匹配>。这意味着类似以下内容:

    ;
       <链接离线=“true” 
         href="http://developer.android.com/reference/" 
         packagelistloc="C:/Android/docs/reference" />
    
    

这对于我来说足以在我的项目 Javadoc 中显示 Android 链接。

While trying to resolve a similar issue myself, the two main points I've found have been:

  • To include the android.jar file you're linking to within the classpath attribute of the javadoc Ant task. That means something like the following:

    <javadoc ... 
      classpath="some/local/library.jar;
        C:/Android/platforms/android-8/android.jar;
        D:/another/library.jar" ... >
    
  • To add a link subitem under javadoc task in order to match the online Android Reference URL with a local copy of Android Reference package-list. That means something like the following:

    <javadoc ...>
       <link offline="true" 
         href="http://developer.android.com/reference/" 
         packagelistloc="C:/Android/docs/reference" />
    </javadoc>
    

This was enough for me in order to show Android links within my project Javadoc.

月寒剑心 2024-09-19 06:09:36

您是否尝试过使用 ant 脚本来处理 javadoc?将其命名为 javadoc.xmlbuild.xml 以外的其他名称 - 否则 Eclipse 会将其选为默认构建脚本。从 eclipse 内部运行 ant 脚本(RMB on file | Run As | Ant Build),或从控制台运行:ant -f

我的看起来与此类似:

<project basedir="." default="doc" name="metagloss api docs">

    <property 
        name="android-sdk-docs"
        value="/home/blackrax/opt/dev/android-sdk-linux_86/docs/reference"/>

    <target name="doc" description="api docs - no piwik" depends="clean, delombok">
        <javadoc destdir="docs">
            <link offline="true"
                  href="http://d.android.com/reference"
                  packagelistLoc="${android-sdk-docs}" />
            <fileset dir="src" includes="**/*.java" />
        </javadoc>
    </target>

    <!-- more implementation, any remaining targets -->
</project>

Have you tried using an ant script for the javadocs? Name it javadoc.xml or something other than build.xml - else eclipse will pick it up as the default build script. Run the ant script either from inside eclipse (RMB on file | Run As | Ant Build), or from the console: ant -f <file-name.xml>.

Mine looks something similar to this:

<project basedir="." default="doc" name="metagloss api docs">

    <property 
        name="android-sdk-docs"
        value="/home/blackrax/opt/dev/android-sdk-linux_86/docs/reference"/>

    <target name="doc" description="api docs - no piwik" depends="clean, delombok">
        <javadoc destdir="docs">
            <link offline="true"
                  href="http://d.android.com/reference"
                  packagelistLoc="${android-sdk-docs}" />
            <fileset dir="src" includes="**/*.java" />
        </javadoc>
    </target>

    <!-- more implementation, any remaining targets -->
</project>
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文