`
duoerbasilu
  • 浏览: 1484256 次
文章分类
社区版块
存档分类
最新评论

How to generate links to the android Classes' reference in javadoc?

 
阅读更多

原文:http://stackoverflow.com/questions/2818204/how-to-generate-links-to-the-android-classes-reference-in-javadoc

Javadoc relies on a file calledpackage-listto determine what Java packages are documented below a given directory. For some reason, such a file ismissingforhttp://d.android.com/reference/, therefore the "naive" approach with

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

doesn't work – you get a warning that the package-list could not be retrieved and no links are generated into your docs. (Note: The checkboxes in that 2nd eclipse dialog just assemble-linkparameters for you, so that doesn't really make any difference)

However, Javadoc offers the-linkofflineparameter to be able to adjust for preciselythissituation: You want to link to some other Javadoc documentation online, but you cannot access it at the time of generating your own docs. Here's how it works: While-linktakes only one parameter (the URL of the JavaDoc docs you want to link to),-linkofflinetakes a second one. That one is the location of thepackage-listfile!

So, to link to the online Android reference documentation, you shouldnotselect any checkboxes in the 2nd eclipse dialog, but instead add

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

in theExtra Javadoc optionsin the 3rd dialog. That way you use thepackage-listof your locally installed Android docs, but the links in your generated Javadoc will still point to the online version anyway.

Hope it helps!


分享到:
评论

相关推荐

Global site tag (gtag.js) - Google Analytics