Skip to content

Commit e3044a5

Browse files
per1234cmaglie
authored andcommitted
Make the formatting of opening comments of built-in examples consistent
1 parent eee3e5b commit e3044a5

File tree

75 files changed

+298
-316
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+298
-316
lines changed

build/shared/examples/01.Basics/AnalogReadSerial/AnalogReadSerial.ino

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
/*
22
AnalogReadSerial
3+
34
Reads an analog input on pin 0, prints the result to the Serial Monitor.
4-
Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu)
5+
Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu).
56
Attach the center pin of a potentiometer to pin A0, and the outside pins to +5V and ground.
67

78
This example code is in the public domain.
9+
10+
http://www.arduino.cc/en/Tutorial/AnalogReadSerial
811
*/
912

1013
// the setup routine runs once when you press reset:

build/shared/examples/01.Basics/Blink/Blink.ino

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/*
22
Blink
3+
34
Turns an LED on for one second, then off for one second, repeatedly.
45

56
Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO
@@ -8,18 +9,17 @@
89
If you want to know what pin the on-board LED is connected to on your Arduino model, check
910
the Technical Specs of your board at https://www.arduino.cc/en/Main/Products
1011

11-
This example code is in the public domain.
12-
1312
modified 8 May 2014
1413
by Scott Fitzgerald
15-
1614
modified 2 Sep 2016
1715
by Arturo Guadalupi
18-
1916
modified 8 Sep 2016
2017
by Colby Newman
21-
*/
2218

19+
This example code is in the public domain.
20+
21+
http://www.arduino.cc/en/Tutorial/Blink
22+
*/
2323

2424
// the setup function runs once when you press reset or power the board
2525
void setup() {

build/shared/examples/01.Basics/DigitalReadSerial/DigitalReadSerial.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
/*
22
DigitalReadSerial
3+
34
Reads a digital input on pin 2, prints the result to the Serial Monitor
45

56
This example code is in the public domain.
7+
8+
http://www.arduino.cc/en/Tutorial/DigitalReadSerial
69
*/
710

811
// digital pin 2 has a pushbutton attached to it. Give it a name:

build/shared/examples/01.Basics/Fade/Fade.ino

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
a "~" sign, like ~3, ~5, ~6, ~9, ~10 and ~11.
1212

1313
This example code is in the public domain.
14+
15+
http://www.arduino.cc/en/Tutorial/Fade
1416
*/
1517

1618
int led = 9; // the PWM pin the LED is attached to

build/shared/examples/01.Basics/ReadAnalogVoltage/ReadAnalogVoltage.ino

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
/*
22
ReadAnalogVoltage
3+
34
Reads an analog input on pin 0, converts it to voltage, and prints the result to the Serial Monitor.
4-
Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu)
5+
Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu).
56
Attach the center pin of a potentiometer to pin A0, and the outside pins to +5V and ground.
67

78
This example code is in the public domain.
9+
10+
http://www.arduino.cc/en/Tutorial/ReadAnalogVoltage
811
*/
912

1013
// the setup routine runs once when you press reset:

build/shared/examples/02.Digital/BlinkWithoutDelay/BlinkWithoutDelay.ino

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
/* Blink without Delay
1+
/*
2+
Blink without Delay
23

34
Turns on and off a light emitting diode (LED) connected to a digital
45
pin, without using the delay() function. This means that other code
@@ -7,10 +8,10 @@
78
The circuit:
89
- Use the onboard LED.
910
- Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO
10-
it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to
11-
the correct LED pin independent of which board is used.
12-
If you want to know what pin the on-board LED is connected to on your Arduino model, check
13-
the Technical Specs of your board at https://www.arduino.cc/en/Main/Products
11+
it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to
12+
the correct LED pin independent of which board is used.
13+
If you want to know what pin the on-board LED is connected to on your Arduino model, check
14+
the Technical Specs of your board at https://www.arduino.cc/en/Main/Products
1415

1516
created 2005
1617
by David A. Mellis
@@ -21,7 +22,6 @@
2122
modified 9 Jan 2017
2223
by Arturo Guadalupi
2324

24-
2525
This example code is in the public domain.
2626

2727
http://www.arduino.cc/en/Tutorial/BlinkWithoutDelay

build/shared/examples/02.Digital/Button/Button.ino

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@
44
Turns on and off a light emitting diode(LED) connected to digital
55
pin 13, when pressing a pushbutton attached to pin 2.
66

7-
87
The circuit:
98
- LED attached from pin 13 to ground
109
- pushbutton attached to pin 2 from +5V
1110
- 10K resistor attached to pin 2 from ground
1211

1312
- Note: on most Arduinos there is already an LED on the board
14-
attached to pin 13.
15-
13+
attached to pin 13.
1614

1715
created 2005
1816
by DojoDave <http://www.0j0.org>

build/shared/examples/02.Digital/Debounce/Debounce.ino

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@
99
The circuit:
1010
- LED attached from pin 13 to ground
1111
- pushbutton attached from pin 2 to +5V
12-
- 10K resistor attached from pin 2 to ground
12+
- 10 kilohm resistor attached from pin 2 to ground
1313

1414
- Note: On most Arduino boards, there is already an LED on the board
15-
connected to pin 13, so you don't need any extra components for this example.
15+
connected to pin 13, so you don't need any extra components for this example.
1616

17-
18-
created 21 November 2006
17+
created 21 Nov 2006
1918
by David A. Mellis
2019
modified 30 Aug 2011
2120
by Limor Fried
@@ -24,7 +23,6 @@
2423
modified 30 Aug 2016
2524
by Arturo Guadalupi
2625

27-
2826
This example code is in the public domain.
2927

3028
http://www.arduino.cc/en/Tutorial/Debounce

build/shared/examples/02.Digital/DigitalInputPullup/DigitalInputPullup.ino

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,19 @@
55
digital input on pin 2 and prints the results to the Serial Monitor.
66

77
The circuit:
8-
- Momentary switch attached from pin 2 to ground
9-
- Built-in LED on pin 13
8+
- momentary switch attached from pin 2 to ground
9+
- built-in LED on pin 13
1010

1111
Unlike pinMode(INPUT), there is no pull-down resistor necessary. An internal
1212
20K-ohm resistor is pulled to 5V. This configuration causes the input to
1313
read HIGH when the switch is open, and LOW when it is closed.
1414

15-
created 14 March 2012
15+
created 14 Mar 2012
1616
by Scott Fitzgerald
1717

18-
http://www.arduino.cc/en/Tutorial/InputPullupSerial
19-
20-
This example code is in the public domain
18+
This example code is in the public domain.
2119

20+
http://www.arduino.cc/en/Tutorial/InputPullupSerial
2221
*/
2322

2423
void setup() {

build/shared/examples/02.Digital/StateChangeDetection/StateChangeDetection.ino

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
The circuit:
1313
- pushbutton attached to pin 2 from +5V
14-
- 10K resistor attached to pin 2 from ground
14+
- 10 kilohm resistor attached to pin 2 from ground
1515
- LED attached from pin 13 to ground (or use the built-in LED on
1616
most Arduino boards)
1717

@@ -22,7 +22,6 @@
2222
This example code is in the public domain.
2323

2424
http://www.arduino.cc/en/Tutorial/ButtonStateChange
25-
2625
*/
2726

2827
// this constant won't change:

0 commit comments

Comments
 (0)