Android Studio attach javadoc to jar

目的

为jar包设置对应的javadoc,帮助我们在IDE中通过F1快速查看sdk说明文档。

方法

以前eclipse可以很简单地做到。现在用Android Studio,需要手工编辑.idea/libraries/xxx.xml,其中xxx是jar文件名,比如testlib。需要增加JAVADOC结点,其中,注意url前面加上协议,后面不要index.html。

修改如下:

<component name="libraryTable">
  <library name="testlib">
    <CLASSES>
      <root url="jar://$PROJECT_DIR$/app/libs/testlib.jar!/" />
    </CLASSES>
    <JAVADOC>
      <root url="file://$USER_HOME$/tmp/testlib-javadoc/docs" />
    </JAVADOC>
    <SOURCES />
  </library>
</component>

提供的javadoc或Reference API(往往可以从提供jar包的官网得到)如下:

java doc filesystem structure

效果

javadoc applied in Android Studio

源码

本文中上述例子的源码下载地址:
https://pan.baidu.com/s/1hrTmwlA

参考

https://coderwall.com/p/ybnbbw/attach-javadoc-to-android-studio-project

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 174,093评论 25 709
  • afinalAfinal是一个android的ioc,orm框架 https://github.com/yangf...
    passiontim阅读 15,611评论 2 45
  • 今天又重新读了《以斯拉记》,真是感触颇多,不禁要分享出来,人若睁眼不诉说上帝的伟大简直比瞎眼的更可怜。 从单纯的故...
    渔夫简想阅读 2,272评论 0 0
  • 这一侧灯火 那一侧黑夜 你站在中间笑着 有风来靠近 嗯, 灯火总要关闭 黑夜终会亮起 安,多情的人 安,窗
    Cactussnow阅读 285评论 4 2
  • IOS学习中,因为小组在做一个项目,而这个项目其中有包括地图定位的功能,所以在老师还没有讲到的情况下,凭着一腔热...
    93未完待续阅读 1,083评论 8 2