dox: documented proto file (CURA-1681 CURA-1682)

1 files changed, 16 insertions, 16 deletions

diff --git a/plugins/CuraEngineBackend/Cura.proto b/plugins/CuraEngineBackend/Cura.proto
index aa42ed989a..38753fd804 100644
--- a/plugins/CuraEngineBackend/Cura.proto
+++ b/plugins/CuraEngineBackend/Cura.proto
@@ -5,14 +5,14 @@ package cura.proto;
 message ObjectList
 {
     repeated Object objects = 1;
-    repeated Setting settings = 2;
+    repeated Setting settings = 2; // meshgroup settings (for one-at-a-time printing)
 }
 
 message Slice
 {
-    repeated ObjectList object_lists = 1;
-    SettingList global_settings = 2;
-    repeated Extruder extruders = 3;
+    repeated ObjectList object_lists = 1; // The meshgroups to be printed one after another
+    SettingList global_settings = 2; // The global settings used for the whole print job
+    repeated Extruder extruders = 3; // The settings sent to each extruder object
 }
 
 message Extruder
@@ -37,10 +37,10 @@ message Progress
 
 message Layer {
     int32 id = 1;
-    float height = 2;
-    float thickness = 3;
+    float height = 2; // Z position
+    float thickness = 3; // height of a single layer
 
-    repeated Polygon polygons = 4;
+    repeated Polygon polygons = 4; // layer data
 }
 
 message Polygon {
@@ -56,19 +56,19 @@ message Polygon {
         MoveCombingType = 8;
         MoveRetractionType = 9;
     }
-    Type type = 1;
-    bytes points = 2;
-    float line_width = 3;
+    Type type = 1; // Type of move
+    bytes points = 2; // The points of the polygon, or two points if only a line segment (Currently only line segments are used)
+    float line_width = 3; // The width of the line being laid down
 }
 
 message GCodeLayer {
     bytes data = 2;
 }
 
-message ObjectPrintTime {
+message ObjectPrintTime { // The print time for the whole print and material estimates for the first extruder
     int64 id = 1;
-    float time = 2;
-    float material_amount = 3;
+    float time = 2; // Total time estimate
+    float material_amount = 3; // material used in the first extruder
 }
 
 message SettingList {
@@ -76,13 +76,13 @@ message SettingList {
 }
 
 message Setting {
-    string name = 1;
+    string name = 1; // Internal key to signify a setting
 
-    bytes value = 2;
+    bytes value = 2; // The value of the setting
 }
 
 message GCodePrefix {
-    bytes data = 2;
+    bytes data = 2; // Header string to be prenpended before the rest of the gcode sent from the engine
 }
 
 message SlicingFinished {