Correct typos in comments and documentation

per1234 · per1234 · commit 8b327d7bede1 · 2021-05-26T04:39:38.000-07:00
diff --git a/cores/arduino/HardwareSerial.cpp b/cores/arduino/HardwareSerial.cpp
@@ -219,7 +219,7 @@ void HardwareSerial::flush()
 	  _tx_udr_empty_irq();
   }
   // If we get here, nothing is queued anymore (DRIE is disabled) and
-  // the hardware finished tranmission (TXC is set).
+  // the hardware finished transmission (TXC is set).
 }
 
 size_t HardwareSerial::write(uint8_t c)
diff --git a/cores/arduino/HardwareSerial.h b/cores/arduino/HardwareSerial.h
@@ -32,7 +32,7 @@
 // using a ring buffer (I think), in which head is the index of the location
 // to which to write the next incoming character and tail is the index of the
 // location from which to read.
-// NOTE: a "power of 2" buffer size is reccomended to dramatically
+// NOTE: a "power of 2" buffer size is recommended to dramatically
 //       optimize all the modulo operations for ring buffers.
 // WARNING: When buffer sizes are increased to > 256, the buffer index
 // variables are automatically increased in size, but the extra
diff --git a/cores/arduino/HardwareSerial_private.h b/cores/arduino/HardwareSerial_private.h
@@ -63,7 +63,7 @@
 #endif
 #endif // !defined TXC0
 
-// Check at compiletime that it is really ok to use the bit positions of
+// Check at compile time that it is really ok to use the bit positions of
 // UART0 for the other UARTs as well, in case these values ever get
 // changed for future hardware.
 #if defined(TXC1) && (TXC1 != TXC0 || RXEN1 != RXEN0 || RXCIE1 != RXCIE0 || \
diff --git a/cores/arduino/Print.h b/cores/arduino/Print.h
@@ -59,7 +59,7 @@ class Print
     }
 
     // default to zero, meaning "a single write may block"
-    // should be overriden by subclasses with buffering
+    // should be overridden by subclasses with buffering
     virtual int availableForWrite() { return 0; }
 
     size_t print(const __FlashStringHelper *);
diff --git a/cores/arduino/Stream.h b/cores/arduino/Stream.h
@@ -25,7 +25,7 @@
 #include <inttypes.h>
 #include "Print.h"
 
-// compatability macros for testing
+// compatibility macros for testing
 /*
 #define   getInt()            parseInt()
 #define   getInt(ignore)    parseInt(ignore)
diff --git a/cores/arduino/USBAPI.h b/cores/arduino/USBAPI.h
@@ -32,7 +32,7 @@ typedef unsigned long u32;
 
 #include "Arduino.h"
 
-// This definitions is usefull if you want to reduce the EP_SIZE to 16
+// This definitions is useful if you want to reduce the EP_SIZE to 16
 // at the moment only 64 and 16 as EP_SIZE for all EPs are supported except the control endpoint
 #ifndef USB_EP_SIZE
 #define USB_EP_SIZE 64
diff --git a/cores/arduino/WString.h b/cores/arduino/WString.h
@@ -95,7 +95,7 @@ class String
 
 	// returns true on success, false on failure (in which case, the string
 	// is left unchanged).  if the argument is null or invalid, the
-	// concatenation is considered unsucessful.
+	// concatenation is considered unsuccessful.
 	unsigned char concat(const String &str);
 	unsigned char concat(const char *cstr);
 	unsigned char concat(char c);
@@ -152,7 +152,7 @@ class String
 	unsigned char startsWith(const String &prefix, unsigned int offset) const;
 	unsigned char endsWith(const String &suffix) const;
 
-	// character acccess
+	// character access
 	char charAt(unsigned int index) const;
 	void setCharAt(unsigned int index, char c);
 	char operator [] (unsigned int index) const;
diff --git a/cores/arduino/new.cpp b/cores/arduino/new.cpp
@@ -18,7 +18,7 @@
 
 #include "new.h"
 
-// The C++ spec dicates that allocation failure should cause the
+// The C++ spec dictates that allocation failure should cause the
 // (non-nothrow version of the) operator new to throw an exception.
 // Since we expect to have exceptions disabled, it would be more
 // appropriate (and probably standards-compliant) to terminate instead.
diff --git a/cores/arduino/wiring.c b/cores/arduino/wiring.c
@@ -125,7 +125,7 @@ void delayMicroseconds(unsigned int us)
 	// 2 microseconds) gives delays longer than desired.
 	//delay_us(us);
 #if F_CPU >= 24000000L
-	// for the 24 MHz clock for the aventurous ones, trying to overclock
+	// for the 24 MHz clock for the adventurous ones trying to overclock
 
 	// zero delay fix
 	if (!us) return; //  = 3 cycles, (4 when true)
@@ -135,9 +135,9 @@ void delayMicroseconds(unsigned int us)
 	// delay requested.
 	us *= 6; // x6 us, = 7 cycles
 
-	// account for the time taken in the preceeding commands.
+	// account for the time taken in the preceding commands.
 	// we just burned 22 (24) cycles above, remove 5, (5*4=20)
-	// us is at least 6 so we can substract 5
+	// us is at least 6 so we can subtract 5
 	us -= 5; //=2 cycles
 
 #elif F_CPU >= 20000000L
@@ -157,9 +157,9 @@ void delayMicroseconds(unsigned int us)
 	// delay requested.
 	us = (us << 2) + us; // x5 us, = 7 cycles
 
-	// account for the time taken in the preceeding commands.
+	// account for the time taken in the preceding commands.
 	// we just burned 26 (28) cycles above, remove 7, (7*4=28)
-	// us is at least 10 so we can substract 7
+	// us is at least 10 so we can subtract 7
 	us -= 7; // 2 cycles
 
 #elif F_CPU >= 16000000L
@@ -174,9 +174,9 @@ void delayMicroseconds(unsigned int us)
 	// delay requested.
 	us <<= 2; // x4 us, = 4 cycles
 
-	// account for the time taken in the preceeding commands.
+	// account for the time taken in the preceding commands.
 	// we just burned 19 (21) cycles above, remove 5, (5*4=20)
-	// us is at least 8 so we can substract 5
+	// us is at least 8 so we can subtract 5
 	us -= 5; // = 2 cycles,
 
 #elif F_CPU >= 12000000L
@@ -191,9 +191,9 @@ void delayMicroseconds(unsigned int us)
 	// delay requested.
 	us = (us << 1) + us; // x3 us, = 5 cycles
 
-	// account for the time taken in the preceeding commands.
+	// account for the time taken in the preceding commands.
 	// we just burned 20 (22) cycles above, remove 5, (5*4=20)
-	// us is at least 6 so we can substract 5
+	// us is at least 6 so we can subtract 5
 	us -= 5; //2 cycles
 
 #elif F_CPU >= 8000000L
@@ -208,19 +208,19 @@ void delayMicroseconds(unsigned int us)
 	// delay requested.
 	us <<= 1; //x2 us, = 2 cycles
 
-	// account for the time taken in the preceeding commands.
+	// account for the time taken in the preceding commands.
 	// we just burned 17 (19) cycles above, remove 4, (4*4=16)
-	// us is at least 6 so we can substract 4
+	// us is at least 6 so we can subtract 4
 	us -= 4; // = 2 cycles
 
 #else
 	// for the 1 MHz internal clock (default settings for common Atmega microcontrollers)
 
 	// the overhead of the function calls is 14 (16) cycles
 	if (us <= 16) return; //= 3 cycles, (4 when true)
-	if (us <= 25) return; //= 3 cycles, (4 when true), (must be at least 25 if we want to substract 22)
+	if (us <= 25) return; //= 3 cycles, (4 when true), (must be at least 25 if we want to subtract 22)
 
-	// compensate for the time taken by the preceeding and next commands (about 22 cycles)
+	// compensate for the time taken by the preceding and next commands (about 22 cycles)
 	us -= 22; // = 2 cycles
 	// the following loop takes 4 microseconds (4 cycles)
 	// per iteration, so execute it us/4 times
diff --git a/cores/arduino/wiring_digital.c b/cores/arduino/wiring_digital.c
@@ -67,7 +67,7 @@ void pinMode(uint8_t pin, uint8_t mode)
 //
 // Mark Sproul:
 // - Removed inline. Save 170 bytes on atmega1280
-// - changed to a switch statment; added 32 bytes but much easier to read and maintain.
+// - changed to a switch statement; added 32 bytes but much easier to read and maintain.
 // - Added more #ifdefs, now compiles for atmega645
 //
 //static inline void turnOffPWM(uint8_t timer) __attribute__ ((always_inline));
diff --git a/libraries/EEPROM/README.md b/libraries/EEPROM/README.md
@@ -53,7 +53,7 @@ This function does not return any value.
 This function will retrieve any object from the EEPROM.
 Two parameters are needed to call this function. The first is an `int` containing the address that is to be written, and the second is the object you would like to read.
 
-This function returns a reference to the `object` passed in. It does not need to be used and is only returned for conveience.
+This function returns a reference to the `object` passed in. It does not need to be used and is only returned for convenience.
 
 #### **`EEPROM.put( address, object )`** [[_example_]](examples/eeprom_put/eeprom_put.ino)
 
@@ -62,7 +62,7 @@ Two parameters are needed to call this function. The first is an `int` containin
 
 This function uses the _update_ method to write its data, and therefore only rewrites changed cells.
 
-This function returns a reference to the `object` passed in. It does not need to be used and is only returned for conveience.
+This function returns a reference to the `object` passed in. It does not need to be used and is only returned for convenience.
 
 #### **Subscript operator: `EEPROM[address]`** [[_example_]](examples/eeprom_crc/eeprom_crc.ino)
 
@@ -136,4 +136,4 @@ This is useful for STL objects, custom iteration and C++11 style ranged for loop
 This function returns an `EEPtr` pointing at the location after the last EEPROM cell.  
 Used with `begin()` to provide custom iteration.
 
-**Note:** The `EEPtr` returned is invalid as it is out of range. Infact the hardware causes wrapping of the address (overflow) and `EEPROM.end()` actually references the first EEPROM cell.
+**Note:** The `EEPtr` returned is invalid as it is out of range. In fact the hardware causes wrapping of the address (overflow) and `EEPROM.end()` actually references the first EEPROM cell.
diff --git a/libraries/EEPROM/examples/eeprom_clear/eeprom_clear.ino b/libraries/EEPROM/examples/eeprom_clear/eeprom_clear.ino
@@ -18,9 +18,9 @@ void setup() {
     Iterate through each byte of the EEPROM storage.
 
     Larger AVR processors have larger EEPROM sizes, E.g:
-    - Arduno Duemilanove: 512b EEPROM storage.
-    - Arduino Uno:        1kb EEPROM storage.
-    - Arduino Mega:       4kb EEPROM storage.
+    - Arduino Duemilanove: 512 B EEPROM storage.
+    - Arduino Uno:         1 kB EEPROM storage.
+    - Arduino Mega:        4 kB EEPROM storage.
 
     Rather than hard-coding the length, you should use the pre-provided length function.
     This will make your code portable to all AVR processors.
diff --git a/libraries/EEPROM/examples/eeprom_iteration/eeprom_iteration.ino b/libraries/EEPROM/examples/eeprom_iteration/eeprom_iteration.ino
@@ -54,4 +54,4 @@ void setup() {
 
 } //End of setup function.
 
-void loop() {}
+void loop() {}
diff --git a/libraries/EEPROM/examples/eeprom_read/eeprom_read.ino b/libraries/EEPROM/examples/eeprom_read/eeprom_read.ino
@@ -33,9 +33,9 @@ void loop() {
     Advance to the next address, when at the end restart at the beginning.
 
     Larger AVR processors have larger EEPROM sizes, E.g:
-    - Arduno Duemilanove: 512b EEPROM storage.
-    - Arduino Uno:        1kb EEPROM storage.
-    - Arduino Mega:       4kb EEPROM storage.
+    - Arduino Duemilanove: 512 B EEPROM storage.
+    - Arduino Uno:         1 kB EEPROM storage.
+    - Arduino Mega:        4 kB EEPROM storage.
 
     Rather than hard-coding the length, you should use the pre-provided length function.
     This will make your code portable to all AVR processors.
diff --git a/libraries/EEPROM/examples/eeprom_update/eeprom_update.ino b/libraries/EEPROM/examples/eeprom_update/eeprom_update.ino
@@ -17,7 +17,7 @@
 int address = 0;
 
 void setup() {
-  /** EMpty setup **/
+  /** Empty setup **/
 }
 
 void loop() {
@@ -48,9 +48,9 @@ void loop() {
     Advance to the next address, when at the end restart at the beginning.
 
     Larger AVR processors have larger EEPROM sizes, E.g:
-    - Arduno Duemilanove: 512b EEPROM storage.
-    - Arduino Uno:        1kb EEPROM storage.
-    - Arduino Mega:       4kb EEPROM storage.
+    - Arduino Duemilanove: 512 B EEPROM storage.
+    - Arduino Uno:         1 kB EEPROM storage.
+    - Arduino Mega:        4 kB EEPROM storage.
 
     Rather than hard-coding the length, you should use the pre-provided length function.
     This will make your code portable to all AVR processors.
diff --git a/libraries/EEPROM/examples/eeprom_write/eeprom_write.ino b/libraries/EEPROM/examples/eeprom_write/eeprom_write.ino
@@ -36,9 +36,9 @@ void loop() {
     Advance to the next address, when at the end restart at the beginning.
 
     Larger AVR processors have larger EEPROM sizes, E.g:
-    - Arduno Duemilanove: 512b EEPROM storage.
-    - Arduino Uno:        1kb EEPROM storage.
-    - Arduino Mega:       4kb EEPROM storage.
+    - Arduino Duemilanove: 512 B EEPROM storage.
+    - Arduino Uno:         1 kB EEPROM storage.
+    - Arduino Mega:        4 kB EEPROM storage.
 
     Rather than hard-coding the length, you should use the pre-provided length function.
     This will make your code portable to all AVR processors.
diff --git a/libraries/HID/src/HID.cpp b/libraries/HID/src/HID.cpp
@@ -43,7 +43,7 @@ int HID_::getDescriptor(USBSetup& setup)
 	if (setup.bmRequestType != REQUEST_DEVICETOHOST_STANDARD_INTERFACE) { return 0; }
 	if (setup.wValueH != HID_REPORT_DESCRIPTOR_TYPE) { return 0; }
 
-	// In a HID Class Descriptor wIndex cointains the interface number
+	// In a HID Class Descriptor wIndex contains the interface number
 	if (setup.wIndex != pluggedInterface) { return 0; }
 
 	int total = 0;
diff --git a/libraries/SPI/examples/BarometricPressureSensor/BarometricPressureSensor.ino b/libraries/SPI/examples/BarometricPressureSensor/BarometricPressureSensor.ino
@@ -43,7 +43,7 @@ void setup() {
   // start the SPI library:
   SPI.begin();
 
-  // initalize the  data ready and chip select pins:
+  // initialize the  data ready and chip select pins:
   pinMode(dataReadyPin, INPUT);
   pinMode(chipSelectPin, OUTPUT);
 
@@ -140,4 +140,3 @@ void writeRegister(byte thisRegister, byte thisValue) {
   // take the chip select high to de-select:
   digitalWrite(chipSelectPin, HIGH);
 }
-
diff --git a/libraries/SPI/examples/DigitalPotControl/DigitalPotControl.ino b/libraries/SPI/examples/DigitalPotControl/DigitalPotControl.ino
@@ -14,7 +14,7 @@
  The circuit:
   * All A pins  of AD5206 connected to +5V
   * All B pins of AD5206 connected to ground
-  * An LED and a 220-ohm resisor in series connected from each W pin to ground
+  * An LED and a 220-ohm resistor in series connected from each W pin to ground
   * CS - to digital pin 10  (SS pin)
   * SDI - to digital pin 11 (MOSI pin)
   * CLK - to digital pin 13 (SCK pin)
@@ -27,7 +27,7 @@
 */
 
 
-// inslude the SPI library:
+// include the SPI library:
 #include <SPI.h>
 
 
@@ -64,7 +64,7 @@ void digitalPotWrite(int address, int value) {
   // take the SS pin low to select the chip:
   digitalWrite(slaveSelectPin, LOW);
   delay(100);
-  //  send in the address and value via SPI:
+  // send in the address and value via SPI:
   SPI.transfer(address);
   SPI.transfer(value);
   delay(100);
diff --git a/libraries/SPI/src/SPI.h b/libraries/SPI/src/SPI.h
@@ -106,7 +106,7 @@ class SPISettings {
     // slowest (128 == 2 ^^ 7, so clock_div = 6).
     uint8_t clockDiv;
 
-    // When the clock is known at compiletime, use this if-then-else
+    // When the clock is known at compile time, use this if-then-else
     // cascade, which the compiler knows how to completely optimize
     // away. When clock is not known, use a loop instead, which generates
     // shorter code.
diff --git a/libraries/SoftwareSerial/examples/SoftwareSerialExample/SoftwareSerialExample.ino b/libraries/SoftwareSerial/examples/SoftwareSerialExample/SoftwareSerialExample.ino
@@ -1,5 +1,5 @@
 /*
-  Software serial multple serial test
+  Software serial multiple serial test
 
  Receives from the hardware serial, sends to software serial.
  Receives from software serial, sends to hardware serial.
@@ -52,4 +52,3 @@ void loop() { // run over and over
     mySerial.write(Serial.read());
   }
 }
-
diff --git a/libraries/SoftwareSerial/examples/TwoPortReceive/TwoPortReceive.ino b/libraries/SoftwareSerial/examples/TwoPortReceive/TwoPortReceive.ino
@@ -1,5 +1,5 @@
 /*
-  Software serial multple serial test
+  Software serial multiple serial test
 
  Receives from the two software serial ports,
  sends to the hardware serial port.
@@ -56,7 +56,7 @@ void setup() {
 }
 
 void loop() {
-  // By default, the last intialized port is listening.
+  // By default, the last initialized port is listening.
   // when you want to listen on a port, explicitly select it:
   portOne.listen();
   Serial.println("Data from port one:");
@@ -83,9 +83,3 @@ void loop() {
   // blank line to separate data from the two ports:
   Serial.println();
 }
-
-
-
-
-
-
diff --git a/libraries/Wire/examples/SFRRanger_reader/SFRRanger_reader.ino b/libraries/Wire/examples/SFRRanger_reader/SFRRanger_reader.ino
@@ -3,7 +3,7 @@
 // and James Tichenor <http://www.jamestichenor.net>
 
 // Demonstrates use of the Wire library reading data from the
-// Devantech Utrasonic Rangers SFR08 and SFR10
+// Devantech Ultrasonic Rangers SFR08 and SFR10
 
 // Created 29 April 2006
 
@@ -13,8 +13,8 @@
 #include <Wire.h>
 
 void setup() {
-  Wire.begin();                // join i2c bus (address optional for master)
-  Serial.begin(9600);          // start serial communication at 9600bps
+  Wire.begin();                // join I2C bus (address optional for master)
+  Serial.begin(9600);          // start serial communication at 9600 bps
 }
 
 int reading = 0;
@@ -23,7 +23,7 @@ void loop() {
   // step 1: instruct sensor to read echoes
   Wire.beginTransmission(112); // transmit to device #112 (0x70)
   // the address specified in the datasheet is 224 (0xE0)
-  // but i2c adressing uses the high 7 bits so it's 112
+  // but I2C addressing uses the high 7 bits so it's 112
   Wire.write(byte(0x00));      // sets register pointer to the command register (0x00)
   Wire.write(byte(0x50));      // command sensor to measure in "inches" (0x50)
   // use 0x51 for centimeters
diff --git a/libraries/Wire/examples/digital_potentiometer/digital_potentiometer.ino b/libraries/Wire/examples/digital_potentiometer/digital_potentiometer.ino
diff --git a/libraries/Wire/examples/i2c_scanner/i2c_scanner.ino b/libraries/Wire/examples/i2c_scanner/i2c_scanner.ino
diff --git a/libraries/Wire/examples/master_reader/master_reader.ino b/libraries/Wire/examples/master_reader/master_reader.ino
diff --git a/libraries/Wire/examples/master_writer/master_writer.ino b/libraries/Wire/examples/master_writer/master_writer.ino
diff --git a/libraries/Wire/examples/slave_receiver/slave_receiver.ino b/libraries/Wire/examples/slave_receiver/slave_receiver.ino
diff --git a/libraries/Wire/examples/slave_sender/slave_sender.ino b/libraries/Wire/examples/slave_sender/slave_sender.ino
diff --git a/libraries/Wire/src/Wire.cpp b/libraries/Wire/src/Wire.cpp
diff --git a/libraries/Wire/src/utility/twi.c b/libraries/Wire/src/utility/twi.c
diff --git a/programmers.txt b/programmers.txt

Original file line number	Diff line number	Diff line change
`@@ -219,7 +219,7 @@ void HardwareSerial::flush()`
`219`	`219`	`_tx_udr_empty_irq();`
`220`	`220`	`}`
`221`	`221`	`// If we get here, nothing is queued anymore (DRIE is disabled) and`
`222`		`- // the hardware finished tranmission (TXC is set).`
	`222`	`+ // the hardware finished transmission (TXC is set).`
`223`	`223`	`}`
`224`	`224`
`225`	`225`	`size_t HardwareSerial::write(uint8_t c)`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ class Print`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`// default to zero, meaning "a single write may block"`
`62`		`- // should be overriden by subclasses with buffering`
	`62`	`+ // should be overridden by subclasses with buffering`
`63`	`63`	`virtual int availableForWrite() { return 0; }`
`64`	`64`
`65`	`65`	`size_t print(const __FlashStringHelper *);`