complete javadoc

9c5716a5 · yihua.huang · db3cbf6c · 9c5716a5 · 9c5716a5 · 9c5716a5
Commit 9c5716a5 authored Jan 21, 2016 by yihua.huang
41 changed files
--- a/pom.xml
+++ b/pom.xml
@@ -6,7 +6,7 @@
        <version>7</version>
    </parent>
    <groupId>us.codecraft</groupId>
-    <version>0.5.3-SNAPSHOT</version>
+    <version>0.5.3</version>
    <modelVersion>4.0.0</modelVersion>
    <packaging>pom</packaging>
    <properties>
@@ -38,7 +38,7 @@
        <connection>scm:git:git@github.com:code4craft/webmagic.git</connection>
        <developerConnection>scm:git:git@github.com:code4craft/webmagic.git</developerConnection>
        <url>git@github.com:code4craft/webmagic.git</url>
-      <tag>HEAD</tag>
+      <tag>webmagic-parent-0.5.3</tag>
  </scm>
    <licenses>
        <license>

--- a/pom.xml.releaseBackup
+++ b/pom.xml.releaseBackup
--- a/release.properties
+++ b/release.properties
+#release configuration
+#Thu Jan 21 17:59:05 CST 2016
+project.dev.us.codecraft\:webmagic-selenium=0.5.4-SNAPSHOT
+scm.commentPrefix=[maven-release-plugin] 
+project.rel.us.codecraft\:webmagic-samples=0.5.3
+project.rel.us.codecraft\:webmagic-selenium=0.5.3
+project.rel.us.codecraft\:webmagic-saxon=0.5.3
+pushChanges=true
+project.dev.us.codecraft\:webmagic-extension=0.5.4-SNAPSHOT
+project.scm.us.codecraft\:webmagic-selenium.empty=true
+project.scm.us.codecraft\:webmagic-parent.developerConnection=scm\:git\:git@github.com\:code4craft/webmagic.git
+project.rel.us.codecraft\:webmagic-core=0.5.3
+project.scm.us.codecraft\:webmagic-scripts.empty=true
+project.rel.us.codecraft\:webmagic-extension=0.5.3
+project.rel.us.codecraft\:webmagic-parent=0.5.3
+scm.tag=webmagic-parent-0.5.3
+remoteTagging=true
+project.scm.us.codecraft\:webmagic-parent.tag=HEAD
+project.dev.us.codecraft\:webmagic-scripts=0.5.4-SNAPSHOT
+exec.additionalArguments=-Psonatype-oss-release -P development
+project.dev.us.codecraft\:webmagic-core=0.5.4-SNAPSHOT
+project.scm.us.codecraft\:webmagic-saxon.empty=true
+project.scm.us.codecraft\:webmagic-extension.empty=true
+scm.url=scm\:git\:git@github.com\:code4craft/webmagic.git
+scm.tagNameFormat=@{project.artifactId}-@{project.version}
+project.scm.us.codecraft\:webmagic-parent.url=git@github.com\:code4craft/webmagic.git
+preparationGoals=clean verify
+project.dev.us.codecraft\:webmagic-saxon=0.5.4-SNAPSHOT
+project.rel.us.codecraft\:webmagic-scripts=0.5.3
+project.scm.us.codecraft\:webmagic-core.empty=true
+project.scm.us.codecraft\:webmagic-parent.connection=scm\:git\:git@github.com\:code4craft/webmagic.git
+project.dev.us.codecraft\:webmagic-samples=0.5.4-SNAPSHOT
+exec.snapshotReleasePluginAllowed=false
+project.dev.us.codecraft\:webmagic-parent=0.5.4-SNAPSHOT
+project.scm.us.codecraft\:webmagic-samples.empty=true
+completedPhase=generate-release-poms
--- a/webmagic-core/pom.xml
+++ b/webmagic-core/pom.xml
@@ -3,7 +3,7 @@
    <parent>
        <groupId>us.codecraft</groupId>
        <artifactId>webmagic-parent</artifactId>
-        <version>0.5.3-SNAPSHOT</version>
+        <version>0.5.3</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>


--- a/webmagic-core/pom.xml.releaseBackup
+++ b/webmagic-core/pom.xml.releaseBackup
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>us.codecraft</groupId>
+        <artifactId>webmagic-parent</artifactId>
+        <version>0.5.3-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>webmagic-core</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>xsoup</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.github.dreamhead</groupId>
+            <artifactId>moco-core</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>commons-collections</groupId>
+            <artifactId>commons-collections</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.jsoup</groupId>
+            <artifactId>jsoup</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-io</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.jayway.jsonpath</groupId>
+            <artifactId>json-path</artifactId>
+            <version>0.8.1</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.alibaba</groupId>
+            <artifactId>fastjson</artifactId>
+        </dependency>
+
+    </dependencies>
+
+</project>
\ No newline at end of file
--- a/webmagic-core/src/main/java/us/codecraft/webmagic/Page.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/Page.java
@@ -56,8 +56,8 @@ public class Page {
    /**
     * store extract results
     *
-     * @param key
-     * @param field
+     * @param key key
+     * @param field field
     */
    public void putField(String key, Object field) {
        resultItems.put(key, field);
@@ -89,7 +89,7 @@ public class Page {
    }

    /**
-     * @param html
+     * @param html html
     * @deprecated since 0.4.0
     * The html is parse just when first time of calling {@link #getHtml()}, so use {@link #setRawText(String)} instead.
     */
@@ -104,7 +104,7 @@ public class Page {
    /**
     * add urls to fetch
     *
-     * @param requests
+     * @param requests requests
     */
    public void addTargetRequests(List<String> requests) {
        synchronized (targetRequests) {
@@ -121,7 +121,8 @@ public class Page {
    /**
     * add urls to fetch
     *
-     * @param requests
+     * @param requests requests
+     * @param priority priority
     */
    public void addTargetRequests(List<String> requests, long priority) {
        synchronized (targetRequests) {
@@ -138,7 +139,7 @@ public class Page {
    /**
     * add url to fetch
     *
-     * @param requestString
+     * @param requestString requestString
     */
    public void addTargetRequest(String requestString) {
        if (StringUtils.isBlank(requestString) || requestString.equals("#")) {
@@ -153,7 +154,7 @@ public class Page {
    /**
     * add requests to fetch
     *
-     * @param request
+     * @param request request
     */
    public void addTargetRequest(Request request) {
        synchronized (targetRequests) {

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/Request.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/Request.java
@@ -53,7 +53,7 @@ public class Request implements Serializable {
     * Need a scheduler supporting priority.<br>
     * @see us.codecraft.webmagic.scheduler.PriorityScheduler
     *
-     * @param priority
+     * @param priority priority
     * @return this
     */
    @Experimental

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/Site.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/Site.java
@@ -81,8 +81,8 @@ public class Site {
    /**
     * Add a cookie with domain {@link #getDomain()}
     *
-     * @param name
-     * @param value
+     * @param name name
+     * @param value value
     * @return this
     */
    public Site addCookie(String name, String value) {
@@ -93,9 +93,9 @@ public class Site {
    /**
     * Add a cookie with specific domain.
     *
-     * @param domain
-     * @param name
-     * @param value
+     * @param domain domain
+     * @param name name
+     * @param value value
     * @return
     */
    public Site addCookie(String domain, String name, String value) {
@@ -153,7 +153,7 @@ public class Site {
    /**
     * set the domain of site.
     *
-     * @param domain
+     * @param domain domain
     * @return this
     */
    public Site setDomain(String domain) {
@@ -165,7 +165,7 @@ public class Site {
     * Set charset of page manually.<br>
     * When charset is not set or set to null, it can be auto detected by Http header.
     *
-     * @param charset
+     * @param charset charset
     * @return this
     */
    public Site setCharset(String charset) {
@@ -189,7 +189,7 @@ public class Site {
    /**
     * set timeout for downloader in ms
     *
-     * @param timeOut
+     * @param timeOut timeOut
     */
    public Site setTimeOut(int timeOut) {
        this.timeOut = timeOut;
@@ -202,7 +202,7 @@ public class Site {
     * {200} by default.<br>
     * It is not necessarily to be set.<br>
     *
-     * @param acceptStatCode
+     * @param acceptStatCode acceptStatCode
     * @return this
     */
    public Site setAcceptStatCode(Set<Integer> acceptStatCode) {
@@ -239,7 +239,7 @@ public class Site {
     * Add a url to start url.<br>
     * Because urls are more a Spider's property than Site, move it to {@link Spider#addUrl(String...)}}
     *
-     * @param startUrl
+     * @param startUrl startUrl
     * @return this
     * @see Spider#addUrl(String...)
     * @deprecated
@@ -252,7 +252,7 @@ public class Site {
     * Add a url to start url.<br>
     * Because urls are more a Spider's property than Site, move it to {@link Spider#addRequest(Request...)}}
     *
-     * @param startRequest
+     * @param startRequest startRequest
     * @return this
     * @see Spider#addRequest(Request...)
     * @deprecated
@@ -269,7 +269,7 @@ public class Site {
     * Set the interval between the processing of two pages.<br>
     * Time unit is micro seconds.<br>
     *
-     * @param sleepTime
+     * @param sleepTime sleepTime
     * @return this
     */
    public Site setSleepTime(int sleepTime) {
@@ -349,7 +349,7 @@ public class Site {
    /**
     * set up httpProxy for this site
     *
-     * @param httpProxy
+     * @param httpProxy httpProxy
     * @return
     */
    public Site setHttpProxy(HttpHost httpProxy) {
@@ -368,7 +368,7 @@ public class Site {
    /**
     * Set retry sleep times when download fail, 1000 by default. <br>
     *
-     * @param retrySleepTime
+     * @param retrySleepTime retrySleepTime
     */
    public Site setRetrySleepTime(int retrySleepTime) {
        this.retrySleepTime = retrySleepTime;
@@ -379,7 +379,7 @@ public class Site {
     * Whether use gzip. <br>
     * Default is true, you can set it to false to disable gzip.
     *
-     * @param useGzip
+     * @param useGzip useGzip
     * @return
     */
    public Site setUseGzip(boolean useGzip) {

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java
@@ -111,7 +111,7 @@ public class Spider implements Runnable, Task {
    /**
     * create a spider with pageProcessor.
     *
-     * @param pageProcessor
+     * @param pageProcessor pageProcessor
     * @return new spider
     * @see PageProcessor
     */
@@ -122,7 +122,7 @@ public class Spider implements Runnable, Task {
    /**
     * create a spider with pageProcessor.
     *
-     * @param pageProcessor
+     * @param pageProcessor pageProcessor
     */
    public Spider(PageProcessor pageProcessor) {
        this.pageProcessor = pageProcessor;
@@ -134,7 +134,7 @@ public class Spider implements Runnable, Task {
     * Set startUrls of Spider.<br>
     * Prior to startUrls of Site.
     *
-     * @param startUrls
+     * @param startUrls startUrls
     * @return this
     */
    public Spider startUrls(List<String> startUrls) {
@@ -147,7 +147,7 @@ public class Spider implements Runnable, Task {
     * Set startUrls of Spider.<br>
     * Prior to startUrls of Site.
     *
-     * @param startRequests
+     * @param startRequests startRequests
     * @return this
     */
    public Spider startRequest(List<Request> startRequests) {
@@ -160,7 +160,7 @@ public class Spider implements Runnable, Task {
     * Set an uuid for spider.<br>
     * Default uuid is domain of site.<br>
     *
-     * @param uuid
+     * @param uuid uuid
     * @return this
     */
    public Spider setUUID(String uuid) {
@@ -171,7 +171,7 @@ public class Spider implements Runnable, Task {
    /**
     * set scheduler for Spider
     *
-     * @param scheduler
+     * @param scheduler scheduler
     * @return this
     * @Deprecated
     * @see #setScheduler(us.codecraft.webmagic.scheduler.Scheduler)
@@ -183,7 +183,7 @@ public class Spider implements Runnable, Task {
    /**
     * set scheduler for Spider
     *
-     * @param scheduler
+     * @param scheduler scheduler
     * @return this
     * @see Scheduler
     * @since 0.2.1
@@ -204,7 +204,7 @@ public class Spider implements Runnable, Task {
    /**
     * add a pipeline for Spider
     *
-     * @param pipeline
+     * @param pipeline pipeline
     * @return this
     * @see #addPipeline(us.codecraft.webmagic.pipeline.Pipeline)
     * @deprecated
@@ -216,7 +216,7 @@ public class Spider implements Runnable, Task {
    /**
     * add a pipeline for Spider
     *
-     * @param pipeline
+     * @param pipeline pipeline
     * @return this
     * @see Pipeline
     * @since 0.2.1
@@ -230,7 +230,7 @@ public class Spider implements Runnable, Task {
    /**
     * set pipelines for Spider
     *
-     * @param pipelines
+     * @param pipelines pipelines
     * @return this
     * @see Pipeline
     * @since 0.4.1
@@ -254,7 +254,7 @@ public class Spider implements Runnable, Task {
    /**
     * set the downloader of spider
     *
-     * @param downloader
+     * @param downloader downloader
     * @return this
     * @see #setDownloader(us.codecraft.webmagic.downloader.Downloader)
     * @deprecated
@@ -266,7 +266,7 @@ public class Spider implements Runnable, Task {
    /**
     * set the downloader of spider
     *
-     * @param downloader
+     * @param downloader downloader
     * @return this
     * @see Downloader
     */
@@ -468,7 +468,7 @@ public class Spider implements Runnable, Task {
    /**
     * Add urls to crawl. <br/>
     *
-     * @param urls
+     * @param urls urls
     * @return
     */
    public Spider addUrl(String... urls) {
@@ -482,7 +482,7 @@ public class Spider implements Runnable, Task {
    /**
     * Download urls synchronizing.
     *
-     * @param urls
+     * @param urls urls
     * @return
     */
    public <T> List<T> getAll(Collection<String> urls) {
@@ -517,7 +517,7 @@ public class Spider implements Runnable, Task {
    /**
     * Add urls with information to crawl.<br/>
     *
-     * @param requests
+     * @param requests requests
     * @return
     */
    public Spider addRequest(Request... requests) {
@@ -567,7 +567,7 @@ public class Spider implements Runnable, Task {
    /**
     * start with more than one threads
     *
-     * @param threadNum
+     * @param threadNum threadNum
     * @return this
     */
    public Spider thread(int threadNum) {
@@ -582,7 +582,7 @@ public class Spider implements Runnable, Task {
    /**
     * start with more than one threads
     *
-     * @param threadNum
+     * @param threadNum threadNum
     * @return this
     */
    public Spider thread(ExecutorService executorService, int threadNum) {
@@ -603,7 +603,7 @@ public class Spider implements Runnable, Task {
     * True: exit when all url of the site is downloaded. <br/>
     * False: not exit until call stop() manually.<br/>
     *
-     * @param exitWhenComplete
+     * @param exitWhenComplete exitWhenComplete
     * @return
     */
    public Spider setExitWhenComplete(boolean exitWhenComplete) {
@@ -679,7 +679,7 @@ public class Spider implements Runnable, Task {
     * Add urls to download when it is true, and just download seed urls when it is false. <br>
     * DO NOT set it unless you know what it means!
     *
-     * @param spawnUrl
+     * @param spawnUrl spawnUrl
     * @return
     * @since 0.4.0
     */

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/downloader/AbstractDownloader.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/downloader/AbstractDownloader.java
@@ -16,7 +16,7 @@ public abstract class AbstractDownloader implements Downloader {
    /**
     * A simple method to download a url.
     *
-     * @param url
+     * @param url url
     * @return html
     */
    public Html download(String url) {
@@ -26,7 +26,8 @@ public abstract class AbstractDownloader implements Downloader {
    /**
     * A simple method to download a url.
     *
-     * @param url
+     * @param url url
+     * @param charset charset
     * @return html
     */
    public Html download(String url, String charset) {

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/downloader/Downloader.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/downloader/Downloader.java
@@ -17,8 +17,8 @@ public interface Downloader {
    /**
     * Downloads web pages and store in Page object.
     *
-     * @param request
-     * @param task
+     * @param request request
+     * @param task task
     * @return page
     */
    public Page download(Request request, Task task);

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/pipeline/Pipeline.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/pipeline/Pipeline.java
@@ -17,8 +17,8 @@ public interface Pipeline {
    /**
     * Process extracted results.
     *
-     * @param resultItems
-     * @param task
+     * @param resultItems resultItems
+     * @param task task
     */
    public void process(ResultItems resultItems, Task task);
 }
--- a/webmagic-core/src/main/java/us/codecraft/webmagic/processor/PageProcessor.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/processor/PageProcessor.java
@@ -22,7 +22,7 @@ public interface PageProcessor {
    /**
     * process the page, extract urls to fetch, extract the data and store
     *
-     * @param page
+     * @param page page
     */
    public void process(Page page);


--- a/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/Scheduler.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/Scheduler.java
@@ -17,8 +17,8 @@ public interface Scheduler {
    /**
     * add a url to fetch
     *
-     * @param request
-     * @param task
+     * @param request request
+     * @param task task
     */
    public void push(Request request, Task task);


--- a/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/component/DuplicateRemover.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/component/DuplicateRemover.java
@@ -13,21 +13,21 @@ public interface DuplicateRemover {
     *
     * Check whether the request is duplicate.
     *
-     * @param request
-     * @param task
+     * @param request request
+     * @param task task
     * @return
     */
    public boolean isDuplicate(Request request, Task task);

    /**
     * Reset duplicate check.
-     * @param task
+     * @param task task
     */
    public void resetDuplicateCheck(Task task);

    /**
     * Get TotalRequestsCount for monitor.
-     * @param task
+     * @param task task
     * @return
     */
    public int getTotalRequestsCount(Task task);

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/ElementSelector.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/ElementSelector.java
@@ -16,7 +16,7 @@ public interface ElementSelector {
     * Extract single result in text.<br>
     * If there are more than one result, only the first will be chosen.
     *
-     * @param element
+     * @param element element
     * @return result
     */
    public String select(Element element);
@@ -24,7 +24,7 @@ public interface ElementSelector {
    /**
     * Extract all results in text.<br>
     *
-     * @param element
+     * @param element element
     * @return results
     */
    public List<String> selectList(Element element);

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java
@@ -68,7 +68,7 @@ public class Html extends HtmlNode {
    }

    /**
-     * @param selector
+     * @param selector selector
     * @return
     */
    public String selectDocument(Selector selector) {

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/HtmlNode.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/HtmlNode.java
@@ -59,7 +59,7 @@ public class HtmlNode extends AbstractSelectable {
    /**
     * select elements
     *
-     * @param elementSelector
+     * @param elementSelector elementSelector
     * @return
     */
    protected Selectable selectElements(BaseElementSelector elementSelector) {
@@ -89,8 +89,8 @@ public class HtmlNode extends AbstractSelectable {
     * Only document can be select
     * See: https://github.com/code4craft/webmagic/issues/113
     *
-     * @param elementIterator
-     * @param element
+     * @param elementIterator elementIterator
+     * @param element element
     */
    private Element checkElementAndConvert(ListIterator<Element> elementIterator) {
        Element element = elementIterator.next();

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Json.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Json.java
@@ -22,7 +22,7 @@ public class Json extends PlainText {

    /**
     * remove padding for JSONP
-     * @param padding
+     * @param padding padding
     * @return
     */
    public Json removePadding(String padding) {

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectable.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectable.java
@@ -13,7 +13,7 @@ public interface Selectable {
    /**
     * select list with xpath
     *
-     * @param xpath
+     * @param xpath xpath
     * @return new Selectable after extract
     */
    public Selectable xpath(String xpath);
@@ -69,7 +69,7 @@ public interface Selectable {
    /**
     * select list with regex, default group is group 1
     *
-     * @param regex
+     * @param regex regex
     * @return new Selectable after extract
     */
    public Selectable regex(String regex);
@@ -77,8 +77,8 @@ public interface Selectable {
    /**
     * select list with regex
     *
-     * @param regex
-     * @param group
+     * @param regex regex
+     * @param group group
     * @return new Selectable after extract
     */
    public Selectable regex(String regex, int group);
@@ -86,8 +86,8 @@ public interface Selectable {
    /**
     * replace with regex
     *
-     * @param regex
-     * @param replacement
+     * @param regex regex
+     * @param replacement replacement
     * @return new Selectable after extract
     */
    public Selectable replace(String regex, String replacement);
@@ -123,7 +123,7 @@ public interface Selectable {
    /**
     * extract by JSON Path expression
     *
-     * @param jsonPath
+     * @param jsonPath jsonPath
     * @return
     */
    public Selectable jsonPath(String jsonPath);
@@ -131,7 +131,7 @@ public interface Selectable {
    /**
     * extract by custom selector
     *
-     * @param selector
+     * @param selector selector
     * @return
     */
    public Selectable select(Selector selector);
@@ -139,7 +139,7 @@ public interface Selectable {
    /**
     * extract by custom selector
     *
-     * @param selector
+     * @param selector selector
     * @return
     */
    public Selectable selectList(Selector selector);

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selector.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selector.java
@@ -14,7 +14,7 @@ public interface Selector {
     * Extract single result in text.<br>
     * If there are more than one result, only the first will be chosen.
     *
-     * @param text
+     * @param text text
     * @return result
     */
    public String select(String text);
@@ -22,7 +22,7 @@ public interface Selector {
    /**
     * Extract all results in text.<br>
     *
-     * @param text
+     * @param text text
     * @return results
     */
    public List<String> selectList(String text);

--- a/webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java
+++ b/webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java
@@ -25,8 +25,8 @@ public class UrlUtils {
     * <p/>
     * Borrowed from Jsoup.
     *
-     * @param url
-     * @param refer
+     * @param url url
+     * @param refer refer
     * @return canonicalizeUrl
     */
    public static String canonicalizeUrl(String url, String refer) {
@@ -51,7 +51,7 @@ public class UrlUtils {

    /**
     *
-     * @param url
+     * @param url url
     * @return
     */
    public static String encodeIllegalCharacterInUrl(String url) {

--- a/webmagic-extension/pom.xml
+++ b/webmagic-extension/pom.xml
@@ -3,7 +3,7 @@
    <parent>
        <groupId>us.codecraft</groupId>
        <artifactId>webmagic-parent</artifactId>
-        <version>0.5.3-SNAPSHOT</version>
+        <version>0.5.3</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>


--- a/webmagic-extension/pom.xml.releaseBackup
+++ b/webmagic-extension/pom.xml.releaseBackup
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>us.codecraft</groupId>
+        <artifactId>webmagic-parent</artifactId>
+        <version>0.5.3-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>webmagic-extension</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>redis.clients</groupId>
+            <artifactId>jedis</artifactId>
+            <version>2.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>webmagic-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>
\ No newline at end of file
--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/MultiPageModel.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/MultiPageModel.java
@@ -38,7 +38,7 @@ public interface MultiPageModel {
    /**
     * Combine multiPageModels to a whole object.
     *
-     * @param multiPageModel
+     * @param multiPageModel multiPageModel
     * @return multiPageModel combined
     */
    public MultiPageModel combine(MultiPageModel multiPageModel);

--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/RequestMatcher.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/RequestMatcher.java
@@ -12,7 +12,7 @@ public interface RequestMatcher {
     * Check whether to process the page.<br></br>
     * Please DO NOT change page status in this method.
     *
-     * @param page
+     * @param page page
     *
     * @return
     */

--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/SubPageProcessor.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/SubPageProcessor.java
@@ -11,7 +11,7 @@ public interface SubPageProcessor extends RequestMatcher {
 	/**
 	 * process the page, extract urls to fetch, extract the data and store
 	 *
-	 * @param page
+	 * @param page page
 	 *
 	 * @return whether continue to match
 	 */

--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/SubPipeline.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/SubPipeline.java
@@ -12,8 +12,8 @@ public interface SubPipeline extends RequestMatcher {
    /**
     * process the page, extract urls to fetch, extract the data and store
     *
-     * @param page
-     * @param task
+     * @param page page
+     * @param task task
     * @return whether continue to match
     */
    public MatchOther processResult(ResultItems resultItems, Task task);

--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/model/OOSpider.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/model/OOSpider.java
@@ -60,9 +60,9 @@ public class OOSpider<T> extends Spider {
    /**
     * create a spider
     *
-     * @param site
-     * @param pageModelPipeline
-     * @param pageModels
+     * @param site site
+     * @param pageModelPipeline pageModelPipeline
+     * @param pageModels pageModels
     */
    public OOSpider(Site site, PageModelPipeline pageModelPipeline, Class... pageModels) {
        this(ModelPageProcessor.create(site, pageModels));

--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/monitor/SpiderMonitor.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/monitor/SpiderMonitor.java
@@ -42,7 +42,7 @@ public class SpiderMonitor {
    /**
     * Register spider for monitor.
     *
-     * @param spiders
+     * @param spiders spiders
     * @return
     */
    public synchronized SpiderMonitor register(Spider... spiders) throws JMException {

--- a/webmagic-extension/src/main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java
+++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/utils/DoubleKeyMap.java
@@ -30,7 +30,7 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
    /**
     * init map with protoMapClass
     *
-     * @param protoMapClass
+     * @param protoMapClass protoMapClass
     */
    @SuppressWarnings("rawtypes")
    public DoubleKeyMap(Map<K1, Map<K2, V>> map, Class<? extends Map> protoMapClass) {
@@ -40,7 +40,7 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
    }

    /**
-     * @param key
+     * @param key key
     * @return map
     */
    public Map<K2, V> get(K1 key) {
@@ -48,8 +48,8 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
    }

    /**
-     * @param key1
-     * @param key2
+     * @param key1 key1
+     * @param key2 key2
     * @return value
     */
    public V get(K1 key1, K2 key2) {
@@ -61,8 +61,8 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {


    /**
-     * @param key1
-     * @param submap
+     * @param key1 key1
+     * @param submap submap
     * @return value
     */
    public V put(K1 key1, Map<K2, V> submap) {
@@ -70,9 +70,9 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
    }

    /**
-     * @param key1
-     * @param key2
-     * @param value
+     * @param key1 key1
+     * @param key2 key2
+     * @param value value
     * @return value
     */
    public synchronized V put(K1 key1, K2 key2, V value) {
@@ -84,8 +84,8 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
    }

    /**
-     * @param key1
-     * @param key2
+     * @param key1 key1
+     * @param key2 key2
     * @return value
     */
    public synchronized V remove(K1 key1, K2 key2) {
@@ -100,7 +100,7 @@ public class DoubleKeyMap<K1, K2, V> extends MultiKeyMapBase {
    }

    /**
-     * @param key1
+     * @param key1 key1
     * @return
     */
    public Map<K2, V> remove(K1 key1) {

--- a/webmagic-samples/pom.xml
+++ b/webmagic-samples/pom.xml
@@ -3,7 +3,7 @@
    <parent>
        <artifactId>webmagic-parent</artifactId>
        <groupId>us.codecraft</groupId>
-        <version>0.5.3-SNAPSHOT</version>
+        <version>0.5.3</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>


--- a/webmagic-samples/pom.xml.releaseBackup
+++ b/webmagic-samples/pom.xml.releaseBackup
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>webmagic-parent</artifactId>
+        <groupId>us.codecraft</groupId>
+        <version>0.5.3-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>webmagic-samples</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>webmagic-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>webmagic-extension</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>copy-dependencies</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>copy-dependencies</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>${project.build.directory}/lib</outputDirectory>
+                            <overWriteReleases>false</overWriteReleases>
+                            <overWriteSnapshots>false</overWriteSnapshots>
+                            <overWriteIfNewer>true</overWriteIfNewer>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>2.4</version>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <addClasspath>true</addClasspath>
+                            <classpathPrefix>./lib/</classpathPrefix>
+                            <mainClass>us.codecraft.webmagic.main.QuickStarter</mainClass>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
--- a/webmagic-saxon/pom.xml
+++ b/webmagic-saxon/pom.xml
@@ -3,7 +3,7 @@
    <parent>
        <artifactId>webmagic-parent</artifactId>
        <groupId>us.codecraft</groupId>
-        <version>0.5.3-SNAPSHOT</version>
+        <version>0.5.3</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>


--- a/webmagic-saxon/pom.xml.releaseBackup
+++ b/webmagic-saxon/pom.xml.releaseBackup
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>webmagic-parent</artifactId>
+        <groupId>us.codecraft</groupId>
+        <version>0.5.3-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>webmagic-saxon</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>webmagic-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>net.sourceforge.htmlcleaner</groupId>
+            <artifactId>htmlcleaner</artifactId>
+            <version>2.5</version>
+        </dependency>
+        <dependency>
+            <groupId>net.sf.saxon</groupId>
+            <artifactId>Saxon-HE</artifactId>
+            <version>9.5.1-1</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <configuration>
+                    <skip>true</skip>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
\ No newline at end of file
--- a/webmagic-scripts/pom.xml
+++ b/webmagic-scripts/pom.xml
@@ -3,7 +3,7 @@
    <parent>
        <artifactId>webmagic-parent</artifactId>
        <groupId>us.codecraft</groupId>
-        <version>0.5.3-SNAPSHOT</version>
+        <version>0.5.3</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>


--- a/webmagic-scripts/pom.xml.releaseBackup
+++ b/webmagic-scripts/pom.xml.releaseBackup
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>webmagic-parent</artifactId>
+        <groupId>us.codecraft</groupId>
+        <version>0.5.3-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>us.codecraft</groupId>
+    <artifactId>webmagic-scripts</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.jruby</groupId>
+            <artifactId>jruby</artifactId>
+            <version>1.7.6</version>
+        </dependency>
+        <dependency><groupId>org.python</groupId>
+            <artifactId>jython</artifactId>
+            <version>2.5.3</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-cli</groupId>
+            <artifactId>commons-cli</artifactId>
+            <version>1.2</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>webmagic-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>us.codecraft</groupId>
+            <artifactId>webmagic-extension</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                    <encoding>UTF-8</encoding>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-resources-plugin</artifactId>
+                <configuration>
+                    <encoding>UTF-8</encoding>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <addClasspath>true</addClasspath>
+                            <classpathPrefix>./lib/</classpathPrefix>
+                            <mainClass>us.codecraft.webmagic.scripts.ScriptConsole</mainClass>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+
+</project>
\ No newline at end of file
--- a/webmagic-selenium/pom.xml
+++ b/webmagic-selenium/pom.xml
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<parent>
 		<artifactId>webmagic-parent</artifactId>
 		<groupId>us.codecraft</groupId>
-		<version>0.5.3-SNAPSHOT</version>
+		<version>0.5.3</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>


--- a/webmagic-selenium/pom.xml.releaseBackup
+++ b/webmagic-selenium/pom.xml.releaseBackup
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<parent>
+		<artifactId>webmagic-parent</artifactId>
+		<groupId>us.codecraft</groupId>
+		<version>0.5.3-SNAPSHOT</version>
+	</parent>
+	<modelVersion>4.0.0</modelVersion>
+
+	<artifactId>webmagic-selenium</artifactId>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.seleniumhq.selenium</groupId>
+			<artifactId>selenium-java</artifactId>
+			<version>2.46.0</version>
+		</dependency>
+		<dependency>
+			<groupId>us.codecraft</groupId>
+			<artifactId>webmagic-core</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>com.github.detro</groupId>
+			<artifactId>phantomjsdriver</artifactId>
+			<version>1.2.0</version>
+		</dependency>
+
+
+
+		<dependency>
+			<groupId>junit</groupId>
+			<artifactId>junit</artifactId>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<plugins>
+			<plugin>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<configuration>
+					<skip>true</skip>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
+
+</project>
\ No newline at end of file
--- a/webmagic-selenium/src/main/java/us/codecraft/webmagic/downloader/selenium/SeleniumDownloader.java
+++ b/webmagic-selenium/src/main/java/us/codecraft/webmagic/downloader/selenium/SeleniumDownloader.java
@@ -42,7 +42,7 @@ public class SeleniumDownloader implements Downloader, Closeable {
 	/**
 	 * 新建
 	 *
-	 * @param chromeDriverPath
+	 * @param chromeDriverPath chromeDriverPath
 	 */
 	public SeleniumDownloader(String chromeDriverPath) {
 		System.getProperties().setProperty("webdriver.chrome.driver",
@@ -62,7 +62,7 @@ public class SeleniumDownloader implements Downloader, Closeable {
 	/**
 	 * set sleep time to wait until load success
 	 *
-	 * @param sleepTime
+	 * @param sleepTime sleepTime
 	 * @return this
 	 */
 	public SeleniumDownloader setSleepTime(int sleepTime) {

--- a/webmagic-selenium/src/main/java/us/codecraft/webmagic/downloader/selenium/WebDriverPool.java
+++ b/webmagic-selenium/src/main/java/us/codecraft/webmagic/downloader/selenium/WebDriverPool.java
@@ -141,7 +141,7 @@ class WebDriverPool {
 	 * check whether input is a valid URL
 	 * 
 	 * @author bob.li.0718@gmail.com
-	 * @param urlString
+	 * @param urlString urlString
 	 * @return true means yes, otherwise no.
 	 */
 	private boolean isUrl(String urlString) {