docs: add enum's value comment.

y-t99 · y-t99 · commit d073fb8329f5 · 2022-05-06T16:11:10.000+08:00
diff --git a/client/src/main/java/cn/vika/client/api/FieldApi.java b/client/src/main/java/cn/vika/client/api/FieldApi.java
@@ -30,8 +30,6 @@ public CreateFieldResponse addField(String spaceId, String datasheetId,
 
         checkPostFieldPathArgs(spaceId, datasheetId);
 
-        // TODO: 校验CreateFieldRequest对象
-
         final String path = String.format(POST_FIELD_PATH, spaceId, datasheetId);
         HttpResult<CreateFieldResponse> result = getDefaultHttpClient().post(
                         path, new HttpHeader(), field,
diff --git a/client/src/main/java/cn/vika/client/api/model/builder/CreateFieldRequestBuilder.java b/client/src/main/java/cn/vika/client/api/model/builder/CreateFieldRequestBuilder.java
@@ -89,8 +89,6 @@ class PropertyOfCreateField implements IPropertyOfCreateField {
     @Override
     public <T extends BaseFieldProperty> IBuildCreateField<T> withProperty(T property) {
 
-        // TODO: 泛型正确性判断
-
         context.setProperty(property);
         return new BuildCreateField<>(context);
     }
diff --git a/client/src/main/java/cn/vika/client/api/model/builder/IBuildCreateField.java b/client/src/main/java/cn/vika/client/api/model/builder/IBuildCreateField.java
@@ -8,10 +8,6 @@
  */
 public interface IBuildCreateField <T extends BaseFieldProperty>  {
 
-    /**
-     *
-     * @return
-     */
     CreateFieldRequest<T> build();
 
 }
diff --git a/client/src/main/java/cn/vika/client/api/model/builder/IFieldTypeOfCreateField.java b/client/src/main/java/cn/vika/client/api/model/builder/IFieldTypeOfCreateField.java
@@ -7,11 +7,6 @@
  */
 public interface IFieldTypeOfCreateField {
 
-    /**
-     *
-     * @param fieldType
-     * @return
-     */
     INameOfCreateField ofType(FieldType fieldType);
 
 }
diff --git a/client/src/main/java/cn/vika/client/api/model/builder/INameOfCreateField.java b/client/src/main/java/cn/vika/client/api/model/builder/INameOfCreateField.java
@@ -5,11 +5,6 @@
  */
 public interface INameOfCreateField {
 
-    /**
-     *
-     * @param name
-     * @return
-     */
     IPropertyOfCreateField withName(String name);
 
 }
diff --git a/client/src/main/java/cn/vika/client/api/model/builder/IPropertyOfCreateField.java b/client/src/main/java/cn/vika/client/api/model/builder/IPropertyOfCreateField.java
@@ -8,12 +8,6 @@
  */
 public interface IPropertyOfCreateField {
 
-    /**
-     *
-     * @param property
-     * @param <T>
-     * @return
-     */
     <T extends BaseFieldProperty> IBuildCreateField<T> withProperty(T property);
 
     IBuildCreateField<EmptyProperty> withoutProperty();
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/CollectTypeEnum.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/CollectTypeEnum.java
@@ -8,11 +8,11 @@
 public enum CollectTypeEnum {
 
     /**
-     *
+     * Indicates that the value of any field is changed when it is updated
      */
     ALL(0),
     /**
-     *
+     *Indicates that the value of specified field is changed when it is updated
      */
     SPECIFIED(1);
 
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/CurrencyFormat.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/CurrencyFormat.java
@@ -3,7 +3,7 @@
 /**
  * @author tao
  */
-public class Currency extends TypeFormat{
+public class CurrencyFormat extends TypeFormat{
 
     private int precision;
 
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/DateFormatEnum.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/DateFormatEnum.java
@@ -7,35 +7,35 @@
  */
 public enum DateFormatEnum {
     /**
-     *
+     * Date's format "2022/01/30"
      */
     DATE_SLASH("YYYY/MM/DD"),
     /**
-     *
+     * Date's format "2022-01-30"
      */
     DATE("YYYY-MM-DD"),
     /**
-     *
+     * Date's format "01/30/2022"
      */
     EUROPEAN_DATE_SLASH("DD/MM/YYYY"),
     /**
-     *
+     * Date's format "2022-01"
      */
     YEAR_MOUTH("YYYY-MM"),
     /**
-     *
+     * Date's format "01-30"
      */
     MOUTH_DAY("MM-DD"),
     /**
-     *
+     * Date's format "2020"
      */
     YEAR("YYYY"),
     /**
-     *
+     * Date's format "01"
      */
     MOUNT("MM"),
     /**
-     *
+     * Date's format "30"
      */
     DAY("DD");
     private final String value;
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/FormatType.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/FormatType.java
@@ -7,19 +7,23 @@
  */
 public enum FormatType {
     /**
-     *
+     * Format about DateTime
+     * @see cn.vika.client.api.model.field.property.option.DateTimeFormat
      */
     DateTime("DateTime"),
     /**
-     *
+     * Format about Number
+     * @see cn.vika.client.api.model.field.property.option.NumberFormat
      */
     Number("Number"),
     /**
-     *
+     * Format about Percent
+     * @see cn.vika.client.api.model.field.property.option.PercentFormat
      */
     Percent("Percent"),
     /**
-     *
+     * Format about Currency
+     * @see cn.vika.client.api.model.field.property.option.CurrencyFormat
      */
     Currency("Currency"),
     ;
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/PrecisionEnum.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/PrecisionEnum.java
@@ -7,23 +7,28 @@
  */
 public enum PrecisionEnum {
     /**
-     *
+     * field's value is integer
+     * example: 1
      */
     POINT0(0),
     /**
-     *
+     * digital precision: to one decimal place
+     * example: 1.1
      */
     POINT1(1),
     /**
-     *
+     * digital precision: to two decimal place
+     * example: 1.11
      */
     POINT2(2),
     /**
-     *
+     * digital precision: to three decimal place
+     * example: 1.111
      */
     POINT3(3),
     /**
-     *
+     * digital precision: to four decimal place
+     * example: 1.1111
      */
     POINT4(4);
 
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/RollUpFunctionEnum.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/RollUpFunctionEnum.java
@@ -7,63 +7,67 @@
  */
 public enum RollUpFunctionEnum {
     /**
-     *
+     * raw reference:
+     * reference the data for the selected columns as-is from the associated datasheet.
      */
     VALUES("VALUES"),
     /**
-     *
+     * calculate the arithmetic average of the raw reference.
      */
     AVERAGE("AVERAGE"),
     /**
-     *
+     * count a non-empty number type for the raw reference.
      */
     COUNT("COUNT"),
     /**
-     *
+     * count the number of non-null values for the raw reference.
+     * this function evaluates both numerical and textual values.
      */
     COUNTA("COUNTA"),
     /**
-     *
+     * count the number of records in the raw reference.
+     * this method counts all values, including blank records.
      */
     COUNTALL("COUNTALL"),
     /**
-     *
+     * sum of values for the raw referenced.
      */
     SUM("SUM"),
     /**
-     *
+     * the minimum value in the raw reference's values.
      */
     MIN("MIN"),
     /**
-     *
+     * the maximum value in the raw reference's values.
      */
     MAX("MAX"),
     /**
-     *
+     * if the raw reference's values all are not empty, return true.
      */
     AND("AND"),
     /**
-     *
+     * if there are at least one not-empty value in the raw reference's values, return true.
      */
     OR("OR"),
     /**
-     *
+     * if there are an odd number of values are not empty in the raw reference's values, return true.
      */
     XOR("XOR"),
     /**
-     *
+     *  the raw reference's values are joined into text.
      */
     CONCATENATE("CONCATENATE"),
     /**
-     *
+     * the raw reference's values are joined into a string with comma.
      */
     ARRAYJOIN("ARRAYJOIN"),
     /**
-     *
+     * deduplicate the raw reference's values.
      */
     ARRAYUNIQUE("ARRAYUNIQUE"),
     /**
-     *
+     * delete the empty strings and empty values in the raw reference's values.
+     * but keep the "false" values and the string with whitespace character values.
      */
     ARRAYCOMPACT("ARRAYCOMPACT");
 
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/SymbolAlignEnum.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/SymbolAlignEnum.java
@@ -7,17 +7,18 @@
  */
 public enum SymbolAlignEnum {
     /**
-     *
+     * the monetary unit is fixed to the left.
      */
     Default("Default"),
     /**
-     *
+     * the monetary unit is fixed to the left.
      */
     Left("Left"),
     /**
-     *
+     * the monetary unit is fixed to the right.
      */
     Right("Right");
+
     private final String value;
 
     SymbolAlignEnum(String value) {
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/TimeFormatEnum.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/TimeFormatEnum.java
@@ -7,11 +7,11 @@
  */
 public enum TimeFormatEnum {
     /**
-     *
+     * 12-hour clock
      */
     HOUR_MINUTE_12("hh:mm"),
     /**
-     *
+     * 24-hour clock
      */
     HOUR_MINUTE_24("HH:mm");
 
diff --git a/client/src/main/java/cn/vika/client/api/model/field/property/option/UserOption.java b/client/src/main/java/cn/vika/client/api/model/field/property/option/UserOption.java

Original file line number	Diff line number	Diff line change
`@@ -89,8 +89,6 @@ class PropertyOfCreateField implements IPropertyOfCreateField {`
`89`	`89`	`@Override`
`90`	`90`	`public <T extends BaseFieldProperty> IBuildCreateField<T> withProperty(T property) {`
`91`	`91`
`92`		`- // TODO: 泛型正确性判断`
`93`		`-`
`94`	`92`	`context.setProperty(property);`
`95`	`93`	`return new BuildCreateField<>(context);`
`96`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,6 @@`
`8`	`8`	`*/`
`9`	`9`	`public interface IBuildCreateField <T extends BaseFieldProperty> {`
`10`	`10`
`11`		`- /**`
`12`		`- *`
`13`		`- * @return`
`14`		`- */`
`15`	`11`	`CreateFieldRequest<T> build();`
`16`	`12`
`17`	`13`	`}`