如何为android项目生成javadocs

时间:2013-06-28 05:58:15

标签: android javadoc

我遵循了stackflow上给出的所有指令,但遗憾的是无法为我的android项目生成doc文件。

如果我没有在java doc生成的最后一步提及类路径,那么会出现“Android参考”错误。

如果使用它,那么得到“javadoc:error - -classpath选项可以指定不超过一次。”错误。

使用classpath:

-classpath“D:\ Android 4.2 SDK \ android_sdk \ platforms \ android-15 \ android.jar”

我使用正确的类路径命令吗?

请帮帮我。

使用的环境: Eclipse indigo

3 个答案:

答案 0 :(得分:5)

如果您使用 Intellij IDEA ,请转到Tools - Generate JavaDoc...指定所有设置并设置参数:-bootclasspath [path]\android-sdk\platforms\android-{version}\android.jar -encoding UTF-8 -docencoding utf-8 -charset utf-8

更多信息请参见此post

答案 1 :(得分:2)

您是否遵循了这些步骤(来自www.mtholyoke.edu)?这适用于我的项目....如果没有,你得到一个错误,请在这里写下你得到的错误。

  1. 项目 - >生成Javadoc

  2. 在“Javadoc命令”字段中 - 浏览以查找javadoc.exe •在Clapp CS实验室中的计算机上,即C:\ JBuilderX \ jdk1.4 \ bin \ javadoc.exe •在其他计算机上,它将是\ bin \ javadoc.exe

  3. 选中要为其创建javadoc的项目/包/文件旁边的框

  4. 在“目标”字段中,浏览以查找所需的目标(例如,当前项目的根目录)。

  5. 保留其他所有内容。

  6. 点击“完成”

  7. Javadoc应该在目标文件夹中。打开“index.html”

    修改

    我在Stackoverflow中发现了一个带有大量tipp的线程,试试这个:

    Javadoc in Eclipse failing to recognize packages

    下一页编辑

    这只是一种可能性,但您将类路径指定为:

    “D:\ Android 4.2 SDK \ android_sdk \ platforms \ android-15 \ android.jar”

    我知道eclipse在路径中出现了一些空间问题。所以第一部分“Android 4.2 SDK”必须指定没有空格,也许这就是问题所在。但请注意,如果您更改此路径,则必须在任何位置设置您已定义它的新路径。

答案 2 :(得分:2)

我正在使用命令行。我还更新了Eclipse Kepler。它似乎以不同的方式执行javadoc?我正在调查。但试试这个:

阅读javadoc手册。这令人困惑,并没有告诉你该怎么做,但是,这里有一个例子可以帮助你。

创建一个名为" options"的文件。

将此文件添加到文件中:

-d target-bin
-stylesheetfile style.css
-use
-splitindex
-windowtitle 'My Project Name Class Specification'
-doctitle 'My Project Name Class Specification'
-header '<b>My Project Name</b><br><font size="-1">0.1.5-alpha</font>'
-bottom 'Copyright 2014 My Company or Myself. All rights reserved.'
-group "Group Of Packages" "com.mypackage.*"
-overview overview.html
-exclude 'android'
-subpackages 'com.mypackage:android'
-charset utf-8
-encoding UTF8
-quiet
-sourcepath ../myProject/src;..\..\..\android-sdks\sources\android-19

然后在命令行上键入:

javadoc @options

现在,在开普勒,&#34;生成Javadoc&#34;对话框说&#34;什么是javadoc命令行&#34; ...我怀疑我必须键入这样的内容。但不知道。

希望这个简单的例子可以帮助您了解如何为您的目的完成任务。

顺便说一下,我创建了一个名为&#34; javadoc&#34;的通用Eclipse项目。在我的工作区中,所以我可以管理文件。