8000 Use Auto Format compatible bullet character in built-in example comme… · arduino/arduino-examples@f8f0232 · GitHub
[go: up one dir, main page]
Skip to content

Commit f8f0232

Browse files
per1234cmaglie
per1234
authored and
cmaglie
committed
Use Auto Format compatible bullet character in built-in example comment lists
Tools > Auto Format in the Arduino IDE removes asterisks from the start of every line in a C style comment, causing that character to be unsuitable for use as a bullet for lists in the example comments.
1 parent c9437b2 commit f8f0232

File tree

41 files changed

+94
-94
lines changed

Some content is hidden

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

41 files changed

+94
-94
lines changed

‎examples/02.Digital/BlinkWithoutDelay/BlinkWithoutDelay.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
can run at the same time without being interrupted by the LED code.
66
77
The circuit:
8-
* Use the onboard LED.
9-
* Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO
8+
- Use the onboard LED.
9+
- Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO
1010
it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to
1111
the correct LED pin independent of which board is used.
1212
If you want to know what pin the on-board LED is connected to on your Arduino model, check

‎examples/02.Digital/Button/Button.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
77
88
The circuit:
9-
* LED attached from pin 13 to ground
10-
* pushbutton attached to pin 2 from +5V
11-
* 10K resistor attached to pin 2 from ground
9+
- LED attached from pin 13 to ground
10+
- pushbutton attached to pin 2 from +5V
11+
- 10K resistor attached to pin 2 from ground
1212
13-
* Note: on most Arduinos there is already an LED on the board
13+
- Note: on most Arduinos there is already an LED on the board
1414
attached to pin 13.
1515
1616

‎examples/02.Digital/Debounce/Debounce.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
noise).
88
99
The circuit:
10-
* LED attached from pin 13 to ground
11-
* pushbutton attached from pin 2 to +5V
12-
* 10K resistor attached from pin 2 to ground
10+
- LED attached from pin 13 to ground
11+
- pushbutton attached from pin 2 to +5V
12+
- 10K resistor attached from pin 2 to ground
1313
14-
* Note: On most Arduino boards, there is already an LED on the board
14+
- Note: On most Arduino boards, there is already an LED on the board
1515
connected to pin 13, so you don't need any extra components for this example.
1616
1717

‎examples/02.Digital/DigitalInputPullup/DigitalInputPullup.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
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

‎examples/02.Digital/StateChangeDetection/StateChangeDetection.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
and on to off.
1111
1212
The circuit:
13-
* pushbutton attached to pin 2 from +5V
14-
* 10K resistor attached to pin 2 from ground
15-
* LED attached from pin 13 to ground (or use the built-in LED on
13+
- pushbutton attached to pin 2 from +5V
14+
- 10K resistor attached to pin 2 from ground
15+
- LED attached from pin 13 to ground (or use the built-in LED on
1616
most Arduino boards)
1717
1818
created 27 Sep 2005

‎examples/02.Digital/toneKeyboard/toneKeyboard.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Plays a pitch that changes based on a changing analog input
55
66
circuit:
7-
* 3 force-sensing resistors from +5V to analog in 0 through 5
8-
* 3 10K resistors from analog in 0 through 5 to ground
9-
* 8-ohm speaker on digital pin 8
7+
- 3 force-sensing resistors from +5V to analog in 0 through 5
8+
- 3 10K resistors from analog in 0 through 5 to ground
9+
- 8-ohm speaker on digital pin 8
1010
1111
created 21 Jan 2010
1212
modified 9 Apr 2012

‎examples/02.Digital/toneMelody/toneMelody.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Plays a melody
55
66
circuit:
7-
* 8-ohm speaker on digital pin 8
7+
- 8-ohm speaker on digital pin 8
88
99
created 21 Jan 2010
1010
modified 30 Aug 2011

‎examples/02.Digital/toneMultiple/toneMultiple.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Plays multiple tones on multiple pins in sequence
55
66
circuit:
7-
* 3 8-ohm speaker on digital pins 6, 7, and 8
7+
- 3 8-ohm speaker on digital pins 6, 7, and 8
88
99
created 8 March 2010
1010
by Tom Igoe

‎examples/02.Digital/tonePitchFollower/tonePitchFollower.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Plays a pitch that changes based on a changing analog input
55
66
circuit:
7-
* 8-ohm speaker on digital pin 9
8-
* photoresistor on analog 0 to 5V
9-
* 4.7K resistor on analog 0 to ground
7+
- 8-ohm speaker on digital pin 9
8+
- photoresistor on analog 0 to 5V
9+
- 4.7K resistor on analog 0 to ground
1010
1111
created 21 Jan 2010
1212
modified 31 May 2012

‎examples/03.Analog/AnalogInOutSerial/AnalogInOutSerial.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
Also prints the results to the Serial Monitor.
77
88
The circuit:
9-
* potentiometer connected to analog pin 0.
9+
- potentiometer connected to analog pin 0.
1010
Center pin of the potentiometer goes to the analog pin.
1111
side pins of the potentiometer go to +5V and ground
12-
* LED connected from digital pin 9 to ground
12+
- LED connected from digital pin 9 to ground
1313
1414
created 29 Dec. 2008
1515
modified 9 Apr 2012

‎examples/03.Analog/AnalogInput/AnalogInput.ino

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
the value obtained by analogRead().
77
88
The circuit:
9-
* Potentiometer attached to analog input 0
10-
* center pin of the potentiometer to the analog pin
11-
* one side pin (either one) to ground
12-
* the other side pin to +5V
13-
* LED anode (long leg) attached to digital output 13
14-
* LED cathode (short leg) attached to ground
15-
16-
* Note: because most Arduinos have a built-in LED attached
9+
- Potentiometer attached to analog input 0
10+
- center pin of the potentiometer to the analog pin
11+
- one side pin (either one) to ground
12+
- the other side pin to +5V
13+
- LED anode (long leg) attached to digital output 13
14+
- LED cathode (short leg) attached to ground
15+
16+
- Note: because most Arduinos have a built-in LED attached
1717
to pin 13 on the board, the LED is optional.
1818
1919

‎examples/03.Analog/AnalogWriteMega/AnalogWriteMega.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This sketch was written for the Arduino Mega, and will not work on other boards.
66
77
The circuit:
8-
* LEDs attached from pins 2 through 13 to ground.
8+
- LEDs attached from pins 2 through 13 to ground.
99
1010
created 8 Feb 2009
1111
by Tom Igoe

‎examples/03.Analog/Calibration/Calibration.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
maximum low and listen for anything higher as the new maximum.
1313
1414
The circuit:
15-
* Analog sensor (potentiometer will do) attached to analog input 0
16-
* LED attached from digital pin 9 to ground
15+
- Analog sensor (potentiometer will do) attached to analog input 0
16+
- LED attached from digital pin 9 to ground
1717
1818
created 29 Oct 2008
1919
By David A Mellis

‎examples/03.Analog/Fading/Fading.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This example shows how to fade an LED using the analogWrite() function.
55
66
The circuit:
7-
* LED attached from digital pin 9 to ground.
7+
- LED attached from digital pin 9 to ground.
88
99
Created 1 Nov 2008
1010
By David A. Mellis

‎examples/03.Analog/Smoothing/Smoothing.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
continually averages them.
88
99
The circuit:
10-
* Analog sensor (potentiometer will do) attached to analog input 0
10+
- Analog sensor (potentiometer will do) attached to analog input 0
1111
1212
Created 22 April 2007
1313
By David A. Mellis <dam@mellis.org>

‎examples/04.Communication/ASCIITable/ASCIITable.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
ASCII table
33
44
Prints out byte values in all possible formats:
5-
* as raw binary values
6-
* as ASCII-encoded decimal, hex, octal, and binary values
5+
- as raw binary values
6+
- as ASCII-encoded decimal, hex, octal, and binary values
77
88
For more on ASCII, see http://www.asciitable.com and http://en.wikipedia.org/wiki/ASCII
99

‎examples/04.Communication/Midi/Midi.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
88
99
The circuit:
10-
* digital in 1 connected to MIDI jack pin 5
11-
* MIDI jack pin 2 connected to ground
12-
* MIDI jack pin 4 connected to +5V through 220-ohm resistor
10+
- digital in 1 connected to MIDI jack pin 5
11+
- MIDI jack pin 2 connected to ground
12+
- MIDI jack pin 4 connected to +5V through 220-ohm resistor
1313
Attach a MIDI cable to the jack, then to a MIDI synth, and play music.
1414
1515
created 13 Jun 2006

‎examples/04.Communication/MultiSerial/MultiSerial.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
This example works only with boards with more than one serial like Arduino Mega, Due, Zero etc
88
99
The circuit:
10-
* Any serial device attached to Serial port 1
11-
* Serial monitor open on Serial port 0:
10+
- Any serial device attached to Serial port 1
11+
- Serial monitor open on Serial port 0:
1212
1313
created 30 Dec. 2008
1414
modified 20 May 2012

‎examples/04.Communication/PhysicalPixel/PhysicalPixel.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
proxy), PD, or Max/MSP.
1212
1313
The circuit:
14-
* LED connected from digital pin 13 to ground
14+
- LED connected from digital pin 13 to ground
1515
1616
created 2006
1717
by David A. Mellis

‎examples/04.Communication/ReadASCIIString/ReadASCIIString.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
It parses them into ints, and uses those to fade an RGB LED.
77
88
Circuit: Common-Cathode RGB LED wired like so:
9-
* Red anode: digital pin 3
10-
* Green anode: digital pin 5
11-
* Blue anode: digital pin 6
12-
* Cathode : GND
9+
- Red anode: digital pin 3
10+
- Green anode: digital pin 5
11+
- Blue anode: digital pin 6
12+
- Cathode : GND
1313
1414
created 13 Apr 2012
1515
by Tom Igoe

‎examples/04.Communication/SerialCallResponse/SerialCallResponse.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
Thanks to Greg Shakar and Scott Fitzgerald for the improvements
1111
1212
The circuit:
13-
* potentiometers attached to analog inputs 0 and 1
14-
* pushbutton attached to digital I/O 2
13+
- potentiometers attached to analog inputs 0 and 1
14+
- pushbutton attached to digital I/O 2
1515
1616
Created 26 Sept. 2005
1717
by Tom Igoe

‎examples/04.Communication/SerialCallResponseASCII/SerialCallResponseASCII.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
Thanks to Greg Shakar and Scott Fitzgerald for the improvements
1313
1414
The circuit:
15-
* potentiometers attached to analog inputs 0 and 1
16-
* pushbutton attached to digital I/O 2
15+
- potentiometers attached to analog inputs 0 and 1
16+
- pushbutton attached to digital I/O 2
1717
1818
1919

‎examples/04.Communication/VirtualColorMixer/VirtualColorMixer.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
take those three values and use them to change the background color of the screen.
55
66
The circuit:
7-
* potentiometers attached to analog inputs 0, 1, and 2
7+
- potentiometers attached to analog inputs 0, 1, and 2
88
99
http://www.arduino.cc/en/Tutorial/VirtualColorMixer
1010

‎examples/05.Control/Arrays/Arrays.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
contiguous, here the pins can be in any random order.
1010
1111
The circuit:
12-
* LEDs from pins 2 through 7 to ground
12+
- LEDs from pins 2 through 7 to ground
1313
1414
created 2006
1515
by David A. Mellis

‎examples/05.Control/ForLoopIteration/ForLoopIteration.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Lights multiple LEDs in sequence, then in reverse.
66
77
The circuit:
8-
* LEDs from pins 2 through 7 to ground
8+
- LEDs from pins 2 through 7 to ground
99
1010
created 2006
1111
by David A. Mellis

‎examples/05.Control/IfStatementConditional/IfStatementConditional.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
regardless of the level.
88
99
The circuit:
10-
* potentiometer connected to analog pin 0.
10+
- potentiometer connected to analog pin 0.
1111
Center pin of the potentiometer goes to the analog pin.
1212
side pins of the potentiometer go to +5V and ground
13-
* LED connected from digital pin 13 to ground
13+
- LED connected from digital pin 13 to ground
1414
15-
* Note: On most Arduino boards, there is already an LED on the board
15+
- Note: On most Arduino boards, there is already an LED on the board
1616
connected to pin 13, so you don't need any extra components for this example.
1717
1818
created 17 Jan 2009

‎examples/05.Control/WhileStatementConditional/WhileStatementConditional.ino

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
This is a variation on the calibrate example.
1111
1212
The circuit:
13-
* photoresistor connected from +5V to analog in pin 0
14-
* 10K resistor connected from ground to analog in pin 0
15-
* LED connected from digital pin 9 to ground through 220 ohm resistor
16-
* pushbutton attached from pin 2 to +5V
17-
* 10K resistor attached from pin 2 to ground
13+
- photoresistor connected from +5V to analog in pin 0
14+
- 10K resistor connected from ground to analog in pin 0
15+
- LED connected from digital pin 9 to ground through 220 ohm resistor
16+
- pushbutton attached from pin 2 to +5V
17+
- 10K resistor attached from pin 2 to ground
1818
1919
created 17 Jan 2009
2020
modified 30 Aug 2011

‎examples/05.Control/switchCase/switchCase.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
over the sensor.
1111
1212
The circuit:
13-
* photoresistor from analog in 0 to +5V
14-
* 10K resistor from analog in 0 to ground
13+
- photoresistor from analog in 0 to +5V
14+
- 10K resistor from analog in 0 to ground
1515
1616
created 1 Jul 2009
1717
modified 9 Apr 2012

‎examples/05.Control/switchCase2/switchCase2.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
the LEDs off.
1111
1212
The circuit:
13-
* 5 LEDs attached to digital pins 2 through 6 through 220-ohm resistors
13+
- 5 LEDs attached to digital pins 2 through 6 through 220-ohm resistors
1414
1515
created 1 Jul 2009
1616
by Tom Igoe

‎examples/06.Sensors/Knock/Knock.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
"knock" to the serial port, and toggles the LED on pin 13.
77
88
The circuit:
9-
* + connection of the piezo attached to analog in 0
10-
* - connection of the piezo attached to ground
11-
* 1-megohm resistor attached from analog in 0 to ground
9+
- + connection of the piezo attached to analog in 0
10+
- - connection of the piezo attached to ground
11+
- 1-megohm resistor attached from analog in 0 to ground
1212
1313
http://www.arduino.cc/en/Tutorial/Knock
1414

‎examples/06.Sensors/Memsic2125/Memsic2125.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
computer.
88
99
The circuit:
10-
* X output of accelerometer to digital pin 2
11-
* Y output of accelerometer to digital pin 3
12-
* +V of accelerometer to +5V
13-
* GND of accelerometer to ground
10+
- X output of accelerometer to digital pin 2
11+
- Y output of accelerometer to digital pin 3
12+
- +V of accelerometer to +5V
13+
- GND of accelerometer to ground
1414
1515
http://www.arduino.cc/en/Tutorial/Memsic2125
1616

‎examples/06.Sensors/Ping/Ping.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
the distance of the object from the sensor.
88
99
The circuit:
10-
* +V connection of the PING))) attached to +5V
11-
* GND connection of the PING))) attached to ground
12-
* SIG connection of the PING))) attached to digital pin 7
10+
- +V connection of the PING))) attached to +5V
11+
- GND connection of the PING))) attached to ground
12+
- SIG connection of the PING))) attached to digital pin 7
1313
1414
http://www.arduino.cc/en/Tutorial/Ping
1515

0 commit comments

Comments
 (0)
0