From bfb226b92ea9021c199d81e189c35d01c6f1f1a0 Mon Sep 17 00:00:00 2001
From: Alexander Gavrilov <angavrilov@gmail.com>
Date: Mon, 19 Mar 2012 11:33:30 +0400
Subject: [PATCH] Add a few comments.

---
 library/proto/BasicApi.proto     | 8 ++++++++
 library/proto/CoreProtocol.proto | 6 +++++-
 plugins/proto/rename.proto       | 2 ++
 3 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/library/proto/BasicApi.proto b/library/proto/BasicApi.proto
index 7b105ee88..137f25726 100644
--- a/library/proto/BasicApi.proto
+++ b/library/proto/BasicApi.proto
@@ -4,6 +4,10 @@ option optimize_for = LITE_RUNTIME;
 
 import "Basic.proto";
 
+// RPC GetVersion : EmptyMessage -> StringMessage
+// RPC GetDFVersion : EmptyMessage -> StringMessage
+
+// RPC GetWorldInfo : EmptyMessage -> GetWorldInfoOut
 message GetWorldInfoOut {
     enum Mode {
         MODE_DWARF = 1;
@@ -27,6 +31,7 @@ message GetWorldInfoOut {
     repeated int32 companion_histfig_ids = 10;
 };
 
+// RPC ListEnums : EmptyMessage -> ListEnumsOut
 message ListEnumsOut {
     repeated EnumItemName material_flags = 1;
     repeated EnumItemName inorganic_flags = 2;
@@ -46,6 +51,7 @@ message ListEnumsOut {
     repeated EnumItemName profession = 11;
 };
 
+// RPC ListMaterials : ListMaterialsIn -> ListMaterialsOut
 message ListMaterialsIn {
     optional BasicMaterialInfoMask mask = 1;
 
@@ -62,6 +68,7 @@ message ListMaterialsOut {
     repeated BasicMaterialInfo value = 1;
 };
 
+// RPC ListUnits : ListUnitsIn -> ListUnitsOut
 message ListUnitsIn {
     optional BasicUnitInfoMask mask = 1;
 
@@ -81,6 +88,7 @@ message ListUnitsOut {
     repeated BasicUnitInfo value = 1;
 };
 
+// RPC ListSquads : ListSquadsIn -> ListSquadsOut
 message ListSquadsIn {}
 message ListSquadsOut {
     repeated BasicSquadInfo value = 1;
diff --git a/library/proto/CoreProtocol.proto b/library/proto/CoreProtocol.proto
index 6f3b84510..92d7c48d9 100644
--- a/library/proto/CoreProtocol.proto
+++ b/library/proto/CoreProtocol.proto
@@ -62,18 +62,22 @@ message StringListMessage {
     repeated string value = 1;
 }
 
+// RPC BindMethod : CoreBindRequest -> CoreBindReply
 message CoreBindRequest {
     required string method = 1;
     required string input_msg = 2;
     required string output_msg = 3;
     optional string plugin = 4;
 }
-
 message CoreBindReply {
     required int32 assigned_id = 1;
 }
 
+// RPC RunCommand : CoreRunCommandRequest -> EmptyMessage
 message CoreRunCommandRequest {
     required string command = 1;
     repeated string arguments = 2;
 }
+
+// RPC CoreSuspend : EmptyMessage -> IntMessage
+// RPC CoreResume : EmptyMessage -> IntMessage
diff --git a/plugins/proto/rename.proto b/plugins/proto/rename.proto
index a6c3b055a..aa1e95f48 100644
--- a/plugins/proto/rename.proto
+++ b/plugins/proto/rename.proto
@@ -2,6 +2,7 @@ package dfproto;
 
 option optimize_for = LITE_RUNTIME;
 
+// RPC RenameSquad : RenameSquadIn -> EmptyMessage
 message RenameSquadIn {
     required int32 squad_id = 1;
 
@@ -9,6 +10,7 @@ message RenameSquadIn {
     optional string alias = 3;
 }
 
+// RPC RenameUnit : RenameUnitIn -> EmptyMessage
 message RenameUnitIn {
     required int32 unit_id = 1;