用JitPack发布开源库时附加文档和源码
2016-09-22 12:31
609 查看
首发地址: http://www.gcssloop.com/course/jitpack-sources-javadoc
很早之前写过一篇用JitPack发布Android开源库的文章,有小伙伴反馈说发布到JitPack上的开源库没有文档注释,使用起来很不方便,这是我的失误,上一篇文章只是讲解了如何使用JitPack发布开源库,最终发布的只有arr(即编译好的动态链接库),不仅没有文档注释(Javadoc),也没有源码(sources),本次就教大家如何在发布同时添加上注释和源码。
由于JitPack本身就是一个自定义Maven仓库,所以与上传Maven的配置方式基本一样。
查看地址是:
例如我的一个开源库:
在线API文档样式:
很早之前写过一篇用JitPack发布Android开源库的文章,有小伙伴反馈说发布到JitPack上的开源库没有文档注释,使用起来很不方便,这是我的失误,上一篇文章只是讲解了如何使用JitPack发布开源库,最终发布的只有arr(即编译好的动态链接库),不仅没有文档注释(Javadoc),也没有源码(sources),本次就教大家如何在发布同时添加上注释和源码。
由于JitPack本身就是一个自定义Maven仓库,所以与上传Maven的配置方式基本一样。
配置项目的 build.gradle
项目的 build.gradle 配置和上一篇一样,没有变化。buildscript { dependencies { // 重点就是下面这一行(上面两行是为了定位这一行的添加位置) classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
配置 Library 的 build.gradle
完整示例(重点内容已经用注释标出):apply plugin: 'com.android.library' apply plugin: 'com.github.dcendents.android-maven' // 添加这个 group='com.github.GcsSloop' // 指定group,com.github.<用户名> android { compileSdkVersion 23 buildToolsVersion "23.0.3" defaultConfig { minSdkVersion 7 targetSdkVersion 23 versionCode 1 versionName "1.0" } buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) testCompile 'junit:junit:4.12' compile 'com.android.support:appcompat-v7:23.4.0' } //--------------------------------------------- // 指定编码 tasks.withType(JavaCompile) { options.encoding = "UTF-8" } // 打包源码 task sourcesJar(type: Jar) { from android.sourceSets.main.java.srcDirs classifier = 'sources' } task javadoc(type: Javadoc) { failOnError false source = android.sourceSets.main.java.sourceFiles classpath += project.files(android.getBootClasspath().join(File.pathSeparator)) classpath += configurations.compile } // 制作文档(Javadoc) task javadocJar(type: Jar, dependsOn: javadoc) { classifier = 'javadoc' from javadoc.destinationDir } artifacts { archives sourcesJar archives javadocJar }
发布参照上一篇文章: 使用JitPack发布开源库
查看在线文档
如果你在JitPack配置了文档和源码支持,在引用同时就包含了源码和文档,不仅如此,你也可以在线查看。查看地址是:
https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/
例如我的一个开源库:
https://jitpack.io/com/github/GcsSloop/ViewSupport/v1.2.2/javadoc/
在线API文档样式:
相关文章推荐
- 【转】用JitPack发布开源库时附加文档和源码
- Android: 使用JitPack发布你的Github开源库
- Android studio 使用JitPack发布library到Github开源库
- 10分钟用Jitpack发布开源库
- 发布开源库到 JitPack.io + jcenter
- 编写开源库并发布到JitPack.io
- 发布新手的第一个开源库-快速发布开源库到JitPack
- 优雅的发布Android开源库(论JitPack的优越性)
- 使用JitPack发布Android开源库
- Android: 使用JitPack发布你的Github开源库
- Android:使用JitPack发布Github开源库
- 5分钟用Jitpack发布开源库
- 利用JitPack发布Android开源库
- Portal-Basic Java Web应用开发框架V3.0正式发布(源码、实例及文档)
- 发布一个小小的源码 StormRCPack
- 异步框架【★更新★】Portal-Basic Java Web 开发框架 v3.1.1 正式发布(源码、示例及文档)-java教程
- Android: 使用JitPack发布你的Github开源库
- Portal-Basic Java Web 应用开发框架 v2.6.2 发布(源码、示例及文档)
- 【双旦献礼】Portal-Basic Java Web 应用开发框架 v3.0.1 正式发布(源码、示例及文档)
- [置顶] Android 使用JitPack快速发布你的GitHub开源库