add javadoc for package #20

oldratlee · oldratlee · commit 6db29fc99113 · 2015-04-18T15:11:05.000+08:00
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
 	<version>1.2.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 	<name>Java Dns Cache Manipulator(DCM)</name>
-	<description>A simple 0-dependency lib for setting dns programmatically without touching host file, make unit/integration test portable.</description>
+	<description>A simple 0-dependency thread-safe lib for setting dns programmatically without touching host file, make unit/integration test portable.</description>
 	<url>https://github.com/alibaba/java-dns-cache-manipulator</url>
 	<inceptionYear>2015</inceptionYear>
 
@@ -172,6 +172,7 @@
 							<links>
 								<link>http://docs.oracle.com/javase/7/docs/api</link>
 							</links>
+							<overview>src/api/overview.html</overview>
 							<additionalJOptions>
 								<additionalJOption>-J-Duser.language=en -J-Duser.country=US</additionalJOption>
 							</additionalJOptions>
diff --git a/src/api/overview.html b/src/api/overview.html
@@ -0,0 +1,9 @@
+<html>
+<body>
+<p>This is the API documentation for the
+    <a href="https://github.com/alibaba/java-dns-cache-manipulator" target="_top">Java Dns Cache Manipulator</a>,
+    a simple 0-dependency thread-safe lib for setting dns programmatically without touching host file,
+    make unit/integration test portable.
+</p>
+</body>
+</html>
diff --git a/src/main/java/com/alibaba/dcm/DnsCacheManipulator.java b/src/main/java/com/alibaba/dcm/DnsCacheManipulator.java
@@ -10,7 +10,7 @@
 import java.util.regex.Pattern;
 
 /**
- * A simple lib for setting dns (in fact dns cache) programmatically.
+ * Setting dns (in fact dns cache).
  *
  * @author Jerry Lee (oldratlee at gmail dot com)
  * @see DnsCacheEntry
diff --git a/src/main/java/com/alibaba/dcm/internal/package-info.java b/src/main/java/com/alibaba/dcm/internal/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Internal helper class.
+ *
+ * @author Jerry Lee (oldratlee at gmail dot com)
+ */
+package com.alibaba.dcm.internal;
diff --git a/src/main/java/com/alibaba/dcm/package-info.java b/src/main/java/com/alibaba/dcm/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * User API.
+ *
+ * @author Jerry Lee (oldratlee at gmail dot com)
+ * @see com.alibaba.dcm.DnsCacheManipulator
+ */
+package com.alibaba.dcm;

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`import java.util.regex.Pattern;`
`11`	`11`
`12`	`12`	`/**`
`13`		`- * A simple lib for setting dns (in fact dns cache) programmatically.`
	`13`	`+ * Setting dns (in fact dns cache).`
`14`	`14`	`*`
`15`	`15`	`* @author Jerry Lee (oldratlee at gmail dot com)`
`16`	`16`	`* @see DnsCacheEntry`