更新下注释说明

ablecao · ablecao · commit 7e2dbe4afe9e · 2018-08-21T16:51:17.000+08:00
diff --git a/src/main/java/com/tencent/xinge/bean/AtyAttr.java b/src/main/java/com/tencent/xinge/bean/AtyAttr.java
@@ -2,15 +2,17 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModelProperty;
 
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class AtyAttr {
 
     @JsonProperty(value = "if", required = true, defaultValue = "0")
+    @ApiModelProperty(notes = "Intent的Flag属性")
     private int atyAttrIntentFlag = 0;
 
-
     @JsonProperty(value = "pf", required = true, defaultValue = "0")
+    @ApiModelProperty(notes = "PendingIntent的Flag属性")
     private int atyAttrPendingIntentFlag = 0;
 
     public int getIf() {
diff --git a/src/main/java/com/tencent/xinge/bean/Browser.java b/src/main/java/com/tencent/xinge/bean/Browser.java
@@ -2,14 +2,17 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModelProperty;
 
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class Browser {
 
     @JsonProperty(value = "url", required = true)
+    @ApiModelProperty(notes = "仅支持http、https")
     private String url="";
 
     @JsonProperty(value = "confirm", required = true)
+    @ApiModelProperty(notes = "是否需要用户确认")
     private int confirm;
 
     public String getUrl() {
diff --git a/src/main/java/com/tencent/xinge/bean/ClickAction.java b/src/main/java/com/tencent/xinge/bean/ClickAction.java
@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.annotations.ApiModelProperty;
 import org.json.JSONObject;
 
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -12,6 +13,7 @@ public class ClickAction {
     public static final int TYPE_INTENT = 3;
 
     @JsonProperty(value = "action_type", required = true, defaultValue = "1")
+    @ApiModelProperty(notes = "动作类型，1，打开activity或app本身；2，打开浏览器；3，打开Intent")
     private int action_type = 1;
 
     @JsonProperty(value = "activity", required = true, defaultValue = "")
@@ -21,9 +23,11 @@ public class ClickAction {
     private Browser browser;
 
     @JsonProperty(value = "aty_attr", required = true)
+    @ApiModelProperty(notes = "activity属性，只针对action_type=1的情况")
     private AtyAttr aty_attr;
 
     @JsonProperty(value = "intent", required = true)
+    @ApiModelProperty(notes = "客户端 Android SDK版本需要大于等于3.2.3，然后在客户端的intent配置data标签，并设置scheme属性")
     private String intent;
 
     public int getAction_type() {
diff --git a/src/main/java/com/tencent/xinge/bean/RetCode.java b/src/main/java/com/tencent/xinge/bean/RetCode.java
@@ -2,8 +2,8 @@
 
 public enum RetCode {
     SUCCESS(0, "成功"),
-    UNKNOWN_ERROR(10000, "未知异常"),
-    NETWORK_TIMEOUT(10001, "超时失败,请重试"),
+    UNKNOWN_ERROR(10100, "发送provider失败l5、链接失败"),
+    NETWORK_TIMEOUT(10101, "发送provider 超时"),
 
     ;
 

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`public enum RetCode {`
`4`	`4`	`SUCCESS(0, "成功"),`
`5`		`- UNKNOWN_ERROR(10000, "未知异常"),`
`6`		`- NETWORK_TIMEOUT(10001, "超时失败,请重试"),`
	`5`	`+ UNKNOWN_ERROR(10100, "发送provider失败l5、链接失败"),`
	`6`	`+ NETWORK_TIMEOUT(10101, "发送provider 超时"),`
`7`	`7`
`8`	`8`	`;`
`9`	`9`