update docs

webmagic-core/src/main/java/us/codecraft/webmagic/Page.java

@@ -10,10 +10,16 @@ import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- * Page保存了抓取的结果，并可定义下一次抓取的链接内容。
- * Author: code4crafter@gmail.com
- * Date: 13-4-21
- * Time: 上午11:22
+ * <pre>
+ *Page保存了上一次抓取的结果，并可定义待抓取的链接内容。
+ *
+ *     主要方法：
+ *     {@link #getUrl()} 获取页面的Url
+ *     {@link #getHtml()}  获取页面的html内容
+ *     {@link #addTargetRequests(java.util.List)} {@link #addTargetRequest(String)} 添加待抓取的链接
+ *
+ * </pre>
+ * @author code4crafter@gmail.com <br>
  */
 public class Page {
 
@@ -34,6 +40,10 @@ public class Page {
     public Page() {
     }
 
+    /**
+     *
+     * @return fields
+     */
     public Map<String, Selectable> getFields() {
         return fields;
     }

webmagic-core/src/main/java/us/codecraft/webmagic/Request.java

@@ -17,7 +17,7 @@ package us.codecraft.webmagic;
  *          String linktext =  (String)page.getRequest().getExtra()[0];
  *      }
  * </pre>
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午11:37
  */

webmagic-core/src/main/java/us/codecraft/webmagic/Site.java

@@ -4,7 +4,7 @@ import java.util.*;
 
 /**
  * Site定义一个待抓取的站点的各种信息。
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午12:13
  */

webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java

@@ -14,7 +14,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午6:53
  */

webmagic-core/src/main/java/us/codecraft/webmagic/Task.java

 package us.codecraft.webmagic;
 
 /**
- * Author: code4crafer@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-6-18
  * Time: 下午2:57
  */

webmagic-core/src/main/java/us/codecraft/webmagic/downloader/Downloader.java

@@ -6,7 +6,7 @@ import us.codecraft.webmagic.Site;
 
 /**
  * Downloader是webmagic下载页面的接口。webmagic默认使用了HttpComponent作为下载器，一般情况，你无需自己实现这个接口。
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午12:14
  */
@@ -17,7 +17,7 @@ public interface Downloader {
      *
      * @param request
      * @param site
-     * @return
+     * @return page
      */
     public Page download(Request request, Site site);
 }

webmagic-core/src/main/java/us/codecraft/webmagic/downloader/HttpClientDownloader.java

@@ -14,7 +14,7 @@ import us.codecraft.webmagic.utils.UrlUtils;
 
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午12:15
  */

webmagic-core/src/main/java/us/codecraft/webmagic/downloader/HttpClientPool.java

@@ -18,7 +18,7 @@ import us.codecraft.webmagic.Site;
 import java.util.Map;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午12:29
  */

webmagic-core/src/main/java/us/codecraft/webmagic/pipeline/ConsolePipeline.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.selector.Selectable;
 import java.util.Map;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:45
  */

webmagic-core/src/main/java/us/codecraft/webmagic/pipeline/FilePipeline.java

@@ -12,7 +12,7 @@ import java.io.PrintWriter;
 import java.util.Map;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午6:28
  */

webmagic-core/src/main/java/us/codecraft/webmagic/pipeline/Pipeline.java

@@ -4,7 +4,7 @@ import us.codecraft.webmagic.Page;
 import us.codecraft.webmagic.Task;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:39
  */

webmagic-core/src/main/java/us/codecraft/webmagic/processor/PageProcessor.java

@@ -4,7 +4,7 @@ import us.codecraft.webmagic.Page;
 import us.codecraft.webmagic.Site;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午11:42
  */

webmagic-core/src/main/java/us/codecraft/webmagic/processor/SimplePageProcessor.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.utils.UrlUtils;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-22
  * Time: 下午9:15
  */

webmagic-core/src/main/java/us/codecraft/webmagic/schedular/FileCacheQueueSchedular.java

@@ -16,7 +16,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:13
  */

webmagic-core/src/main/java/us/codecraft/webmagic/schedular/QueueSchedular.java

@@ -10,7 +10,7 @@ import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.LinkedBlockingQueue;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:13
  */

webmagic-core/src/main/java/us/codecraft/webmagic/schedular/Schedular.java

@@ -4,7 +4,7 @@ import us.codecraft.webmagic.Request;
 import us.codecraft.webmagic.Task;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:12
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java

@@ -4,7 +4,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:54
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/PlainText.java

@@ -6,7 +6,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:54
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/RegexResult.java

 package us.codecraft.webmagic.selector;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:39
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/RegexSelector.java

@@ -9,7 +9,7 @@ import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:09
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/ReplaceSelector.java

@@ -6,7 +6,7 @@ import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:09
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectable.java

@@ -3,7 +3,7 @@ package us.codecraft.webmagic.selector;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-20
  * Time: 下午7:51
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selector.java

@@ -3,7 +3,7 @@ package us.codecraft.webmagic.selector;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-20
  * Time: 下午8:02
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/SelectorFactory.java

@@ -7,7 +7,7 @@ import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:56
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/SmartContentSelector.java

@@ -10,7 +10,7 @@ import java.util.concurrent.atomic.AtomicInteger;
 /**
  * readability算法，基础是找到所有p标签的父节点
  * 写的比较乱，最终效果还在尝试中
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午4:42
  */

webmagic-core/src/main/java/us/codecraft/webmagic/selector/XpathSelector.java

@@ -6,7 +6,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午9:39
  */

webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java

@@ -6,7 +6,7 @@ import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:52
  */

webmagic-core/src/test/java/us/codecraft/webmagic/HtmlTest.java

@@ -5,7 +5,7 @@ import org.junit.Test;
 import us.codecraft.webmagic.selector.Html;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午8:42
  */

webmagic-core/src/test/java/us/codecraft/webmagic/selector/RegexSelectorTest.java

@@ -4,7 +4,7 @@ import junit.framework.Assert;
 import org.junit.Test;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 上午7:13
  */

webmagic-core/src/test/java/us/codecraft/webmagic/selector/XpathSelectorTest.java

@@ -4,7 +4,7 @@ import org.junit.Assert;
 import org.junit.Test;
 
 /**
- * Author: code4crafter@gmail.com Date: 13-4-21 Time: 上午10:06
+ * @author code4crafter@gmail.com <br> Date: 13-4-21 Time: 上午10:06
  */
 public class XpathSelectorTest {
 

webmagic-core/src/test/java/us/codecraft/webmagic/utils/UrlUtilsTest.java

@@ -4,7 +4,7 @@ import org.junit.Assert;
 import org.junit.Test;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午2:22
  */

webmagic-plugin/src/main/java/us/codecraft/webmagic/pipeline/FreemarkerPipeline.java

@@ -13,7 +13,7 @@ import java.io.IOException;
 import java.io.PrintWriter;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-6-8
  * Time: 下午9:00
  */

webmagic-plugin/src/test/java/us/codecraft/webmagic/FreemarkerPipelineTest.java

@@ -6,7 +6,7 @@ import us.codecraft.webmagic.pipeline.FreemarkerPipeline;
 import java.io.IOException;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-6-9
  * Time: 上午7:14
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/DiandianBlogProcessor.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午8:08
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/DianpingProcessor.java

@@ -8,7 +8,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午8:08
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/DiaoyuwengProcessor.java

@@ -8,7 +8,7 @@ import us.codecraft.webmagic.selector.PlainText;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午8:08
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/F58PageProcesser.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:48
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/HuxiuProcessor.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午8:08
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/KaichibaProcessor.java

@@ -5,7 +5,7 @@ import us.codecraft.webmagic.Site;
 import us.codecraft.webmagic.processor.PageProcessor;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-5-20
  * Time: 下午5:31
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/MeicanProcessor.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-5-20
  * Time: 下午5:31
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/NjuBBSProcessor.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午8:08
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/OschinaBlogPageProcesser.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:48
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/OschinaPageProcesser.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:48
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/QzoneBlogProcessor.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午8:08
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/SinaBlogProcesser.java

@@ -5,7 +5,7 @@ import us.codecraft.webmagic.Page;
 import us.codecraft.webmagic.processor.PageProcessor;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:48
  */

webmagic-samples/src/main/java/us/codecraft/webmagic/samples/TianyaPageProcesser.java

@@ -7,7 +7,7 @@ import us.codecraft.webmagic.processor.PageProcessor;
 import java.util.List;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-21
  * Time: 下午1:48
  */

webmagic-samples/src/test/java/us/codecraft/webmagic/SpiderTest.java

@@ -8,7 +8,7 @@ import us.codecraft.webmagic.samples.HuxiuProcessor;
 import us.codecraft.webmagic.schedular.FileCacheQueueSchedular;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-4-20
  * Time: 下午7:46
  */

webmagic-samples/src/test/java/us/codecraft/webmagic/processor/DiandianProcessorTest.java

@@ -11,7 +11,7 @@ import us.codecraft.webmagic.schedular.FileCacheQueueSchedular;
 import java.io.IOException;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-6-9
  * Time: 上午8:02
  */

webmagic-samples/src/test/java/us/codecraft/webmagic/processor/DiaoyuwengProcessorTest.java

@@ -11,7 +11,7 @@ import us.codecraft.webmagic.schedular.FileCacheQueueSchedular;
 import java.io.IOException;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-6-9
  * Time: 上午8:02
  */

webmagic-samples/src/test/java/us/codecraft/webmagic/processor/SinablogProcessorTest.java

@@ -11,7 +11,7 @@ import us.codecraft.webmagic.schedular.FileCacheQueueSchedular;
 import java.io.IOException;
 
 /**
- * Author: code4crafter@gmail.com
+ * @author code4crafter@gmail.com <br>
  * Date: 13-6-9
  * Time: 上午8:02
  */