Apply Per's feedback and add more comments

Author: Hannes7eicher

libraries/AnalogWave/examples/DACEqualTemperedScale/DACEqualTemperedScale.ino

@@ -21,6 +21,9 @@
    created 18 Dec 2018
    modified 3 Jul 2023
    by Tom Igoe
+
+  See the full documentation here:
+  https://docs.arduino.cc/tutorials/uno-r4-wifi/dac
 */
 
 // include the AnalogWave library:

libraries/AnalogWave/examples/DACJacques/DACJacques.ino

@@ -1,4 +1,4 @@
-  /*
+/*
   DAC Melody player
 
   Generates a series of tones from MIDI note values
@@ -14,6 +14,9 @@ circuit:
   created 13 Feb 2017
   modified 3 Jul 2023
   by Tom Igoe
+
+  See the full documentation here:
+  https://docs.arduino.cc/tutorials/uno-r4-wifi/dac
 */
 #include "analogWave.h"
 analogWave wave(DAC);

libraries/AnalogWave/examples/SineWave/SineWave.ino

@@ -3,7 +3,7 @@
 
   Generates a pre-generated sawtooth-waveform.
 
-  See the full documentatio here:
+  See the full documentation here:
   https://docs.arduino.cc/tutorials/uno-r4-wifi/dac
 */
 

libraries/Arduino_CAN/examples/CANRead/CANRead.ino

@@ -1,3 +1,12 @@
+/*
+  CANRead
+
+  Receive and read CAN Bus messages
+
+  See the full documentation here:
+  https://docs.arduino.cc/tutorials/uno-r4-wifi/can
+*/
+
 /**************************************************************************************
  * INCLUDE
  **************************************************************************************/

libraries/Arduino_CAN/examples/CANWrite/CANWrite.ino

@@ -1,3 +1,12 @@
+/*
+  CANWrite
+
+  Write and send CAN Bus messages
+
+  See the full documentation here:
+  https://docs.arduino.cc/tutorials/uno-r4-wifi/can
+*/
+
 /**************************************************************************************
  * INCLUDE
  **************************************************************************************/

libraries/Arduino_FreeRTOS/examples/FreeRTOS-Blink/FreeRTOS-Blink.ino

@@ -1,3 +1,11 @@
+/*
+  The code demonstrates the usage of FreeRTOS (Real-Time Operating System) to run concurrent tasks.
+
+  One task is responsible for running the loop() logic (in a thread-safe manner), 
+  while the other task blinks an LED using the built-in LED on non-Portenta boards or 
+  the RGB LED on the Portenta C33 board.
+*/
+
 /**************************************************************************************
  * INCLUDE
  **************************************************************************************/

libraries/Arduino_LED_Matrix/examples/DisplaySingleFrame/DisplaySingleFrame.ino

@@ -1,38 +1,38 @@
 /*
-Single Frame
-
-Displays single frames using matrix.loadFrame
-
-See the full documentation here:
-https://docs.arduino.cc/tutorials/uno-r4-wifi/led-matrix
+  Single Frame
+  
+  Displays single frames using matrix.loadFrame
+  
+  See the full documentation here:
+  https://docs.arduino.cc/tutorials/uno-r4-wifi/led-matrix
 */
 
-#include "Arduino_LED_Matrix.h"   // Include the library for controlling LED matrix
+#include "Arduino_LED_Matrix.h"   // Include the LED_Matrix library
 #include "frames.h"               // Include a header file containing frame data
 
 ArduinoLEDMatrix matrix;          // Create an instance of the ArduinoLEDMatrix class
 
 void setup() {
   Serial.begin(115200);           // Initialize serial communication at a baud rate of 115200
   matrix.begin();                 // Initialize the LED matrix
-}   
+}
 
 void loop() {
   // Load and display the "chip" frame on the LED matrix
   matrix.loadFrame(chip);
   delay(500);  // Pause for 500 milliseconds (half a second)
 
-  // Load and display the "happy" frame on the LED matrix
+  // Load and display the "danger" frame on the LED matrix
   matrix.loadFrame(danger);
-  delay(500);  // Pause for 500 milliseconds (half a second)
+  delay(500);
 
   // Load and display the "happy" frame on the LED matrix
   matrix.loadFrame(happy);
-  delay(500);  // Pause for 500 milliseconds (half a second)
+  delay(500);
 
   // Load and display the "heart" frame on the LED matrix
   matrix.loadFrame(heart);
-  delay(500);  // Pause for 500 milliseconds (half a second)
+  delay(500);
 
   // Print the current value of millis() to the serial monitor
   Serial.println(millis());

libraries/Arduino_LED_Matrix/examples/GameOfLife/GameOfLife.ino

@@ -13,7 +13,7 @@
   https://docs.arduino.cc/tutorials/uno-r4-wifi/led-matrix
 */
 
-#include "Arduino_LED_Matrix.h"
+#include "Arduino_LED_Matrix.h" // Include the LED_Matrix library
 
 // grid dimensions. should not be larger than 8x8
 #define MAX_Y 8

libraries/Arduino_LED_Matrix/examples/LivePreview/LivePreview.ino

@@ -10,7 +10,7 @@
   https://docs.arduino.cc/tutorials/uno-r4-wifi/led-matrix  
 */
 
-#include "Arduino_LED_Matrix.h" // Include the library for controlling LED matrix
+#include "Arduino_LED_Matrix.h" // Include the LED_Matrix library
 
 ArduinoLEDMatrix matrix;        // Create an instance of the ArduinoLEDMatrix class
 
@@ -35,4 +35,4 @@ void loop() {
      // Load and display the received frame data on the LED matrix
     matrix.loadFrame(frame);
   }
-}
+}

libraries/Arduino_LED_Matrix/examples/MatrixFrameBuffer/MatrixFrameBuffer.ino

@@ -1,23 +1,23 @@
 /*
-Matrix Frame Buffer
-
-This Arduino sketch demonstrates the creation and manipulation of 
-a frame buffer for the LED matrix. The frame buffer is used to control 
-the lighting of individual LEDs on the matrix, turning them randomly on and off.
-
-See the full documentation here:
-https://docs.arduino.cc/tutorials/uno-r4-wifi/led-matrix
+  Matrix Frame Buffer
+  
+  This Arduino sketch demonstrates the creation and manipulation of 
+  a frame buffer for the LED matrix. The frame buffer is used to control 
+  the lighting of individual LEDs on the matrix, turning them randomly on and off.
+  
+  See the full documentation here:
+  https://docs.arduino.cc/tutorials/uno-r4-wifi/led-matrix
 */
 
-// Include the Arduino_LED_Matrix library 
-#include "Arduino_LED_Matrix.h"
+// Include the LED_Matrix library
+#include "Arduino_LED_Matrix.h"  
 
-// Creating an instance of the ArduinoLEDMatrix class
-ArduinoLEDMatrix matrix;
+// Create an instance of the ArduinoLEDMatrix class
+ArduinoLEDMatrix matrix;        
 
-// Defining the frame array for the LED matrix with pixel values
+// Define the frame array for the LED matrix with pixel values
 uint8_t frame[8][12] = {
-  { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 },
+  { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 }, 
   { 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0 },
   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
   { 0, 0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0 },
@@ -27,7 +27,7 @@ uint8_t frame[8][12] = {
   { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 }
 };
 
-// Setting up time intervals and dimensions for the matrix
+// Set up time intervals and dimensions for the matrix
 unsigned long lastTickTime, lastGameTickTime;
 #define UPDATE_INTERVAL 100
 #define GAME_UPDATE_INTERVAL 66
@@ -39,24 +39,24 @@ unsigned long lastTickTime, lastGameTickTime;
 uint8_t pointX = 0, pointY = 0;
 
 void setup() {
-  // Initializing serial communication and delaying for setup
+  // Initialize serial communication and delaying for setup
   Serial.begin(115200);
   delay(1500);
 
-  // Initializing the LED matrix
+  // Initialize the LED matrix
   matrix.begin();
 
-  // Initializing time tracking variables
+  // Initialize time tracking variables
   lastGameTickTime = lastTickTime = millis();
 }
 
 void loop() {
-  // Tracking the current time
+  // Track the current time
   unsigned long msNow = millis();
 
-  // Updating the game logic with a fixed interval
+  // Update the game logic with a fixed interval
   if (msNow - lastGameTickTime > GAME_UPDATE_INTERVAL) {
-    // Incrementing pointX and handling wraparound
+    // Increment pointX and handling wraparound
     pointX++;
     if (pointX >= COLUMNS) {
       pointX = 0;
@@ -66,23 +66,23 @@ void loop() {
       }
     }
 
-    // Generating random positions and pixel value
+    // Generate random positions and pixel value
     pointX = random(COLUMNS);
     pointY = random(ROWS);
     uint8_t pixelValue = random(2);
 
-    // Updating the frame with the new pixel value
+    // Update the frame with the new pixel value
     frame[pointY][pointX] = pixelValue;
 
-    // Updating the last game tick time
+    // Update the last game tick time
     lastGameTickTime = msNow;
   }
 
-  // Rendering the LED matrix with the current frame at a fixed interval
+  // Render the LED matrix with the current frame at a fixed interval
   if (msNow - lastTickTime > UPDATE_INTERVAL) {
     matrix.renderBitmap(frame, 8, 12);
 
-    // Updating the last rendering tick time
+    // Update the last rendering tick time
     lastTickTime = msNow;
   }
 }