Improve built-in example comments

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

@@ -1,10 +1,13 @@
 /*
   AnalogReadSerial
-  Reads an analog input on pin 0, prints the result to the serial monitor.
-  Graphical representation is available using serial plotter (Tools > Serial Plotter menu)
+
+  Reads an analog input on pin 0, prints the result to the Serial Monitor.
+  Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu).
   Attach the center pin of a potentiometer to pin A0, and the outside pins to +5V and ground.
 
   This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/AnalogReadSerial
 */
 
 // the setup routine runs once when you press reset:

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

@@ -1,25 +1,26 @@
 /*
   Blink
-  Turns on an LED on for one second, then off for one second, repeatedly.
 
-  Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO 
+  Turns an LED on for one second, then off for one second, repeatedly.
+
+  Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO
   it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to
   the correct LED pin independent of which board is used.
-  If you want to know what pin the on-board LED is connected to on your Arduino model, check
-  the Technical Specs of your board  at https://www.arduino.cc/en/Main/Products
-
-  This example code is in the public domain.
+  If you want to know what pin the on-board LED is connected to on your Arduino
+  model, check the Technical Specs of your board at:
+  https://www.arduino.cc/en/Main/Products
 
   modified 8 May 2014
   by Scott Fitzgerald
-
   modified 2 Sep 2016
   by Arturo Guadalupi
-
   modified 8 Sep 2016
   by Colby Newman
-*/
 
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/Blink
+*/
 
 // the setup function runs once when you press reset or power the board
 void setup() {

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

@@ -1,9 +1,12 @@
 /*
   DigitalReadSerial
- Reads a digital input on pin 2, prints the result to the serial monitor
 
- This example code is in the public domain.
- */
+  Reads a digital input on pin 2, prints the result to the Serial Monitor
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/DigitalReadSerial
+*/
 
 // digital pin 2 has a pushbutton attached to it. Give it a name:
 int pushButton = 2;
@@ -24,6 +27,3 @@ void loop() {
   Serial.println(buttonState);
   delay(1);        // delay in between reads for stability
 }
-
-
-

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

@@ -1,17 +1,17 @@
 /*
- Fade
+  Fade
 
- This example shows how to fade an LED on pin 9
- using the analogWrite() function.
+  This example shows how to fade an LED on pin 9 using the analogWrite()
+  function.
 
- The analogWrite() function uses PWM, so if
- you want to change the pin you're using, be
- sure to use another PWM capable pin. On most
- Arduino, the PWM pins are identified with 
- a "~" sign, like ~3, ~5, ~6, ~9, ~10 and ~11.
+  The analogWrite() function uses PWM, so if you want to change the pin you're
+  using, be sure to use another PWM capable pin. On most Arduino, the PWM pins
+  are identified with a "~" sign, like ~3, ~5, ~6, ~9, ~10 and ~11.
 
- This example code is in the public domain.
- */
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/Fade
+*/
 
 int led = 9;           // the PWM pin the LED is attached to
 int brightness = 0;    // how bright the LED is

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

@@ -1 +1 @@
-Demonstrates the use of analog output to fade an LED.
+Demonstrates the use of analogWrite() to fade an LED.

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

@@ -1,10 +1,13 @@
 /*
   ReadAnalogVoltage
-  Reads an analog input on pin 0, converts it to voltage, and prints the result to the serial monitor.
-  Graphical representation is available using serial plotter (Tools > Serial Plotter menu)
+
+  Reads an analog input on pin 0, converts it to voltage, and prints the result to the Serial Monitor.
+  Graphical representation is available using Serial Plotter (Tools > Serial Plotter menu).
   Attach the center pin of a potentiometer to pin A0, and the outside pins to +5V and ground.
 
   This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/ReadAnalogVoltage
 */
 
 // the setup routine runs once when you press reset:

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

@@ -1 +1 @@
-Reads an analog input and prints the voltage to the serial monitor.
+Reads an analog input and prints the voltage to the Serial Monitor.

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

@@ -1,43 +1,44 @@
-/* Blink without Delay
-
- Turns on and off a light emitting diode (LED) connected to a digital
- pin, without using the delay() function.  This means that other code
- can run at the same time without being interrupted by the LED code.
-
- The circuit:
- * Use the onboard LED.
- * Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA and ZERO 
-  it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN is set to
-  the correct LED pin independent of which board is used.
-  If you want to know what pin the on-board LED is connected to on your Arduino model, check
-  the Technical Specs of your board  at https://www.arduino.cc/en/Main/Products
-
- created 2005
- by David A. Mellis
- modified 8 Feb 2010
- by Paul Stoffregen
- modified 11 Nov 2013
- by Scott Fitzgerald
- modified 9 Jan 2017
- by Arturo Guadalupi
-
-
- This example code is in the public domain.
-
- http://www.arduino.cc/en/Tutorial/BlinkWithoutDelay
- */
-
-// constants won't change. Used here to set a pin number :
+/*
+  Blink without Delay
+
+  Turns on and off a light emitting diode (LED) connected to a digital pin,
+  without using the delay() function. This means that other code can run at the
+  same time without being interrupted by the LED code.
+
+  The circuit:
+  - Use the onboard LED.
+  - Note: Most Arduinos have an on-board LED you can control. On the UNO, MEGA
+    and ZERO it is attached to digital pin 13, on MKR1000 on pin 6. LED_BUILTIN
+    is set to the correct LED pin independent of which board is used.
+    If you want to know what pin the on-board LED is connected to on your
+    Arduino model, check the Technical Specs of your board at:
+    https://www.arduino.cc/en/Main/Products
+
+  created 2005
+  by David A. Mellis
+  modified 8 Feb 2010
+  by Paul Stoffregen
+  modified 11 Nov 2013
+  by Scott Fitzgerald
+  modified 9 Jan 2017
+  by Arturo Guadalupi
+
+  This example code is in the public domain.
+
+  http://www.arduino.cc/en/Tutorial/BlinkWithoutDelay
+*/
+
+// constants won't change. Used here to set a pin number:
 const int ledPin =  LED_BUILTIN;// the number of the LED pin
 
-// Variables will change :
+// Variables will change:
 int ledState = LOW;             // ledState used to set the LED
 
 // Generally, you should use "unsigned long" for variables that hold time
 // The value will quickly become too large for an int to store
 unsigned long previousMillis = 0;        // will store last time LED was updated
 
-// constants won't change :
+// constants won't change:
 const long interval = 1000;           // interval at which to blink (milliseconds)
 
 void setup() {
@@ -48,10 +49,9 @@ void setup() {
 void loop() {
   // here is where you'd put code that needs to be running all the time.
 
-  // check to see if it's time to blink the LED; that is, if the
-  // difference between the current time and last time you blinked
-  // the LED is bigger than the interval at which you want to
-  // blink the LED.
+  // check to see if it's time to blink the LED; that is, if the difference
+  // between the current time and last time you blinked the LED is bigger than
+  // the interval at which you want to blink the LED.
   unsigned long currentMillis = millis();
 
   if (currentMillis - previousMillis >= interval) {
@@ -69,4 +69,3 @@ void loop() {
     digitalWrite(ledPin, ledState);
   }
 }
-

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

@@ -1,31 +1,28 @@
 /*
   Button
 
- Turns on and off a light emitting diode(LED) connected to digital
- pin 13, when pressing a pushbutton attached to pin 2.
+  Turns on and off a light emitting diode(LED) connected to digital pin 13,
+  when pressing a pushbutton attached to pin 2.
 
+  The circuit:
+  - LED attached from pin 13 to ground
+  - pushbutton attached to pin 2 from +5V
+  - 10K resistor attached to pin 2 from ground
 
- The circuit:
- * LED attached from pin 13 to ground
- * pushbutton attached to pin 2 from +5V
- * 10K resistor attached to pin 2 from ground
+  - Note: on most Arduinos there is already an LED on the board
+    attached to pin 13.
 
- * Note: on most Arduinos there is already an LED on the board
- attached to pin 13.
+  created 2005
+  by DojoDave <http://www.0j0.org>
+  modified 30 Aug 2011
+  by Tom Igoe
 
+  This example code is in the public domain.
 
- created 2005
- by DojoDave <http://www.0j0.org>
- modified 30 Aug 2011
- by Tom Igoe
+  http://www.arduino.cc/en/Tutorial/Button
+*/
 
- This example code is in the public domain.
-
- http://www.arduino.cc/en/Tutorial/Button
- */
-
-// constants won't change. They're used here to
-// set pin numbers:
+// constants won't change. They're used here to set pin numbers:
 const int buttonPin = 2;     // the number of the pushbutton pin
 const int ledPin =  13;      // the number of the LED pin
 
@@ -43,13 +40,12 @@ void loop() {
   // read the state of the pushbutton value:
   buttonState = digitalRead(buttonPin);
 
-  // check if the pushbutton is pressed.
-  // if it is, the buttonState is HIGH:
+  // check if the pushbutton is pressed. If it is, the buttonState is HIGH:
   if (buttonState == HIGH) {
     // turn LED on:
     digitalWrite(ledPin, HIGH);
   } else {
     // turn LED off:
     digitalWrite(ledPin, LOW);
   }
-}
+}

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

@@ -1,37 +1,33 @@
 /*
- Debounce
+  Debounce
 
- Each time the input pin goes from LOW to HIGH (e.g. because of a push-button
- press), the output pin is toggled from LOW to HIGH or HIGH to LOW.  There's
- a minimum delay between toggles to debounce the circuit (i.e. to ignore
- noise).
+  Each time the input pin goes from LOW to HIGH (e.g. because of a push-button
+  press), the output pin is toggled from LOW to HIGH or HIGH to LOW. There's a
+  minimum delay between toggles to debounce the circuit (i.e. to ignore noise).
 
- The circuit:
- * LED attached from pin 13 to ground
- * pushbutton attached from pin 2 to +5V
- * 10K resistor attached from pin 2 to ground
+  The circuit:
+  - LED attached from pin 13 to ground
+  - pushbutton attached from pin 2 to +5V
+  - 10 kilohm resistor attached from pin 2 to ground
 
- * Note: On most Arduino boards, there is already an LED on the board
- connected to pin 13, so you don't need any extra components for this example.
+  - Note: On most Arduino boards, there is already an LED on the board connected
+    to pin 13, so you don't need any extra components for this example.
 
+  created 21 Nov 2006
+  by David A. Mellis
+  modified 30 Aug 2011
+  by Limor Fried
+  modified 28 Dec 2012
+  by Mike Walters
+  modified 30 Aug 2016
+  by Arturo Guadalupi
 
- created 21 November 2006
- by David A. Mellis
- modified 30 Aug 2011
- by Limor Fried
- modified 28 Dec 2012
- by Mike Walters
- modified 30 Aug 2016
- by Arturo Guadalupi
+  This example code is in the public domain.
 
+  http://www.arduino.cc/en/Tutorial/Debounce
+*/
 
- This example code is in the public domain.
-
- http://www.arduino.cc/en/Tutorial/Debounce
- */
-
-// constants won't change. They're used here to
-// set pin numbers:
+// constants won't change. They're used here to set pin numbers:
 const int buttonPin = 2;    // the number of the pushbutton pin
 const int ledPin = 13;      // the number of the LED pin
 
@@ -40,8 +36,8 @@ int ledState = HIGH;         // the current state of the output pin
 int buttonState;             // the current reading from the input pin
 int lastButtonState = LOW;   // the previous reading from the input pin
 
-// the following variables are unsigned long's because the time, measured in miliseconds,
-// will quickly become a bigger number than can be stored in an int.
+// the following variables are unsigned longs because the time, measured in
+// milliseconds, will quickly become a bigger number than can be stored in an int.
 unsigned long lastDebounceTime = 0;  // the last time the output pin was toggled
 unsigned long debounceDelay = 50;    // the debounce time; increase if the output flickers
 
@@ -58,8 +54,8 @@ void loop() {
   int reading = digitalRead(buttonPin);
 
   // check to see if you just pressed the button
-  // (i.e. the input went from LOW to HIGH),  and you've waited
-  // long enough since the last press to ignore any noise:
+  // (i.e. the input went from LOW to HIGH), and you've waited long enough
+  // since the last press to ignore any noise:
 
   // If the switch changed, due to noise or pressing:
   if (reading != lastButtonState) {
@@ -68,8 +64,8 @@ void loop() {
   }
 
   if ((millis() - lastDebounceTime) > debounceDelay) {
-    // whatever the reading is at, it's been there for longer
-    // than the debounce delay, so take it as the actual current state:
+    // whatever the reading is at, it's been there for longer than the debounce
+    // delay, so take it as the actual current state:
 
     // if the button state has changed:
     if (reading != buttonState) {
@@ -85,8 +81,6 @@ void loop() {
   // set the LED:
   digitalWrite(ledPin, ledState);
 
-  // save the reading.  Next time through the loop,
-  // it'll be the lastButtonState:
+  // save the reading. Next time through the loop, it'll be the lastButtonState:
   lastButtonState = reading;
 }
-