Skip to content

Commit

Permalink
整理javadoc,去除错误和警告
Browse files Browse the repository at this point in the history
  • Loading branch information
xtuhcy committed Nov 3, 2016
1 parent 8127c14 commit a10893c
Show file tree
Hide file tree
Showing 15 changed files with 72 additions and 77 deletions.
4 changes: 2 additions & 2 deletions src/main/java/com/geccocrawler/gecco/GeccoEngine.java
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ private GeccoEngine() {
/**
* 动态配置规则不能使用该方法构造GeccoEngine
*
* @return
* @return GeccoEngine
*/
public static GeccoEngine create() {
GeccoEngine geccoEngine = new GeccoEngine();
Expand Down Expand Up @@ -363,7 +363,7 @@ public void closeUnitlComplete() {
/**
* 启动引擎,并返回GeccoEngine对象
*
* @return
* @return GeccoEngine
*/
public GeccoEngine engineStart() {
start();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/**
* 下载器名称
*
* @return
* @return 下载器名称
*/
String value();

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/geccocrawler/gecco/annotation/Gecco.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
/**
* 下载超时时间
*
* @return
* @return 下载超时时间
*/
int timeout() default 3000;

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/geccocrawler/gecco/annotation/Html.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* </pre>
*
* @author LiuJunGuang
* @return
* @return 是否取外部Html
*/
public boolean outer() default false;
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ protected String getCharset(String requestCharset, String contentType) {
/**
* 将原始的inputStream转换为ByteArrayInputStream使raw可以重复使用
*
* @param in
* @return
* @param in 原始的inputStream
* @return 可以重复使用的ByteArrayInputStream
*/
protected ByteArrayInputStream toByteInputStream(InputStream in) {
ByteArrayInputStream bis = null;
Expand Down
15 changes: 8 additions & 7 deletions src/main/java/com/geccocrawler/gecco/dynamic/DynamicBean.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ public interface DynamicBean {
/**
* 由于有歧义,已经被existField代替
*
* @param fieldName
* @return
* @param fieldName 字段名称
* @return DynamicField
*/
@Deprecated
public DynamicField field(String fieldName);
Expand All @@ -53,7 +53,7 @@ public interface DynamicBean {
*
* @param fieldName 字段名称
* @param fieldType 字段类型
* @return
* @return DynamicField
*/
public DynamicField field(String fieldName, CtClass fieldType);

Expand All @@ -62,7 +62,8 @@ public interface DynamicBean {
/**
* 删除一个属性
*
* @param fieldName
* @param fieldName 字段名
* @return DynamicBean
*/
public DynamicBean removeField(String fieldName);

Expand Down Expand Up @@ -127,14 +128,14 @@ public interface DynamicBean {
* 将加载的bean注册到爬虫引擎中。
* 主要应用在先定义Bean后期的爬虫引擎的情况。
*
* @return
* @return spiderBeanClass
*/
public Class<?> register();

/**
* 加载bean到classloader中
*
* @return
* @return spiderBeanClass
*/
public Class<?> loadClass();

Expand All @@ -146,7 +147,7 @@ public interface DynamicBean {
/**
* Constant pool table.
*
* @return
* @return ConstPool
*/
public ConstPool getConstPool();
}
14 changes: 8 additions & 6 deletions src/main/java/com/geccocrawler/gecco/dynamic/DynamicField.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@

public interface DynamicField {

/**
* 动态生成属性注解
*
* @return
*/
public DynamicField request();
/**
* 动态生成属性注解
*
* @return DynamicField
*/
public DynamicField request();

public DynamicField requestParameter(String param);

public DynamicField requestParameter();

/**
* replace by csspath
* @param cssPath cssPath
* @return DynamicField
*/
@Deprecated
public DynamicField htmlField(String cssPath);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public class GeccoClassLoader extends ClassLoader {

/**
* 创建一个新的GeccoClassLoader
* @return
* @return GeccoClassLoader
*/
public static synchronized GeccoClassLoader create() {
if(instance != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ public JavassistDynamicBean(String spiderBeanName) {
* 名称
* @param beanType
* 类型html/json
* @param create
* 是否新建类和属性。true表示创建写的类和属性已经setter/getter方法,false表示只动态生成注解
*/
public JavassistDynamicBean(String spiderBeanName, String beanType) {
try {
Expand Down
78 changes: 39 additions & 39 deletions src/main/java/com/geccocrawler/gecco/listener/EventListener.java
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
package com.geccocrawler.gecco.listener;

import com.geccocrawler.gecco.GeccoEngine;

/**
* 爬虫引擎生命周期监听器
*
* @author LiuJunGuang
*/
public interface EventListener {

/**
* 开始启动时,回调
*
* @param ge
*/
public void onStart(GeccoEngine ge);

/**
* 暂停时,回调
*
* @param ge
*/
public void onPause(GeccoEngine ge);

/**
* 恢复抓取时,回调
*
* @param ge
*/
public void onRestart(GeccoEngine ge);

/**
* 引擎停止时,回调
*
* @param ge
*/
public void onStop(GeccoEngine ge);
}
package com.geccocrawler.gecco.listener;

import com.geccocrawler.gecco.GeccoEngine;

/**
* 爬虫引擎生命周期监听器
*
* @author LiuJunGuang
*/
public interface EventListener {

/**
* 开始启动时,回调
*
* @param ge GeccoEngine
*/
public void onStart(GeccoEngine ge);

/**
* 暂停时,回调
*
* @param ge GeccoEngine
*/
public void onPause(GeccoEngine ge);

/**
* 恢复抓取时,回调
*
* @param ge GeccoEngine
*/
public void onRestart(GeccoEngine ge);

/**
* 引擎停止时,回调
*
* @param ge GeccoEngine
*/
public void onStop(GeccoEngine ge);
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ public static Map<String, DownloadStatistics> getStatistics() {
/**
* 双重检查机制锁
*
* @param host
* @return
* @param host host
* @return DownloadStatistics
*/
public static DownloadStatistics getStatistics(String host) {
DownloadStatistics downloadStatistics = statistics.get(host);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,7 @@
import net.sf.cglib.beans.BeanMap;

/**
* <LI>java.lang.Boolean objects</LI>
* <LI>java.lang.String objects</LI>
* <LI>java.lang.Number objects</LI>
* <LI>org.mozilla.javascript.Scriptable objects</LI>
* <LI>null</LI>
* <LI>The value returned by Context.getUndefinedValue()</LI>
* <LI>NOT_FOUND</LI>
* 解析页面中的javascript变量
*
* @author huchengyi
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public class DownloadImage {
*
* @param parentPath 指定目录
* @param imgUrl 图片地址
* @return
* @return 下载文件地址
*/
public static String download(String parentPath, String imgUrl) {
if(Strings.isNullOrEmpty(imgUrl) || Strings.isNullOrEmpty(parentPath)) {
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/geccocrawler/gecco/utils/ReflectUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class ReflectUtils {
/**
* 获得类的所有基类和接口
*
* @param clazz
* @param clazz
* @return 所有基类的集合
*/
public static Set<Class<?>> getAllSuperType(Class clazz) {
Expand Down Expand Up @@ -50,8 +50,8 @@ public static boolean haveSuperType(Class childClazz, Class superClazz) {
/**
* 是否继承某个基类
*
* @param bean
* @param superClazz
* @param bean 需要判断的对象bean
* @param superClazz 基类
* @return 是否继承某个基类
*/
public static boolean haveSuperType(Object bean, Class superClazz) {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/geccocrawler/gecco/utils/UrlUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ public class UrlUtils {
* 相对地址转绝对地址
*
* @param absolutePath 当前绝对地址
* @param relativeUrl 相对地址
* @return
* @param relativePath 相对地址
* @return 绝对地址
*/
public static String relative2Absolute(String absolutePath, String relativePath) {
if(relativePath == null) {
Expand Down

0 comments on commit a10893c

Please sign in to comment.