Update all the example comments

Author: micromouseonline

examples/poll-in-loop/poll-in-loop.ino

@@ -12,6 +12,15 @@
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
+
+ This example creates a single encoder instance that is updated by
+ running the service method directly in the main program loop. This
+ must be called frequently enough to avoid missing any pin changes. That
+ means several hundred times a second in many cases. If a change is detected
+ in the main loop, the current count is sent to the serial port.
+ 
+ You can add a delay into the loop in this eample to see just how often you
+ need to call the service method and still get reliable counts.
  */
 
 #include <Arduino.h>

examples/two-encoders/two-encoders.ino

@@ -1,17 +1,21 @@
 /*
- Copyright 2021 Peter Harrison - Helicron
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
-      https://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
+  Copyright 2021 Peter Harrison - Helicron
+ 
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+ 
+       https://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+ 
+  This example creates two independent encoders and samples them using a 
+  timer interrupt. If either changes, the current count for both is sent to
+  the serial port.
  */
 
 #include <Arduino.h>

examples/using-pin-change/using-pin-change.ino

@@ -12,6 +12,13 @@
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
+
+ This example creates a single encoder instance that is updated by
+ pin-change interrupts associated with the two pins. If a change is detected
+ in the main loop, the current count is sent to the serial port. 
+ 
+ Note that if you enable pin change interrupts for other pins in the same
+ group, you may cause conflicts.
  */
 
 #include <Arduino.h>

examples/using-timerone/using-timerone.ino

@@ -12,6 +12,14 @@
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
+
+
+ This example creates a single encoder instance that is updated by
+ a timer interrupt running at 1kHz. If a change is detected
+ in the main loop, the current count is sent to the serial port.
+ 
+ Be sure that the timer interrupt is frequent enough that it cannot miss
+ a change in pin state.
  */
 
 #include <Arduino.h>