Skip to content

Commit cc6abbe

Browse files
committed
让Jitpack支持文档
1 parent ec03e66 commit cc6abbe

1 file changed

Lines changed: 103 additions & 0 deletions

File tree

‎Course/jitpack-javadoc.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# 让JitPack支持Javadoc
2+
3+
很早之前写过一篇[用JitPack发布Android开源库](http://www.gcssloop.com/course/PublishLibraryByJitPack/)的文章,有小伙伴反应说**发到JitPack上的开源库没有文档注释,使用起来很不方便。**
4+
5+
这算是我的失误,上一篇文章只是讲解了如何使用JitPack发布开源库,最终发布的只有arr(即编译好的动态链接库),不仅没有文档注释,也没有源码,本次就教大家如何在发布同时添加上源码和注释。
6+
7+
由于JitPack本身就是一个自定义Maven仓库,所以配置方式与Maven类似。
8+
9+
10+
11+
### 配置项目的 build.gradle
12+
13+
项目的 build.gradle 配置和上一篇一样,没有变化。
14+
15+
```java
16+
buildscript {
17+
dependencies {
18+
// 重点就是下面这一行(上面两行是为了定位这一行的添加位置)
19+
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
20+
```
21+
22+
23+
24+
### 配置 Library 的 build.gradle
25+
26+
完整示例(重点内容已经用注释标出):
27+
28+
```java
29+
apply plugin: 'com.android.library'
30+
apply plugin: 'com.github.dcendents.android-maven' // 添加这个
31+
32+
group='com.github.GcsSloop' // 指定group,com.github.<用户名>
33+
34+
android {
35+
compileSdkVersion 23
36+
buildToolsVersion "23.0.3"
37+
38+
defaultConfig {
39+
minSdkVersion 7
40+
targetSdkVersion 23
41+
versionCode 1
42+
versionName "1.0"
43+
}
44+
buildTypes {
45+
release {
46+
minifyEnabled false
47+
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
48+
}
49+
}
50+
}
51+
52+
dependencies {
53+
compile fileTree(dir: 'libs', include: ['*.jar'])
54+
testCompile 'junit:junit:4.12'
55+
compile 'com.android.support:appcompat-v7:23.4.0'
56+
}
57+
58+
//---------------------------------------------
59+
60+
// 指定编码
61+
tasks.withType(JavaCompile) {
62+
options.encoding = "UTF-8"
63+
}
64+
65+
// 打包源码
66+
task sourcesJar(type: Jar) {
67+
from android.sourceSets.main.java.srcDirs
68+
classifier = 'sources'
69+
}
70+
71+
task javadoc(type: Javadoc) {
72+
failOnError false
73+
source = android.sourceSets.main.java.sourceFiles
74+
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
75+
classpath += configurations.compile
76+
}
77+
78+
// 制作文档(Javadoc)
79+
task javadocJar(type: Jar, dependsOn: javadoc) {
80+
classifier = 'javadoc'
81+
from javadoc.destinationDir
82+
}
83+
84+
artifacts {
85+
archives sourcesJar
86+
archives javadocJar
87+
}
88+
```
89+
90+
91+
92+
### 发布参照上一篇文章: [使用JitPack发布开源库](http://www.gcssloop.com/course/PublishLibraryByJitPack/)
93+
94+
95+
96+
### 查看在线文档
97+
98+
如果你在JitPack配置了文档支持,你可以在线查看。
99+
100+
查看地址是 `https://jitpack.io/com/github/USER/REPO/VERSION/javadoc/`
101+
102+
例如我的一个开源库: https://jitpack.io/com/github/GcsSloop/ViewSupport/v1.2.2/javadoc/
103+

0 commit comments

Comments
 (0)