Add javadoc overview and package desc (simple yet)

jpush · Jun 27, 2014 · f33fe5e · f33fe5e
1 parent ac9f4e6
commit f33fe5e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 
  <groupId>cn.jpush.api</groupId>
  <artifactId>jpush-client</artifactId>
- <version>3.1.0-SNAPSHOT</version>
+ <version>3.1.1-SNAPSHOT</version>
  <packaging>jar</packaging>
  <url>https://github.com/jpush/jpush-api-java-client</url>
  <name>JPush API Java Client</name>
@@ -147,6 +147,9 @@
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <version>2.9.1</version>
+ <configuration>
+ <overview>resources/javadoc-overview.html</overview>
+ </configuration>
  </plugin>
  </plugins>
  </reporting>

diff --git a/resources/javadoc-overview.html b/resources/javadoc-overview.html
@@ -0,0 +1,10 @@
+<html>
+<head>
+ <title>JPush Client</title>
+</head>
+<body>
+ JPush API Java 客户端。
+
+ 主要分为 2 个功能部分：推送、报表。
+</body>
+</html>
diff --git a/src/cn/jpush/api/push/package.html b/src/cn/jpush/api/push/package.html
@@ -0,0 +1,10 @@
+<html>
+<head>
+ <title></title>
+</head>
+<body>
+ 推送功能。
+
+ 基于 JSON 来拼装 Payload。
+</body>
+</html>