Skip to content

Commit 573fdb0

Browse files
add missing comments
1 parent 6588ff4 commit 573fdb0

15 files changed

+87
-18
lines changed

rpc/cc/arduino/cli/commands/v1/commands.pb.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/commands/v1/commands.proto

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ service ArduinoCoreService {
179179
// Read the settings from a YAML file
180180
rpc ConfigurationOpen(ConfigurationOpenRequest) returns (ConfigurationOpenResponse);
181181

182+
// Get the current configuration
182183
rpc ConfigurationGet(ConfigurationGetRequest) returns (ConfigurationGetResponse);
183184

184185
// Enumerate all the keys/values pairs available in the configuration
@@ -215,13 +216,16 @@ message InitResponse {
215216
TaskProgress task_progress = 2;
216217
}
217218
oneof message {
219+
// The progress
218220
Progress init_progress = 1;
221+
// The error in case the instance initialization failed.
219222
google.rpc.Status error = 2;
220223
// Selected profile information
221224
SketchProfile profile = 3;
222225
}
223226
}
224227

228+
// Represent the reason why an instance initialization failed.
225229
enum FailedInstanceInitReason {
226230
// FAILED_INSTANCE_INIT_REASON_UNSPECIFIED the error reason is not specialized
227231
FAILED_INSTANCE_INIT_REASON_UNSPECIFIED = 0;
@@ -297,6 +301,7 @@ message UpdateLibrariesIndexResponse {
297301
}
298302

299303
message IndexUpdateReport {
304+
// The status of the index update
300305
enum Status {
301306
// The status of the index update is unspecified.
302307
STATUS_UNSPECIFIED = 0;

rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/commands/v1/common.pb.go

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/commands/v1/common.proto

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,11 @@ message Instance {
2727

2828
message DownloadProgress {
2929
oneof message {
30+
// Start of the download.
3031
DownloadProgressStart start = 1;
32+
// Update of the download.
3133
DownloadProgressUpdate update = 2;
34+
// End of the download.
3235
DownloadProgressEnd end = 3;
3336
}
3437
}
@@ -214,7 +217,9 @@ message MonitorPortConfiguration {
214217
}
215218

216219
message MonitorPortSetting {
220+
// The setting id
217221
string setting_id = 1;
222+
// The setting value
218223
string value = 2;
219224
}
220225

rpc/cc/arduino/cli/commands/v1/compile.pb.go

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/commands/v1/compile.proto

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,11 @@ message BuilderResult {
133133
}
134134

135135
message ExecutableSectionSize {
136+
// The name of the executable section
136137
string name = 1;
138+
// The executable size
137139
int64 size = 2;
140+
// The exectuable maximum size
138141
int64 max_size = 3;
139142
}
140143

rpc/cc/arduino/cli/commands/v1/core.pb.go

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

rpc/cc/arduino/cli/commands/v1/core.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ message PlatformLoadingError {}
6161
message PlatformDownloadRequest {
6262
// Arduino Core Service instance from the `Init` response.
6363
Instance instance = 1;
64+
// Vendor name of the platform (e.g., `arduino`).
6465
string platform_package = 2;
6566
// Architecture name of the platform (e.g., `avr`).
6667
string architecture = 3;

rpc/cc/arduino/cli/commands/v1/lib.pb.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)