如何在javadoc中生成指向android Classes参考的链接？

Question

当我在Eclipse中为我的Android项目生成javadoc时,会有很多警告

cannot find symbol
symbol  : class TextView

和

warning - Tag @see: reference not found: android.app.Dialog

我也试过了

-link http://developer.android.com/reference/
-link http://java.sun.com/j2se/1.4.2/docs/api/

在Extra javadoc options (path names with white spaces must be enclosed in quotes)tab中Configure Javadoc Arguments(eclipse-> project-> Generate Javadoc的第三个对话框).

但只有-link http://java.sun.com/j2se/1.4.2/docs/api/工作即http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true生成String类链接.但是android.app.Dialog,没有生成任何链接.

编辑

我也尝试android.jar在Select referenced archives and projects to which links should be generated 选项卡中选择Configure Javadoc arguments for standard doclet(eclipse-> project-> Generate Javadoc的第二个对话框),但这会创建本地android-sdk目录中文档的本地链接,而不是像Java API那样的在线Android引用.

Answer 1

Javadoc依赖于一个调用的文件package-list来确定在给定目录下记录的Java包.出于某种原因,这样的文件丢失了http://d.android.com/reference/,所以"天真"与方法

-link http://d.android.com/reference/

不起作用 - 您会收到一条警告,指出无法检索包列表,也没有在您的文档中生成链接.(注意:第二个eclipse对话框中的复选框只是-link为你组装参数,所以这并没有什么区别)

然而,Javadoc中提供的-linkoffline参数,以便能够调整正是这种情况:你想在网上链接到一些其他的Javadoc文档,但你不能在生成自己的文档的时间访问它.以下是它的工作原理:虽然-link只需要一个参数(您要链接到的JavaDoc文档的URL),但-linkoffline需要第二个参数.那个是package-list文件的位置!

因此,链接到中文版在线参考文档,你应该不会选择在第二日食对话框任何复选框,而是添加

-linkoffline http://d.android.com/reference file:/C:/pathtoyour/android-sdk-windows/docs/reference

在第3个对话框中的Extra Javadoc选项中.这样您就可以使用package-list本地安装的Android文档,但生成的Javadoc中的链接仍然会指向在线版本.

希望能帮助到你!