用JitPack发布开源库时附加文档和源码
来源:互联网 发布:图片查看软件 编辑:程序博客网 时间:2024/06/03 22:48
首发地址: http://www.gcssloop.com/course/jitpack-sources-javadoc
很早之前写过一篇用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文档样式:
0 0
- 用JitPack发布开源库时附加文档和源码
- 5分钟用Jitpack发布开源库
- 10分钟用Jitpack发布开源库
- jitpack生成发布依赖
- GitHub jitpack 发布
- 发布 Library 到 JitPack
- 利用JitPack发布Android开源库
- 使用JitPack发布Android开源库
- github项目发布的jitpack
- 快速发布library到JitPack
- 发布开源库到 JitPack.io + jcenter
- 作品发布:挖金子修订版源码和文档
- JitPack
- Eclipse同时附加javadoc和android文档
- 编写开源库并发布到JitPack.io
- Android 急速发布项目到 JitPack
- Android 急速发布项目到 JitPack
- Android 急速发布项目到 JitPack
- navicat 导出向导 , 通过Excel生成批量SQL语句,处理大量数据
- dos2unix命令
- iOS10 适配
- 未曾有因缘经
- C++ 一个字符串的代理类(String View)
- 用JitPack发布开源库时附加文档和源码
- 微信企业号开发笔记——文本信息发送
- C++类和new、delete操作符
- CSS3 圆角属性 border-radius和-webkit-border-radius使用
- java泛型(一)、泛型的基本介绍和使用
- 转义字符
- ORACLE没有listener.ora监听程序仍然可以正常运行
- Inequalities - Tchebychef's inequality
- iOS学习笔记 推送证书与秘钥申请