Formatting and comments updating.

Formatting and comments updating to improve documentation and make the code more readable.

Author: lendres

examples/CountingButton_Demo_01/CountingButton_Demo_01.ino

@@ -1,6 +1,7 @@
 /*
-	Toggles an LED on when the button is held down and off when the button
-	is released.
+	This example counts and displays the number of times a button is pressed.
+	Once the specified count is reached, an LED is turned on.  A long press
+	will reset the counter and turn the LED off.
 
 	The button should be wired such that when pressed, the "buttonPin" is
 	connected to ground.
@@ -34,12 +35,17 @@ void setup()
 
 void loop()
 {
-	// Press the button once to turn it on, and again to turn it off.
+	// During each loop, the number of times the button is pressed is retrieved
+	// from the button.
 	int count = button.getCount();
 
+	// Display the button count on the serial monitor.
 	Serial.print("Button press count: ");
 	Serial.println(count);
 
+	// If the count is above a specified value, turn the LED on, otherwise turn
+	// if off.  If the button is reset with a long press, the counter is reset
+	// and the LED is turned off.
 	if (count > 4)
 	{
 		digitalWrite(ledPin, HIGH);

examples/CycleButton_Demo_01/CycleButton_Demo_01.ino

@@ -1,17 +1,17 @@
 /*
-  Displays the current value of the CycleButton to the serial monitor.  When
-  the value is greater than a set value, an LED is turned on.
-  
-  The value is incremented each time the button is pushed.  If the value is
-  higher than the maximum value, it resets to the minimum value.  Holding
-  the button down longer than the long press time will also reset the counter.
-  
-  The button should be wired such that when pressed, the "buttonPin" is
-  connected to ground.
+	Displays the current value of the CycleButton to the serial monitor.  When
+	the value is greater than a set value, an LED is turned on.
+
+	The value is incremented each time the button is pushed.  If the value is
+	higher than the maximum value, it resets to the minimum value.  Holding
+	the button down longer than the long press time will also reset the counter.
+
+	The button should be wired such that when pressed, the "buttonPin" is
+	connected to ground.
 
-  The LED should be wired with the "ledPin" to the positive lead and the
-  negative lead should be connected to ground.  A current limiting resistor
-  should be used.
+	The LED should be wired with the "ledPin" to the positive lead and the
+	negative lead should be connected to ground.  A current limiting resistor
+	should be used.
 */
 
 #include "CycleButton.h"
@@ -23,33 +23,38 @@
 int buttonPin   = 8;
 int ledPin      = 9;
 
-// The CycleButton will automatically configure the button pin.
+// The CycleButton will automatically configure the button pin.  The second number is
+// the maximum value of the counter.
 CycleButton button(buttonPin, 6);
 
 void setup()
 {
-  Serial.begin(9600);
-  Serial.println("*** Cycle Button Demo 01 ***");
+	Serial.begin(9600);
+	Serial.println("*** Cycle Button Demo 01 ***");
 
-  // Setup the output LED.
-  pinMode(ledPin, OUTPUT);
-  digitalWrite(ledPin, LOW);
+	// Setup the output LED.
+	pinMode(ledPin, OUTPUT);
+	digitalWrite(ledPin, LOW);
 }
 
 void loop()
 {
-  // Press the button once to turn it on, and again to turn it off.
-  int value = button.getValue();
-  
-  Serial.print("Cycle button value: ");
-  Serial.println(value);
+	// During each loop, the number of times the button is pressed is retrieved
+	// from the button.
+	int value = button.getValue();
+
+	Serial.print("Cycle button value: ");
+	Serial.println(value);
 
-  if (value > 3)
-  {
-    digitalWrite(ledPin, HIGH);
-  }
-  else
-  {
-    digitalWrite(ledPin, LOW);
-  }
-}
+	// If the count is above a specified value, turn the LED on, otherwise turn
+	// if off.  Once the button's max value is reached, it will reset to the first
+	// value and the LED is turned off.  The button can also be manually reset.
+	if (value > 2)
+	{
+		digitalWrite(ledPin, HIGH);
+	}
+	else
+	{
+		digitalWrite(ledPin, LOW);
+	}
+}

examples/LatchingButton_Demo_01/LatchingButton_Demo_01.ino

@@ -1,6 +1,8 @@
 /*
-	Toggles an LED on when the button is held down and off when the button
-	is released.
+	Toggles an LED when a button is pressed and released.  The LED is set to
+	the current state of the button.  If the button is latched, the LED is on,
+	if the button is not latched, the LED is off.  This button uses the "isLatched"
+	function to determine the buttons state.
 
 	The button should be wired such that when pressed, the "buttonPin" is
 	connected to ground.

examples/LatchingButton_Demo_02/LatchingButton_Demo_02.ino

@@ -1,6 +1,8 @@
 /*
-	Toggles an LED on when the button is held down and off when the button
-	is released.
+	Toggles an LED when a button is pressed and released.  The LED is set to
+	the current state of the button.  If the button is latched, the LED is on,
+	if the button is not latched, the LED is off.  This example uses the "getStatus"
+	function to determine the current state of the button.
 
 	The button should be wired such that when pressed, the "buttonPin" is
 	connected to ground.

examples/MomentaryButton_Demo_01/MomentaryButton_Demo_01.ino

@@ -1,5 +1,6 @@
 /*
-	Toggles an LED between on and off with each press of the button.
+	Turns an LED on when the button is pressed and off when the button is released.
+	This example demonstrates the "isPressed" function.
 
 	The button should be wired such that when pressed, the "buttonPin" is
 	connected to ground.

examples/MomentaryButton_Demo_02/MomentaryButton_Demo_02.ino

@@ -1,5 +1,6 @@
 /*
-	Toggles an LED between on and off with each press of the button.
+	Toggles an LED between on and off each time the button is pressed and released.
+	This example demonstrates the "wasPressed" function.
 
 	The button should be wired such that when pressed, the "buttonPin" is
 	connected to ground.

examples/MomentaryButton_Demo_03/MomentaryButton_Demo_03.ino

@@ -1,5 +1,6 @@
 /*
-	Toggles an LED between on and off with each press of the button.
+	Toggles an LED between on and off with each time a button is pressed and released.
+	This example demonstrates the "getStatus" function.
 
 	The button should be wired such that when pressed, the "buttonPin" is
 	connected to ground.

src/AlwaysOffButton.h

@@ -36,8 +36,10 @@ class AlwaysOffButton : public SimpleButton
 	public:
 		AlwaysOffButton(int pin);
 		AlwaysOffButton(int pin, int debounceInterval);
+		
 		~AlwaysOffButton();
 
+	// Status access functions.  Call in the "loop" to get the status of the button.
 	public:
 		// Returns true if the button is currently pressed.
 		BUTTONSTATUS getStatus();

src/AlwaysOnButton.h

@@ -36,8 +36,10 @@ class AlwaysOnButton : public SimpleButton
 	public:
 		AlwaysOnButton(int pin);
 		AlwaysOnButton(int pin, int debounceInterval);
+		
 		~AlwaysOnButton();
 
+	// Status access functions.  Call in the "loop" to get the status of the button.
 	public:
 		// Returns true if the button is currently pressed.
 		BUTTONSTATUS getStatus();

src/CountingButton.h

@@ -45,14 +45,20 @@ class CountingButton : public ButtonBase, public ResetableButton
 	public:
 		CountingButton(int pin);
 		CountingButton(int pin, int debounceInterval);
+
 		~CountingButton();
 
+	// Set up functions.  Normally, these would be called in the "setup" function of your sketch.
 	public:
 		void setLongPressInterval(int longPressInterval);
 
+	// Status access functions.  Call in the "loop" to get the status of the button.
+	public:
 		// Checks the button and returns the current count.
 		int getCount();
 
+	// Other control functions.
+	public:
 		// Return to zero.
 		void reset();