美文网首页
Android Studio attach javadoc to

Android Studio attach javadoc to

作者: xyxzfj | 来源:发表于2017-03-19 12:20 被阅读134次

    目的

    为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 Studio attach javadoc to

          本文链接:https://www.haomeiwen.com/subject/mgrkgttx.html