补充注释 (#624)

grpc_api/bilibili/app/archive/middleware/v1/preload.proto

@@ -13,6 +13,6 @@ message PlayerArgs {
     // 返回url是否强制使用域名
     // 0:不强制使用域名 1:http域名 2:https域名
     int64 force_host = 4;
-    //
+    // 音量均衡
     int64 voice_balance = 5;
 }

grpc_api/bilibili/metadata/device/device.proto

@@ -6,8 +6,8 @@ package bilibili.metadata.device;
 // gRPC头部:x-bili-device-bin
 message Device {
     // 产品id
-    // 粉 白 蓝 直播姬 HD 海外 OTT 漫画 TV野版 小视频 网易漫画 网易漫画 网易漫画HD 国际版
+    // 粉 白 蓝 直播姬 HD 海外 OTT 漫画 TV野版 小视频 网易漫画 网易漫画 网易漫画HD 国际版 东南亚版
-    // 1  2  3    4    5   6    7   8     9     10      11       12       13       14
+    // 1  2  3    4    5   6    7   8     9     10      11       12       13       14       30
     int32 app_id = 1;
     // 构建id
     int32 build = 2;
@@ -36,6 +36,6 @@ message Device {
     string version_name = 13;
     // 设备指纹, 不区分本地或远程设备指纹，作为推送目标的索引
     string fp = 14;
-    //
+    // 首次启动时的毫秒时间戳
     int64 fts = 15;
 }

grpc_api/bilibili/metadata/metadata.proto

@@ -13,7 +13,7 @@ message Metadata {
     string device = 3;
     // 构建id
     int32 build = 4;
-    // 渠道
+    // APP分发渠道
     string channel = 5;
     // 设备buvid
     string buvid = 6;

grpc_api/bilibili/metadata/restriction/restriction.proto

@@ -19,6 +19,6 @@ message Restriction {
     ModeType mode = 3;
     // app 审核review状态
     bool review = 4;
-    //
+    // 客户端是否选择关闭个性化推荐
     bool disable_rcmd = 5;
 }

grpc_api/bilibili/pagination/pagination.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 
 package bilibili.pagination;
 
-//
+// 分页信息
 message FeedPagination {
     //
     int32 page_size = 1;
@@ -12,7 +12,7 @@ message FeedPagination {
     bool is_refresh = 3;
 }
 
-//
+// 分页信息
 message FeedPaginationReply {
     //
     string next_offset = 1;
@@ -22,7 +22,7 @@ message FeedPaginationReply {
     string last_read_offset = 3;
 }
 
-//
+// 分页信息
 message Pagination {
     //
     int32 page_size = 1;
@@ -30,7 +30,7 @@ message Pagination {
     string next = 2;
 }
 
-//
+// 分页信息
 message PaginationReply {
     //
     string next = 1;

grpc_api/bilibili/pgc/gateway/player/v2/playurl.proto

@@ -22,15 +22,15 @@ message BadgeInfo {
     string bg_color_night = 3;
     // 文案色值
     string text_color = 4;
-    //
+    // ? 新版本客户端已弃用此项
     GradientColor bg_gradient_color = 5;
 }
 
-//
+// Dialog组件: 底部显示
 message BottomDisplay {
-    //
+    // 文案
     TextInfo title = 1;
-    //
+    // 图标
     string icon = 2;
 }
 
@@ -68,34 +68,35 @@ message ButtonInfo {
     map<string, string> order_report_params = 15;
 }
 
-//
+// 投屏限制. code = 0 时为无限制, 否则表示不不允许投屏并提示message
 message CastTips {
     //
     int32 code = 1;
-    //
+    // 
     string message = 2;
 }
 
-//
+// 跳过片头/片尾配置
 message ClipInfo {
     //
     int64 material_no = 1;
-    //
+    // DASH分段始
     int32 start = 2;
-    //
+    // DASH分段终
     int32 end = 3;
-    //
+    // Clip类型
     ClipType clip_type = 4;
-    //
+    // 跳过片头/片尾时的提示语
     string toast_text = 5;
-    //
+    // 
     MultiView multi_view = 6;
 }
 
+// 跳过片头/片尾配置: Clip类型
 enum ClipType {
     NT_UNKNOWN = 0;           //
-    CLIP_TYPE_OP = 1;         //
+    CLIP_TYPE_OP = 1;         // 跳过OP
-    CLIP_TYPE_ED = 2;         //
+    CLIP_TYPE_ED = 2;         // 跳过ED
     CLIP_TYPE_HE = 3;         //
     CLIP_TYPE_MULTI_VIEW = 4; //
 }
@@ -176,7 +177,7 @@ message DashItem {
     uint32 codecid = 5;
     // md5
     string md5 = 6;
-    // 大小
+    // 视频大小
     uint64 size = 7;
     // 帧率
     string frame_rate = 8;
@@ -252,13 +253,13 @@ message DialogConfig {
     bool is_force_halfscreen_enable = 4;
 }
 
-//
+// 当前分辨率信息
 message Dimension {
-    //
+    // 宽
     int32 width = 1;
-    //
+    // 长
     int32 height = 2;
-    //
+    // 旋转角度
     int32 rotate = 3;
 }
 
@@ -276,7 +277,7 @@ message DolbyItem {
     DashItem audio = 2;
 }
 
-//
+// DRM技术类型
 enum DrmTechType {
     NON = 0;       //
     FAIR_PLAY = 1; //
@@ -296,7 +297,7 @@ message Event {
     Shake shake = 1;
 }
 
-//
+// ? 放映室提示语
 message FreyaConfig {
     //
     string desc = 1;
@@ -312,7 +313,7 @@ message FreyaConfig {
     int32 full_screen_number = 6;
 }
 
-//
+// 渐变色信息
 message GradientColor {
     //
     string start_color = 1;
@@ -320,7 +321,7 @@ message GradientColor {
     string end_color = 2;
 }
 
-//
+// 高画质试看信息
 message HighDefinitionTrialInfo {
     //
     bool trial_able = 1;
@@ -376,7 +377,7 @@ message MultiView {
     int64 avid = 4;
 }
 
-//
+// 大会员广告: 支付提示信息
 message PayTip {
     //
     string title = 1;
@@ -482,19 +483,19 @@ message PlayViewBusinessInfo {
     string playback_speed_color = 4;
     //
     ContinuePlayInfo continue_play_info = 5;
-    //
+    // 跳过片头/片尾配置
     repeated ClipInfo clip_info = 6;
     //
     InlineType inline_type = 7;
     //
     int32 ep_whole_duration = 8;
-    //
+    // 当前分辨率信息
     Dimension dimension = 9;
     //
     map<int32, QualityExtInfo> quality_ext_map = 10;
     //
     map<string, int32> exp_map = 11;
-    //
+    // DRM技术类型
     DrmTechType drm_tech_type = 12;
 }
 
@@ -578,21 +579,21 @@ message PopWin {
     string pop_type = 9;
 }
 
-//
+// 广告组件: 竖屏时视频下部提示栏
 message PromptBar {
-    //
+    // 主标题, 如: "本片含大会员专享内容"
     TextInfo title = 1;
-    //
+    // 副标题, 如: "成为大会员可免费看全部剧集"
     TextInfo sub_title = 2;
-    //
+    // 副标题前面的icon
     string sub_title_icon = 3;
-    //
+    // 背景图
     string bg_image = 4;
-    //
+    // 背景渐变色
     GradientColor bg_gradient_color = 5;
-    //
+    // 按钮
     repeated ButtonInfo button = 6;
-    //
+    // 埋点上报信息
     Report report = 7;
     //
     string full_screen_ip_icon = 8;
@@ -600,9 +601,9 @@ message PromptBar {
     GradientColor full_screen_bg_gradient_color = 9;
 }
 
-//
+// 云控拓展视频画质信息
 message QualityExtInfo {
-    //
+    // 是否支持试看
     bool trial_support = 1;
 }
 

grpc_api/bilibili/polymer/app/search/v1/search.proto

@@ -7,9 +7,9 @@ import "bilibili/pagination/pagination.proto";
 
 //
 service Search {
-    //
+    // 搜索所有类型结果
     rpc SearchAll(SearchAllRequest) returns (SearchAllResponse);
-    //
+    // 搜索指定类型结果
     rpc SearchByType(SearchByTypeRequest) returns (SearchByTypeResponse);
     //
     rpc SearchComic(SearchComicRequest) returns (SearchComicResponse);
@@ -1098,9 +1098,9 @@ message SearchBannerCard {
 
 //
 message SearchByTypeRequest {
-    //
+    // 搜索目标类型, 番剧为7
     int32 type = 1;
-    //
+    // 关键词
     string keyword = 2;
     //
     int32 category_sort = 3;
@@ -1118,21 +1118,21 @@ message SearchByTypeRequest {
 
 //
 message SearchByTypeResponse {
-    //
+    // 追踪id
     string trackid = 1;
-    //
+    // 当前页码
     int32 pages = 2;
     //
     string exp_str = 3;
-    //
+    // 搜索关键词
     string keyword = 4;
-    //
+    // 是否为推荐结果
     int32 result_is_recommend = 5;
-    //
+    // 搜索结果条目
     repeated Item items = 6;
-    //
+    // 分页信息
     bilibili.pagination.PaginationReply pagination = 7;
-    //
+    // 
     map<string, string> annotation = 8;
 }