如何将javadoc或源文件附加到libs文件夹中的jar文件中?

用于Eclipse的新版ADT r17插件添加了自动设置JAR依赖关系的功能。 / libs文件夹中的任何.jar文件现在都会添加到构建配置中。 不幸的是Android的依赖关系类路径容器是不可修改的。

不可修改的Android依赖关系类路径

我如何将javadoc和源文件附加到自动插入的.jar(从/ libs文件夹)?


回答你的问题的最好方法是总结Xavier,plastiv,VinceFR和Christopher的答案。

一步一步的指导

为了将源代码和javadoc链接到由Eclipse自动链接的.jar库,您必须执行以下操作:

  • 将库.jar文件放在libs文件夹中,并将关联的源.jar和doc .jar文件放在单独的子文件夹(如libs / src和libs / docs)中。 如果需要,您可以使用src和docs以外的名称,但重要的是.jar文件不直接位于libs文件夹中。
  • 使用实际库.jar的确切名称在libs文件夹中创建一个.properties文件(请参阅示例)。 确保你保留.jar部分。
  • .properties文件中指定源和javadoc .jar的相对路径。
  • 关闭并重新打开Eclipse项目! 或者,按F5刷新项目。
  • 在源代码中选择链接库的一个对象。
  • 在Eclipse中打开Javadoc视图来检查文档(请参阅截图)。
  • 打开所选对象的源代码声明(默认快捷键:F3)。

  • 该示例使用Gson库。

    libs文件夹的目录结构:

    libs
    ├── docs
    │   └── gson-2.2.2-javadoc.jar
    ├── gson-2.2.2.jar
    ├── gson-2.2.2.jar.properties
    └── src
        └── gson-2.2.2-sources.jar
    

    gson-2.2.2.jar.properties的内容

    src=src/gson-2.2.2-sources.jar
    doc=docs/gson-2.2.2-javadoc.jar
    


    附加信息

    您当然可以将javadoc和sources.jar移动到其他文件夹并指定相对路径。 这取决于你。 可以将源代码和javadoc jar直接放到lib文件夹中,但不建议这样做 ,因为这会导致应用程序中包含文档和源代码。


    Eclipse JavaDoc面板的屏幕截图:

    Eclipse中的JavaDoc视图

    使用Gson和Android 4.2.2的Eclipse项目的屏幕截图:

    Eclipse测试项目截图


    引用解压缩的javadocs

    如果你想引用javadoc而不是作为一个压缩的.jar 文件提供,而只是按照 android开发人员在注释中所要求的文件和文件夹做以下操作:

  • 将库.jar放在libs/文件夹中
  • 使用以下内容创建yourlibraryname.jar.properties文件(不要忘记.jar ):

     doc=docs
    
  • 将javadocs文件夹添加到libs/文件夹。

  • 你应该拿出以下文件夹结构:

    ├── docs
    │   ├── allclasses-frame.html
    │   ├── allclasses-noframe.html
    │   ├── com
    │   │   └── google
    │   │       └── ads
    │   │           ├── Ad.html
    │   │           │   ....
    │   │           └── package-tree.html
    │   │   ...
    │   └── stylesheet.css
    ├── GoogleAdMobAdsSdk-6.4.1.jar
    └── GoogleAdMobAdsSdk-6.4.1.jar.properties
    

    不要忘记关闭并重新打开上面提到的Eclipse项目! 以下是参考GoogleAdMobAds Android库的示例工程的屏幕截图。

    GoogleAdMobAds Android库Eclipse项目


    在Windows上,您必须在属性文件中转义反斜杠以引用doc和src路径。 例如,对于android-support-v4.jar,属性文件内容如下所示:

    doc=C:Program Files (x86)Androidandroid-sdkextrasandroidsupportv4docs
    src=C:Program Files (x86)Androidandroid-sdkextrasandroidsupportv4src
    

    答案来自http://code.google.com/p/android/issues/detail?id=27490#c21

    在你的libs文件夹中,你必须有:

    doc(folder)
        foo_doc(folder)
            index.html
            ...
            ...
    foo.jar
    foo.jar.properties
    

    在你的foo.jar.properties ,只需放入doc=./doc/foo_doc

    也许你将不得不刷新你的项目,清理它,关闭它并重新打开它。

    这个对我有用!

    链接地址: http://www.djcxy.com/p/88667.html

    上一篇: How to attach javadoc or sources to jars in libs folder?

    下一篇: Android Sdk tools Revision 22 issue?