Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 573fdb0

Browse filesBrowse files
alessio-peruginialessio-perugini
committed
add missing comments
1 parent 6588ff4 commit 573fdb0
Copy full SHA for 573fdb0

15 files changed

+87
-18
lines changed

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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/commands.pb.go
+4Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/commands.proto
+5Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/commands_grpc.pb.go
+2Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/common.pb.go
+6-1Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/common.proto
+5Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/compile.pb.go
+6-3Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/compile.proto
+3Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/core.pb.go
+3-2Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/core.proto
+1Lines 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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/lib.pb.go
+4Lines 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/lib.proto

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/lib.proto
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ message LibraryInstallRequest {
6060
LibraryInstallLocation install_location = 6;
6161
}
6262

63+
// The location where the library should be installed.
6364
enum LibraryInstallLocation {
6465
// In the `libraries` subdirectory of the user directory (sketchbook). This is
6566
// the default if not specified.
@@ -183,6 +184,7 @@ message LibrarySearchRequest {
183184
string search_args = 3;
184185
}
185186

187+
// Represent the status of the library search.
186188
enum LibrarySearchStatus {
187189
// No search results were found.
188190
LIBRARY_SEARCH_STATUS_FAILED = 0;
@@ -355,13 +357,15 @@ message Library {
355357
bool in_development = 29;
356358
}
357359

360+
// Represent the library layout
358361
enum LibraryLayout {
359362
// Library is in the 1.0 Arduino library format.
360363
LIBRARY_LAYOUT_FLAT = 0;
361364
// Library is in the 1.5 Arduino library format.
362365
LIBRARY_LAYOUT_RECURSIVE = 1;
363366
}
364367

368+
// Represent the location of the library
365369
enum LibraryLocation {
366370
// In the configured 'builtin.libraries' directory.
367371
LIBRARY_LOCATION_BUILTIN = 0;

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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/settings.pb.go
+21-10Lines changed: 21 additions & 10 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/settings.proto

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/settings.proto
+11Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,17 +83,28 @@ message Configuration {
8383
bool enable_notification = 1;
8484
}
8585

86+
// The configuration for the instance
8687
Directories directories = 1;
88+
// The network configuration
8789
Network network = 2;
90+
// The sketch configuration
8891
Sketch sketch = 3;
92+
// The build cache configuration
8993
BuildCache build_cache = 4;
94+
// The board manager configuration
9095
BoardManager board_manager = 5;
96+
// The daemon configuration
9197
Daemon daemon = 6;
98+
// The output configuration
9299
Output output = 7;
100+
// The logging configuration
93101
Logging logging = 8;
102+
// The library configuration
94103
Library library = 9;
104+
// The updater configuration
95105
Updater updater = 10;
96106

107+
// The language locale
97108
optional string locale = 100;
98109
}
99110

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

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/upload.pb.go
+7-2Lines changed: 7 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/upload.proto

Copy file name to clipboardExpand all lines: rpc/cc/arduino/cli/commands/v1/upload.proto
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,16 +168,21 @@ message BurnBootloaderResponse {
168168
}
169169

170170
message ListProgrammersAvailableForUploadRequest {
171+
// Arduino Core Service instance from the `Init` response.
171172
Instance instance = 1;
173+
// Fully qualified board name of the target board (e.g., `arduino:avr:uno`).
172174
string fqbn = 2;
173175
}
174176

175177
message ListProgrammersAvailableForUploadResponse {
178+
// List of programmers supported by the board
176179
repeated Programmer programmers = 1;
177180
}
178181

179182
message SupportedUserFieldsRequest {
183+
// Arduino Core Service instance from the `Init` response.
180184
Instance instance = 1;
185+
// Fully qualified board name of the target board (e.g., `arduino:avr:uno`).
181186
string fqbn = 2;
182187
// Protocol that will be used to upload, this information is
183188
// necessary to pick the right upload tool for the board specified

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.