Correct typos in comments and documentation

Author: per1234

MDNS.cpp

@@ -402,7 +402,7 @@ MDNSError_t MDNS::_sendMDNSMessage(uint32_t /*peerAddress*/, uint32_t xid, int t
             ptr += slen;
          }
 
-         // PTR record (for the dns-sd service in general)
+         // PTR record (for the DNS-SD service in general)
          this->_writeDNSName((const uint8_t*)DNS_SD_SERVICE, &ptr, buf,
                                           sizeof(DNSHeader_t), 1);
 
@@ -783,9 +783,9 @@ MDNSError_t MDNS::_processMDNSQuery()
                         for (j=0; j<MDNS_MAX_SERVICES_PER_PACKET; j++) {
                            if (NULL != ptrNames[j] && ptrNamesMatches[j]) {
                               // only compare the part we have. this is incorrect, but good enough,
-                              // since actual MDNS implementations won't go here anyways, as they
+                              // since actual mDNS implementations won't go here anyways, as they
                               // should use name compression. This is just so that multiple Arduinos
-                              // running this MDNSResponder code should be able to find each other's
+                              // running this mDNSResponder code should be able to find each other's
                               // services.
                               if (ptrLensCmp[j] >= ir) 
                                  ptrNamesMatches[j] &= this->_matchStringPart(&ptrNamesCmp[j],
@@ -800,7 +800,7 @@ MDNSError_t MDNS::_processMDNSQuery()
             } while (rLen > 0 && rLen <= 128);
 
             // if this matched a name of ours (and there are no characters left), then
-            // check wether this is an A record query (for our own name) or a PTR record query
+            // check whether this is an A record query (for our own name) or a PTR record query
             // (for one of our services).
             // if so, we'll note to send a record
             if (i < qCnt)
@@ -982,7 +982,7 @@ MDNSError_t MDNS::_processMDNSQuery()
                   for (j=0; j<MDNS_MAX_SERVICES_PER_PACKET; j++) {
                      if (servIPs[j][0] == ptrIPs[i] || servIPs[j][0] == 255) {
                         // the || part is such a hack, but it will work as long as there's only
-                        // one A record per MDNS packet. fucking DNS name compression.                     
+                        // one A record per mDNS packet. fucking DNS name compression.                     
                         ipAddr = &servIPs[j][1];
 
                         break;
@@ -1051,7 +1051,7 @@ void MDNS::run()
    uint8_t i;
    unsigned long now = millis();
 
-   // first, look for MDNS queries to handle
+   // first, look for mDNS queries to handle
    (void)_processMDNSQuery();
 
    // are we querying a name or service? if so, should we resend the packet or time out?

examples/Ethernet/DiscoveringServices/DiscoveringServices.ino

@@ -48,7 +48,7 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(Ethernet.localIP(), "arduino");
 
@@ -70,7 +70,7 @@ void loop()
   char serviceName[256];
   int length = 0;
 
-  // read in a service name from the Arduino IDE's serial monitor.
+  // read in a service name from the Arduino IDE's Serial Monitor.
   while (Serial.available()) {
     serviceName[length] = Serial.read();
     length = (length+1) % 256;
@@ -108,7 +108,7 @@ void loop()
   mdns.run();
 }
 
-// This function is called when a name is resolved via MDNS/Bonjour. We set
+// This function is called when a name is resolved via mDNS/Bonjour. We set
 // this up in the setup() function above. The name you give to this callback
 // function does not matter at all, but it must take exactly these arguments
 // as below.
@@ -159,4 +159,3 @@ void serviceFound(const char* type, MDNSServiceProtocol /*proto*/,
     }
   }
 }
-

examples/Ethernet/RegisteringServices/RegisteringServices.ino

@@ -48,15 +48,15 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(Ethernet.localIP(), "arduino");
 
   // Now let's register the service we're offering (a web service) via mDNS!
   // To do so, we call the addServiceRecord() method. The first argument is the
   // name of our service instance and its type, separated by a dot. In this
   // case, the service type is _http. There are many other service types, use
-  // google to look up some common ones, but you can also invent your own
+  // Google to look up some common ones, but you can also invent your own
   // service type, like _mycoolservice - As long as your clients know what to
   // look for, you're good to go.
   // The second argument is the port on which the service is running. This is
@@ -84,16 +84,16 @@ void loop()
   // in the browser when you connect.
   EthernetClient client = server.available();
   if (client) {
-    // an http request ends with a blank line
+    // an HTTP request ends with a blank line
     bool current_line_is_blank = true;
     while (client.connected()) {
       if (client.available()) {
         char c = client.read();
         // if we've gotten to the end of the line (received a newline
-        // character) and the line is blank, the http request has ended,
+        // character) and the line is blank, the HTTP request has ended,
         // so we can send a reply
         if (c == '\n' && current_line_is_blank) {
-          // send a standard http response header
+          // send a standard HTTP response header
           client.println("HTTP/1.1 200 OK");
           client.println("Content-Type: text/html");
           client.println();

examples/Ethernet/RegisteringServicesWithTxtRecord/RegisteringServicesWithTxtRecord.ino

@@ -46,15 +46,15 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(Ethernet.localIP(), "arduino");
 
   // Now let's register the service we're offering (a web service) via mDNS!
   // To do so, we call the addServiceRecord() method. The first argument is the
   // name of our service instance and its type, separated by a dot. In this
   // case, the service type is _http. There are many other service types, use
-  // google to look up some common ones, but you can also invent your own
+  // Google to look up some common ones, but you can also invent your own
   // service type, like _mycoolservice - As long as your clients know what to
   // look for, you're good to go.
   // The second argument is the port on which the service is running. This is
@@ -98,7 +98,7 @@ void loop()
   char lastLetter = '\0';
   char isPage2 = 0;
   if (client) {
-    // an http request ends with a blank line
+    // an HTTP request ends with a blank line
     bool current_line_is_blank = true;
     while (client.connected()) {
       if (client.available()) {
@@ -109,10 +109,10 @@ void loop()
         lastLetter = c;
 
         // if we've gotten to the end of the line (received a newline
-        // character) and the line is blank, the http request has ended,
+        // character) and the line is blank, the HTTP request has ended,
         // so we can send a reply
         if (c == '\n' && current_line_is_blank) {
-          // send a standard http response header
+          // send a standard HTTP response header
           client.println("HTTP/1.1 200 OK");
           client.println("Content-Type: text/html");
           client.println();

examples/Ethernet/ResolvingHostNames/ResolvingHostNames.ino

@@ -18,7 +18,7 @@
 //  <http://www.gnu.org/licenses/>.
 //
 
-//  Illustrates how to resolve host names via MDNS (Multicast DNS)
+//  Illustrates how to resolve host names via mDNS (Multicast DNS)
 
 
 #include <SPI.h>
@@ -47,7 +47,7 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(Ethernet.localIP(), "arduino");
 
@@ -67,7 +67,7 @@ void loop()
   char hostName[512];
   int length = 0;
 
-  // read in a host name from the Arduino IDE's serial monitor.
+  // read in a host name from the Arduino IDE's Serial Monitor.
   while (Serial.available()) {
     hostName[length] = Serial.read();
     length = (length+1) % 512;
@@ -118,4 +118,3 @@ void nameFound(const char* name, IPAddress ip)
     Serial.println("' timed out.");
   }
 }
-

examples/WiFi/WiFiDiscoveringServices/WiFiDiscoveringServices.ino

@@ -27,7 +27,7 @@
 
 char ssid[] = "yourNetwork";     //  your network SSID (name)
 char pass[] = "secretPassword";  // your network password
-int status = WL_IDLE_STATUS;     // the Wifi radio's status
+int status = WL_IDLE_STATUS;     // the WiFi radio's status
 
 WiFiUDP udp;
 MDNS mdns(udp);
@@ -51,7 +51,7 @@ void setup()
     while (true);
   }
 
-  // attempt to connect to Wifi network:
+  // attempt to connect to WiFi network:
   while ( status != WL_CONNECTED) {
     Serial.print("Attempting to connect to WPA SSID: ");
     Serial.println(ssid);
@@ -66,7 +66,7 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(WiFi.localIP(), "arduino");
 
@@ -87,7 +87,7 @@ void loop()
   char serviceName[256];
   int length = 0;
 
-  // read in a service name from the Arduino IDE's serial monitor.
+  // read in a service name from the Arduino IDE's Serial Monitor.
   while (Serial.available()) {
     serviceName[length] = Serial.read();
     length = (length+1) % 256;
@@ -176,4 +176,3 @@ void serviceFound(const char* type, MDNSServiceProtocol /*proto*/,
     }
   }
 }
-

examples/WiFi/WiFiRegisteringServices/WiFiRegisteringServices.ino

@@ -27,7 +27,7 @@
 
 char ssid[] = "yourNetwork";     //  your network SSID (name)
 char pass[] = "secretPassword";  // your network password
-int status = WL_IDLE_STATUS;     // the Wifi radio's status
+int status = WL_IDLE_STATUS;     // the WiFi radio's status
 
 WiFiUDP udp;
 MDNS mdns(udp);
@@ -48,7 +48,7 @@ void setup()
     while (true);
   }
 
-  // attempt to connect to Wifi network:
+  // attempt to connect to WiFi network:
   while ( status != WL_CONNECTED) {
     Serial.print("Attempting to connect to WPA SSID: ");
     Serial.println(ssid);
@@ -65,15 +65,15 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(WiFi.localIP(), "arduino");
 
   // Now let's register the service we're offering (a web service) via Bonjour!
   // To do so, we call the addServiceRecord() method. The first argument is the
   // name of our service instance and its type, separated by a dot. In this
   // case, the service type is _http. There are many other service types, use
-  // google to look up some common ones, but you can also invent your own
+  // Google to look up some common ones, but you can also invent your own
   // service type, like _mycoolservice - As long as your clients know what to
   // look for, you're good to go.
   // The second argument is the port on which the service is running. This is
@@ -101,16 +101,16 @@ void loop()
   // in the browser when you connect.
   WiFiClient client = server.available();
   if (client) {
-    // an http request ends with a blank line
+    // an HTTP request ends with a blank line
     bool current_line_is_blank = true;
     while (client.connected()) {
       if (client.available()) {
         char c = client.read();
         // if we've gotten to the end of the line (received a newline
-        // character) and the line is blank, the http request has ended,
+        // character) and the line is blank, the HTTP request has ended,
         // so we can send a reply
         if (c == '\n' && current_line_is_blank) {
-          // send a standard http response header
+          // send a standard HTTP response header
           client.println("HTTP/1.1 200 OK");
           client.println("Content-Type: text/html");
           client.println();

examples/WiFi/WiFiRegisteringServicesWithTxtRecord/WiFiRegisteringServicesWithTxtRecord.ino

@@ -27,7 +27,7 @@
 
 char ssid[] = "yourNetwork";     //  your network SSID (name)
 char pass[] = "secretPassword";  // your network password
-int status = WL_IDLE_STATUS;     // the Wifi radio's status
+int status = WL_IDLE_STATUS;     // the WiFi radio's status
 
 WiFiUDP udp;
 MDNS mdns(udp);
@@ -48,7 +48,7 @@ void setup()
     while (true);
   }
 
-  // attempt to connect to Wifi network:
+  // attempt to connect to WiFi network:
   while ( status != WL_CONNECTED) {
     Serial.print("Attempting to connect to WPA SSID: ");
     Serial.println(ssid);
@@ -65,15 +65,15 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(WiFi.localIP(), "arduino");
 
   // Now let's register the service we're offering (a web service) via Bonjour!
   // To do so, we call the addServiceRecord() method. The first argument is the
   // name of our service instance and its type, separated by a dot. In this
   // case, the service type is _http. There are many other service types, use
-  // google to look up some common ones, but you can also invent your own
+  // Google to look up some common ones, but you can also invent your own
   // service type, like _mycoolservice - As long as your clients know what to
   // look for, you're good to go.
   // The second argument is the port on which the service is running. This is
@@ -117,7 +117,7 @@ void loop()
   char lastLetter = '\0';
   char isPage2 = 0;
   if (client) {
-    // an http request ends with a blank line
+    // an HTTP request ends with a blank line
     bool current_line_is_blank = true;
     while (client.connected()) {
       if (client.available()) {
@@ -128,10 +128,10 @@ void loop()
         lastLetter = c;
 
         // if we've gotten to the end of the line (received a newline
-        // character) and the line is blank, the http request has ended,
+        // character) and the line is blank, the HTTP request has ended,
         // so we can send a reply
         if (c == '\n' && current_line_is_blank) {
-          // send a standard http response header
+          // send a standard HTTP response header
           client.println("HTTP/1.1 200 OK");
           client.println("Content-Type: text/html");
           client.println();

examples/WiFi/WiFiResolvingHostNames/WiFiResolvingHostNames.ino

@@ -18,7 +18,7 @@
 //  <http://www.gnu.org/licenses/>.
 //
 
-//  Illustrates how to resolve host names via MDNS (Multicast DNS)
+//  Illustrates how to resolve host names via mDNS (Multicast DNS)
 
 
 #include <SPI.h>
@@ -28,7 +28,7 @@
 
 char ssid[] = "yourNetwork";     //  your network SSID (name)
 char pass[] = "secretPassword";  // your network password
-int status = WL_IDLE_STATUS;     // the Wifi radio's status
+int status = WL_IDLE_STATUS;     // the WiFi radio's status
 
 WiFiUDP udp;
 MDNS mdns(udp);
@@ -50,7 +50,7 @@ void setup()
     while (true);
   }
 
-  // attempt to connect to Wifi network:
+  // attempt to connect to WiFi network:
   while ( status != WL_CONNECTED) {
     Serial.print("Attempting to connect to WPA SSID: ");
     Serial.println(ssid);
@@ -65,7 +65,7 @@ void setup()
 
   // Initialize the mDNS library. You can now reach or ping this
   // Arduino via the host name "arduino.local", provided that your operating
-  // system is mDNS/Bonjour-enabled (such as MacOS X).
+  // system is mDNS/Bonjour-enabled (such as macOS).
   // Always call this before any other method!
   mdns.begin(WiFi.localIP(), "arduino");
 
@@ -84,7 +84,7 @@ void loop()
   char hostName[512];
   int length = 0;
 
-  // read in a host name from the Arduino IDE's serial monitor.
+  // read in a host name from the Arduino IDE's Serial Monitor.
   while (Serial.available()) {
     hostName[length] = Serial.read();
     length = (length+1) % 512;
@@ -135,4 +135,3 @@ void nameFound(const char* name, IPAddress ip)
     Serial.println("' timed out.");
   }
 }
-