UDN-企业互联网技术人气社区

板块导航

浏览  : 1207
回复  : 0

[其它] 用JitPack发布开源库时附加文档和源码

[复制链接]
呵呵燕的头像 楼主
发表于 2016-9-10 19:07:19 | 显示全部楼层 |阅读模式
  很早之前写过一篇用JitPack发布Android开源库的文章,有小伙伴反馈说发布到JitPack上的开源库没有文档注释,使用起来很不方便,这是我的失误,上一篇文章只是讲解了如何使用JitPack发布开源库,最终发布的只有arr(即编译好的动态链接库),不仅没有文档注释(Javadoc),也没有源码(sources),本次就教大家如何在发布同时添加上注释和源码。

  由于JitPack本身就是一个自定义Maven仓库,所以与上传Maven的配置方式基本一样。

  配置项目的 build.gradle

  项目的 build.gradle 配置和上一篇一样,没有变化。

  1.   buildscript {

  2.   dependencies {

  3.   // 重点就是下面这一行(上面两行是为了定位这一行的添加位置)

  4.   classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
复制代码


  配置 Library 的 build.gradle

  完整示例(重点内容已经用注释标出):

  1.   apply plugin: 'com.android.library'

  2.   apply plugin: 'com.github.dcendents.android-maven' // 添加这个

  3.   group='com.github.GcsSloop' // 指定group,com.github.<用户名>

  4.   android {

  5.   compileSdkVersion 23

  6.   buildToolsVersion "23.0.3"

  7.   defaultConfig {

  8.   minSdkVersion 7

  9.   targetSdkVersion 23

  10.   versionCode 1

  11.   versionName "1.0"

  12.   }

  13.   buildTypes {

  14.   release {

  15.   minifyEnabled false

  16.   proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'

  17.   }

  18.   }

  19.   }

  20.   dependencies {

  21.   compile fileTree(dir: 'libs', include: ['*.jar'])

  22.   testCompile 'junit:junit:4.12'

  23.   compile 'com.android.support:appcompat-v7:23.4.0'

  24.   }

  25.   //---------------------------------------------

  26.   // 指定编码

  27.   tasks.withType(JavaCompile) {

  28.   options.encoding = "UTF-8"

  29.   }

  30.   // 打包源码

  31.   task sourcesJar(type: Jar) {

  32.   from android.sourceSets.main.java.srcDirs

  33.   classifier = 'sources'

  34.   }

  35.   task javadoc(type: Javadoc) {

  36.   failOnError false

  37.   source = android.sourceSets.main.java.sourceFiles

  38.   classpath += project.files(android.getBootClasspath().join(File.pathSeparator))

  39.   classpath += configurations.compile

  40.   }

  41.   // 制作文档(Javadoc)

  42.   task javadocJar(type: Jar, dependsOn: javadoc) {

  43.   classifier = 'javadoc'

  44.   from javadoc.destinationDir

  45.   }

  46.   artifacts {

  47.   archives sourcesJar

  48.   archives javadocJar

  49.   }
复制代码


  发布参照上一篇文章: 使用JitPack发布开源库

  查看在线文档

  如果你在JitPack配置了文档和源码支持,在引用同时就包含了源码和文档,不仅如此,你也可以在线查看。

  查看地址是: https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/

  例如我的一个开源库:https://jitpack.io/com/github/Gc ... ort/v1.2.2/javadoc/

  在线API文档样式:

8.jpg


原文作者:GcsSloop 来源:开发者头条

相关帖子

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关于我们
联系我们
  • 电话:010-86393388
  • 邮件:udn@yonyou.com
  • 地址:北京市海淀区北清路68号
移动客户端下载
关注我们
  • 微信公众号:yonyouudn
  • 扫描右侧二维码关注我们
  • 专注企业互联网的技术社区
版权所有:用友网络科技股份有限公司82041 京ICP备05007539号-11 京公网网备安1101080209224 Powered by Discuz!
快速回复 返回列表 返回顶部