Skip to content

Commit f9dcb43

Browse files
committed
docs: add some enumerations' explanation.
1 parent c6892c5 commit f9dcb43

File tree

3 files changed

+29
-25
lines changed

3 files changed

+29
-25
lines changed

client/src/main/java/cn/vika/client/api/model/field/FieldTypeEnum.java

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,101 @@
11
package cn.vika.client.api.model.field;
22

33
/**
4-
* field types
4+
* the enumerations are field types' values to create field.
55
*
66
* @author tao
77
*/
88
public enum FieldTypeEnum {
99
/**
10-
*
10+
* the request body field type's value to create vika SingleText field.
1111
*/
1212
SingleText("SingleText"),
1313
/**
14-
*
14+
* the request body field type's value to create vika Text field.
1515
*/
1616
Text("Text"),
1717
/**
18-
*
18+
* the request body field type's value to create vika SingleSelect field.
1919
*/
2020
SingleSelect("SingleSelect"),
2121
/**
22-
*
22+
* the request body field type's value to create vika MultiSelect field.
2323
*/
2424
MultiSelect("MultiSelect"),
2525
/**
26-
*
26+
* the request body field type's value to create vika Number field.
2727
*/
2828
Number("Number"),
2929
/**
30-
*
30+
* the request body field type's value to create vika Currency field.
3131
*/
3232
Currency("Currency"),
3333
/**
34-
*
34+
* the request body field type's value to create vika Percent field.
3535
*/
3636
Percent("Percent"),
3737
/**
38-
*
38+
* the request body field type's value to create vika DateTime field.
3939
*/
4040
DateTime("DateTime"),
4141
/**
42-
*
42+
* the request body field type's value to create vika Attachment field.
4343
*/
4444
Attachment("Attachment"),
4545
/**
46-
*
46+
* the request body field type's value to create vika Member field.
4747
*/
4848
Member("Member"),
4949
/**
50-
*
50+
* the request body field type's value to create vika Checkbox field.
5151
*/
5252
Checkbox("Checkbox"),
5353
/**
54-
*
54+
* the request body field type's value to create vika Rating field.
5555
*/
5656
Rating("Rating"),
5757
/**
58-
*
58+
* the request body field type's value to create vika URL field.
5959
*/
6060
URL("URL"),
6161
/**
62-
*
62+
* the request body field type's value to create vika Phone field.
6363
*/
6464
Phone("Phone"),
6565
/**
66-
*
66+
* the request body field type's value to create vika Email field.
6767
*/
6868
Email("Email"),
6969
/**
70-
*
70+
* the request body field type's value to create vika MagicLink field.
7171
*/
7272
MagicLink("MagicLink"),
7373
/**
74-
*
74+
* the request body field type's value to create vika MagicLookUp field.
7575
*/
7676
MagicLookUp("MagicLookUp"),
7777
/**
78-
*
78+
* the request body field type's value to create vika Formula field.
7979
*/
8080
Formula("Formula"),
8181
/**
82-
*
82+
* the request body field type's value to create vika AutoNumber field.
8383
*/
8484
AutoNumber("AutoNumber"),
8585
/**
86-
*
86+
* the request body field type's value to create vika CreatedTime field.
8787
*/
8888
CreatedTime("CreatedTime"),
8989
/**
90-
*
90+
* the request body field type's value of create vika LastModifiedTime field.
9191
*/
9292
LastModifiedTime("LastModifiedTime"),
9393
/**
94-
*
94+
* the request body field type's value to create vika CreatedBy field.
9595
*/
9696
CreatedBy("CreatedBy"),
9797
/**
98-
*
98+
* the request body field type's value to create vika LastModifiedBy field.
9999
*/
100100
LastModifiedBy("LastModifiedBy");
101101

client/src/main/java/cn/vika/client/api/model/field/property/option/CollectTypeEnum.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public enum CollectTypeEnum {
1212
*/
1313
ALL(0),
1414
/**
15-
*Indicates that the value of specified field is changed when it is updated
15+
* Indicates that the value of specified field is changed when it is updated
1616
*/
1717
SPECIFIED(1);
1818

client/src/main/java/cn/vika/client/api/model/field/property/option/TypeFormat.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
package cn.vika.client.api.model.field.property.option;
22

33
/**
4+
* The TypeFormat has no methods or fields
5+
* and serves only to identify that subclass is
6+
* the Formula's and MagicLookUp's property's format object.
7+
*
48
* @author tao
59
*/
610
public abstract class TypeFormat {

0 commit comments

Comments
 (0)