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 46f5667..0fd770d 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/Spider.java @@ -518,7 +518,7 @@ public class Spider implements Runnable, Task { * Add urls with information to crawl.
* * @param requests requests - * @return + * @return this */ public Spider addRequest(Request... requests) { for (Request request : requests) { @@ -730,7 +730,7 @@ public class Spider implements Runnable, Task { } /** - * Set wait time when no url is polled.

+ * Set wait time when no url is polled.

* * @param emptySleepTime In MILLISECONDS. */ diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/DuplicateRemovedScheduler.java b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/DuplicateRemovedScheduler.java index b14d8ee..9be7adb 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/DuplicateRemovedScheduler.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/scheduler/DuplicateRemovedScheduler.java @@ -8,7 +8,7 @@ import us.codecraft.webmagic.scheduler.component.DuplicateRemover; import us.codecraft.webmagic.scheduler.component.HashSetDuplicateRemover; /** - * Remove duplicate urls and only push urls which are not duplicate.

+ * Remove duplicate urls and only push urls which are not duplicate.

* * @author code4crafer@gmail.com * @since 0.5.0 diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java index d8d5d8d..d80e8b4 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Html.java @@ -69,7 +69,7 @@ public class Html extends HtmlNode { /** * @param selector selector - * @return + * @return result */ public String selectDocument(Selector selector) { if (selector instanceof ElementSelector) { diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/HtmlNode.java b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/HtmlNode.java index 3472eb6..030522f 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/HtmlNode.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/HtmlNode.java @@ -60,7 +60,7 @@ public class HtmlNode extends AbstractSelectable { * select elements * * @param elementSelector elementSelector - * @return + * @return result */ protected Selectable selectElements(BaseElementSelector elementSelector) { ListIterator elementIterator = getElements().listIterator(); diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectors.java b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectors.java index 96beedb..f63841b 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectors.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/selector/Selectors.java @@ -35,6 +35,7 @@ public abstract class Selectors { /** * @Deprecated * @see #xpath(String) + * @param expr expr * @return new selector */ public static XpathSelector xsoup(String expr) { diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/thread/CountableThreadPool.java b/webmagic-core/src/main/java/us/codecraft/webmagic/thread/CountableThreadPool.java index 9b7d894..5d64796 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/thread/CountableThreadPool.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/thread/CountableThreadPool.java @@ -7,10 +7,10 @@ import java.util.concurrent.locks.Condition; import java.util.concurrent.locks.ReentrantLock; /** - * Thread pool for workers.

- * Use {@link java.util.concurrent.ExecutorService} as inner implement.

- * New feature:

- * 1. Block when thread pool is full to avoid poll many urls without process.

+ * Thread pool for workers.

+ * Use {@link java.util.concurrent.ExecutorService} as inner implement.

+ * New feature:

+ * 1. Block when thread pool is full to avoid poll many urls without process.

* 2. Count of thread alive for monitor. * * @author code4crafer@gmail.com diff --git a/webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java b/webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java index 511dd93..9f66f73 100644 --- a/webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java +++ b/webmagic-core/src/main/java/us/codecraft/webmagic/utils/UrlUtils.java @@ -52,7 +52,7 @@ public class UrlUtils { /** * * @param url url - * @return + * @return new url */ public static String encodeIllegalCharacterInUrl(String url) { //TODO more charator support diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/PatternRequestMatcher.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/PatternRequestMatcher.java index 9201a4c..1be61a8 100644 --- a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/PatternRequestMatcher.java +++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/PatternRequestMatcher.java @@ -9,7 +9,7 @@ import java.util.regex.Pattern; * User: Sebastian MA * Date: April 03, 2014 * Time: 10:00 - *

+ *

* A PatternHandler is in charge of both page extraction and data processing by implementing * its two abstract methods. */ diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/RequestMatcher.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/RequestMatcher.java index 7501237..7d351a4 100644 --- a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/RequestMatcher.java +++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/RequestMatcher.java @@ -9,12 +9,12 @@ import us.codecraft.webmagic.Request; public interface RequestMatcher { /** - * Check whether to process the page.

+ * Check whether to process the page.

* Please DO NOT change page status in this method. * * @param page page * - * @return + * @return whether matches */ public boolean match(Request page); diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/SubPipeline.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/handler/SubPipeline.java index 23bc065..027c5b5 100644 --- 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,7 +12,7 @@ public interface SubPipeline extends RequestMatcher { /** * process the page, extract urls to fetch, extract the data and store * - * @param page page + * @param resultItems resultItems * @param task task * @return whether continue to match */ diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/model/OOSpider.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/model/OOSpider.java index 96d7420..08dc64a 100644 --- a/webmagic-extension/src/main/java/us/codecraft/webmagic/model/OOSpider.java +++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/model/OOSpider.java @@ -25,7 +25,7 @@ import java.util.List; * private String content; * * {@literal @}ExtractBy(value = "//div[@class='BlogTags']/a/text()", multi = true) - * private List tags; + * private List<String> tags; * } * * And start the spider by: diff --git a/webmagic-extension/src/main/java/us/codecraft/webmagic/monitor/SpiderMonitor.java b/webmagic-extension/src/main/java/us/codecraft/webmagic/monitor/SpiderMonitor.java index 2271c22..55472f1 100644 --- a/webmagic-extension/src/main/java/us/codecraft/webmagic/monitor/SpiderMonitor.java +++ b/webmagic-extension/src/main/java/us/codecraft/webmagic/monitor/SpiderMonitor.java @@ -43,7 +43,7 @@ public class SpiderMonitor { * Register spider for monitor. * * @param spiders spiders - * @return + * @return this */ public synchronized SpiderMonitor register(Spider... spiders) throws JMException { for (Spider spider : spiders) { 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 61dcd37..9e83b6d 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 @@ -30,6 +30,7 @@ public class DoubleKeyMap extends MultiKeyMapBase { /** * init map with protoMapClass * + * @param map the origin map to contains the DoubleKeyMap * @param protoMapClass protoMapClass */ @SuppressWarnings("rawtypes")