From cc6abbe1c32339b13c1e2acbc7def3c9fd1fe539 Mon Sep 17 00:00:00 2001 From: GcsSloop Date: Fri, 9 Sep 2016 23:30:30 +0800 Subject: [PATCH] =?UTF-8?q?=E8=AE=A9Jitpack=E6=94=AF=E6=8C=81=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Course/jitpack-javadoc.md | 103 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 Course/jitpack-javadoc.md diff --git a/Course/jitpack-javadoc.md b/Course/jitpack-javadoc.md new file mode 100644 index 0000000..b5d1af0 --- /dev/null +++ b/Course/jitpack-javadoc.md @@ -0,0 +1,103 @@ +# 让JitPack支持Javadoc + +很早之前写过一篇[用JitPack发布Android开源库](http://www.gcssloop.com/course/PublishLibraryByJitPack/)的文章,有小伙伴反应说**发到JitPack上的开源库没有文档注释,使用起来很不方便。** + +这算是我的失误,上一篇文章只是讲解了如何使用JitPack发布开源库,最终发布的只有arr(即编译好的动态链接库),不仅没有文档注释,也没有源码,本次就教大家如何在发布同时添加上源码和注释。 + +由于JitPack本身就是一个自定义Maven仓库,所以配置方式与Maven类似。 + + + +### 配置项目的 build.gradle + +项目的 build.gradle 配置和上一篇一样,没有变化。 + +```java +buildscript { + dependencies { + // 重点就是下面这一行(上面两行是为了定位这一行的添加位置) + classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3' +``` + + + +### 配置 Library 的 build.gradle + +完整示例(重点内容已经用注释标出): + +```java +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发布开源库](http://www.gcssloop.com/course/PublishLibraryByJitPack/) + + + +### 查看在线文档 + +如果你在JitPack配置了文档支持,你可以在线查看。 + +查看地址是 `https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/` + +例如我的一个开源库: https://jitpack.io/com/github/GcsSloop/ViewSupport/v1.2.2/javadoc/ +