From 21eca688e991668af6f0747272bd1c42c263dba1 Mon Sep 17 00:00:00 2001
From: "yihua.huang" <code4crafter@gmail.com>
Date: Fri, 9 Aug 2013 20:56:33 +0800
Subject: [PATCH] complete docs

---
 .../src/main/java/us/codecraft/webmagic/Spider.java          | 4 ++--
 .../webmagic/{schedular => scheduler}/QueueScheduler.java    | 2 +-
 .../webmagic/{schedular => scheduler}/Scheduler.java         | 2 +-
 .../codecraft/webmagic/{schedular => scheduler}/package.html | 0
 .../java/us/codecraft/webmagic/model/annotation/package.html | 5 +++++
 .../webmagic/scheduler/FileCacheQueueScheduler.java          | 1 -
 .../java/us/codecraft/webmagic/scheduler/RedisScheduler.java | 1 -
 .../main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java  | 4 ++--
 8 files changed, 11 insertions(+), 8 deletions(-)
 rename webmagic-core/src/main/java/us/codecraft/webmagic/{schedular => scheduler}/QueueScheduler.java (96%)
 rename webmagic-core/src/main/java/us/codecraft/webmagic/{schedular => scheduler}/Scheduler.java (95%)
 rename webmagic-core/src/main/java/us/codecraft/webmagic/{schedular => scheduler}/package.html (100%)
 create mode 100644 webmagic-extension/src/main/java/us/codecraft/webmagic/model/annotation/package.html

diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java b/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java
index 878c63e3..cf627967 100644
--- a/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java
@@ -8,8 +8,8 @@ import us.codecraft.webmagic.downloader.HttpClientDownloader;
 import us.codecraft.webmagic.pipeline.ConsolePipeline;
 import us.codecraft.webmagic.pipeline.Pipeline;
 import us.codecraft.webmagic.processor.PageProcessor;
-import us.codecraft.webmagic.schedular.QueueScheduler;
-import us.codecraft.webmagic.schedular.Scheduler;
+import us.codecraft.webmagic.scheduler.QueueScheduler;
+import us.codecraft.webmagic.scheduler.Scheduler;
 import us.codecraft.webmagic.utils.ThreadUtils;
 
 import java.util.ArrayList;
diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/schedular/QueueScheduler.java b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/QueueScheduler.java
similarity index 96%
rename from webmagic-core/src/main/java/us/codecraft/webmagic/schedular/QueueScheduler.java
rename to webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/QueueScheduler.java
index 613e4062..723b5f93 100644
--- a/webmagic-core/src/main/java/us/codecraft/webmagic/schedular/QueueScheduler.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/QueueScheduler.java
@@ -1,4 +1,4 @@
-package us.codecraft.webmagic.schedular;
+package us.codecraft.webmagic.scheduler;
 
 import org.apache.log4j.Logger;
 import us.codecraft.webmagic.Request;
diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/schedular/Scheduler.java b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/Scheduler.java
similarity index 95%
rename from webmagic-core/src/main/java/us/codecraft/webmagic/schedular/Scheduler.java
rename to webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/Scheduler.java
index 8d9649be..fc39b450 100644
--- a/webmagic-core/src/main/java/us/codecraft/webmagic/schedular/Scheduler.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/Scheduler.java
@@ -1,4 +1,4 @@
-package us.codecraft.webmagic.schedular;
+package us.codecraft.webmagic.scheduler;
 
 import us.codecraft.webmagic.Request;
 import us.codecraft.webmagic.Task;
diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/schedular/package.html b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/package.html
similarity index 100%
rename from webmagic-core/src/main/java/us/codecraft/webmagic/schedular/package.html
rename to webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/package.html
diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/model/annotation/package.html b/webmagic-extension/src/main/java/us/codecraft/webmagic/model/annotation/package.html
new file mode 100644
index 00000000..1e3004fb
--- /dev/null
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/model/annotation/package.html
@@ -0,0 +1,5 @@
+<html>
+	<body>
+webmagic注解抓取方式所定义的注解。
+	</body>
+</html>
diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/FileCacheQueueScheduler.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/FileCacheQueueScheduler.java
index c294f090..a8dc23a5 100644
--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/FileCacheQueueScheduler.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/FileCacheQueueScheduler.java
@@ -4,7 +4,6 @@ import org.apache.commons.lang3.math.NumberUtils;
 import org.apache.log4j.Logger;
 import us.codecraft.webmagic.Request;
 import us.codecraft.webmagic.Task;
-import us.codecraft.webmagic.schedular.Scheduler;
 
 import java.io.*;
 import java.util.LinkedHashSet;
diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/RedisScheduler.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/RedisScheduler.java
index e26ed9d6..e7c5bcd4 100644
--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/RedisScheduler.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/scheduler/RedisScheduler.java
@@ -7,7 +7,6 @@ import redis.clients.jedis.JedisPool;
 import redis.clients.jedis.JedisPoolConfig;
 import us.codecraft.webmagic.Request;
 import us.codecraft.webmagic.Task;
-import us.codecraft.webmagic.schedular.Scheduler;
 
 /**
  * 使用redis管理url，构建一个分布式的爬虫。<br>
diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java
index b4a477fa..b284a157 100755
--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java
@@ -42,7 +42,7 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
 
     /**
      * @param key
-     * @return
+     * @return map
      */
     public Map<K2, V> get(K1 key) {
         return map.get(key);
@@ -51,7 +51,7 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
     /**
      * @param key1
      * @param key2
-     * @return
+     * @return value
      */
     public V get(K1 key1, K2 key2) {
         if (get(key1) == null) {