Disable RPC API docs for plugins that aren't currently built

This allows ci/check-rpc.py to pass, and will cause it to fail if the plugins are re-enabled and we forget to un-disable the docs.
DFHack · Aug 4, 2023 · 1411c5e · 1411c5e
1 parent b17ca80
commit 1411c5e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/plugins/proto/isoworldremote.proto b/plugins/proto/isoworldremote.proto
@@ -5,7 +5,7 @@ package isoworldremote;
 
 option optimize_for = LITE_RUNTIME;
 
-// Plugin: isoworldremote
+// DISABLED Plugin: isoworldremote
 
 enum BasicMaterial {
     AIR = 0;
@@ -54,7 +54,7 @@ message EmbarkTile {
     optional bool is_valid = 7;
 }
 
-// RPC GetEmbarkTile : TileRequest -> EmbarkTile
+// DISABLED RPC GetEmbarkTile : TileRequest -> EmbarkTile
 message TileRequest {
     optional int32 want_x = 1;
     optional int32 want_y = 2;
@@ -64,7 +64,7 @@ message MapRequest {
     optional string save_folder = 1;
 }
 
-// RPC GetEmbarkInfo : MapRequest -> MapReply
+// DISABLED RPC GetEmbarkInfo : MapRequest -> MapReply
 message MapReply {
     required bool available = 1;
     optional int32 region_x = 2;
@@ -75,7 +75,7 @@ message MapReply {
     optional int32 current_season = 7;
 }
 
-// RPC GetRawNames : MapRequest -> RawNames
+// DISABLED RPC GetRawNames : MapRequest -> RawNames
 message RawNames {
     required bool available = 1;
     repeated string inorganic = 2;

diff --git a/plugins/proto/rename.proto b/plugins/proto/rename.proto
@@ -4,25 +4,25 @@ package dfproto;
 
 option optimize_for = LITE_RUNTIME;
 
-// Plugin: rename
+// DISABLED Plugin: rename
 
-// RPC RenameSquad : RenameSquadIn -> EmptyMessage
+// DISABLED RPC RenameSquad : RenameSquadIn -> EmptyMessage
 message RenameSquadIn {
     required int32 squad_id = 1;
 
     optional string nickname = 2;
     optional string alias = 3;
 }
 
-// RPC RenameUnit : RenameUnitIn -> EmptyMessage
+// DISABLED RPC RenameUnit : RenameUnitIn -> EmptyMessage
 message RenameUnitIn {
     required int32 unit_id = 1;
 
     optional string nickname = 2;
     optional string profession = 3;
 }
 
-// RPC RenameBuilding : RenameBuildingIn -> EmptyMessage
+// DISABLED RPC RenameBuilding : RenameBuildingIn -> EmptyMessage
 message RenameBuildingIn {
     required int32 building_id = 1;