dapp/vote:update doc

plugin/dapp/vote/proto/vote.proto

@@ -10,8 +10,8 @@ message VoteAction {
         UpdateGroup  updateGroup  = 3; //更新组成员
         CreateVote   createVote   = 4; //创建一个投票
         CommitVote   commitVote   = 5; //组员提交投票
-        CloseVote    closeVote    = 6;
-        UpdateMember updateMember = 7;
+        CloseVote    closeVote    = 6; //关闭投票
+        UpdateMember updateMember = 7; //更新用户信息
     }
 }
 
@@ -25,7 +25,7 @@ message CreateGroup {
     string   name                    = 1; //投票组名称
     repeated string admins           = 2; //管理员地址列表
     repeated GroupMember members     = 3; //组员
-    string               description = 4;
+    string               description = 4; //描述
 }
 
 //更新投票组
@@ -33,8 +33,8 @@ message UpdateGroup {
     string   groupID                = 1; //投票组ID
     repeated GroupMember addMembers = 2; //需要增加的组成员
     repeated string removeMembers   = 3; //删除组成员的地址列表
-    repeated string addAdmins       = 4;
-    repeated string removeAdmins    = 5;
+    repeated string addAdmins       = 4; //增加管理员
+    repeated string removeAdmins    = 5; //删除管理员
 }
 
 // 投票组信息
@@ -46,7 +46,7 @@ message GroupInfo {
     string   creator                 = 4; //创建者
     repeated string admins           = 5; //管理员列表
     repeated GroupMember members     = 6; //成员列表
-    string               description = 7;
+    string               description = 7; //描述信息
 }
 
 message GroupInfos {
@@ -62,11 +62,11 @@ message VoteOption {
 // 创建投票交易，请求结构
 message CreateVote {
     string   name                  = 1; //投票名称
-    string   groupID               = 2; //投票关联组列表
+    string   groupID               = 2; //投票关联组
     repeated string voteOptions    = 3; //投票选项列表
     int64           beginTimestamp = 4; //投票开始时间戳
     int64           endTimestamp   = 5; //投票结束时间戳
-    string          description    = 6;
+    string          description    = 6; //描述信息
 }
 
 // 创建提交投票交易，请求结构
@@ -76,31 +76,31 @@ message CommitVote {
 }
 
 message CommitInfo {
-    string addr   = 1;
-    string txHash = 2;
+    string addr   = 1; //提交地址
+    string txHash = 2; //提交交易哈希
 }
 
 message CloseVote {
-    string voteID = 1;
+    string voteID = 1; // 投票ID
 }
 
 message UpdateMember {
-    string name = 1;
+    string name = 1; //用户名称
 }
 
 //投票信息
 message VoteInfo {
 
-    string   ID                        = 1; //投票ID
-    string   name                      = 2; //投票名称
-    string   creator                   = 3; //创建者
-    string   groupID                   = 4; //投票关联的投票组
-    repeated VoteOption voteOptions    = 5; //投票的选项
-    int64               beginTimestamp = 6; //投票开始时间戳
-    int64               endTimestamp   = 7; //投票结束时间戳
-    repeated CommitInfo commitInfos    = 8; //已投票的提交信息
-    string              description    = 9;
-    uint32              status         = 10;
+    string   ID                        = 1;  //投票ID
+    string   name                      = 2;  //投票名称
+    string   creator                   = 3;  //创建者
+    string   groupID                   = 4;  //投票关联的投票组
+    repeated VoteOption voteOptions    = 5;  //投票的选项
+    int64               beginTimestamp = 6;  //投票开始时间戳
+    int64               endTimestamp   = 7;  //投票结束时间戳
+    repeated CommitInfo commitInfos    = 8;  //已投票的提交信息
+    string              description    = 9;  //描述信息
+    uint32              status         = 10; //状态，0正常，1关闭
 }
 
 message VoteInfos {
@@ -109,7 +109,7 @@ message VoteInfos {
 
 message MemberInfo {
     string   addr            = 1; //地址
-    string   name            = 2;
+    string   name            = 2; //用户名称
     repeated string groupIDs = 3; //所属投票组的ID列表
 }
 
@@ -118,7 +118,7 @@ message MemberInfos {
 }
 
 message ReqStrings {
-    repeated string items = 1;
+    repeated string items = 1; //请求项数组
 }
 
 //列表请求结构
@@ -129,14 +129,13 @@ message ReqListItem {
 }
 
 message ReqListVote {
-
-    string      groupID = 1;
-    ReqListItem listReq = 2;
+    string      groupID = 1; //所属组ID
+    ReqListItem listReq = 2; //列表请求
 }
 
 message ReplyVoteList {
-    repeated VoteInfo pendingList  = 1;
-    repeated VoteInfo ongoingList  = 2;
-    repeated VoteInfo finishedList = 3;
-    repeated VoteInfo closedList   = 4;
+    repeated VoteInfo pendingList  = 1; //即将开始投票列表
+    repeated VoteInfo ongoingList  = 2; //正在进行投票列表
+    repeated VoteInfo finishedList = 3; //已经完成投票列表
+    repeated VoteInfo closedList   = 4; //已经关闭投票列表
 }